Skip to content

Commit dcb18bb

Browse files
Lee-WLee-W
committed
test(bump_update_verison_in_files): refactor test cases through pytest-regression
1 parent a36063b commit dcb18bb

17 files changed

Lines changed: 213 additions & 125 deletions

‎.pre-commit-config.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ repos:
55
hooks:
66
- id: check-vcs-permalinks
77
- id: end-of-file-fixer
8+
exclude: "tests/test_*/*"
89
- id: trailing-whitespace
910
args: [--markdown-linebreak-ext=md]
1011
- id: debug-statements

‎commitizen/bump.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,10 +188,10 @@ def _bump_with_regex(version_file_contents, current_version, new_version, regex)
188188
right = version_file_contents[match.end() + offset :]
189189
line_break = _get_line_break_position(right)
190190
middle = right[:line_break]
191+
right = right[line_break:]
191192
if current_version in middle:
192193
offset += len(new_version) - len(current_version)
193194
current_version_found = True
194-
right = right[line_break:]
195195
version_file_contents = (
196196
left + middle.replace(current_version, new_version) + right
197197
)

‎tests/test_bump_update_version_in_files.py‎

Lines changed: 40 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -1,130 +1,48 @@
1-
import re
1+
from shutil import copyfile
22

33
import pytest
44

55
from commitizen import bump
66
from commitizen.exceptions import CurrentVersionNotFoundError
77

8-
PYPROJECT = """
9-
[tool.poetry]
10-
name = "commitizen"
11-
version = "1.2.3"
12-
"""
13-
14-
VERSION_PY = """
15-
__title__ = 'requests'
16-
__description__ = 'Python HTTP for Humans.'
17-
__url__ = 'http://python-requests.org'
18-
__version__ = '1.2.3'
19-
"""
20-
21-
INCONSISTENT_VERSION_PY = """
22-
__title__ = 'requests'
23-
__description__ = 'Python HTTP for Humans.'
24-
__url__ = 'http://python-requests.org'
25-
__version__ = '2.10.3'
26-
"""
27-
28-
REPEATED_VERSION_NUMBER = """
29-
{
30-
"name": "magictool",
31-
"version": "1.2.3",
32-
"dependencies": {
33-
"lodash": "1.2.3"
34-
}
35-
}
36-
"""
37-
38-
# The order cannot be guaranteed here
39-
CARGO_LOCK = """
40-
[[package]]
41-
name = "textwrap"
42-
version = "1.2.3"
43-
44-
[[package]]
45-
name = "there-i-fixed-it"
46-
version = "1.2.3"
47-
48-
[[package]]
49-
name = "other-project"
50-
version = "1.2.3"
51-
"""
52-
53-
DOCKER_COMPOSE = """
54-
version: "3.3"
55-
56-
services:
57-
app:
58-
image: my-repo/my-container:v1.2.3
59-
command: my-command
60-
"""
61-
62-
MULTIPLE_VERSIONS_TO_UPDATE_POETRY_LOCK = """
63-
[[package]]
64-
name = "to-update-1"
65-
version = "1.2.9"
66-
67-
[[package]]
68-
name = "not-to-update"
69-
version = "1.3.3"
70-
71-
[[package]]
72-
name = "not-to-update"
73-
version = "1.3.3"
74-
75-
[[package]]
76-
name = "not-to-update"
77-
version = "1.3.3"
78-
79-
[[package]]
80-
name = "not-to-update"
81-
version = "1.3.3"
82-
83-
[[package]]
84-
name = "not-to-update"
85-
version = "1.3.3"
86-
87-
[[package]]
88-
name = "to-update-2"
89-
version = "1.2.9"
90-
"""
91-
928
MULTIPLE_VERSIONS_INCREASE_STRING = 'version = "1.2.9"\n' * 30
939
MULTIPLE_VERSIONS_REDUCE_STRING = 'version = "1.2.10"\n' * 30
9410

11+
TESTING_FILE_PREFIX = "tests/testing_version_files"
12+
9513

9614
@pytest.fixture(scope="function")
9715
def commitizen_config_file(tmpdir):
9816
tmp_file = tmpdir.join("pyproject.toml")
99-
tmp_file.write(PYPROJECT)
17+
copyfile(f"{TESTING_FILE_PREFIX}/sample_pyproject.toml", str(tmp_file))
10018
return str(tmp_file)
10119

10220

10321
@pytest.fixture(scope="function")
10422
def python_version_file(tmpdir):
10523
tmp_file = tmpdir.join("__verion__.py")
106-
tmp_file.write(VERSION_PY)
24+
copyfile(f"{TESTING_FILE_PREFIX}/sample_version.py", str(tmp_file))
10725
return str(tmp_file)
10826

