Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
commitizen/tests/test_cli.py at script-parallel-filter · commitizen-tools/commitizen · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
commitizen-tools
/
commitizen
Public
Uh oh!
There was an error while loading.
Please reload this page
.
Notifications
You must be signed in to change notification settings
Fork
350
Star
3.5k
Code
Issues
116
Pull requests
47
Discussions
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Discussions
Actions
Projects
Security and quality
Insights
Files
Expand file tree
script-parallel-filter
Breadcrumbs
commitizen
/
tests
/
test_cli.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
253 lines (194 loc) · 8.16 KB
script-parallel-filter
Breadcrumbs
commitizen
/
tests
/
test_cli.py
Copy path
Top
File metadata and controls
Code
Blame
253 lines (194 loc) · 8.16 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
242
243
244
245
246
247
248
249
250
251
252
253
import
os
import
re
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
,
)
from
tests
.
utils
import
UtilFixture
ARGPARSE_CHOICES_PATTERN
=
re
.
compile
(
r"\(choose from (?P<choices>[^)]*)\)"
)
ARGPARSE_QUOTED_CHOICE_PATTERN
=
re
.
compile
(
r"'([^']*)'"
)
def
normalize_argparse_choice_quotes
(
text
:
str
)
->
str
:
def
normalize_match
(
match
:
re
.
Match
[
str
])
->
str
:
choices
=
ARGPARSE_QUOTED_CHOICE_PATTERN
.
sub
(
r"\1"
,
match
.
group
(
"choices"
))
return
f"(choose from
{
choices
}
)"
return
ARGPARSE_CHOICES_PATTERN
.
sub
(
normalize_match
,
text
)
def
test_normalize_argparse_choice_quotes
():
text
=
(
"cz: error: argument {init,commit}: invalid choice: 'invalidCommand' "
"(choose from 'init', 'commit')"
)
assert
normalize_argparse_choice_quotes
(
text
)
==
(
"cz: error: argument {init,commit}: invalid choice: 'invalidCommand' "
"(choose from init, commit)"
)
@
pytest
.
mark
.
usefixtures
(
"python_version"
,
"consistent_terminal_output"
)
def
test_no_argv
(
util
:
UtilFixture
,
capsys
,
file_regression
):
with
pytest
.
raises
(
ExpectedExit
):
util
.
run_cli
()
out
,
err
=
capsys
.
readouterr
()
assert
out
==
""
file_regression
.
check
(
err
,
extension
=
".txt"
)
@
pytest
.
mark
.
parametrize
(
"arg"
,
[
"--invalid-arg"
,
"invalidCommand"
],
)
@
pytest
.
mark
.
usefixtures
(
"python_version"
,
"consistent_terminal_output"
)
def
test_invalid_command
(
util
:
UtilFixture
,
capsys
,
file_regression
,
arg
):
with
pytest
.
raises
(
NoCommandFoundError
):
util
.
run_cli
(
arg
)
out
,
err
=
capsys
.
readouterr
()
assert
out
==
""
if
arg
==
"invalidCommand"
:
err
=
normalize_argparse_choice_quotes
(
err
)
file_regression
.
check
(
err
,
extension
=
".txt"
)
def
test_cz_config_file_without_correct_file_path
(
util
:
UtilFixture
):
with
pytest
.
raises
(
ConfigFileNotFound
,
match
=
"Cannot found the config file"
):
util
.
run_cli
(
"--config"
,
"./config/pyproject.toml"
,
"example"
)
def
test_cz_with_arg_but_without_command
(
util
:
UtilFixture
):
with
pytest
.
raises
(
NoCommandFoundError
,
match
=
"Command is required"
):
util
.
run_cli
(
"--name"
,
"cz_jira"
)
def
test_name
(
util
:
UtilFixture
,
capsys
):
util
.
run_cli
(
"-n"
,
"cz_jira"
,
"example"
)
out
,
_
=
capsys
.
readouterr
()
assert
out
.
startswith
(
"JRA"
)
@
pytest
.
mark
.
usefixtures
(
"tmp_git_project"
)
def
test_name_default_value
(
util
:
UtilFixture
,
capsys
):
util
.
run_cli
(
"example"
)
out
,
_
=
capsys
.
readouterr
()
assert
out
.
startswith
(
"fix: correct minor typos in code"
)
def
test_ls
(
util
:
UtilFixture
,
capsys
):
util
.
run_cli
(
"-n"
,
"cz_jira"
,
"ls"
)
out
,
_
=
capsys
.
readouterr
()
assert
"cz_conventional_commits"
in
out
assert
isinstance
(
out
,
str
)
def
test_arg_debug
(
util
:
UtilFixture
):
util
.
run_cli
(
"--debug"
,
"info"
)
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
():
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
():
with
pytest
.
raises
(
SystemExit
)
as
excinfo
:
cli
.
commitizen_excepthook
(
NotAGitProjectError
,
NotAGitProjectError
(),
""
,
debug
=
True
,
)
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)"
"""
subprocess
.
run
([
"register-python-argcomplete"
,
"cz"
],
check
=
True
)
def
test_commitizen_excepthook_no_raises
():
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
@
pytest
.
mark
.
parametrize
(
(
"input_str"
,
"expected_result"
),
[
pytest
.
param
(
"1"
, [
1
],
id
=
"single_code"
),
pytest
.
param
(
"1,2,3"
, [
1
,
2
,
3
],
id
=
"multiple_number_codes"
),
pytest
.
param
(
"NO_COMMITIZEN_FOUND,NO_COMMITS_FOUND,NO_PATTERN_MAP"
,
[
1
,
3
,
5
],
id
=
"string_codes"
,
),
pytest
.
param
(
"NO_COMMITIZEN_FOUND,2,NO_COMMITS_FOUND,4"
,
[
1
,
2
,
3
,
4
],
id
=
"number_and_string_codes"
,
),
pytest
.
param
(
"NO_COMMITIZEN_FOUND,2,nothing,4"
,
[
1
,
2
,
4
],
id
=
"number_and_string_codes_and_invalid_code"
,
),
],
)
def
test_parse_no_raise
(
input_str
,
expected_result
):
result
=
cli
.
parse_no_raise
(
input_str
)
assert
result
==
expected_result
def
test_unknown_args_raises
(
util
:
UtilFixture
):
with
pytest
.
raises
(
InvalidCommandArgumentError
,
match
=
"Invalid commitizen arguments were found"
):
util
.
run_cli
(
"c"
,
"-this_arg_is_not_supported"
)
def
test_unknown_args_before_double_dash_raises
(
util
:
UtilFixture
):
with
pytest
.
raises
(
InvalidCommandArgumentError
,
match
=
"Invalid commitizen arguments were found before -- separator"
,
):
util
.
run_cli
(
"c"
,
"-this_arg_is_not_supported"
,
"--"
)
def
test_commitizen_excepthook_non_commitizen_exception
(
mocker
:
MockFixture
):
"""Test that commitizen_excepthook delegates to sys.__excepthook__ for non-CommitizenException."""
# Mock the original excepthook
mock_original_excepthook
=
mocker
.
Mock
()
mocker
.
patch
(
"commitizen.cli.sys.__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 sys.__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.sys.__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 sys.__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.sys.__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 sys.__excepthook__ was called with None as traceback
mock_original_excepthook
.
assert_called_once_with
(
ValueError
,
test_exception
,
None
)
You can’t perform that action at this time.