test(warning): introduce a UtilFixture helper and remove git wait_for_tag() function, removing the associated warnings

Author: noirbizarre

tests/commands/test_changelog_command.py

@@ -10,4 +10,4 @@
 - mama gotta work
 - output glitch
 
-## 1.0.0 (1970-01-01)
+## 1.0.0 (2025-12-29)

tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_alpha_.md

@@ -10,4 +10,4 @@
 - mama gotta work
 - output glitch
 
-## 1.0.0 (1970-01-01)
+## 1.0.0 (2025-12-29)

tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_beta_.md

@@ -10,4 +10,4 @@
 - mama gotta work
 - output glitch
 
-## 1.0.0 (1970-01-01)
+## 1.0.0 (2025-12-29)

tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_rc_.md

@@ -10,4 +10,4 @@
 - mama gotta work
 - output glitch
 
-## 1.0.0 (1970-01-01)
+## 1.0.0 (2025-12-29)

tests/commands/test_changelog_command/test_changelog_release_candidate_version_with_merge_prerelease_alpha_.md

@@ -10,4 +10,4 @@
 - mama gotta work
 - output glitch
 
-## 1.0.0 (1970-01-01)
+## 1.0.0 (2025-12-29)

tests/commands/test_changelog_command/test_changelog_release_candidate_version_with_merge_prerelease_beta_.md

@@ -10,4 +10,4 @@
 - mama gotta work
 - output glitch
 
-## 1.0.0 (1970-01-01)
+## 1.0.0 (2025-12-29)

tests/commands/test_changelog_command/test_changelog_release_candidate_version_with_merge_prerelease_rc_.md

@@ -16,19 +16,23 @@
 from commitizen.config import BaseConfig
 from commitizen.cz import registry
 from commitizen.cz.base import BaseCommitizen
-from tests.utils import create_file_and_commit
 
 if TYPE_CHECKING:
     from collections.abc import Iterator, Mapping
 
     from pytest_mock import MockerFixture
 
     from commitizen.question import CzQuestion
+    from tests.utils import UtilFixture
 
 
 SIGNER = "GitHub Action"
 SIGNER_MAIL = "action@github.com"
 
+pytest_plugins = [
+    "tests.utils",
+]
+
 
 @pytest.fixture
 def repo_root() -> Path:
@@ -83,7 +87,7 @@ def tmp_commitizen_project(tmp_git_project):
 
 
 @pytest.fixture(scope="function")