10927

11028
@pytest.fixture(scope="function")
11129
def inconsistent_python_version_file(tmpdir):
11230
tmp_file = tmpdir.join("__verion__.py")
113-
tmp_file.write(INCONSISTENT_VERSION_PY)
31+
copyfile(f"{TESTING_FILE_PREFIX}/inconsistent_version.py", str(tmp_file))
11432
return str(tmp_file)
11533

11634

11735
@pytest.fixture(scope="function")
11836
def random_location_version_file(tmpdir):
11937
tmp_file = tmpdir.join("Cargo.lock")
120-
tmp_file.write(CARGO_LOCK)
38+
copyfile(f"{TESTING_FILE_PREFIX}/sample_cargo.lock", str(tmp_file))
12139
return str(tmp_file)
12240

12341

12442
@pytest.fixture(scope="function")
12543
def version_repeated_file(tmpdir):
12644
tmp_file = tmpdir.join("package.json")
127-
tmp_file.write(REPEATED_VERSION_NUMBER)
45+
copyfile(f"{TESTING_FILE_PREFIX}/repeated_version_number.json", str(tmp_file))
12846
return str(tmp_file)
12947

13048

@@ -145,14 +63,17 @@ def multiple_versions_reduce_string(tmpdir):
14563
@pytest.fixture(scope="function")
14664
def docker_compose_file(tmpdir):
14765
tmp_file = tmpdir.join("docker-compose.yaml")
148-
tmp_file.write(DOCKER_COMPOSE)
66+
copyfile(f"{TESTING_FILE_PREFIX}/sample_docker_compose.yaml", str(tmp_file))
14967
return str(tmp_file)
15068

15169

15270
@pytest.fixture(scope="function")
15371
def multiple_versions_to_update_poetry_lock(tmpdir):
15472
tmp_file = tmpdir.join("pyproject.toml")
155-
tmp_file.write(MULTIPLE_VERSIONS_TO_UPDATE_POETRY_LOCK)
73+
copyfile(
74+
f"{TESTING_FILE_PREFIX}/multiple_versions_to_update_pyproject.toml",
75+
str(tmp_file),
76+
)
15677
return str(tmp_file)
15778

15879

@@ -171,77 +92,73 @@ def version_files(
17192
]
17293

17394

174-
def test_update_version_in_files(version_files):
95+
def test_update_version_in_files(version_files, file_regression):
17596
old_version = "1.2.3"
17697
new_version = "2.0.0"
17798
bump.update_version_in_files(old_version, new_version, version_files)
99+
100+
file_contents = ""
178101
for filepath in version_files:
179102
with open(filepath, "r") as f:
180-
data = f.read()
181-
assert new_version in data
103+
file_contents += f.read()
104+
file_regression.check(file_contents, extension=".txt")
182105

183106

184-
def test_partial_update_of_file(version_repeated_file):
107+
def test_partial_update_of_file(version_repeated_file, file_regression):
185108
old_version = "1.2.3"
186109
new_version = "2.0.0"
187110
regex = "version"
188111
location = f"{version_repeated_file}:{regex}"
189112

190113
bump.update_version_in_files(old_version, new_version, [location])
191114
with open(version_repeated_file, "r") as f:
192-
data = f.read()
193-
assert new_version in data
194-
assert old_version in data
115+
file_regression.check(f.read(), extension=".json")
195116

196117

197-
def test_random_location(random_location_version_file):
118+
def test_random_location(random_location_version_file, file_regression):
198119
old_version = "1.2.3"
199120
new_version = "2.0.0"
200121
location = f"{random_location_version_file}:there-i-fixed-it.+\nversion"
201122

202123
bump.update_version_in_files(old_version, new_version, [location])
203124
with open(random_location_version_file, "r") as f:
204-
data = f.read()
205-
assert len(re.findall(old_version, data)) == 2
206-
assert len(re.findall(new_version, data)) == 1
125+
file_regression.check(f.read(), extension=".lock")
207126

208127

209-
def test_duplicates_are_change_with_no_regex(random_location_version_file):
128+
def test_duplicates_are_change_with_no_regex(
129+
random_location_version_file, file_regression
130+
):
210131
old_version = "1.2.3"
211132
new_version = "2.0.0"
212133
location = f"{random_location_version_file}:version"
213134

214135
bump.update_version_in_files(old_version, new_version, [location])
215136
with open(random_location_version_file, "r") as f:
216-
data = f.read()
217-
assert len(re.findall(old_version, data)) == 0
218-
assert len(re.findall(new_version, data)) == 3
137+
file_regression.check(f.read(), extension=".lock")
219138

