1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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()
|
