Swap DEFAULT_CONFIG global dict to a function-scoped fixture.

Also add a default_config_with fixture for default plus one change (the
main use case in our parametrised tests).

Author: samcunliffe

tests/conftest.py

@@ -6,16 +6,73 @@
 
 import pytest
 
-from .helpers import DEFAULT_CONFIG, _generate_package  # type: ignore[import-not-found]
+
+@pytest.fixture
+def default_config() -> dict[str, str]:
+    """
+    Get the minimal default configuration for cutting a cookie in tests.
+
+    This is used if `generate_package` is called without arguments.
+    """
+    return {
+        "github_owner": "test-user",
+        "project_short_description": "description",
+        "project_name": "Cookiecutter Test",
+        "project_slug": "cookiecutter-test",
+    }
+
+
+@pytest.fixture
+def default_config_with(default_config: dict[str, str]) -> typing.Callable:
+    """Extend or modify the default configuration with one additional value."""
+
+    def _wrapped_with(key: str, value: str) -> dict[str, str]:
+        default_config[key] = value
+        return default_config
+
+    return _wrapped_with
+
+
+def _generate_package(
+    config: dict[str, str], path: pathlib.Path
+) -> tuple[subprocess.CompletedProcess[str], pathlib.Path]:
+    """
+    Generate a project from the cookiecutter template.
+
+    Parameters
+    ----------
+    config
+        A dictionary with values for the cookiecutter template,
+        as defined in the cookiecutter.json
+    path
+        Directory to create package in.
+
+    Returns
+    -------
+    subprocess.CompletedProcess, pathlib.Path
+        The result of the cookiecutter command and the path to the generated package.
+
+    """
+    args = [f"{key}={val}" for key, val in config.items()]
+    cmd = ["cookiecutter", ".", "--no-input", "--output-dir", f"{path}"]
+    return subprocess.run(  # noqa: S603
+        cmd + args,
+        check=False,
+        shell=False,
+        capture_output=True,
+        text=True,
+    ), path / config["project_slug"]
 
 
 @pytest.fixture
-def generate_package(tmp_path: pathlib.Path) -> typing.Callable:
+def generate_package(
+    default_config: dict[str, str], tmp_path: pathlib.Path
+) -> typing.Callable:
     """Generate project from cookiecutter template."""
 
