Merge pull request #459 from jarshwah/master

passenv respects PYTHONPATH. Fixes #457 and #458

Author: hpk42

CONTRIBUTORS

@@ -9,7 +9,7 @@ Barry Warsaw
 Chris Rose
 Jannis Leidel
 Ronny Pfannschmidt
-Lukasz Balcerzak 
+Lukasz Balcerzak
 Philip Thiem
 Monty Taylor
 Bruno Oliveira
@@ -39,3 +39,4 @@ Eli Collins
 Andrii Soldatenko
 Igor Duarte Cardoso
 Allan Feldman
+Josh Smeaton

doc/config.txt

@@ -222,6 +222,12 @@ Complete list of settings that you can put into ``testenv*`` sections:
    invocation environment) can define additional space-separated variable
    names that are to be passed down to the test command environment.
 
+   .. versionchanged:: 2.7
+
+   ``PYTHONPATH`` will be passed down if explicitly defined. If ``PYTHONPATH``
+   exists in the host environment but is **not** declared in ``passenv`` a
+   warning will be emitted.
+
 .. confval:: recreate=True|False(default)
 
     Always recreate virtual environment if this option is True.

tests/test_venv.py

@@ -561,6 +561,39 @@ def test_envbinddir_path(self, newmocksession, monkeypatch):
         assert 'PIP_REQUIRE_VIRTUALENV' not in os.environ
         assert '__PYVENV_LAUNCHER__' not in os.environ
 
+    def test_pythonpath_usage(self, newmocksession, monkeypatch):
+        monkeypatch.setenv("PYTHONPATH", "/my/awesome/library")
+        mocksession = newmocksession([], """
+            [testenv:python]
+            commands=abc
+        """)
+        venv = mocksession.getenv("python")
+        action = mocksession.newaction(venv, "getenv")
+        venv.run_install_command(['qwe'], action=action)
+        assert 'PYTHONPATH' not in os.environ
+        mocksession.report.expect("warning", "*Discarding $PYTHONPATH from environment*")
+
+        l = mocksession._pcalls
+        assert len(l) == 1
+        assert 'PYTHONPATH' not in l[0].env
+
+        # passenv = PYTHONPATH allows PYTHONPATH to stay in environment
+        monkeypatch.setenv("PYTHONPATH", "/my/awesome/library")
+        mocksession = newmocksession([], """
+            [testenv:python]
+            commands=abc
+            passenv = PYTHONPATH
+        """)
+        venv = mocksession.getenv("python")
+        action = mocksession.newaction(venv, "getenv")
+        venv.run_install_command(['qwe'], action=action)
+        assert 'PYTHONPATH' in os.environ
+        mocksession.report.not_expect("warning", "*Discarding $PYTHONPATH from environment*")
+
+        l = mocksession._pcalls
+        assert len(l) == 2
+        assert l[1].env['PYTHONPATH'] == '/my/awesome/library'
+
 
 def test_env_variables_added_to_pcall(tmpdir, mocksession, newconfig, monkeypatch):
     pkg = tmpdir.ensure("package.tar.gz")
@@ -572,11 +605,11 @@ def test_env_variables_added_to_pcall(tmpdir, mocksession, newconfig, monkeypatc
         passenv = x123
         setenv =
             ENV_VAR = value
+            PYTHONPATH = value
     """)
     mocksession._clearmocks()
 
     venv = VirtualEnv(config.envconfigs['python'], session=mocksession)
-    # import pdb; pdb.set_trace()
     mocksession.installpkg(venv, pkg)
     venv.test()
 
@@ -589,13 +622,18 @@ def test_env_variables_added_to_pcall(tmpdir, mocksession, newconfig, monkeypatc
         assert env['ENV_VAR'] == 'value'
         assert env['VIRTUAL_ENV'] == str(venv.path)
         assert env['X123'] == "123"
+        assert 'PYTHONPATH' in env
+        assert env['PYTHONPATH'] == 'value'
     # all env variables are passed for installation
     assert l[0].env["YY"] == "456"
     assert "YY" not in l[1].env
 
     assert set(["ENV_VAR", "VIRTUAL_ENV", "PYTHONHASHSEED", "X123", "PATH"])\
         .issubset(l[1].env)
 
+    # setenv does not trigger PYTHONPATH warnings
+    mocksession.report.not_expect("warning", "*Discarding $PYTHONPATH from environment*")
+
     # for e in os.environ:
     #    assert e in env
 

tox/venv.py

@@ -275,9 +275,18 @@ def run_install_command(self, packages, action, options=()):
             argv[i:i + 1] = list(options)
 
         for x in ('PIP_RESPECT_VIRTUALENV', 'PIP_REQUIRE_VIRTUALENV',
-                  '__PYVENV_LAUNCHER__', 'PYTHONPATH'):
+                  '__PYVENV_LAUNCHER__'):
             os.environ.pop(x, None)
 
+        if 'PYTHONPATH' not in self.envconfig.passenv:
+            # If PYTHONPATH not explicitly asked for, remove it.
+            if 'PYTHONPATH' in os.environ:
+                self.session.report.warning(
+                    "Discarding $PYTHONPATH from environment, to override "
+                    "specify PYTHONPATH in 'passenv' in your configuration."
+                )
+                os.environ.pop('PYTHONPATH')
+
         old_stdout = sys.stdout
         sys.stdout = codecs.getwriter('utf8')(sys.stdout)
         self._pcall(argv, cwd=self.envconfig.config.toxinidir, action=action,