Tox4

.github/workflows/check.yml

@@ -59,7 +59,10 @@ jobs:
       - name: setup test suite
         run: tox -vv --notest
       - name: run test suite
-        run: tox --skip-pkg-install
+        run: |
+          . .tox/py310/bin/activate
+          cd tests
+          pytest . --timeout 180 --durations 5
         env:
           PYTEST_ADDOPTS: "-vv --durations=20"
           CI_RUN: "yes"

requirements_tests.txt

@@ -0,0 +1,8 @@
+-e .
+devpi_process
+pytest
+pytest-cov
+pytest-mock
+pytest-ordering
+pytest-timeout
+tox>=4,<5

setup.cfg

@@ -26,7 +26,7 @@ classifiers =
 packages = find:
 install_requires =
     ruamel.yaml>=0.15.0,<0.18
-    tox>=3.8.1,<4
+    tox>=4,<5
 python_requires = >=3.5
 
 [options.packages.find]

tests/conftest.py

@@ -1 +1,101 @@
-from tox._pytestplugin import *  # noqa
+from pathlib import Path
+from types import TracebackType
+from typing import Any, Dict, Optional, Sequence
+
+import pytest
+from pytest import MonkeyPatch
+from pytest_mock import MockerFixture
+from tox.execute.api import ExecuteInstance, ExecuteOptions, ExecuteStatus
+from tox.execute.request import ExecuteRequest
+from tox.execute.stream import SyncWrite
+from tox.pytest import CaptureFixture, ToxProject, ToxProjectCreator
+
+from tox_conda.plugin import CondaEnvRunner
+
+
+@pytest.fixture(name="tox_project")
+def init_fixture(
+    tmp_path: Path,
+    capfd: CaptureFixture,
+    monkeypatch: MonkeyPatch,
+    mocker: MockerFixture,
+) -> ToxProjectCreator:
+    def _init(
+        files: Dict[str, Any], base: Optional[Path] = None, prj_path: Optional[Path] = None
+    ) -> ToxProject:
+        """create tox  projects"""
+        return ToxProject(files, base, prj_path or tmp_path / "p", capfd, monkeypatch, mocker)
+
+    return _init
+
+
+@pytest.fixture
+def mock_conda_env_runner(request, monkeypatch):
+    class MockExecuteStatus(ExecuteStatus):
+        def __init__(
+            self, options: ExecuteOptions, out: SyncWrite, err: SyncWrite, exit_code: int
+        ) -> None:
+            super().__init__(options, out, err)
+            self._exit_code = exit_code
+
+        @property
+        def exit_code(self) -> Optional[int]:
+            return self._exit_code
+
+        def wait(self, timeout: Optional[float] = None) -> Optional[int]:  # noqa: U100
+            return self._exit_code
+
+        def write_stdin(self, content: str) -> None:  # noqa: U100
+            return None  # pragma: no cover
+
+        def interrupt(self) -> None:
+            return None  # pragma: no cover
+
+    class MockExecuteInstance(ExecuteInstance):
+        def __init__(
+            self,
+            request: ExecuteRequest,
+            options: ExecuteOptions,
+            out: SyncWrite,
+            err: SyncWrite,
+            exit_code: int,
+        ) -> None:
+            super().__init__(request, options, out, err)
+            self.exit_code = exit_code
+
+        def __enter__(self) -> ExecuteStatus:
+            return MockExecuteStatus(self.options, self._out, self._err, self.exit_code)
+
+        def __exit__(
+            self,
+            exc_type: Optional[BaseException],  # noqa: U100
+            exc_val: Optional[BaseException],  # noqa: U100
+            exc_tb: Optional[TracebackType],  # noqa: U100
+        ) -> None:
+            pass
+
+        @property
+        def cmd(self) -> Sequence[str]:
+            return self.request.cmd
+
+    shell_cmds = []
+    no_mocked_run_ids = getattr(request, "param", None)
+    if no_mocked_run_ids is None:
+        no_mocked_run_ids = ["_get_python"]
+    original_execute_instance_factor = CondaEnvRunner._execute_instance_factory
+
+    def mock_execute_instance_factory(
+        request: ExecuteRequest, options: ExecuteOptions, out: SyncWrite, err: SyncWrite
+    ):
+        shell_cmds.append(request.shell_cmd)
+
+        if request.run_id not in no_mocked_run_ids:
+            return MockExecuteInstance(request, options, out, err, 0)
+        else:
+            return original_execute_instance_factor(request, options, out, err)
+
+    monkeypatch.setattr(CondaEnvRunner, "_execute_instance_factory", mock_execute_instance_factory)
+    monkeypatch.setenv("CONDA_EXE", "conda")
+    monkeypatch.setenv("CONDA_DEFAULT_ENV", "test-env")
+
+    yield shell_cmds

