Install pypi dependencies and run all commands from activated anaconda envs (#71)

Co-authored-by: Antoine DECHAUME <[email protected]>

Author: AntoineD

tests/test_conda.py

@@ -23,3 +23,34 @@ def index_of(m):
     ), result.output()
 
     assert result.outlines[-4] == "True"
+
+
+def test_conda_run_command(cmd, initproj):
+    """Check that all the commands are run from an activated anaconda env.
+
+    This is done by looking at the CONDA_PREFIX environment variable which contains
+    the environment name.
+    This variable is dumped to a file because commands_{pre,post} do not redirect
+    their outputs.
+    """
+    env_name = "foobar"
+    initproj(
+        "pkg-1",
+        filedefs={
+            "tox.ini": """
+                [tox]
+                skipsdist=True
+                [testenv:{}]
+                commands_pre = python -c "import os; open('commands_pre', 'w').write(os.environ['CONDA_PREFIX'])"
+                commands = python -c "import os; open('commands', 'w').write(os.environ['CONDA_PREFIX'])"
+                commands_post = python -c "import os; open('commands_post', 'w').write(os.environ['CONDA_PREFIX'])"
+            """.format(  # noqa: E501
+                env_name
+            )
+        },
+    )
+    result = cmd("-v", "-e", env_name)
+    result.assert_success()
+
+    for filename in ("commands_pre", "commands_post", "commands"):
+        assert open(filename).read().endswith(env_name)

tests/test_conda_env.py

@@ -62,7 +62,7 @@ def test_install_deps_no_conda(newconfig, mocksession):
     assert len(pcalls) >= 1
     call = pcalls[-1]
     cmd = call.args
-    assert cmd[1:4] == ["-m", "pip", "install"]
+    assert cmd[6:9] == ["-m", "pip", "install"]
 
 
 def test_install_conda_deps(newconfig, mocksession):
@@ -97,8 +97,8 @@ def test_install_conda_deps(newconfig, mocksession):
     assert conda_cmd[7:9] == ["pytest", "asdf"]
 
     pip_cmd = pcalls[-1].args
-    assert pip_cmd[1:4] == ["-m", "pip", "install"]
-    assert pip_cmd[4:6] == ["numpy", "astropy"]
+    assert pip_cmd[6:9] == ["-m", "pip", "install"]
+    assert pip_cmd[9:11] == ["numpy", "astropy"]
 
 
 def test_install_conda_no_pip(newconfig, mocksession):

tox_conda/plugin.py

@@ -48,6 +48,27 @@ def get_py_version(envconfig, action):
     return "python={}".format(version)
 
 
+class CondaRunWrapper:
+    """A functor that execute a command via conda run.
+
+    It wraps popen so the command is executed in the context of an activated env.
+    """
+
+    CONDA_RUN_CMD_PREFIX = "{conda_exe} run --no-capture-output -p {envdir}"
+
+    def __init__(self, venv, popen):
+        self.__envdir = venv.envconfig.envdir
+        self.__conda_exe = venv.envconfig.conda_exe
+        self.__popen = popen
+
+    def __call__(self, cmd_args, **kwargs):
+        conda_run_cmd_prefix = self.CONDA_RUN_CMD_PREFIX.format(
+            conda_exe=self.__conda_exe, envdir=self.__envdir
+        )
+        cmd_args = conda_run_cmd_prefix.split() + cmd_args
+        return self.__popen(cmd_args, **kwargs)
+
+
 @hookimpl
 def tox_addoption(parser):
     parser.add_testenv_attribute(
@@ -87,7 +108,7 @@ def tox_configure(config):
     # This is a pretty cheesy workaround. It allows tox to consider changes to
     # the conda dependencies when it decides whether an existing environment
     # needs to be updated before being used
-    for _, envconfig in config.envconfigs.items():
+    for envconfig in config.envconfigs.values():
         # Make sure the right environment is activated. This works because we're
         # creating environments using the `-p/--prefix` option in `tox_testenv_create`
         envconfig.setenv["CONDA_DEFAULT_ENV"] = envconfig.setenv["TOX_ENV_DIR"]
@@ -161,6 +182,9 @@ def tox_testenv_create(venv, action):
         pass
     venv.envconfig.config.interpreters.get_executable(venv.envconfig)
 
+    # this will force commands and commands_{pre,post} to be executed via conda run
+    venv.popen = CondaRunWrapper(venv, venv.popen)
+
     return True
 
 
@@ -210,8 +234,10 @@ def tox_testenv_install_deps(venv, action):
         # to be present when we call pip install
         venv.envconfig.deps = venv.envconfig.deps[: -1 * num_conda_deps]
 
-    # Install dependencies from pypi here
+    # Install dependencies from pypi via conda run
+    action.via_popen = CondaRunWrapper(venv, action.via_popen)
     tox.venv.tox_testenv_install_deps(venv=venv, action=action)
+
     # Restore for the config file
     venv.envconfig.deps = saved_deps
     return True