tox 4.0 replacement for TOX_TESTENV_PASSENV

[jwodder]

I have a CI job that runs tox with some environment variables passed through by setting TOX_TESTENV_PASSENV to a space-separated (later changed to comma-separated on a hunch) list of the names of the envvars. When tox 4.0 was released, this stopped working, and I cannot find any equivalent of TOX_TESTENV_PASSENV in the new documentation. What is the proper equivalent of this envvar under tox 4.0?

[gaborbernat]

Hm, using this env var feels like an anti-pattern as you're making your CI behave differently than local. Why not just add those values into passenv?

Similar functionality can be done with tox 4 with https://tox.wiki/en/latest/cli_interface.html#tox-run---override, which works as an env-var too TOX_OVERRIDE=testenv.passenv=A,B,C I believe.

[jaraco]

I've been unsuccessful in passing multiple variables:

 jaraco.mongodb debt/win-timeout @ env 'TOX_OVERRIDE=testenv.pass_env=FOO,BAR' tox c -k pass_env
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
ROOT: env var TOX_OVERRIDE='testenv.pass_env=FOO,BAR' cannot be transformed to typing.List[tox.config.loader.api.Override] because ArgumentTypeError('override BAR has no = sign in it')
[testenv:py]
pass_env =
  CC
  CCSHARED
  CFLAGS
  CPPFLAGS
  CURL_CA_BUNDLE
  CXX
  HOME
  LANG
  LANGUAGE
  LDFLAGS
  LD_LIBRARY_PATH
  PIP_*
  PKG_CONFIG
  PKG_CONFIG_PATH
  PKG_CONFIG_SYSROOT_DIR
  REQUESTS_CA_BUNDLE
  SSL_CERT_FILE
  TERM
  TMPDIR
  VIRTUALENV_*
  http_proxy
  https_proxy
  no_proxy

Why not just add those values into passenv?

I'm trying to passthrough GITHUB_* and RUNNER_* to allow the tests to accommodate slow runners on Windows on Github (jaraco/jaraco.mongodb@cd1cf2d). I only expect those to be present in CI and thus want to keep that concern local to that environment's config.

[gaborbernat]

Did you read https://tox.wiki/en/latest/config.html#overriding-configuration-from-the-command-line?

[gaborbernat]

Ah, the issue here is related to the fact that we allow multiple overrides. So TOX_OVERRIDE='testenv.pass_env=FOO,BAR' is actually broken down into two override, one testenv.pass_env=FOO and one BAR... If you use the CLI flags you'll not run into this issue. But not sure what we can do about env-vars.

[gaborbernat]

This will work:

tox -x 'testenv.pass_env=FOO,BAR' c -k pass_env -e p

[gaborbernat]

@jaraco #3111 should fix your issue

[hashar]

I have the use case for CI to set:

XDG_CACHE_HOME: from the above it looks like that can be done by setting TOX_OVERRIDE='testenv.pass_env=XDG_CACHE_HOME

PY_COLORS=1: which I guess can be done using TOX_OVERRIDE='testenv.set_env=PY_COLORS=1. And it looks like it is working:

$ TOX_OVERRIDE=testenv.pass_env=XDG_CACHE_HOME,testenv.set_env=PY_COLORS=1 tox config -k setenv pass_env
[testenv:demo]
set_env = 
  ...
  PY_COLORS=1
pass_env =
  ...
  XDG_CACHE_HOME