Add factory to create PROJECT_CONFIG equivalent for tests

Author: ArBridgeman

test/unit/config_test.py

@@ -10,8 +10,8 @@
 
 class TestBaseConfig:
     @staticmethod
-    def test_works_as_defined():
-        BaseConfig()
+    def test_works_as_defined(test_project_config_factory):
+        test_project_config_factory()
 
     @staticmethod
     @pytest.mark.parametrize(
@@ -58,14 +58,16 @@ def test_expansion_validation_fails_for_invalid_version():
         BaseConfigExpansion(python_versions=("1.f.0",))
 
 
-def test_minimum_python_version():
-    conf = BaseConfig(python_versions=("5.5.5", "1.10", "9.9.9"))
+def test_minimum_python_version(test_project_config_factory):
+    conf = test_project_config_factory(python_versions=("5.5.5", "1.10", "9.9.9"))
     assert conf.minimum_python_version == "1.10"
 
 
 @pytest.mark.parametrize("minimum_python_version", ["3.10", "3.10.5"])
-def test_pyupgrade_argument(minimum_python_version):
-    conf = BaseConfig(python_versions=("3.11", minimum_python_version, "3.12"))
+def test_pyupgrade_argument(test_project_config_factory, minimum_python_version):
+    conf = test_project_config_factory(
+        python_versions=("3.11", minimum_python_version, "3.12")
+    )
     assert conf.pyupgrade_argument == ("--py310-plus",)
 
 
@@ -83,6 +85,10 @@ def test_pyupgrade_argument(minimum_python_version):
         ),
     ],
 )
-def test_excluded_python_paths(add_to_excluded_python_paths, expected):
-    conf = BaseConfig(add_to_excluded_python_paths=add_to_excluded_python_paths)
+def test_excluded_python_paths(
+    test_project_config_factory, add_to_excluded_python_paths, expected
+):
+    conf = test_project_config_factory(
+        add_to_excluded_python_paths=add_to_excluded_python_paths
+    )
     assert sorted(conf.excluded_python_paths) == sorted(expected)

test/unit/conftest.py

@@ -1,9 +1,15 @@
-from pathlib import Path
-
 import pytest
 from toolbox.config import BaseConfig
 
 
 @pytest.fixture
-def test_project_config():
-    return BaseConfig(root_path=Path("."), project_name="test")
+def test_project_config_factory(tmp_path):
+    def _test_project_config(**kwargs) -> BaseConfig:
+        defaults = {
+            "root_path": tmp_path,
+            "project_name": "test",
+        }
+        config = {**defaults, **kwargs}
+        return BaseConfig(**config)
+
+    return _test_project_config

test/unit/nox/_artifacts_test.py

@@ -36,14 +36,14 @@
     check_artifacts,
     copy_artifacts,
 )
+from noxconfig import Config
 
 
 @contextlib.contextmanager
 def mock_check_artifacts_session(
-    path: Path,
+    config: Config,
 ):
-    with patch("exasol.toolbox.nox._artifacts.PROJECT_CONFIG") as config:
-        config.root = path
+    with patch("exasol.toolbox.nox._artifacts.PROJECT_CONFIG", new=config):
         yield Mock()
 
 
@@ -92,10 +92,18 @@ def _create_artifact_files(path: Path, existing_files: set):
     )
     @mock.patch("exasol.toolbox.nox._artifacts._is_valid_coverage", return_value=True)
     def test_passes_when_as_expected(
-        self, mock_coverage, mock_security, mock_lint_json, mock_lint_txt, tmp_path
+        self,
+        mock_coverage,
+        mock_security,
+        mock_lint_json,
+        mock_lint_txt,
+        test_project_config_factory,
+        tmp_path,
     ):
         self._create_artifact_files(tmp_path, ALL_LINT_FILES)
-        with mock_check_artifacts_session(tmp_path) as session:
+        with mock_check_artifacts_session(
+            config=test_project_config_factory()
+        ) as session:
             check_artifacts(session)
 
     @pytest.mark.parametrize(
@@ -105,18 +113,26 @@ def test_passes_when_as_expected(
             (pytest.param(ALL_LINT_FILES, id="all_files_missing")),
         ],
     )
-    def test_fails_when_file_missing(self, tmp_path, missing_files, capsys):
+    def test_fails_when_file_missing(
+        self, test_project_config_factory, tmp_path, missing_files, capsys
+    ):
         existing_files = ALL_LINT_FILES - missing_files
         self._create_artifact_files(tmp_path, existing_files)
 
