test(commands): centralize all --help tests in a file to dedup code

Author: bearomorphism

tests/commands/test_bump_command.py

@@ -28,7 +28,7 @@
     NotAllowed,
     NoVersionSpecifiedError,
 )
-from tests.utils import create_file_and_commit, create_tag, skip_below_py_3_13
+from tests.utils import create_file_and_commit, create_tag
 
 if TYPE_CHECKING:
     import py
@@ -1438,19 +1438,6 @@ def test_bump_changelog_contains_increment_only(mocker, tmp_commitizen_project,
     assert "2.0.0" not in out
 
 
-@skip_below_py_3_13
-def test_bump_command_shows_description_when_use_help_option(
-    mocker: MockFixture, capsys, file_regression
-):
-    testargs = ["cz", "bump", "--help"]
-    mocker.patch.object(sys, "argv", testargs)
-    with pytest.raises(SystemExit):
-        cli.main()
-
-    out, _ = capsys.readouterr()
-    file_regression.check(out, extension=".txt")
-
-
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_bump_get_next(mocker: MockFixture, capsys):
     create_file_and_commit("feat: new file")

tests/commands/test_changelog_command.py

@@ -30,7 +30,6 @@
     create_tag,
     get_current_branch,
     merge_branch,
-    skip_below_py_3_13,
     switch_branch,
     wait_for_tag,
 )
@@ -1927,16 +1926,3 @@ class FakeTemplate:
 
     assert not target.exists()
     assert "Template filename is not set" in str(exc_info.value)
-
-
-@skip_below_py_3_13
-def test_changelog_command_shows_description_when_use_help_option(
-    mocker: MockFixture, capsys, file_regression
-):
-    testargs = ["cz", "changelog", "--help"]
-    mocker.patch.object(sys, "argv", testargs)
-    with pytest.raises(SystemExit):
-        cli.main()
-
-    out, _ = capsys.readouterr()
-    file_regression.check(out, extension=".txt")

tests/commands/test_check_command.py

@@ -15,7 +15,7 @@
     InvalidCommitMessageError,
     NoCommitsFoundError,
 )
-from tests.utils import create_file_and_commit, skip_below_py_3_13
+from tests.utils import create_file_and_commit
 
 if TYPE_CHECKING:
     import re
@@ -427,19 +427,6 @@ def test_check_conventional_commit_succeed_with_git_diff(mocker, capsys):
     assert "Commit validation: successful!" in out
 
 
-@skip_below_py_3_13
-def test_check_command_shows_description_when_use_help_option(
-    mocker: MockFixture, capsys, file_regression
-):
-    testargs = ["cz", "check", "--help"]
-    mocker.patch.object(sys, "argv", testargs)
-    with pytest.raises(SystemExit):
-        cli.main()
-
-    out, _ = capsys.readouterr()
-    file_regression.check(out, extension=".txt")
-
-
 def test_check_command_with_message_length_limit(config, mocker: MockFixture):
     success_mock = mocker.patch("commitizen.out.success")
     message = "fix(scope): some commit message"

tests/commands/test_commit_command.py

@@ -1,11 +1,10 @@
 import os
-import sys
 from unittest.mock import ANY
 
 import pytest
 from pytest_mock import MockFixture
 
-from commitizen import cli, cmd, commands
+from commitizen import cmd, commands
 from commitizen.cz.exceptions import CzException
 from commitizen.cz.utils import get_backup_file_path
 from commitizen.exceptions import (
@@ -19,7 +18,6 @@
     NotAllowed,
     NothingToCommitError,
 )
-from tests.utils import skip_below_py_3_13
 
 
 @pytest.fixture
@@ -512,19 +510,6 @@ def test_manual_edit(editor, config, mocker: MockFixture, tmp_path):
         assert edited_message == test_message.strip()
 
 
-@skip_below_py_3_13
-def test_commit_command_shows_description_when_use_help_option(
-    mocker: MockFixture, capsys, file_regression
-):
-    testargs = ["cz", "commit", "--help"]
-    mocker.patch.object(sys, "argv", testargs)
-    with pytest.raises(SystemExit):
-        cli.main()
-
-    out, _ = capsys.readouterr()
-    file_regression.check(out, extension=".txt")
-
-
 @pytest.mark.usefixtures("staging_is_clean")
 @pytest.mark.parametrize(
     "out", ["no changes added to commit", "nothing added to commit"]

tests/commands/test_common_command.py

@@ -0,0 +1,69 @@
+import sys
+
+import pytest
+from pytest_mock import MockFixture
+
+from commitizen import cli
+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",
+    [
+        "bump",
+        "changelog",
+        "check",
+        "commit",
+        "example",
+        "info",
+        "init",
+        "ls",
+        "schema",
+        "version",
+    ],
+)
+def test_command_shows_description_when_use_help_option(
+    mocker: MockFixture,
+    capsys,
+    file_regression,
+    monkeypatch: pytest.MonkeyPatch,
+    command: str,
+):
+    """Test that the command shows the description when the help option is used.
+
+    Note: If the command description changes, please run `pytest tests/commands/test_common_command.py --regen-all` to regenerate the test files.
+    """
+    # Force consistent terminal output
+    monkeypatch.setenv("COLUMNS", "80")
+    monkeypatch.setenv("TERM", "dumb")
+    monkeypatch.setenv("LC_ALL", "C")
+    monkeypatch.setenv("LANG", "C")
+    monkeypatch.setenv("NO_COLOR", "1")
+    monkeypatch.setenv("PAGER", "cat")
+
+    testargs = ["cz", command, "--help"]
+    mocker.patch.object(sys, "argv", testargs)
+    with pytest.raises(SystemExit):
+        cli.main()
+
+    out, _ = capsys.readouterr()
+    file_regression.check(out, extension=".txt")
+
+
+@pytest.mark.parametrize(
+    "command",
+    [
+        Example,
+        Info,
+        ListCz,
+        Schema,
+    ],
+)
+def test_simple_command_call_once(config, mocker: MockFixture, command):
+    write_mock = mocker.patch("commitizen.out.write")
+    command(config)()
+    write_mock.assert_called_once()