test(fixtures): refactor e2e infrastructure to be more configurable & resilient

Author: codejedi365

tests/conftest.py

@@ -1,4 +1,4 @@
-"""Note: fixtures are stored in the tests/fixtures directory for better organisation"""
+"""Note: fixtures are stored in the tests/fixtures directory for better organization"""
 
 from __future__ import annotations
 
@@ -9,21 +9,23 @@
 from hashlib import md5
 from pathlib import Path
 from tempfile import NamedTemporaryFile
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, cast
 from unittest import mock
 
 import pytest
 from click.testing import CliRunner
 from filelock import FileLock
 from git import Commit, Repo
 
+from semantic_release.version.version import Version
+
 from tests.const import PROJ_DIR
 from tests.fixtures import *
 from tests.util import copy_dir_tree, remove_dir_tree
 
 if TYPE_CHECKING:
     from tempfile import _TemporaryFileWrapper
-    from typing import Any, Callable, Generator, Protocol, Sequence, TypedDict
+    from typing import Any, Callable, Generator, Optional, Protocol, Sequence, TypedDict
 
     from click.testing import Result
     from filelock import AcquireReturnProxy
@@ -325,7 +327,7 @@ def _get_authorization_to_build_repo_cache(
 def get_cached_repo_data(request: pytest.FixtureRequest) -> GetCachedRepoDataFn:
     def _get_cached_repo_data(proj_dirname: str) -> RepoData | None:
         cache_key = f"psr/repos/{proj_dirname}"
-        return request.config.cache.get(cache_key, None)
+        return cast("Optional[RepoData]", request.config.cache.get(cache_key, None))
 
     return _get_cached_repo_data
 
@@ -335,6 +337,10 @@ def set_cached_repo_data(request: pytest.FixtureRequest) -> SetCachedRepoDataFn:
     def magic_serializer(obj: Any) -> Any:
         if isinstance(obj, Path):
             return obj.__fspath__()
+
+        if isinstance(obj, Version):
+            return obj.__dict__
+
         return obj
 
     def _set_cached_repo_data(proj_dirname: str, data: RepoData) -> None:
@@ -386,13 +392,30 @@ def _build_repo_w_cache_checking(
             with log_file_lock, log_file.open(mode="a") as afd:
                 afd.write(f"{stable_now_date().isoformat()}: {build_msg}...\n")
 
+            try:
+                # Try to build repository but catch any errors so that it doesn't cascade through all tests
+                # do to an unreleased lock
+                build_definition = build_repo_func(cached_repo_path)
+            except Exception:
+                remove_dir_tree(cached_repo_path, force=True)
+
+                if filelock:
+                    filelock.lock.release()
+
+                with log_file_lock, log_file.open(mode="a") as afd:
+                    afd.write(
+                        f"{stable_now_date().isoformat()}: {build_msg}...FAILED\n"
+                    )
+
+                raise
+
             # Marks the date when the cached repo was created
             set_cached_repo_data(
                 repo_name,
                 {
                     "build_date": today_date_str,
                     "build_spec_hash": build_spec_hash,
-                    "build_definition": build_repo_func(cached_repo_path),
+                    "build_definition": build_definition,
                 },
             )
 

tests/e2e/cmd_changelog/test_changelog.py

@@ -77,6 +77,12 @@
 
     from requests_mock import Mocker
 
+    from semantic_release.commit_parser.conventional.parser import (
+        ConventionalCommitParser,
+    )
+    from semantic_release.commit_parser.emoji import EmojiCommitParser
+    from semantic_release.commit_parser.scipy import ScipyCommitParser
+
     from tests.conftest import RunCliFn
     from tests.e2e.conftest import RetrieveRuntimeContextFn
     from tests.fixtures.example_project import (
@@ -867,9 +873,12 @@ def test_changelog_update_mode_unreleased_n_released(
     commit_n_rtn_changelog_entry: CommitNReturnChangelogEntryFn,
     changelog_file: Path,
     insertion_flag: str,
-    get_commit_def_of_conventional_commit: GetCommitDefFn,
-    get_commit_def_of_emoji_commit: GetCommitDefFn,
-    get_commit_def_of_scipy_commit: GetCommitDefFn,
+    get_commit_def_of_conventional_commit: GetCommitDefFn[ConventionalCommitParser],
+    get_commit_def_of_emoji_commit: GetCommitDefFn[EmojiCommitParser],
+    get_commit_def_of_scipy_commit: GetCommitDefFn[ScipyCommitParser],
+    default_conventional_parser: ConventionalCommitParser,
+    default_emoji_parser: EmojiCommitParser,
+    default_scipy_parser: ScipyCommitParser,
 ):
     """
     Given there are unreleased changes and a previous release in the changelog,
@@ -890,18 +899,23 @@ def test_changelog_update_mode_unreleased_n_released(
     commit_n_section: Commit2Section = {
         "conventional": {
             "commit": get_commit_def_of_conventional_commit(
-                "perf: improve the performance of the application"
+                "perf: improve the performance of the application",
+                parser=default_conventional_parser,
             ),
             "section": "Performance Improvements",
         },
         "emoji": {
             "commit": get_commit_def_of_emoji_commit(
-                ":zap: improve the performance of the application"
+                ":zap: improve the performance of the application",
+                parser=default_emoji_parser,
             ),
             "section": ":zap:",
         },
         "scipy": {
-            "commit": get_commit_def_of_scipy_commit("MAINT: fix an issue"),
+            "commit": get_commit_def_of_scipy_commit(
+                "MAINT: fix an issue",
+                parser=default_scipy_parser,
+            ),
             "section": "Fix",
         },
     }

tests/e2e/cmd_version/bump_version/conftest.py

@@ -12,7 +12,7 @@
 
 if TYPE_CHECKING:
     from pathlib import Path
-    from typing import Protocol
+    from typing import Protocol, Sequence
 
     from click.testing import Result
 
@@ -24,40 +24,51 @@ class InitMirrorRepo4RebuildFn(Protocol):
         def __call__(
             self,
             mirror_repo_dir: Path,
-            configuration_step: RepoActionConfigure,
+            configuration_steps: Sequence[RepoActionConfigure],
+            files_to_remove: Sequence[Path],
         ) -> Path: ...
 
     class RunPSReleaseFn(Protocol):
         def __call__(
             self,
             next_version_str: str,
             git_repo: Repo,
+            config_toml_path: Path = ...,
         ) -> Result: ...
 
 
 @pytest.fixture(scope="session")
 def init_mirror_repo_for_rebuild(
     build_repo_from_definition: BuildRepoFromDefinitionFn,
-    changelog_md_file: Path,
-    changelog_rst_file: Path,
 ) -> InitMirrorRepo4RebuildFn:
     def _init_mirror_repo_for_rebuild(
         mirror_repo_dir: Path,
-        configuration_step: RepoActionConfigure,
+        configuration_steps: Sequence[RepoActionConfigure],
+        files_to_remove: Sequence[Path],
     ) -> Path:
         # Create the mirror repo directory
         mirror_repo_dir.mkdir(exist_ok=True, parents=True)
 
         # Initialize mirror repository
         build_repo_from_definition(
             dest_dir=mirror_repo_dir,
-            repo_construction_steps=[configuration_step],
+            repo_construction_steps=configuration_steps,
         )
 
         with Repo(mirror_repo_dir) as mirror_git_repo:
-            # remove the default changelog files to enable Update Mode (new default of v10)
-            mirror_git_repo.git.rm(str(changelog_md_file), force=True)
-            mirror_git_repo.git.rm(str(changelog_rst_file), force=True)
+            for filepath in files_to_remove:
+                file = (
+                    (mirror_git_repo.working_dir / filepath).resolve().absolute()
+                    if not filepath.is_absolute()
+                    else filepath
+                )
+                if (
+                    not file.is_relative_to(mirror_git_repo.working_dir)
+                    or not file.exists()
+                ):
+                    continue
+
+                mirror_git_repo.git.rm(str(file), force=True)
 
         return mirror_repo_dir
 
@@ -69,6 +80,7 @@ def run_psr_release(
     run_cli: RunCliFn,
     changelog_rst_file: Path,
     update_pyproject_toml: UpdatePyprojectTomlFn,
+    pyproject_toml_file: Path,
 ) -> RunPSReleaseFn:
     base_version_cmd = [MAIN_PROG_NAME, "--strict", VERSION_SUBCMD]
     write_changelog_only_cmd = [
@@ -82,6 +94,7 @@ def run_psr_release(
     def _run_psr_release(
         next_version_str: str,
         git_repo: Repo,
+        config_toml_path: Path = pyproject_toml_file,
     ) -> Result:
         version_n_buildmeta = next_version_str.split("+", maxsplit=1)
         version_n_prerelease = version_n_buildmeta[0].split("-", maxsplit=1)
@@ -107,6 +120,7 @@ def _run_psr_release(
         update_pyproject_toml(
             "tool.semantic_release.changelog.default_templates.changelog_file",
             str(changelog_rst_file),
+            toml_file=config_toml_path,
         )
         cli_cmd = [*write_changelog_only_cmd, *prerelease_args, *build_metadata_args]
         result = run_cli(cli_cmd[1:], env={Github.DEFAULT_ENV_TOKEN_NAME: "1234"})
@@ -116,7 +130,7 @@ def _run_psr_release(
         git_repo.git.reset("--mixed", "HEAD")
 
         # Add the changelog file to the git index but reset the working directory
-        git_repo.git.add(str(changelog_rst_file))
+        git_repo.git.add(str(changelog_rst_file.resolve()))
         git_repo.git.checkout("--", ".")
 
         # Actual run to release & write the MD changelog

tests/e2e/conftest.py

@@ -34,6 +34,7 @@ class GetSanitizedChangelogContentFn(Protocol):
         def __call__(
             self,
             repo_dir: Path,
+            changelog_file: Path = ...,
             remove_insertion_flag: bool = True,
         ) -> str: ...
 
@@ -81,7 +82,7 @@ def config_path(example_project_dir: ExProjectDir) -> Path:
     return example_project_dir / DEFAULT_CONFIG_FILE
 
 
-@pytest.fixture
+@pytest.fixture(scope="session")
 def read_config_file() -> ReadConfigFileFn:
     def _read_config_file(file: Path | str) -> RawConfig:
         config_text = load_raw_config_file(file)
@@ -136,31 +137,35 @@ def _strip_logging_messages(log: str) -> str:
 
 
 @pytest.fixture(scope="session")
-def long_hash_pattern() -> Pattern:
+def long_hash_pattern() -> Pattern[str]:
     return regexp(r"\b([0-9a-f]{40})\b", IGNORECASE)
 
 
 @pytest.fixture(scope="session")
-def short_hash_pattern() -> Pattern:
+def short_hash_pattern() -> Pattern[str]:
     return regexp(r"\b([0-9a-f]{7})\b", IGNORECASE)
 
 
 @pytest.fixture(scope="session")
 def get_sanitized_rst_changelog_content(
     changelog_rst_file: Path,
     default_rst_changelog_insertion_flag: str,
-    long_hash_pattern: Pattern,
-    short_hash_pattern: Pattern,
+    long_hash_pattern: Pattern[str],
+    short_hash_pattern: Pattern[str],
 ) -> GetSanitizedChangelogContentFn:
     rst_short_hash_link_pattern = regexp(r"(_[0-9a-f]{7})\b", IGNORECASE)
 
     def _get_sanitized_rst_changelog_content(
         repo_dir: Path,
+        changelog_file: Path = changelog_rst_file,
         remove_insertion_flag: bool = False,
     ) -> str:
+        if not (changelog_path := repo_dir / changelog_file).exists():
+            return ""
+
         # Note that our repo generation fixture includes the insertion flag automatically
         # toggle remove_insertion_flag to True to remove the insertion flag, applies to Init mode repos
-        with (repo_dir / changelog_rst_file).open(newline=os.linesep) as rfd:
+        with changelog_path.open(newline=os.linesep) as rfd:
             # use os.linesep here because the insertion flag is os-specific
             # but convert the content to universal newlines for comparison
             changelog_content = (
@@ -182,16 +187,20 @@ def _get_sanitized_rst_changelog_content(
 def get_sanitized_md_changelog_content(
     changelog_md_file: Path,
     default_md_changelog_insertion_flag: str,
-    long_hash_pattern: Pattern,
-    short_hash_pattern: Pattern,
+    long_hash_pattern: Pattern[str],
+    short_hash_pattern: Pattern[str],
 ) -> GetSanitizedChangelogContentFn:
     def _get_sanitized_md_changelog_content(
         repo_dir: Path,
+        changelog_file: Path = changelog_md_file,
         remove_insertion_flag: bool = False,
     ) -> str:
+        if not (changelog_path := repo_dir / changelog_file).exists():
+            return ""
+
         # Note that our repo generation fixture includes the insertion flag automatically
         # toggle remove_insertion_flag to True to remove the insertion flag, applies to Init mode repos
-        with (repo_dir / changelog_md_file).open(newline=os.linesep) as rfd:
+        with changelog_path.open(newline=os.linesep) as rfd:
             # use os.linesep here because the insertion flag is os-specific
             # but convert the content to universal newlines for comparison
             changelog_content = (

tests/e2e/test_main.py

@@ -3,6 +3,7 @@
 import json
 import subprocess
 from pathlib import Path
+from shutil import rmtree
 from textwrap import dedent
 from typing import TYPE_CHECKING
 
@@ -18,8 +19,6 @@
 from tests.util import assert_exit_code, assert_successful_exit_code
 
 if TYPE_CHECKING:
-    from pathlib import Path
-
     from tests.conftest import RunCliFn
     from tests.e2e.conftest import StripLoggingMessagesFn
     from tests.fixtures.example_project import ExProjectDir, UpdatePyprojectTomlFn
@@ -245,7 +244,10 @@ def test_uses_default_config_when_no_config_file_found(
     # We have to initialise an empty git repository, as the example projects
     # all have pyproject.toml configs which would be used by default
     with git.Repo.init(example_project_dir) as repo:
+        rmtree(str(Path(repo.git_dir, "hooks")))
+
         repo.git.branch("-M", "main")
+
         with repo.config_writer("repository") as config:
             config.set_value("user", "name", "semantic release testing")
             config.set_value("user", "email", "[email protected]")