-    def wrapped_with_tmp_path(
-        config: dict[str, str] = DEFAULT_CONFIG,
+    def _wrapped_with_tmp_path(
+        config: dict[str, str] = default_config,
     ) -> tuple[subprocess.CompletedProcess, pathlib.Path]:
         return _generate_package(config, tmp_path)
 
-    return wrapped_with_tmp_path
+    return _wrapped_with_tmp_path

tests/helpers.py

@@ -5,19 +5,20 @@
 
 import pytest
 
-from .helpers import DEFAULT_CONFIG  # type: ignore[import-not-found]
-
 
 @pytest.mark.parametrize("initialise_git_repository", [True, False])
 def test_initialisation_of_git_repo(
     initialise_git_repository: bool,  # noqa: FBT001
+    default_config_with: typing.Callable,
     generate_package: typing.Callable,
 ) -> None:
     """Checks to see if git was correctly initialised if desired."""
-    test_config = DEFAULT_CONFIG.copy()
-    test_config["initialise_git_repository"] = str(initialise_git_repository)
+    config = default_config_with(
+        "initialise_git_repository", str(initialise_git_repository)
+    )
+
     # Run cookiecutter with initialise_git_repository
-    result, test_project_dir = generate_package(config=test_config)
+    result, test_project_dir = generate_package(config=config)
 
     # check if git is initialised
     git_status = subprocess.run(  # noqa: S603
@@ -51,9 +52,9 @@ def test_initialisation_of_git_repo(
         )
         assert (
             "GitHub CLI detected, you can create a repo with the following:\n\n"
-            f"gh repo create {test_config['github_owner']}/"
+            f"gh repo create {config['github_owner']}/"
             f"cookiecutter-test -d "
-            f'"{test_config["project_short_description"]}" --public -r '
+            f'"{config["project_short_description"]}" --public -r '
             f"origin --source cookiecutter-test" in result.stdout
         )
     except FileNotFoundError:
@@ -63,11 +64,11 @@ def test_initialisation_of_git_repo(
         assert (
             "You now have a local git repository. To sync this to GitHub you "
             "need to create an empty GitHub repo with the name "
-            f"{test_config['github_owner']}/"
+            f"{config['github_owner']}/"
             f"cookiecutter-test - DO NOT SELECT ANY "
             "OTHER OPTION.\n\nSee this link for more detail "
             "https://docs.github.com/en/get-started/quickstart/create-a-repo"
             ".\n\nThen run:\n\ngit remote add origin [email protected]:"
-            f"{test_config['github_owner']}/"
+            f"{config['github_owner']}/"
             f"cookiecutter-test.git" in result.stdout
         )

tests/test_git_init.py

@@ -1,6 +1,7 @@
 """Checks that the cookiecutter works."""
 
 import difflib
+import os
 import pathlib
 import shutil
 import subprocess
@@ -9,19 +10,39 @@
 import pytest
 import pytest_venv  # type: ignore[import-not-found]
 
-from .helpers import (  # type: ignore[import-not-found]
-    DEFAULT_CONFIG,
-    get_all_files_folders,
-)
 
+def get_all_files_folders(root_path: pathlib.Path) -> set[pathlib.Path]:
+    """
+    Get all files and folders under a directory.
 
-def test_package_generation(generate_package: typing.Callable) -> None:
+    The paths are returned relative to the root path given.
+    __pycache__ directories and .DS_Store files are ignored.
+    """
+    file_set: set[pathlib.Path] = set()
+    for dirpath, _, filenames in os.walk(root_path):
+        dirpath_path = pathlib.Path(dirpath).relative_to(root_path)
+        if dirpath_path.name in ["__pycache__"]:
+            continue
+
+        # Add this directory
+        file_set.update((dirpath_path,))
+        # Add any files in it
+        for filename in filenames:
+            if filename in [".DS_Store"]:
+                continue
+            file_set.update((dirpath_path / filename,))
+
+    return file_set
+
+
+def test_package_generation(
+    default_config_with: typing.Callable, generate_package: typing.Callable
+) -> None:
     """Test package generation."""
-    test_config = DEFAULT_CONFIG.copy()
     # Not having a git repo makes it easier to check in/out reference
     # data files to the main python-tooling git repository
-    test_config["initialise_git_repository"] = "False"
-    _, test_project_dir = generate_package(config=test_config)
+    config = default_config_with("initialise_git_repository", "False")
+    _, test_project_dir = generate_package(config=config)
 
     expected_package_dir = (
         pathlib.Path(__file__).parent / "data" / "test_package_generation"
@@ -89,10 +110,11 @@ def test_pip_installable(
 
 
 @pytest.mark.parametrize("funder", ["", "STFC", "UKRI", "Wellcome Trust"])
-def test_optional_funder(generate_package: typing.Callable, funder: str) -> None:
+def test_optional_funder(
+    funder: str, default_config_with: typing.Callable, generate_package: typing.Callable
+) -> None:
     """Test specifying funder or not in package generation."""
-    config = DEFAULT_CONFIG.copy()
-    config["funder"] = funder
+    config = default_config_with("funder", funder)
     _, test_project_dir = generate_package(config)
 
     with (test_project_dir / "README.md").open() as f:
@@ -102,8 +124,7 @@ def test_optional_funder(generate_package: typing.Callable, funder: str) -> None
         assert "## Acknowledgements" not in readme_text
     else:
         assert (
-            f"## Acknowledgements\n\nThis work was funded by {config['funder']}."
-            in readme_text
+            f"## Acknowledgements\n\nThis work was funded by {funder}." in readme_text
         ), readme_text