-        with mock_check_artifacts_session(tmp_path) as session:
+        with mock_check_artifacts_session(
+            config=test_project_config_factory()
+        ) as session:
             with pytest.raises(SystemExit):
                 check_artifacts(session)
         assert f"files not available: {missing_files}" in capsys.readouterr().err
 
-    def test_fails_when_check_fails(self, tmp_path, capsys):
+    def test_fails_when_check_fails(
+        self, test_project_config_factory, tmp_path, capsys
+    ):
         self._create_artifact_files(tmp_path, ALL_LINT_FILES)
-        with mock_check_artifacts_session(tmp_path) as session:
+        with mock_check_artifacts_session(
+            config=test_project_config_factory()
+        ) as session:
             with pytest.raises(SystemExit):
                 check_artifacts(session)
         assert "error in [" in capsys.readouterr().err

test/unit/nox/_format_test.py

@@ -12,26 +12,33 @@
     fix_format,
 )
 from exasol.toolbox.nox._shared import Mode
-from noxconfig import Config
 
 
 @pytest.fixture
-def file_with_unneeded_import(tmp_path):
-    file_path = tmp_path / "dummy_file.py"
+def config(test_project_config_factory):
+    return test_project_config_factory()
+
+
+@pytest.fixture
+def file_with_unneeded_import(config):
+    config.source_code_path.mkdir(parents=True, exist_ok=True)
+    file_path = config.source_code_path / "dummy_file.py"
     file_path.write_text("import black")
     return file_path
 
 
 @pytest.fixture
-def file_with_not_ordered_import(tmp_path):
-    file_path = tmp_path / "dummy_file.py"
+def file_with_not_ordered_import(config):
+    config.source_code_path.mkdir(parents=True, exist_ok=True)
+    file_path = config.source_code_path / "dummy_file.py"
     file_path.write_text("import isort\nimport black")
     return file_path
 
 
 @pytest.fixture
-def file_without_blank_line(tmp_path):
-    file_path = tmp_path / "dummy_file.py"
+def file_without_blank_line(config):
+    config.source_code_path.mkdir(parents=True, exist_ok=True)
+    file_path = config.source_code_path / "dummy_file.py"
     file_path.write_text("import black\nimport isort")
     return file_path
 
@@ -86,10 +93,11 @@ def test_black_mode_check(nox_session, file_without_blank_line, caplog):
         assert file_without_blank_line.read_text() == "import black\nimport isort"
 
 
-def test_pyupgrade(nox_session, tmp_path):
-    file_path = tmp_path / "dummy_file.py"
+def test_pyupgrade(nox_session, config):
+    config.source_code_path.mkdir(parents=True, exist_ok=True)
+    file_path = config.source_code_path / "dummy_file.py"
     file_path.write_text("from typing import Union\nx:Union[int, str]=2")
-    _pyupgrade(session=nox_session, config=Config(), files=[str(file_path)])
+    _pyupgrade(session=nox_session, config=config, files=[str(file_path)])
     assert file_path.read_text() == "from typing import Union\nx:int | str=2"
 
 
@@ -148,11 +156,9 @@ def file_with_multiple_problems(tmp_path):
     return file_path
 
 
-def test_fix_format(nox_session, tmp_path, file_with_multiple_problems):
-    with patch("exasol.toolbox.nox._format.PROJECT_CONFIG") as config:
+def test_fix_format(nox_session, config, file_with_multiple_problems):
+    with patch("exasol.toolbox.nox._format.PROJECT_CONFIG", new=config):
         with patch("exasol.toolbox.nox._format._version") as version:
-            config.root = tmp_path
-            config.pyupgrade_argument = ("--py310-plus",)
             # Simulate version is up-to-date, as version check is out of the scope of the test case
             version.return_value = True
             fix_format(nox_session)
@@ -171,13 +177,10 @@ def test_fix_format(nox_session, tmp_path, file_with_multiple_problems):
     )
 
 
-def test_check_format(
-    nox_session, tmp_path, file_with_multiple_problems, caplog, capsys
-):
+def test_check_format(nox_session, config, file_with_multiple_problems, caplog, capsys):
     expected_text = file_with_multiple_problems.read_text()
 
-    with patch("exasol.toolbox.nox._format.PROJECT_CONFIG") as config:
-        config.root = tmp_path
+    with patch("exasol.toolbox.nox._format.PROJECT_CONFIG", new=config):
         with pytest.raises(CommandFailed):
             check_format(nox_session)
 

test/unit/nox/_lint_test.py

@@ -1,6 +1,5 @@
 import json
 from inspect import cleandoc
-from pathlib import Path
 from unittest.mock import patch
 
 import pytest
@@ -14,7 +13,12 @@
 
 
 @pytest.fixture
