Support all Unix shell-style wildcards for pass_env (#2145)

Signed-off-by: Bernát Gábor <[email protected]>

Author: gaborbernat

docs/changelog/2121.feature.rst

@@ -0,0 +1 @@
+Allow any Unix shell-style wildcards expression for  :ref:`pass_env` - by :user:`gaborbernat`.

docs/config.rst

@@ -242,11 +242,10 @@ Base
    :keys: pass_env, passenv
    :default: <empty list>
 
-   Environment variables to pass on to the tox environment. You can use the ``*`` to express wildcard expressions, e.g.
-   ``PIP_*`` translates to all environment variables that start with the ``PIP_`` characters.  If a specified
-   environment variable doesn't exist in the tox invocation environment it is ignored. The list of environment variable
-   names is not case sensitive, and all variables that match when upper cased will be passed. For example, passing ``A``
-   will pass both ``A`` and ``a``.
+   Environment variables to pass on to the tox environment. The values are evaluated as UNIX shell-style wildcards, see
+   `fnmatch <https://docs.python.org/3/library/fnmatch.html>`_  If a specified environment variable doesn't exist in the
+   tox invocation environment it is ignored. The list of environment variable names is not case sensitive, for example:
+   passing ``A`` or ``a`` will pass through both ``A`` and ``a``.
 
 .. conf::
    :keys: set_env, setenv

src/tox/tox_env/api.py

@@ -1,6 +1,7 @@
 """
 Defines the abstract base traits of a tox environment.
 """
+import fnmatch
 import logging
 import os
 import re
@@ -278,17 +279,8 @@ def _clean(self, force: bool = False) -> None:  # noqa: U100
     def _environment_variables(self) -> Dict[str, str]:
         if self._env_vars is not None:
             return self._env_vars
-        result: Dict[str, str] = {}
         pass_env: List[str] = self.conf["pass_env"]
-        glob_pass_env = [re.compile(e.replace("*", ".*")) for e in pass_env if "*" in e]
-        literal_pass_env = [e for e in pass_env if "*" not in e]
-        for env in literal_pass_env:
-            if env in os.environ:  # pragma: no branch
-                result[env] = os.environ[env]
-        if glob_pass_env:  # pragma: no branch
-            for env, value in os.environ.items():
-                if any(g.match(env) is not None for g in glob_pass_env):
-                    result[env] = value
+        result = self._load_pass_env(pass_env)
         set_env: SetEnv = self.conf["set_env"]
         # load/paths_env might trigger a load of the environment variables, set result here, returns current state
         self._env_vars = result
@@ -298,6 +290,15 @@ def _environment_variables(self) -> Dict[str, str]:
             result[key] = set_env.load(key)
         return result
 
+    @staticmethod
+    def _load_pass_env(pass_env: List[str]) -> Dict[str, str]:
+        result: Dict[str, str] = {}
+        patterns = [re.compile(fnmatch.translate(e), re.IGNORECASE) for e in pass_env]
+        for env, value in os.environ.items():
+            if any(p.match(env) for p in patterns):
+                result[env] = value
+        return result
+
     @property
     def _paths(self) -> List[Path]:
         return self._paths_private

tests/tox_env/test_tox_env_api.py

@@ -1,7 +1,11 @@
 from pathlib import Path
 from textwrap import dedent
+from unittest.mock import patch
+
+import pytest
 
 from tox.pytest import ToxProjectCreator
+from tox.tox_env.api import ToxEnv
 
 
 def test_recreate(tox_project: ToxProjectCreator) -> None:
@@ -60,3 +64,23 @@ def test_env_log(tox_project: ToxProjectCreator) -> None:
     result_second.assert_success()
     filename = {i.name for i in log_dir.iterdir()}
     assert filename == {"1-commands[0].log"}
+
+
+def test_tox_env_pass_env_literal_exist() -> None:
+    with patch("os.environ", {"A": "1"}):
+        env = ToxEnv._load_pass_env(["A"])
+    assert env == {"A": "1"}
+
+
+def test_tox_env_pass_env_literal_miss() -> None:
+    with patch("os.environ", {}):
+        env = ToxEnv._load_pass_env(["A"])
+    assert not env
+
+
+@pytest.mark.parametrize("glob", ["*", "?"])
+@pytest.mark.parametrize("char", ["a", "A"])
+def test_tox_env_pass_env_match_ignore_case(char: str, glob: str) -> None:
+    with patch("os.environ", {"A1": "1", "a2": "2", "A2": "3", "B": "4"}):
+        env = ToxEnv._load_pass_env([f"{char}{glob}"])
+    assert env == {"A1": "1", "a2": "2", "A2": "3"}

whitelist.txt

@@ -44,7 +44,7 @@ dedent
 deinit
 delenv
 dep
-deps
+Deps
 desc
 dest
 devenv
@@ -100,6 +100,7 @@ hookspecs
 htmlhelp
 ident
 IGN
+IGNORECASE
 impl
 INET
 insort
@@ -170,7 +171,7 @@ refspec
 reftitle
 releaselevel
 replacer
-repo
+Repo
 req
 reqs
 retann
@@ -205,7 +206,7 @@ testenv
 textwrap
 tmp
 tmpdir
-toml
+Toml
 tomli
 towncrier
 tox