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
 
@@ -310,7 +311,7 @@ def get_smart_tag_range(
 
 
 def get_start_and_end_rev(
-    tags: List[GitTag], version: str, tag_format: str, create_tag: Callable
+    tags: List[GitTag], version: str, tag_format: str
 ) -> Tuple[Optional[str], Optional[str]]:
     """Find the tags for the given version.
 
@@ -325,14 +326,14 @@ def get_start_and_end_rev(
     except ValueError:
         end = version
 
-    end_tag = create_tag(end, tag_format=tag_format)
+    end_tag = normalize_tag(end, tag_format=tag_format)
 
     start_tag = None
     if start:
-        start_tag = create_tag(start, tag_format=tag_format)
+        start_tag = normalize_tag(start, tag_format=tag_format)
 
     tags_range = get_smart_tag_range(tags, start=end_tag, end=start_tag)
-    if len(tags_range) == 0:
+    if not tags_range:
         return None, None
 
     start_rev: Optional[str] = tags_range[-1].name

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,
@@ -138,7 +138,6 @@ def __call__(self):
                 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/

tests/commands/test_changelog_command.py

@@ -1,8 +1,5 @@
 import sys
-import time
-
 from datetime import date
-from unittest import mock
 
 import pytest
 
@@ -15,7 +12,7 @@
     NotAGitProjectError,
     NotAllowed,
 )
-from tests.utils import create_file_and_commit
+from tests.utils import create_file_and_commit, wait_for_tag
 
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
@@ -536,10 +533,11 @@ def test_changelog_with_filename_as_empty_string(mocker, changelog_path, config_
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.freeze_time("2022-02-13")
-@mock.patch("commitizen.git.GitTag.date", "2022-02-13")
 def test_changelog_from_rev_first_version_from_arg(
     mocker, 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')
 
@@ -549,18 +547,18 @@ def test_changelog_from_rev_first_version_from_arg(
     testargs = ["cz", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+    wait_for_tag()
+
     create_file_and_commit("feat: after 0.2.0")
     create_file_and_commit("feat: another feature")
 
     testargs = ["cz", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+
     testargs = ["cz", "changelog", "0.2.0"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-
     with open(changelog_path, "r") as f:
         out = f.read()
 
@@ -569,10 +567,11 @@ def test_changelog_from_rev_first_version_from_arg(
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.freeze_time("2022-02-13")
-@mock.patch("commitizen.git.GitTag.date", "2022-02-13")
 def test_changelog_from_rev_latest_version_from_arg(
     mocker, 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')
 
@@ -581,14 +580,17 @@ def test_changelog_from_rev_latest_version_from_arg(
     testargs = ["cz", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+    wait_for_tag()
+
     create_file_and_commit("feat: after 0.2.0")
     create_file_and_commit("feat: another feature")
 
     testargs = ["cz", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+
+    wait_for_tag()
+
     testargs = ["cz", "changelog", "0.3.0"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
@@ -613,12 +615,15 @@ def test_changelog_from_rev_single_version_not_found(
     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"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
+    wait_for_tag()
 
     testargs = ["cz", "changelog", "0.8.0"]  # it shouldn't exist
     mocker.patch.object(sys, "argv", testargs)
@@ -657,10 +662,11 @@ def test_changelog_from_rev_range_version_not_found(mocker, config_path):
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.freeze_time("2022-02-13")
-@mock.patch("commitizen.git.GitTag.date", "2022-02-13")
 def test_changelog_from_rev_version_range_including_first_tag(
     mocker, 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')
 
@@ -683,16 +689,16 @@ def test_changelog_from_rev_version_range_including_first_tag(
     with open(changelog_path, "r") as f:
         out = f.read()
 
-    print(out)
     file_regression.check(out, extension=".md")
 
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.freeze_time("2022-02-13")
-@mock.patch("commitizen.git.GitTag.date", "2022-02-13")
 def test_changelog_from_rev_version_range_from_arg(
     mocker, 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')
 
@@ -701,21 +707,21 @@ def test_changelog_from_rev_version_range_from_arg(
     testargs = ["cz", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+    wait_for_tag()
     create_file_and_commit("feat: after 0.2.0")
     create_file_and_commit("feat: another feature")
 
     testargs = ["cz", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+    wait_for_tag()
 
     create_file_and_commit("feat: getting ready for this")
 
     testargs = ["cz", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+    wait_for_tag()
 
     testargs = ["cz", "changelog", "0.3.0..0.4.0"]
     mocker.patch.object(sys, "argv", testargs)
@@ -728,10 +734,11 @@ def test_changelog_from_rev_version_range_from_arg(
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.freeze_time("2022-02-13")
-@mock.patch("commitizen.git.GitTag.date", "2022-02-13")
 def test_changelog_from_rev_version_with_big_range_from_arg(
     mocker, 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')
 
@@ -741,40 +748,40 @@ def test_changelog_from_rev_version_with_big_range_from_arg(
     testargs = ["cz", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+    wait_for_tag()
 
     create_file_and_commit("feat: after 0.2.0")
     create_file_and_commit("feat: another feature")
 
     testargs = ["cz", "bump", "--yes"]  # 0.3.0
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+    wait_for_tag()
     create_file_and_commit("feat: getting ready for this")
 
     testargs = ["cz", "bump", "--yes"]  # 0.4.0
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+    wait_for_tag()
     create_file_and_commit("fix: small error")
 
     testargs = ["cz", "bump", "--yes"]  # 0.4.1
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+    wait_for_tag()
     create_file_and_commit("feat: new shinny feature")
 
     testargs = ["cz", "bump", "--yes"]  # 0.5.0
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+    wait_for_tag()
     create_file_and_commit("feat: amazing different shinny feature")
     # dirty hack to avoid same time between tags
 
     testargs = ["cz", "bump", "--yes"]  # 0.6.0
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+    wait_for_tag()
 
     testargs = ["cz", "changelog", "0.3.0..0.5.0"]
     mocker.patch.object(sys, "argv", testargs)
@@ -787,10 +794,10 @@ def test_changelog_from_rev_version_with_big_range_from_arg(
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.freeze_time("2022-02-13")
-@mock.patch("commitizen.git.GitTag.date", "2022-02-13")
 def test_changelog_from_rev_latest_version_dry_run(
     mocker, 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')
@@ -800,15 +807,17 @@ def test_changelog_from_rev_latest_version_dry_run(
     testargs = ["cz", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-    time.sleep(0.5)
+    wait_for_tag()
+
     create_file_and_commit("feat: after 0.2.0")
     create_file_and_commit("feat: another feature")
 
     testargs = ["cz", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
     capsys.readouterr()
-    time.sleep(0.5)
+    wait_for_tag()
+
     testargs = ["cz", "changelog", "0.3.0", "--dry-run"]
     mocker.patch.object(sys, "argv", testargs)
     with pytest.raises(DryRunExit):

tests/test_bump_create_tag.py renamed to tests/test_bump_normalize_tag.py

@@ -19,5 +19,5 @@
 @pytest.mark.parametrize("test_input,expected", conversion)
 def test_create_tag(test_input, expected):
     version, format = test_input
-    new_tag = bump.create_tag(Version(version), format)
+    new_tag = bump.normalize_tag(Version(version), format)
     assert new_tag == expected

tests/test_changelog_parser.py

@@ -33,15 +33,17 @@ def changelog_content() -> str:
 
 
 @pytest.fixture
-def existing_changelog_file():
-    changelog_path = "tests/CHANGELOG.md"
+def existing_changelog_file(tmpdir):
+    with tmpdir.as_cwd():
+        changelog_path = os.path.join(os.getcwd(), "CHANGELOG.md")
+        # changelog_path = "tests/CHANGELOG.md"
 
-    with open(changelog_path, "w") as f:
-        f.write(CHANGELOG_TEMPLATE)
+        with open(changelog_path, "w") as f:
+            f.write(CHANGELOG_TEMPLATE)
 
-    yield changelog_path
+        yield changelog_path
 
-    os.remove(changelog_path)
+        os.remove(changelog_path)
 
 
 def test_read_changelog_blocks(existing_changelog_file):