tests/test_cache.py

@@ -0,0 +1,222 @@
+"""Cache tests."""
+
+from fnmatch import fnmatch
+
+
+def assert_create_command(cmd):
+    assert fnmatch(cmd, "*conda create*") or fnmatch(cmd, "*conda env create*")
+
+
+def assert_install_command(cmd):
+    assert fnmatch(cmd, "*conda install*")
+
+
+def test_conda_no_recreate(tox_project, mock_conda_env_runner):
+    ini = """
+        [testenv:py123]
+        skip_install = True
+        conda_env = conda-env.yml
+        conda_deps =
+            asdf
+    """
+    yaml = """
+         name: tox-conda
+         channels:
+           - conda-forge
+           - nodefaults
+         dependencies:
+           - numpy
+           - astropy
+           - pip:
+             - pytest
+        """
+    for _ in range(2):
+        proj = tox_project({"tox.ini": ini})
+        (proj.path / "conda-env.yml").write_text(yaml)
+        outcome = proj.run("-e", "py123")
+        outcome.assert_success()
+
+    executed_shell_commands = mock_conda_env_runner
+    # get_python, create env, install deps, get_python, and nothing else because no changes
+    assert len(executed_shell_commands) == 4
+    assert_create_command(executed_shell_commands[1])
+    assert_install_command(executed_shell_commands[2])
+
+
+def test_conda_recreate_by_dependency_change(tox_project, mock_conda_env_runner):
+    ini = """
+        [testenv:py123]
+        skip_install = True
+        conda_deps =
+            asdf
+    """
+    ini_modified = """
+        [testenv:py123]
+        skip_install = True
+        conda_deps =
+            asdf
+            black
+    """
+    outcome = tox_project({"tox.ini": ini}).run("-e", "py123")
+    outcome.assert_success()
+
+    outcome = tox_project({"tox.ini": ini_modified}).run("-e", "py123")
+    outcome.assert_success()
+
+    executed_shell_commands = mock_conda_env_runner
+    # get_python, create env, install deps, get_python, create env, install deps
+    assert len(executed_shell_commands) == 6
+
+    assert_create_command(executed_shell_commands[1])
+    assert_install_command(executed_shell_commands[2])
+    assert_create_command(executed_shell_commands[4])
+    assert_install_command(executed_shell_commands[5])
+
+
+def test_conda_recreate_by_env_file_path_change(tox_project, mock_conda_env_runner):
+    ini = """
+        [testenv:py123]
+        skip_install = True
+        conda_env = conda-env-1.yml
+    """
+    ini_modified = """
+        [testenv:py123]
+        skip_install = True
+        conda_env = conda-env-2.yml
+    """
+    yaml = """
+         name: tox-conda
+         channels:
+           - conda-forge
+           - nodefaults
+         dependencies:
+           - numpy
+           - astropy
+           - pip:
+             - pytest
+        """
+
+    proj_1 = tox_project({"tox.ini": ini})
+    (proj_1.path / "conda-env-1.yml").write_text(yaml)
+    outcome = proj_1.run("-e", "py123")
+    outcome.assert_success()
+
+    proj_2 = tox_project({"tox.ini": ini_modified})
+    (proj_2.path / "conda-env-2.yml").write_text(yaml)
+    outcome = proj_2.run("-e", "py123")
+    outcome.assert_success()
+
+    executed_shell_commands = mock_conda_env_runner
+    # get_python, create env, get_python, create env
+    assert len(executed_shell_commands) == 4
+
+    assert_create_command(executed_shell_commands[1])
+    assert_create_command(executed_shell_commands[3])
+
+
+def test_conda_recreate_by_env_file_content_change(tox_project, mock_conda_env_runner):
+    ini = """
+        [testenv:py123]
+        skip_install = True
+        conda_env = conda-env.yml
+    """
+    yaml = """
+         name: tox-conda
+         channels:
+           - conda-forge
+           - nodefaults
+         dependencies:
+           - numpy
+           - astropy
+        """
+    yaml_modified = """
+         name: tox-conda
+         channels:
+           - conda-forge
+           - nodefaults
+         dependencies:
+           - numpy
+           - astropy
+           - pip:
+             - pytest
+        """
+
+    proj = tox_project({"tox.ini": ini})
+    (proj.path / "conda-env.yml").write_text(yaml)
+    outcome = proj.run("-e", "py123")
+    outcome.assert_success()
+
+    (proj.path / "conda-env.yml").write_text(yaml_modified)
+    outcome = proj.run("-e", "py123")
+    outcome.assert_success()
+
+    executed_shell_commands = mock_conda_env_runner
+    # get_python, create env, get_python, create env
+    assert len(executed_shell_commands) == 4
+
+    assert_create_command(executed_shell_commands[1])
+    assert_create_command(executed_shell_commands[3])
+
+
+def test_conda_recreate_by_spec_file_path_change(tox_project, mock_conda_env_runner):
+    ini = """
+        [testenv:py123]
+        skip_install = True
+        conda_spec = conda_spec-1.txt
+    """
+    ini_modified = """
+        [testenv:py123]
+        skip_install = True
+        conda_spec = conda_spec-2.txt
+    """
+    proj_1 = tox_project({"tox.ini": ini})
+    (proj_1.path / "conda_spec-1.txt").touch()
+    outcome = proj_1.run("-e", "py123")
+    outcome.assert_success()
+
+    proj_2 = tox_project({"tox.ini": ini_modified})
+    (proj_2.path / "conda_spec-2.txt").touch()
+    outcome = proj_2.run("-e", "py123")
+    outcome.assert_success()
+
+    executed_shell_commands = mock_conda_env_runner
+    # get_python, create env, install deps, get_python, create env, install deps
+    assert len(executed_shell_commands) == 6
+
+    assert_create_command(executed_shell_commands[1])
+    assert_install_command(executed_shell_commands[2])
+    assert_create_command(executed_shell_commands[4])
+    assert_install_command(executed_shell_commands[5])
+
+
+def test_conda_recreate_by_spec_file_content_change(tox_project, mock_conda_env_runner):
+    ini = """
+        [testenv:py123]
+        skip_install = True
+        conda_spec = conda_spec.txt
+    """
+    txt = """
+        black
+    """
+    txt_modified = """
+        black
+        numpy
+    """
+
+    proj = tox_project({"tox.ini": ini})
+    (proj.path / "conda_spec.txt").write_text(txt)
+    outcome = proj.run("-e", "py123")
+    outcome.assert_success()
+
+    (proj.path / "conda_spec.txt").write_text(txt_modified)
+    outcome = proj.run("-e", "py123")
+    outcome.assert_success()
+
+    executed_shell_commands = mock_conda_env_runner
+    # get_python, create env, install deps, get_python, create env, install deps
+    assert len(executed_shell_commands) == 6
+
+    assert_create_command(executed_shell_commands[1])
+    assert_install_command(executed_shell_commands[2])
+    assert_create_command(executed_shell_commands[4])
+    assert_install_command(executed_shell_commands[5])