Rewrite tests for venv install as test cases

Each test case now defines and writes its own requirement files and checks the full content, instead of just checking for common markers.

Author: connesy

tests/test_venv_install.py

@@ -1,24 +1,76 @@
-import os
+import re
 from pathlib import Path
 
 import pytest
+from pytest_cases import parametrize_with_cases
 
-from tests.helpers import RequirementFiles, run_command
+from tests.helpers import run_command
+from tests.test_venv_install_cases import CasesVenvInstallDevRequirementstxt, CasesVenvInstallRequirementstxt
+
+_package_regex = re.compile(r"^([a-zA-Z0-9_-]+)\b")
+
+
+@pytest.mark.order(after="test_venv_activate.py::test_venv_activate")
+@pytest.mark.parametrize("command_arg", ["", "requirements.txt"])
+@parametrize_with_cases(argnames=["files"], cases=CasesVenvInstallRequirementstxt)
+def test_venv_install_requirements_txt(
+    command_arg: str,
+    files: dict[str, str],
+    tmp_path: Path,
+    capfd: pytest.CaptureFixture,
+):
+    (tmp_path / "requirements.txt").write_text(files["requirements.txt"])
+
+    # Install the requirements
+    run_command(f"venv install {command_arg} --skip-lock", cwd=tmp_path, activated=True)
+
+    # Check pip install log output
+    output: str = capfd.readouterr().out
+    assert "Installing requirements from requirements.txt" in output
+
+    installed_line = [line for line in output.splitlines() if line.startswith("Successfully installed")][0]
+    for requirement in files["requirements.txt"].splitlines():
+        re_match = _package_regex.match(requirement)
+        if re_match is None:
+            raise ValueError(f"Could not extract package name from requirement '{requirement}'")
+
+        package_name = re_match.group()
+        assert package_name in installed_line
 
 
 @pytest.mark.order(after="test_venv_activate.py::test_venv_activate")
-@pytest.mark.parametrize(
-    "file",
-    [
-        "",
-        "requirements.txt",
-        "dev-requirements.txt",
-        "requirements.lock",
-        "dev-requirements.lock",
-    ],
-)
-def test_venv_install(file: str, venv_dir: RequirementFiles, create_test_credentials: None):
-    """Checks that we can install requirements in an activated environment"""
-    file_path: str | Path = venv_dir.get(file, file)
-
-    run_command(f"venv install {file_path} --skip-lock", activated=True, cwd=venv_dir["base"])
+@parametrize_with_cases(argnames=["files"], cases=CasesVenvInstallDevRequirementstxt)
+def test_venv_install_dev_requirements_txt(
+    files: dict[str, str],
+    tmp_path: Path,
+    capfd: pytest.CaptureFixture,
+):
+    for file_name, contents in files.items():
+        (tmp_path / file_name).write_text(contents)
+
+    # Install the requirements
+    run_command("venv install dev-requirements.txt --skip-lock", cwd=tmp_path, activated=True)
+
+    # Check pip install log output
+    output: str = capfd.readouterr().out
+    assert "Installing requirements from dev-requirements.txt" in output
+
+    installed_line = [line for line in output.splitlines() if line.startswith("Successfully installed")][0]
+    for requirement in [
+        *files["requirements.txt"].splitlines(),
+        *files["dev-requirements.txt"].splitlines(),
+    ]:
+        if requirement.startswith("-r"):
+            # Skip '-r requirements.txt' line
+            continue
+
+        _check_package_was_installed(requirement=requirement, installed_line=installed_line)
+
+
+def _check_package_was_installed(requirement: str, installed_line: str) -> None:
+    re_match = _package_regex.match(requirement)
+    if re_match is None:
+        raise ValueError(f"Could not extract package name from requirement '{requirement}'")
+
+    package_name = re_match.group()
+    assert package_name in installed_line

tests/test_venv_install_cases.py

@@ -0,0 +1,92 @@
+class CasesVenvInstallRequirementstxt:
+    def case_pypi(self):
+        requirements = [
+            "python-json-logger==2.0.7",
+        ]
+
+        return {"requirements.txt": "\n".join(requirements)}
+
+    def case_git(self):
+        requirements = [
+            "python-json-logger @ git+https://github.com/madzak/[email protected]",
+        ]
+
+        return {"requirements.txt": "\n".join(requirements)}
+
+    def case_git_token(self, create_test_credentials: None):
+        requirements = ["python-json-logger @ git+https://${TEST_TOKEN}@github.com/madzak/[email protected]"]
+
+        return {"requirements.txt": "\n".join(requirements)}
+
+    def case_git_user_pass(self, create_test_credentials: None):
+        requirements = [
+            "python-json-logger @ git+https://${TEST_USER}:${TEST_PASS}@github.com/madzak/[email protected]"
+        ]
+
+        return {"requirements.txt": "\n".join(requirements)}
+
+
+class CasesVenvInstallDevRequirementstxt:
+    def case_pypi_dev(self):
+        requirements = [
+            "python-json-logger==2.0.7",
+        ]
+
+        dev_requirements = [
+            "-r requirements.txt",
+            "numpy==1.26.0",
+        ]
+
+        files = {
+            "requirements.txt": "\n".join(requirements),
+            "dev-requirements.txt": "\n".join(dev_requirements),
+        }
+        return files
+
+    def case_git_dev(self):
+        requirements = [
+            "python-json-logger @ git+https://github.com/madzak/[email protected]",
+        ]
+
+        dev_requirements = [
+            "-r requirements.txt",
+            "numpy==1.26.0",
+        ]
+
+        files = {
+            "requirements.txt": "\n".join(requirements),
+            "dev-requirements.txt": "\n".join(dev_requirements),
+        }
+        return files
+
+    def case_git_token_dev(self, create_test_credentials: None):
+        requirements = [
+            "python-json-logger @ git+https://${TEST_TOKEN}@github.com/madzak/[email protected]",
+        ]
+
+        dev_requirements = [
+            "-r requirements.txt",
+            "numpy==1.26.0",
+        ]
+
+        files = {
+            "requirements.txt": "\n".join(requirements),
+            "dev-requirements.txt": "\n".join(dev_requirements),
+        }
+        return files
+
+    def case_git_user_pass_dev(self, create_test_credentials: None):
+        requirements = [
+            "python-json-logger @ git+https://${TEST_USER}:${TEST_PASS}@github.com/madzak/[email protected]",
+        ]
+
+        dev_requirements = [
+            "-r requirements.txt",
+            "numpy==1.26.0",
+        ]
+
+        files = {
+            "requirements.txt": "\n".join(requirements),
+            "dev-requirements.txt": "\n".join(dev_requirements),
+        }
+        return files