refactor: speed up testing and wait for tags

Author: woile

commitizen/bump.py

@@ -196,7 +196,9 @@ def _version_to_regex(version: str):
     return re.compile(f"{clean_regex}")
 
 
-def create_tag(version: Union[Version, str], tag_format: Optional[str] = None) -> str:
+def normalize_tag(
+    version: Union[Version, str], tag_format: Optional[str] = None
+) -> str:
     """The tag and the software version might be different.
 
     That's why this function exists.

commitizen/changelog.py

@@ -34,6 +34,7 @@
 from jinja2 import Environment, PackageLoader
 
 from commitizen import defaults
+from commitizen.bump import normalize_tag
 from commitizen.exceptions import InvalidConfigurationError
 from commitizen.git import GitCommit, GitTag
 
@@ -284,22 +285,22 @@ def incremental_build(new_content: str, lines: List, metadata: Dict) -> List:
 
 
 def get_smart_tag_range(
-    tags: List[GitTag], start: str, end: Optional[str] = None
+    tags: List[GitTag], newest: str, oldest: Optional[str] = None
 ) -> List[GitTag]:
     """Smart because it finds the N+1 tag.
 
     This is because we need to find until the next tag
     """
     accumulator = []
     keep = False
-    if not end:
-        end = start
+    if not oldest:
+        oldest = newest
     for index, tag in enumerate(tags):
-        if tag.name == start:
+        if tag.name == newest:
             keep = True
         if keep:
             accumulator.append(tag)
-        if tag.name == end:
+        if tag.name == oldest:
             keep = False
             try:
                 accumulator.append(tags[index + 1])
@@ -309,43 +310,43 @@ def get_smart_tag_range(
     return accumulator
 
 
-def get_start_and_end_rev(
-    tags: List[GitTag], version: str, tag_format: str, create_tag: Callable
+def get_oldest_and_newest_rev(
+    tags: List[GitTag], version: str, tag_format: str
 ) -> Tuple[Optional[str], Optional[str]]:
     """Find the tags for the given version.
 
     `version` may come in different formats:
     - `0.1.0..0.4.0`: as a range
     - `0.3.0`: as a single version
     """
-    start: Optional[str] = None
-    end: Optional[str] = None
+    oldest: Optional[str] = None
+    newest: Optional[str] = None
     try:
-        start, end = version.split("..")
+        oldest, newest = version.split("..")
     except ValueError:
-        end = version
+        newest = version
 
-    end_tag = create_tag(end, tag_format=tag_format)
+    newest_tag = normalize_tag(newest, tag_format=tag_format)
 
-    start_tag = None
-    if start:
-        start_tag = create_tag(start, tag_format=tag_format)
+    oldest_tag = None
+    if oldest:
+        oldest_tag = normalize_tag(oldest, tag_format=tag_format)
 
-    tags_range = get_smart_tag_range(tags, start=end_tag, end=start_tag)
-    if len(tags_range) == 0:
+    tags_range = get_smart_tag_range(tags, newest=newest_tag, oldest=oldest_tag)
+    if not tags_range:
         return None, None
 
-    start_rev: Optional[str] = tags_range[-1].name
-    end_rev = end_tag
+    oldest_rev: Optional[str] = tags_range[-1].name
+    newest_rev = newest_tag
 
     # check if it's the first tag created
     # and it's also being requested as part of the range
-    if start_rev == tags[-1].name and start_rev == start_tag:
-        return None, end_rev
+    if oldest_rev == tags[-1].name and oldest_rev == oldest_tag:
+        return None, newest_rev
 
     # when they are the same, and it's also the
-    # first tag crated
-    if start_rev == end_rev:
-        return None, end_rev
+    # first tag created
+    if oldest_rev == newest_rev:
+        return None, newest_rev
 
-    return start_rev, end_rev
+    return oldest_rev, newest_rev

commitizen/commands/bump.py

@@ -101,7 +101,7 @@ def __call__(self):  # noqa: C901
         is_files_only: Optional[bool] = self.arguments["files_only"]
         is_local_version: Optional[bool] = self.arguments["local_version"]
 
-        current_tag_version: str = bump.create_tag(
+        current_tag_version: str = bump.normalize_tag(
             current_version, tag_format=tag_format
         )
 
@@ -149,7 +149,7 @@ def __call__(self):  # noqa: C901
             is_local_version=is_local_version,
         )
 
-        new_tag_version = bump.create_tag(new_version, tag_format=tag_format)
+        new_tag_version = bump.normalize_tag(new_version, tag_format=tag_format)
         message = bump.create_commit_message(
             current_version, new_version, bump_commit_message
         )

commitizen/commands/changelog.py

@@ -3,7 +3,7 @@
 from operator import itemgetter
 from typing import Callable, Dict, List, Optional
 
-from commitizen import bump, changelog, factory, git, out
+from commitizen import changelog, factory, git, out
 from commitizen.config import BaseConfig
 from commitizen.exceptions import (
     DryRunExit,
@@ -125,7 +125,7 @@ def __call__(self):
         if not tags:
             tags = []
 
-        end_rev = "HEAD"
+        end_rev = ""
 
         if self.incremental:
             changelog_meta = changelog.get_metadata(self.file_name)
@@ -134,11 +134,10 @@ def __call__(self):
                 start_rev = self._find_incremental_rev(latest_version, tags)
 
         if self.rev_range and self.tag_format:
-            start_rev, end_rev = changelog.get_start_and_end_rev(
+            start_rev, end_rev = changelog.get_oldest_and_newest_rev(
                 tags,
                 version=self.rev_range,
                 tag_format=self.tag_format,
-                create_tag=bump.create_tag,
             )
 
         commits = git.get_commits(

commitizen/git.py

@@ -86,10 +86,10 @@ def get_commits(
     )
 
     if start:
-        c = cmd.run(f"{git_log_cmd} {start}..{end}")
+        command = f"{git_log_cmd} {start}..{end}"
     else:
-        c = cmd.run(f"{git_log_cmd} {end}")
-
+        command = f"{git_log_cmd} {end}"
+    c = cmd.run(command)
     if not c.out:
         return []
 

pyproject.toml

@@ -79,6 +79,7 @@ types-termcolor = "^0.1.1"
 mkdocs = "^1.0"
 mkdocs-material = "^4.1"
 pydocstyle = "^5.0.2"
+pytest-xdist = "^2.5.0"
 
 [tool.poetry.scripts]
 cz = "commitizen.cli:main"

scripts/test

@@ -5,7 +5,7 @@ if [ -d 'venv' ] ; then
     export PREFIX="venv/bin/"
 fi
 
-${PREFIX}pytest --cov-report term-missing --cov-report=xml:coverage.xml --cov=commitizen tests/
+${PREFIX}pytest -n 3 --cov-report term-missing --cov-report=xml:coverage.xml --cov=commitizen tests/
 ${PREFIX}black commitizen tests --check
 ${PREFIX}isort --check-only commitizen tests
 ${PREFIX}flake8 commitizen/ tests/