test(fixtures): update repo definitions & improve reusability & maintenance

Author: codejedi365

tests/const.py

@@ -2,6 +2,7 @@
 
 import git
 
+import semantic_release
 from semantic_release.cli.commands.main import Cli
 
 A_FULL_VERSION_STRING = "1.11.567"
@@ -12,7 +13,7 @@
 EXAMPLE_REPO_NAME = "example_repo"
 EXAMPLE_HVCS_DOMAIN = "example.com"
 
-MAIN_PROG_NAME = str(__import__("semantic_release").__name__).replace("_", "-")
+MAIN_PROG_NAME = str(semantic_release.__name__).replace("_", "-")
 SUCCESS_EXIT_CODE = 0
 
 CHANGELOG_SUBCMD = Cli.SubCmds.CHANGELOG.name.lower()
@@ -27,58 +28,41 @@
 
 COMMIT_MESSAGE = "{version}\n\nAutomatically generated by python-semantic-release\n"
 
+ANGULAR_COMMITS_CHORE = ("ci: added a commit lint job\n",)
 # Different in-scope commits that produce a certain release type
-ANGULAR_COMMITS_PATCH = [
-    "fix: something annoying\n",
-    "fixup the bugfix\n",
-    "oops it broke again\n",
-    "fix\n",
-    "fix\n",
-    "fix\n",
-    "fix\n",
-    "fix: release the bugfix-fix\n",
-]
-ANGULAR_COMMITS_MINOR = [
-    "feat: something special\n",
-    "fix: needed a tweak\n",
-    "tweaked again\n",
-    "tweaked again\n",
-    "tweaked again\n",
-    "fix\n",
-    "fix\n",
+ANGULAR_COMMITS_PATCH = (
+    *ANGULAR_COMMITS_CHORE,
+    "fix: fixed voltage in the flux capacitor\n",
+)
+ANGULAR_COMMITS_MINOR = (
+    *ANGULAR_COMMITS_PATCH,
     "feat: last minute rush order\n",
-]
+)
 # Take previous commits and insert a breaking change
-ANGULAR_COMMITS_MAJOR = ANGULAR_COMMITS_MINOR.copy()
-ANGULAR_COMMITS_MAJOR.insert(
-    4, "fix!: big change\n\nBREAKING CHANGE: reworked something for previous feature\n"
+ANGULAR_COMMITS_MAJOR = (
+    *ANGULAR_COMMITS_MINOR,
+    "fix!: big change\n\nBREAKING CHANGE: reworked something for previous feature\n",
 )
 
-EMOJI_COMMITS_PATCH = [
-    ":bug: something annoying\n",
-    "fixup the bugfix\n",
-    "oops it broke again\n",
-    "fix\n",
-    "fix\n",
-    "fix\n",
-    "fix\n",
-    "fix\n",
-    ":bug: release the bugfix-fix\n",
-]
-EMOJI_COMMITS_MINOR = [
-    ":sparkles: something special\n",
+EMOJI_COMMITS_CHORE = (
+    ":broom: updated lint & code style\n",
+    ":none: updated ci pipeline\n",
+)
+
+EMOJI_COMMITS_PATCH = (
+    *EMOJI_COMMITS_CHORE,
+    ":bug: fixed voltage in the flux capacitor\n",
+)
+EMOJI_COMMITS_MINOR = (
+    *EMOJI_COMMITS_PATCH,
     ":sparkles::pencil: docs for something special\n",
-    ":bug: needed a tweak\n",
-    "tweaked again\n",
-    "tweaked again\n",
-    "tweaked again\n",
-    "fix\n",
-    "fix\n",
     # Emoji in description should not be used to evaluate change type
-    ":sparkles: last minute rush order\n\n:boom: Good thing we're 10x developers",
-]
-EMOJI_COMMITS_MAJOR = EMOJI_COMMITS_MINOR.copy()
-EMOJI_COMMITS_MAJOR.insert(4, ":boom: Move to the blockchain")
+    ":sparkles: last minute rush order\n\n:boom: Good thing we're 10x developers\n",
+)
+EMOJI_COMMITS_MAJOR = (
+    *EMOJI_COMMITS_MINOR,
+    ":boom: Move to the blockchain\n",
+)
 
 # Note - the scipy commit fixtures for commits that should evaluate to the various scopes
 # are in tests/fixtures/scipy
@@ -293,12 +277,15 @@ def _read_long_description():
 
 EXAMPLE_RELEASE_NOTES_TEMPLATE = r"""
 ## What's Changed
-{% for type_, commits in release["elements"] | dictsort %}
-### {{ type_ | capitalize }}
-{%- if type_ != "unknown" %}
-{% for commit in commits %}
-* {{ commit.commit.summary.rstrip() }} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
-{%- endfor %}{% endif %}{% endfor %}
+{%    for type_, commits in release["elements"] | dictsort
+%}{{    "### %s" | format(type_ | title)
+}}{%    if type_ != "unknown"
+%}{%      for commit in commits
+%}{{        "* %s" | format(commit.descriptions[0] | trim)
+}}{%      endfor
+%}{%    endif
+%}{%  endfor
+%}
 """.lstrip()  # noqa: E501
 
 RELEASE_NOTES = "# Release Notes"

tests/fixtures/commit_parsers.py

@@ -7,6 +7,17 @@
     EmojiParserOptions,
 )
 