-def file_with_multiple_problems(tmp_path):
+def config(test_project_config_factory):
+    return test_project_config_factory()
+
+
+@pytest.fixture
+def file_with_multiple_problems(config):
     """
     In this file with multiple problems, it is expected that the nox
     lint sessions would detect the following errors:
@@ -30,8 +34,8 @@ def file_with_multiple_problems(tmp_path):
         * [B607:start_process_with_partial_path] Starting a process with a partial executable path
         * [B603:subprocess_without_shell_equals_true] subprocess call - check for execution of untrusted input.
     """
-
-    file_path = tmp_path / "dummy_file.py"
+    config.source_code_path.mkdir(parents=True, exist_ok=True)
+    file_path = config.source_code_path / "dummy_file.py"
     text = """
     import subprocess
 
@@ -42,15 +46,13 @@ def file_with_multiple_problems(tmp_path):
     return file_path
 
 
-def test_lint(nox_session, tmp_path, file_with_multiple_problems):
-    with patch("exasol.toolbox.nox._lint.PROJECT_CONFIG") as config:
-        config.root = tmp_path
-        config.source = Path("")
+def test_lint(nox_session, config, file_with_multiple_problems):
+    with patch("exasol.toolbox.nox._lint.PROJECT_CONFIG", new=config):
         with pytest.raises(CommandFailed, match="Returned code 20"):
             lint(session=nox_session)
 
-    json_file = tmp_path / ".lint.json"
-    txt_file = tmp_path / ".lint.txt"
+    json_file = config.root_path / ".lint.json"
+    txt_file = config.root_path / ".lint.txt"
 
     assert json_file.exists()
     assert txt_file.exists()
@@ -60,10 +62,8 @@ def test_lint(nox_session, tmp_path, file_with_multiple_problems):
     assert {"C0114", "C0304", "W1510"}.issubset(errors)
 
 
-def test_type_check(nox_session, tmp_path, file_with_multiple_problems, caplog):
-    with patch("exasol.toolbox.nox._lint.PROJECT_CONFIG") as config:
-        config.root = tmp_path
-        config.source = Path("")
+def test_type_check(nox_session, config, file_with_multiple_problems, caplog):
+    with patch("exasol.toolbox.nox._lint.PROJECT_CONFIG", new=config):
         with pytest.raises(CommandFailed, match="Returned code 1"):
             type_check(session=nox_session)
 
@@ -74,13 +74,11 @@ def test_type_check(nox_session, tmp_path, file_with_multiple_problems, caplog):
     )
 
 
-def test_security_lint(nox_session, tmp_path, file_with_multiple_problems):
-    with patch("exasol.toolbox.nox._lint.PROJECT_CONFIG") as config:
-        config.root = tmp_path
-        config.source = Path("")
+def test_security_lint(nox_session, config, file_with_multiple_problems):
+    with patch("exasol.toolbox.nox._lint.PROJECT_CONFIG", new=config):
         security_lint(session=nox_session)
 
-    output_file = tmp_path / ".security.json"
+    output_file = config.root_path / ".security.json"
     assert output_file.exists()
 
     contents = output_file.read_text()

test/unit/nox/_package_version_test.py

@@ -15,13 +15,16 @@
 
 
 @pytest.fixture
-def config(version_file) -> Config:
-    return Config(version_file=version_file)
+def config(test_project_config_factory) -> Config:
+    config = test_project_config_factory()
+    # We need to set up the directory path so that version_file can execute
+    config.source_code_path.mkdir(parents=True, exist_ok=True)
+    return config
 
 
 @pytest.fixture
-def version_file(tmp_path):
-    version_file = tmp_path / "version.py"
+def version_file(config):
+    version_file = config.version_filepath
     write_version_module(version=DEFAULT_VERSION, version_file=version_file)
     return version_file
 
@@ -38,7 +41,7 @@ def test_write_version_module(version_file) -> None:
 class TestVersionCheck:
     @staticmethod
     @mock.patch.object(Version, "from_poetry", return_value=DEFAULT_VERSION)
-    def test_same_value_is_successful(from_poetry, config):
+    def test_same_value_is_successful(from_poetry, config, version_file):
         Version(major=0, minor=1, patch=0)
         parser = _create_parser()
         args = parser.parse_args([])
@@ -48,7 +51,7 @@ def test_same_value_is_successful(from_poetry, config):
 
     @staticmethod
     @mock.patch.object(Version, "from_poetry", return_value=ALTERNATE_VERSION)
-    def test_different_value_is_failure(from_poetry, config):
+    def test_different_value_is_failure(from_poetry, config, version_file):
         Version(major=0, minor=1, patch=0)
         parser = _create_parser()
         args = parser.parse_args([])