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 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
|
import os
import subprocess
import sys
import types
from functools import partial
import pytest
from pytest_mock import MockFixture
from commitizen import cli
from commitizen.exceptions import (
ConfigFileNotFound,
ExpectedExit,
InvalidCommandArgumentError,
NoCommandFoundError,
NotAGitProjectError,
)
def test_sysexit_no_argv(mocker: MockFixture, capsys):
testargs = ["cz"]
mocker.patch.object(sys, "argv", testargs)
with pytest.raises(ExpectedExit):
cli.main()
out, _ = capsys.readouterr()
assert out.startswith("usage")
def test_cz_config_file_without_correct_file_path(mocker: MockFixture, capsys):
testargs = ["cz", "--config", "./config/pyproject.toml", "example"]
mocker.patch.object(sys, "argv", testargs)
with pytest.raises(ConfigFileNotFound) as excinfo:
cli.main()
assert "Cannot found the config file" in str(excinfo.value)
def test_cz_with_arg_but_without_command(mocker: MockFixture):
testargs = ["cz", "--name", "cz_jira"]
mocker.patch.object(sys, "argv", testargs)
with pytest.raises(NoCommandFoundError) as excinfo:
cli.main()
assert "Command is required" in str(excinfo.value)
def test_name(mocker: MockFixture, capsys):
testargs = ["cz", "-n", "cz_jira", "example"]
mocker.patch.object(sys, "argv", testargs)
cli.main()
out, _ = capsys.readouterr()
assert out.startswith("JRA")
@pytest.mark.usefixtures("tmp_git_project")
def test_name_default_value(mocker: MockFixture, capsys):
testargs = ["cz", "example"]
mocker.patch.object(sys, "argv", testargs)
cli.main()
out, _ = capsys.readouterr()
assert out.startswith("fix: correct minor typos in code")
def test_ls(mocker: MockFixture, capsys):
testargs = ["cz", "-n", "cz_jira", "ls"]
mocker.patch.object(sys, "argv", testargs)
cli.main()
out, err = capsys.readouterr()
assert "cz_conventional_commits" in out
assert isinstance(out, str)
def test_arg_debug(mocker: MockFixture):
testargs = ["cz", "--debug", "info"]
mocker.patch.object(sys, "argv", testargs)
cli.main()
excepthook = sys.excepthook
# `sys.excepthook` is replaced by a `partial` in `cli.main`
# it's not a normal function
assert isinstance(excepthook, partial)
assert excepthook.keywords.get("debug") is True
def test_commitizen_excepthook(capsys):
with pytest.raises(SystemExit) as excinfo:
cli.commitizen_excepthook(NotAGitProjectError, NotAGitProjectError(), "")
assert excinfo.type is SystemExit
assert excinfo.value.code == NotAGitProjectError.exit_code
def test_commitizen_debug_excepthook(capsys):
with pytest.raises(SystemExit) as excinfo:
cli.commitizen_excepthook(
NotAGitProjectError,
NotAGitProjectError(),
"",
debug=True,
)
assert excinfo.type is SystemExit
assert excinfo.value.code == NotAGitProjectError.exit_code
assert "NotAGitProjectError" in str(excinfo.traceback[0])
@pytest.mark.skipif(
os.name == "nt",
reason="`argcomplete` does not support Git Bash on Windows.",
)
def test_argcomplete_activation():
"""
This function is testing the one-time activation of argcomplete for
commitizen only.
Equivalent to run:
$ eval "$(register-python-argcomplete pytest)"
"""
output = subprocess.run(["register-python-argcomplete", "cz"])
assert output.returncode == 0
def test_commitizen_excepthook_no_raises(capsys):
with pytest.raises(SystemExit) as excinfo:
cli.commitizen_excepthook(
NotAGitProjectError,
NotAGitProjectError(),
"",
no_raise=[NotAGitProjectError.exit_code],
)
assert excinfo.type is SystemExit
assert excinfo.value.code == 0
def test_parse_no_raise_single_integer():
input_str = "1"
result = cli.parse_no_raise(input_str)
assert result == [1]
def test_parse_no_raise_integers():
input_str = "1,2,3"
result = cli.parse_no_raise(input_str)
assert result == [1, 2, 3]
def test_parse_no_raise_error_code():
input_str = "NO_COMMITIZEN_FOUND,NO_COMMITS_FOUND,NO_PATTERN_MAP"
result = cli.parse_no_raise(input_str)
assert result == [1, 3, 5]
def test_parse_no_raise_mix_integer_error_code():
input_str = "NO_COMMITIZEN_FOUND,2,NO_COMMITS_FOUND,4"
result = cli.parse_no_raise(input_str)
assert result == [1, 2, 3, 4]
def test_parse_no_raise_mix_invalid_arg_is_skipped():
input_str = "NO_COMMITIZEN_FOUND,2,nothing,4"
result = cli.parse_no_raise(input_str)
assert result == [1, 2, 4]
def test_unknown_args_raises(mocker: MockFixture):
testargs = ["cz", "c", "-this_arg_is_not_supported"]
mocker.patch.object(sys, "argv", testargs)
with pytest.raises(InvalidCommandArgumentError) as excinfo:
cli.main()
assert "Invalid commitizen arguments were found" in str(excinfo.value)
def test_unknown_args_before_double_dash_raises(mocker: MockFixture):
testargs = ["cz", "c", "-this_arg_is_not_supported", "--"]
mocker.patch.object(sys, "argv", testargs)
with pytest.raises(InvalidCommandArgumentError) as excinfo:
cli.main()
assert "Invalid commitizen arguments were found before -- separator" in str(
excinfo.value
)
def test_commitizen_excepthook_non_commitizen_exception(mocker: MockFixture):
"""Test that commitizen_excepthook delegates to original_excepthook for non-CommitizenException."""
# Mock the original excepthook
mock_original_excepthook = mocker.Mock()
mocker.patch("commitizen.cli.original_excepthook", mock_original_excepthook)
# Create a regular exception
test_exception = ValueError("test error")
# Call commitizen_excepthook with the regular exception
cli.commitizen_excepthook(ValueError, test_exception, None)
# Verify original_excepthook was called with correct arguments
mock_original_excepthook.assert_called_once_with(ValueError, test_exception, None)
def test_commitizen_excepthook_non_commitizen_exception_with_traceback(
mocker: MockFixture,
):
"""Test that commitizen_excepthook handles traceback correctly for non-CommitizenException."""
# Mock the original excepthook
mock_original_excepthook = mocker.Mock()
mocker.patch("commitizen.cli.original_excepthook", mock_original_excepthook)
# Create a regular exception with a traceback
test_exception = ValueError("test error")
test_traceback = mocker.Mock(spec=types.TracebackType)
# Call commitizen_excepthook with the regular exception and traceback
cli.commitizen_excepthook(ValueError, test_exception, test_traceback)
# Verify original_excepthook was called with correct arguments including traceback
mock_original_excepthook.assert_called_once_with(
ValueError, test_exception, test_traceback
)
def test_commitizen_excepthook_non_commitizen_exception_with_invalid_traceback(
mocker: MockFixture,
):
"""Test that commitizen_excepthook handles invalid traceback correctly for non-CommitizenException."""
# Mock the original excepthook
mock_original_excepthook = mocker.Mock()
mocker.patch("commitizen.cli.original_excepthook", mock_original_excepthook)
# Create a regular exception with an invalid traceback
test_exception = ValueError("test error")
test_traceback = mocker.Mock() # Not a TracebackType
# Call commitizen_excepthook with the regular exception and invalid traceback
cli.commitizen_excepthook(ValueError, test_exception, test_traceback)
# Verify original_excepthook was called with None as traceback
mock_original_excepthook.assert_called_once_with(ValueError, test_exception, None)
|