-def tmp_commitizen_project_initial(tmp_git_project):
+def tmp_commitizen_project_initial(tmp_git_project, util: UtilFixture):
     def _initial(
         config_extra: str | None = None,
         version="0.1.0",
@@ -102,7 +106,7 @@ def _initial(
             )
             if config_extra:
                 tmp_commitizen_cfg_file.write(config_extra, mode="a")
-            create_file_and_commit(initial_commit)
+            util.create_file_and_commit(initial_commit)
 
             return tmp_git_project
 

tests/conftest.py

@@ -1,15 +1,20 @@
 from __future__ import annotations
 
-import time
+import sys
 import uuid
+from dataclasses import dataclass
+from datetime import datetime
 from pathlib import Path
 from typing import TYPE_CHECKING, NamedTuple
 
-from deprecated import deprecated
+import pytest
 
-from commitizen import cmd, exceptions, git
+from commitizen import cli, cmd, exceptions, git
 
 if TYPE_CHECKING:
+    from freezegun.api import FrozenDateTimeFactory
+    from pytest_mock import MockerFixture
+
     from commitizen.version_schemes import Increment, Prerelease
 
 
@@ -61,36 +66,106 @@ def merge_branch(branch: str):
         raise exceptions.GitCommandError(c.err)
 
 
-def get_current_branch() -> str:
-    c = cmd.run("git rev-parse --abbrev-ref HEAD")
-    if c.return_code != 0:
-        raise exceptions.GitCommandError(c.err)
-    return c.out
-
-
 def create_tag(tag: str, message: str | None = None) -> None:
     c = git.tag(tag, annotated=(message is not None), msg=message)
     if c.return_code != 0:
         raise exceptions.CommitError(c.err)
 
 
-@deprecated(
-    reason="\n\
-Prefer using `create_file_and_commit(filename, committer_date={your_date})` to influence the order of tags.\n\
-This is because lightweight tags (like the ones created here) use the commit's creatordate which we can specify \
-with the GIT_COMMITTER_DATE flag, instead of waiting entire seconds during tests."
-)
-def wait_for_tag():
-    """Deprecated -- use `create_file_and_commit(filename, committer_date={your_date})` to order tags instead
-
-    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
+@dataclass
+class UtilFixture:
+    """
+    An helper fixture providing most common operations for tests.
 
-    See https://stackoverflow.com/questions/28237043/what-is-the-resolution-of-gits-commit-date-or-author-date-timestamps
+    git and cli operations grant control over time.
     """
-    time.sleep(1.1)
+
+    mocker: MockerFixture
+    monkeypatch: pytest.MonkeyPatch
+    freezer: FrozenDateTimeFactory
+
+    def __post_init__(self):
+        self.patch_env()
+
+    def create_file_and_commit(
+        self,
+        message: str,
+        filename: str | None = None,
+        committer_date: str | None = None,
+    ):
+        """Create a file and commit it."""
+        if not filename:
+            filename = str(uuid.uuid4())
+
+        Path(filename).touch()
+        c = cmd.run("git add .")
+        if c.return_code != 0:
+            raise exceptions.CommitError(c.err)
+        c = git.commit(message, committer_date=committer_date)
+        if c.return_code != 0:
+            raise exceptions.CommitError(c.err)
+        self.tick()
+
+    def branch(self, name: str):
+        """Create a new branch."""
+        c = cmd.run(f"git branch {name}")
+        if c.return_code != 0:
+            raise exceptions.GitCommandError(c.err)
+
+    def switch_branch(self, branch: str):
+        """Switch to given branch."""
+        c = cmd.run(f"git switch {branch}")
+        if c.return_code != 0:
+            raise exceptions.GitCommandError(c.err)
+
+    def merge_branch(self, branch: str):
+        """Merge given branch into current branch."""
+        c = cmd.run(f"git merge {branch}")
+        if c.return_code != 0:
+            raise exceptions.GitCommandError(c.err)
+        self.tick()
+
+    def current_branch(self) -> str:
+        """Get current git branch name."""
+        c = cmd.run("git rev-parse --abbrev-ref HEAD")
+        if c.return_code != 0:
+            raise exceptions.GitCommandError(c.err)
+        return c.out
+
+    def tag(
+        self, tag: str, message: str | None = None, annotated: bool | None = None
+    ) -> None:
+        """Create a git tag."""
+        c = git.tag(
+            tag, annotated=(annotated is True or message is not None), msg=message
+        )
+        if c.return_code != 0:
+            raise exceptions.CommitError(c.err)
+        self.tick()
+
+    def cli(self, *args: str):
+        """Execute commitizen CLI with given args."""
+        self.mocker.patch.object(sys, "argv", ["cz", *args])
+        cli.main()
+        self.tick()
+
+    def patch_env(self):
+        """Patch environment variables to sync with FreezeGun time."""
+        self.monkeypatch.setenv("DATE", datetime.now().isoformat())
+        self.monkeypatch.setenv("GIT_AUTHOR_DATE", datetime.now().isoformat())
+        self.monkeypatch.setenv("GIT_COMMITTER_DATE", datetime.now().isoformat())
+
+    def tick(self):
+        """Advance time by 1 second."""
+        self.freezer.tick()
+        self.patch_env()
+
+
+@pytest.fixture
+def util(
+    monkeypatch: pytest.MonkeyPatch,
+    mocker: MockerFixture,
+    freezer: FrozenDateTimeFactory,
+) -> UtilFixture:
+    """An helper fixture"""
+    return UtilFixture(mocker=mocker, monkeypatch=monkeypatch, freezer=freezer)