refactor: speed up testing and wait for tags

Author: woile

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,6 +1,4 @@
 import sys
-import time
-
 from datetime import date
 from unittest import mock
 
@@ -15,7 +13,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")
@@ -549,18 +547,19 @@ 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)
+
+    # time.sleep(1)
     testargs = ["cz", "changelog", "0.2.0"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
-
     with open(changelog_path, "r") as f:
         out = f.read()
 
@@ -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)
@@ -701,21 +706,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)
@@ -741,40 +746,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)
@@ -800,15 +805,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_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):

tests/utils.py

@@ -1,3 +1,4 @@
+import time
 import uuid
 from pathlib import Path
 from typing import Optional
@@ -19,3 +20,17 @@ def create_file_and_commit(message: str, filename: Optional[str] = None):
     Path(f"./{filename}").touch()
     cmd.run("git add .")
     git.commit(message)
+
+
+def wait_for_tag():
+    """Wait for tag.
+
+    The resolution of timestamps is 1 second, so we need to wait
+    to create another tag unfortunately.
+
+    This means:
+    If we create 2 tags under the same second, they might be returned in the wrong order
+
+    See https://stackoverflow.com/questions/28237043/what-is-the-resolution-of-gits-commit-date-or-author-date-timestamps
+    """
+    time.sleep(1.1)