+from tests.const import (
+    ANGULAR_COMMITS_CHORE,
+    ANGULAR_COMMITS_MAJOR,
+    ANGULAR_COMMITS_MINOR,
+    ANGULAR_COMMITS_PATCH,
+    EMOJI_COMMITS_CHORE,
+    EMOJI_COMMITS_MAJOR,
+    EMOJI_COMMITS_MINOR,
+    EMOJI_COMMITS_PATCH,
+)
+
 # Note scipy defined in ./scipy.py as already used there
 
 
@@ -32,3 +43,43 @@ def default_emoji_parser_options(
     default_emoji_parser: EmojiCommitParser,
 ) -> EmojiParserOptions:
     return default_emoji_parser.get_default_options()
+
+
+@pytest.fixture(scope="session")
+def angular_major_commits():
+    return ANGULAR_COMMITS_MAJOR
+
+
+@pytest.fixture(scope="session")
+def angular_minor_commits():
+    return ANGULAR_COMMITS_MINOR
+
+
+@pytest.fixture(scope="session")
+def angular_patch_commits():
+    return ANGULAR_COMMITS_PATCH
+
+
+@pytest.fixture(scope="session")
+def angular_chore_commits():
+    return ANGULAR_COMMITS_CHORE
+
+
+@pytest.fixture(scope="session")
+def emoji_major_commits():
+    return EMOJI_COMMITS_MAJOR
+
+
+@pytest.fixture(scope="session")
+def emoji_minor_commits():
+    return EMOJI_COMMITS_MINOR
+
+
+@pytest.fixture(scope="session")
+def emoji_patch_commits():
+    return EMOJI_COMMITS_PATCH
+
+
+@pytest.fixture(scope="session")
+def emoji_chore_commits():
+    return EMOJI_COMMITS_CHORE

tests/fixtures/example_project.py

@@ -39,6 +39,9 @@
 
     ExProjectDir = Path
 
+    class GetWheelFileFn(Protocol):
+        def __call__(self, version_str: str) -> Path: ...
+
     class SetFlagFn(Protocol):
         def __call__(self, flag: bool) -> None: ...
 
@@ -73,6 +76,11 @@ def setup_py_file() -> Path:
     return Path("setup.py")
 
 
+@pytest.fixture(scope="session")
+def dist_dir() -> Path:
+    return Path("dist")
+
+
 @pytest.fixture(scope="session")
 def changelog_md_file() -> Path:
     return Path("CHANGELOG.md")
@@ -98,6 +106,14 @@ def default_rst_changelog_insertion_flag() -> str:
     return f"..{os.linesep}    version list"
 
 
+@pytest.fixture(scope="session")
+def get_wheel_file(dist_dir: Path) -> GetWheelFileFn:
+    def _get_wheel_file(version_str: str) -> Path:
+        return dist_dir / f"{EXAMPLE_PROJECT_NAME}-{version_str}-py3-none-any.whl"
+
+    return _get_wheel_file
+
+
 @pytest.fixture
 def example_project_dir(tmp_path: Path) -> ExProjectDir:
     return tmp_path.resolve()
@@ -248,6 +264,22 @@ def example_setup_py(
     return example_project_dir / setup_py_file
 
 
+@pytest.fixture
+def example_dist_dir(
+    example_project_dir: ExProjectDir,
+    dist_dir: Path,
+) -> Path:
+    return example_project_dir / dist_dir
+
+
+@pytest.fixture
+def example_project_wheel_file(
+    example_dist_dir: Path,
+    get_wheel_file: GetWheelFileFn,
+) -> Path:
+    return example_dist_dir / get_wheel_file(EXAMPLE_PROJECT_VERSION)
+
+
 # Note this is just the path and the content may change
 @pytest.fixture
 def example_changelog_md(

tests/fixtures/git_repo.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import sys
 from functools import reduce
 from pathlib import Path
 from textwrap import dedent
@@ -33,6 +34,7 @@
     from tests.conftest import TeardownCachedDirFn
     from tests.fixtures.example_project import (
         ExProjectDir,
+        GetWheelFileFn,
         UpdatePyprojectTomlFn,
         UseCustomParserFn,
         UseHvcsFn,
@@ -271,6 +273,7 @@ def build_configured_base_repo(  # noqa: C901
     use_custom_parser: UseCustomParserFn,
     example_git_https_url: str,
     update_pyproject_toml: UpdatePyprojectTomlFn,
+    get_wheel_file: GetWheelFileFn,
 ) -> BuildRepoFn:
     """
     This fixture is intended to simplify repo scenario building by initially
@@ -326,6 +329,28 @@ def _build_configured_base_repo(  # noqa: C901
                     "tool.semantic_release.tag_format", tag_format_str
                 )
 
+            # Set the build_command to create a wheel file (using the build_command_env version variable)
+            build_result_file = (
+                get_wheel_file("$NEW_VERSION")
+                if sys.platform != "win32"
+                else get_wheel_file("$Env:NEW_VERSION")
+            )
+            update_pyproject_toml(
+                # NOTE: must work in both bash and Powershell
+                "tool.semantic_release.build_command",
+                dedent(
+                    f"""\
+                    mkdir -p "{build_result_file.parent}"
+                    touch "{build_result_file}"
+                    """
+                    if sys.platform != "win32"
+                    else f"""\
+                    mkdir {build_result_file.parent} > $null
+                    New-Item -ItemType file -Path "{build_result_file}" -Force | Select-Object OriginalPath
+                    """
+                ),
+            )
+
             # Apply configurations to pyproject.toml
             if extra_configs is not None:
                 for key, value in extra_configs.items():