fix(changelog): changelog command does not find version tag with version_type=semver option

Signed-off-by: apkawa <[email protected]>

Author: Apkawa

commitizen/changelog.py

@@ -27,9 +27,11 @@
 
 import os
 import re
+import sys
+import typing
 from collections import OrderedDict, defaultdict
 from datetime import date
-from typing import Callable, Dict, Iterable, List, Optional, Tuple
+from typing import Callable, Dict, Iterable, List, Optional, Tuple, Type
 
 from jinja2 import Environment, PackageLoader
 from packaging.version import InvalidVersion, Version
@@ -39,6 +41,12 @@
 from commitizen.exceptions import InvalidConfigurationError, NoCommitsFoundError
 from commitizen.git import GitCommit, GitTag
 
+if sys.version_info >= (3, 8):
+    from commitizen.version_types import VersionProtocol
+else:
+    # workaround mypy issue for 3.7 python
+    VersionProtocol = typing.Any
+
 
 def get_commit_tag(commit: GitCommit, tags: List[GitTag]) -> Optional[GitTag]:
     return next((tag for tag in tags if tag.rev == commit.rev), None)
@@ -313,7 +321,10 @@ def get_smart_tag_range(
 
 
 def get_oldest_and_newest_rev(
-    tags: List[GitTag], version: str, tag_format: str
+    tags: List[GitTag],
+    version: str,
+    tag_format: str,
+    version_type_cls: Optional[Type[VersionProtocol]] = None,
 ) -> Tuple[Optional[str], Optional[str]]:
     """Find the tags for the given version.
 
@@ -328,11 +339,15 @@ def get_oldest_and_newest_rev(
     except ValueError:
         newest = version
 
-    newest_tag = normalize_tag(newest, tag_format=tag_format)
+    newest_tag = normalize_tag(
+        newest, tag_format=tag_format, version_type_cls=version_type_cls
+    )
 
     oldest_tag = None
     if oldest:
-        oldest_tag = normalize_tag(oldest, tag_format=tag_format)
+        oldest_tag = normalize_tag(
+            oldest, tag_format=tag_format, version_type_cls=version_type_cls
+        )
 
     tags_range = get_smart_tag_range(tags, newest=newest_tag, oldest=oldest_tag)
     if not tags_range:

commitizen/commands/changelog.py

@@ -3,7 +3,7 @@
 from operator import itemgetter
 from typing import Callable, Dict, List, Optional
 
-from commitizen import bump, changelog, defaults, factory, git, out
+from commitizen import bump, changelog, defaults, factory, git, out, version_types
 from commitizen.config import BaseConfig
 from commitizen.exceptions import (
     DryRunExit,
@@ -53,6 +53,9 @@ def __init__(self, config: BaseConfig, args):
             "merge_prerelease"
         ) or self.config.settings.get("changelog_merge_prerelease")
 
+        version_type = self.config.settings.get("version_type")
+        self.version_type = version_type and version_types.types[version_type]
+
     def _find_incremental_rev(self, latest_version: str, tags: List[GitTag]) -> str:
         """Try to find the 'start_rev'.
 
@@ -137,7 +140,9 @@ def __call__(self):
             latest_version = changelog_meta.get("latest_version")
             if latest_version:
                 latest_tag_version: str = bump.normalize_tag(
-                    latest_version, tag_format=self.tag_format
+                    latest_version,
+                    tag_format=self.tag_format,
+                    version_type_cls=self.version_type,
                 )
                 start_rev = self._find_incremental_rev(latest_tag_version, tags)
 
@@ -146,6 +151,7 @@ def __call__(self):
                 tags,
                 version=self.rev_range,
                 tag_format=self.tag_format,
+                version_type_cls=self.version_type,
             )
 
         commits = git.get_commits(start=start_rev, end=end_rev, args="--topo-order")

tests/commands/test_changelog_command.py

@@ -1152,3 +1152,60 @@ def test_empty_commit_list(mocker):
     mocker.patch.object(sys, "argv", testargs)
     with pytest.raises(NoCommitsFoundError):
         cli.main()
+
+
+@pytest.mark.usefixtures("tmp_commitizen_project")
+@pytest.mark.freeze_time("2022-02-13")
+def test_changelog_prerelease_rev_with_use_version_type_semver(
+    mocker: MockFixture, capsys, config_path, changelog_path, file_regression
+):
+    mocker.patch("commitizen.git.GitTag.date", "2022-02-13")
+
+    with open(config_path, "a") as f:
+        f.write('tag_format = "$version"\n' 'version_type = "semver"')
+
+    # create commit and tag
+    create_file_and_commit("feat: new file")
+    testargs = ["cz", "bump", "--yes"]
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+    wait_for_tag()
+
+    create_file_and_commit("feat: after 0.2.0")
+    create_file_and_commit("feat: another feature")
+
+    testargs = ["cz", "bump", "--yes", "--prerelease", "alpha"]
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+    capsys.readouterr()
+    wait_for_tag()
+
+    tag_exists = git.tag_exist("0.3.0-a0")
+    assert tag_exists is True
+
+    testargs = ["cz", "changelog", "0.3.0-a0", "--dry-run"]
+    mocker.patch.object(sys, "argv", testargs)
+    with pytest.raises(DryRunExit):
+        cli.main()
+
+    out, _ = capsys.readouterr()
+
+    file_regression.check(out, extension=".md")
+
+    testargs = ["cz", "bump", "--yes", "--prerelease", "alpha"]
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+    capsys.readouterr()
+    wait_for_tag()
+
+    tag_exists = git.tag_exist("0.3.0-a1")
+    assert tag_exists is True
+
+    testargs = ["cz", "changelog", "0.3.0-a1", "--dry-run"]
+    mocker.patch.object(sys, "argv", testargs)
+    with pytest.raises(DryRunExit):
+        cli.main()
+
+    out, _ = capsys.readouterr()
+
+    assert out == "## 0.3.0-a1 (2022-02-13)\n\n"

tests/commands/test_changelog_command/test_changelog_prerelease_rev_with_use_version_type_semver.md

@@ -0,0 +1,7 @@
+## 0.3.0-a0 (2022-02-13)
+
+### Feat
+
+- another feature
+- after 0.2.0
+