test(snapshots): provide a test:regen command to regenerate all snapshots, including those depending on Python version

Author: noirbizarre

docs/contributing.md

@@ -64,6 +64,7 @@ If you're a first-time contributor, please check out issues labeled [good first
     - Run the full test suite: `poetry all`
     - Ensure test coverage doesn't drop (we use [CodeCov](https://app.codecov.io/gh/commitizen-tools/commitizen))
     - For documentation changes, run `poetry doc` to check for warnings/errors
+    - If you need to change some file regression snapshots, run: `poetry test:regen`
 4. **Committing Changes**
     - Use Commitizen to make commits (we follow [conventional commits](https://www.conventionalcommits.org/))
     - Example: `cz commit`

pyproject.toml

@@ -264,6 +264,12 @@ test.cmd = "pytest -n 3 --dist=loadfile"
 "test:all".help = "Run the test suite on all supported Python versions"
 "test:all".cmd = "tox --parallel"
 
+"test:regen".help = "Regenerate the test fixtures"
+"test:regen".parallel = [
+    { ref = "test -k 'not py_' --regen-all" },
+    { ref = "test:all -- -k py_ --regen-all" },
+]
+
 cover.help = "Run the test suite with coverage"
 cover.ref = "test --cov-report term-missing --cov-report=xml:coverage.xml --cov=commitizen"
 

tests/commands/test_common_command.py

@@ -7,10 +7,6 @@
 from commitizen.commands import Example, Info, ListCz, Schema
 
 
-@pytest.mark.skipif(
-    sys.version_info < (3, 13),
-    reason="The output message of argparse is different between Python 3.13 and lower than Python 3.13",
-)
 @pytest.mark.parametrize(
     "command",
     [
@@ -26,6 +22,7 @@
         "version",
     ],
 )
+@pytest.mark.usefixtures("python_version")
 def test_command_shows_description_when_use_help_option(
     mocker: MockFixture,
     capsys,

tests/conftest.py

@@ -2,9 +2,10 @@
 
 import os
 import re
+import sys
 import tempfile
 from pathlib import Path
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, cast
 
 import pytest
 
@@ -28,6 +29,7 @@
 
 SIGNER = "GitHub Action"
 SIGNER_MAIL = "[email protected]"
+PYTHON_VERSION = f"{sys.version_info.major}.{sys.version_info.minor}"
 
 
 @pytest.fixture
@@ -290,3 +292,9 @@ def any_changelog_format(config: BaseConfig) -> ChangelogFormat:
     """For test not relying on formats specifics, use the default"""
     config.settings["changelog_format"] = defaults.CHANGELOG_FORMAT
     return get_changelog_format(config)
+
+
+@pytest.fixture(params=[pytest.param(PYTHON_VERSION, id=f"py_{PYTHON_VERSION}")])
+def python_version(request: pytest.FixtureRequest) -> str:
+    """The current python version in '{major}.{minor}' format"""
+    return cast("str", request.param)