220139

221-
def test_version_bump_increase_string_length(multiple_versions_increase_string):
140+
def test_version_bump_increase_string_length(
141+
multiple_versions_increase_string, file_regression
142+
):
222143
old_version = "1.2.9"
223144
new_version = "1.2.10"
224-
version_bump_change_string_size(
225-
multiple_versions_increase_string, old_version, new_version
226-
)
145+
location = f"{multiple_versions_increase_string}:version"
146+
147+
bump.update_version_in_files(old_version, new_version, [location])
148+
with open(multiple_versions_increase_string, "r") as f:
149+
file_regression.check(f.read(), extension=".txt")
227150

228151

229-
def test_version_bump_reduce_string_length(multiple_versions_reduce_string):
152+
def test_version_bump_reduce_string_length(
153+
multiple_versions_reduce_string, file_regression
154+
):
230155
old_version = "1.2.10"
231156
new_version = "2.0.0"
232-
version_bump_change_string_size(
233-
multiple_versions_reduce_string, old_version, new_version
234-
)
235-
236-
237-
def version_bump_change_string_size(filename, old_version, new_version):
238-
location = f"{filename}:version"
157+
location = f"{multiple_versions_reduce_string}:version"
239158

240159
bump.update_version_in_files(old_version, new_version, [location])
241-
with open(filename, "r") as f:
242-
data = f.read()
243-
assert len(re.findall(old_version, data)) == 0
244-
assert len(re.findall(new_version, data)) == 30
160+
with open(multiple_versions_reduce_string, "r") as f:
161+
file_regression.check(f.read(), extension=".txt")
245162

246163

247164
def test_file_version_inconsistent_error(

‎tests/test_bump_update_version_in_files/test_duplicates_are_change_with_no_regex.lock‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[[package]]
2+
name = "textwrap"
3+
version = "2.0.0"
4+
5+
[[package]]
6+
name = "there-i-fixed-it"
7+
version = "2.0.0"
8+
9+
[[package]]
10+
name = "other-project"
11+
version = "2.0.0"

‎tests/test_bump_update_version_in_files/test_multiplt_versions_to_bump.toml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
[[package]]
32
name = "to-update-1"
43
version = "1.2.10"

‎tests/test_bump_update_version_in_files/test_partial_update_of_file.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"name": "magictool",
3+
"version": "2.0.0",
4+
"dependencies": {
5+
"lodash": "1.2.3"
6+
}
7+
}

‎tests/test_bump_update_version_in_files/test_random_location.lock‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[[package]]
2+
name = "textwrap"
3+
version = "1.2.3"
4+
5+
[[package]]
6+
name = "there-i-fixed-it"
7+
version = "2.0.0"
8+
9+
[[package]]
10+
name = "other-project"
11+
version = "1.2.3"

‎tests/test_bump_update_version_in_files/test_update_version_in_files.txt‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[tool.poetry]
2+
name = "commitizen"
3+
version = "2.0.0"
4+
__title__ = "requests"
5+
__description__ = "Python HTTP for Humans."
6+
__url__ = "http://python-requests.org"
7+
__version__ = "2.0.0"
8+
{
9+
"name": "magictool",
10+
"version": "2.0.0",
11+
"dependencies": {
12+
"lodash": "2.0.0"
13+
}
14+
}
15+
version: "3.3"
16+
17+
services:
18+
app:
19+
image: my-repo/my-container:v2.0.0
20+
command: my-command

‎tests/test_bump_update_version_in_files/test_version_bump_increase_string_length.txt‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
version = "1.2.10"
2+
version = "1.2.10"
3+
version = "1.2.10"
4+
version = "1.2.10"
5+
version = "1.2.10"
6+
version = "1.2.10"
7+
version = "1.2.10"
8+
version = "1.2.10"
9+
version = "1.2.10"
10+
version = "1.2.10"
11+
version = "1.2.10"
12+
version = "1.2.10"
13+
version = "1.2.10"
14+
version = "1.2.10"
15+
version = "1.2.10"
16+
version = "1.2.10"
17+
version = "1.2.10"
18+
version = "1.2.10"
19+
version = "1.2.10"
20+
version = "1.2.10"
21+
version = "1.2.10"
22+
version = "1.2.10"
23+
version = "1.2.10"
24+
version = "1.2.10"
25+
version = "1.2.10"
26+
version = "1.2.10"
27+
version = "1.2.10"
28+
version = "1.2.10"
29+
version = "1.2.10"
30+
version = "1.2.10"

0 commit comments

Comments
 (0)