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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
from __future__ import annotations
import os
import subprocess
import sys
from pathlib import Path
from typing import TYPE_CHECKING
from unittest import mock
import pytest
import shellingham
import tomlkit
from flatdict import FlatDict
from pytest_lazy_fixtures.lazy_fixture import lf as lazy_fixture
from tests.const import MAIN_PROG_NAME, VERSION_SUBCMD
from tests.fixtures.repos import repo_w_trunk_only_conventional_commits
from tests.util import assert_successful_exit_code, get_func_qual_name
if TYPE_CHECKING:
from tests.conftest import RunCliFn
from tests.fixtures.example_project import GetWheelFileFn, UpdatePyprojectTomlFn
from tests.fixtures.git_repo import BuiltRepoResult
@pytest.mark.skipif(sys.platform == "win32", reason="Unix only")
@pytest.mark.parametrize(
"shell",
filter(
None,
[
# because we will actually run the build command in this shell, we must ensure it exists
"bash"
if list(
filter(
lambda sh_exe: Path(sh_exe).exists(),
("/bin/bash", "/usr/bin/bash", "/usr/local/bin/bash"),
)
)
else "",
"zsh"
if list(
filter(
lambda sh_exe: Path(sh_exe).exists(),
("/bin/zsh", "/usr/bin/zsh", "/usr/local/bin/zsh"),
)
)
else "",
],
)
or ["sh"],
)
@pytest.mark.parametrize(
"repo_result, cli_args, next_release_version",
[
(
lazy_fixture(repo_w_trunk_only_conventional_commits.__name__),
["--patch"],
"0.1.2",
)
],
)
def test_version_runs_build_command(
repo_result: BuiltRepoResult,
cli_args: list[str],
next_release_version: str,
run_cli: RunCliFn,
shell: str,
get_wheel_file: GetWheelFileFn,
example_pyproject_toml: Path,
mocked_git_push: mock.MagicMock,
post_mocker: mock.Mock,
):
# Setup
built_wheel_file = get_wheel_file(next_release_version)
pyproject_config = FlatDict(
tomlkit.loads(example_pyproject_toml.read_text(encoding="utf-8")),
delimiter=".",
)
build_command = pyproject_config.get("tool.semantic_release.build_command", "")
patched_os_environment = {
"CI": "true",
"PATH": os.getenv("PATH", ""),
"HOME": "/home/username",
"VIRTUAL_ENV": "./.venv",
# Simulate that all CI's are set
"GITHUB_ACTIONS": "true",
"GITLAB_CI": "true",
"GITEA_ACTIONS": "true",
"BITBUCKET_REPO_FULL_NAME": "python-semantic-release/python-semantic-release.git",
"PSR_DOCKER_GITHUB_ACTION": "true",
}
# Wrap subprocess.run to capture the arguments to the call
with mock.patch(
get_func_qual_name(subprocess.run),
wraps=subprocess.run,
) as patched_subprocess_run, mock.patch(
get_func_qual_name(shellingham.detect_shell), return_value=(shell, shell)
):
# ACT: run & force a new version that will trigger the build command
cli_cmd = [MAIN_PROG_NAME, VERSION_SUBCMD, *cli_args]
result = run_cli(cli_cmd[1:], env=patched_os_environment)
# Evaluate
assert_successful_exit_code(result, cli_cmd)
patched_subprocess_run.assert_called_with(
[shell, "-c", build_command],
check=True,
env={
"NEW_VERSION": next_release_version, # injected into environment
"PACKAGE_NAME": "", # PSR injected environment variable
"CI": patched_os_environment["CI"],
"BITBUCKET_CI": "true", # Converted
"GITHUB_ACTIONS": patched_os_environment["GITHUB_ACTIONS"],
"GITEA_ACTIONS": patched_os_environment["GITEA_ACTIONS"],
"GITLAB_CI": patched_os_environment["GITLAB_CI"],
"HOME": patched_os_environment["HOME"],
"PATH": patched_os_environment["PATH"],
"VIRTUAL_ENV": patched_os_environment["VIRTUAL_ENV"],
"PSR_DOCKER_GITHUB_ACTION": patched_os_environment[
"PSR_DOCKER_GITHUB_ACTION"
],
},
)
assert built_wheel_file.exists()
assert mocked_git_push.call_count == 2
assert post_mocker.call_count == 1
@pytest.mark.skipif(sys.platform != "win32", reason="Windows only")
@pytest.mark.parametrize("shell", ("powershell", "pwsh", "cmd"))
@pytest.mark.parametrize(
"repo_result, cli_args, next_release_version",
[
(
lazy_fixture(repo_w_trunk_only_conventional_commits.__name__),
["--patch"],
"0.1.2",
)
],
)
def test_version_runs_build_command_windows(
repo_result: BuiltRepoResult,
cli_args: list[str],
next_release_version: str,
run_cli: RunCliFn,
shell: str,
get_wheel_file: GetWheelFileFn,
example_pyproject_toml: Path,
update_pyproject_toml: UpdatePyprojectTomlFn,
mocked_git_push: mock.MagicMock,
post_mocker: mock.Mock,
clean_os_environment: dict[str, str],
):
if shell == "cmd":
build_result_file = get_wheel_file("%NEW_VERSION%")
update_pyproject_toml(
"tool.semantic_release.build_command",
str.join(
" && ",
[
f"mkdir {build_result_file.parent}",
f"type nul > {build_result_file}",
f"echo 'Built distribution: {build_result_file}'",
],
),
)
# Setup
package_name = "my-package"
update_pyproject_toml("project.name", package_name)
built_wheel_file = get_wheel_file(next_release_version)
pyproject_config = FlatDict(
tomlkit.loads(example_pyproject_toml.read_text(encoding="utf-8")),
delimiter=".",
)
build_command = pyproject_config.get("tool.semantic_release.build_command", "")
patched_os_environment = {
**clean_os_environment,
"CI": "true",
"VIRTUAL_ENV": "./.venv",
# Simulate that all CI's are set
"GITHUB_ACTIONS": "true",
"GITLAB_CI": "true",
"GITEA_ACTIONS": "true",
"BITBUCKET_REPO_FULL_NAME": "python-semantic-release/python-semantic-release.git",
"PSR_DOCKER_GITHUB_ACTION": "true",
}
# Wrap subprocess.run to capture the arguments to the call
with mock.patch(
get_func_qual_name(subprocess.run),
wraps=subprocess.run,
) as patched_subprocess_run, mock.patch(
get_func_qual_name(shellingham.detect_shell), return_value=(shell, shell)
):
# ACT: run & force a new version that will trigger the build command
cli_cmd = [MAIN_PROG_NAME, VERSION_SUBCMD, *cli_args]
result = run_cli(cli_cmd[1:], env=patched_os_environment)
# Evaluate
assert_successful_exit_code(result, cli_cmd)
patched_subprocess_run.assert_called_once_with(
[shell, "/c" if shell == "cmd" else "-Command", build_command],
check=True,
env={
**clean_os_environment,
"NEW_VERSION": next_release_version, # injected into environment
"PACKAGE_NAME": package_name, # PSR injected environment variable
"CI": patched_os_environment["CI"],
"BITBUCKET_CI": "true", # Converted
"GITHUB_ACTIONS": patched_os_environment["GITHUB_ACTIONS"],
"GITEA_ACTIONS": patched_os_environment["GITEA_ACTIONS"],
"GITLAB_CI": patched_os_environment["GITLAB_CI"],
"VIRTUAL_ENV": patched_os_environment["VIRTUAL_ENV"],
"PSR_DOCKER_GITHUB_ACTION": patched_os_environment[
"PSR_DOCKER_GITHUB_ACTION"
],
},
)
dist_file_exists = built_wheel_file.exists()
assert dist_file_exists, f"\n Expected wheel file to be created at {built_wheel_file}, but it does not exist."
assert mocked_git_push.call_count == 2
assert post_mocker.call_count == 1
@pytest.mark.parametrize(
"repo_result, cli_args, next_release_version",
[
(
lazy_fixture(repo_w_trunk_only_conventional_commits.__name__),
["--patch"],
"0.1.2",
)
],
)
def test_version_runs_build_command_w_user_env(
repo_result: BuiltRepoResult,
cli_args: list[str],
next_release_version: str,
run_cli: RunCliFn,
example_pyproject_toml: Path,
update_pyproject_toml: UpdatePyprojectTomlFn,
clean_os_environment: dict[str, str],
):
# Setup
patched_os_environment = {
**clean_os_environment,
"CI": "true",
"VIRTUAL_ENV": "./.venv",
# Simulate that all CI's are set
"GITHUB_ACTIONS": "true",
"GITLAB_CI": "true",
"GITEA_ACTIONS": "true",
"BITBUCKET_REPO_FULL_NAME": "python-semantic-release/python-semantic-release.git",
"PSR_DOCKER_GITHUB_ACTION": "true",
# User environment variables (varying passthrough results)
"MY_CUSTOM_VARIABLE": "custom",
"IGNORED_VARIABLE": "ignore_me",
"OVERWRITTEN_VAR": "initial",
"SET_AS_EMPTY_VAR": "not_empty",
}
pyproject_config = FlatDict(
tomlkit.loads(example_pyproject_toml.read_text(encoding="utf-8")),
delimiter=".",
)
build_command = pyproject_config.get("tool.semantic_release.build_command", "")
update_pyproject_toml(
"tool.semantic_release.build_command_env",
[
# Includes arbitrary whitespace which will be removed
" MY_CUSTOM_VARIABLE ", # detect and pass from environment
" OVERWRITTEN_VAR = overrided", # pass hardcoded value which overrides environment
" SET_AS_EMPTY_VAR = ", # keep variable initialized but as empty string
" HARDCODED_VAR=hardcoded ", # pass hardcoded value that doesn't override anything
"VAR_W_EQUALS = a-var===condition", # only splits on 1st equals sign
"=ignored-invalid-named-var", # TODO: validation error instead, but currently just ignore
],
)
package_name = "my-package"
update_pyproject_toml("project.name", package_name)
# Mock out subprocess.run
with mock.patch(
get_func_qual_name(subprocess.run),
return_value=subprocess.CompletedProcess(args=(), returncode=0),
) as patched_subprocess_run, mock.patch(
get_func_qual_name(shellingham.detect_shell),
return_value=("bash", "/usr/bin/bash"),
):
cli_cmd = [
MAIN_PROG_NAME,
VERSION_SUBCMD,
*cli_args,
"--no-commit",
"--no-tag",
"--no-changelog",
"--no-push",
]
# ACT: run & force a new version that will trigger the build command
result = run_cli(cli_cmd[1:], env=patched_os_environment)
# Evaluate
# [1] Make sure it did not error internally
assert_successful_exit_code(result, cli_cmd)
# [2] Make sure the subprocess was called with the correct environment
patched_subprocess_run.assert_called_once_with(
["bash", "-c", build_command],
check=True,
env={
**clean_os_environment,
"NEW_VERSION": next_release_version, # injected into environment
"PACKAGE_NAME": package_name, # PSR injected environment variable
"CI": patched_os_environment["CI"],
"BITBUCKET_CI": "true", # Converted
"GITHUB_ACTIONS": patched_os_environment["GITHUB_ACTIONS"],
"GITEA_ACTIONS": patched_os_environment["GITEA_ACTIONS"],
"GITLAB_CI": patched_os_environment["GITLAB_CI"],
"VIRTUAL_ENV": patched_os_environment["VIRTUAL_ENV"],
"PSR_DOCKER_GITHUB_ACTION": patched_os_environment[
"PSR_DOCKER_GITHUB_ACTION"
],
"MY_CUSTOM_VARIABLE": patched_os_environment["MY_CUSTOM_VARIABLE"],
"OVERWRITTEN_VAR": "overrided",
"SET_AS_EMPTY_VAR": "",
"HARDCODED_VAR": "hardcoded",
# Note that IGNORED_VARIABLE is not here.
"VAR_W_EQUALS": "a-var===condition",
},
)
@pytest.mark.usefixtures(repo_w_trunk_only_conventional_commits.__name__)
def test_version_skips_build_command_with_skip_build(
run_cli: RunCliFn,
mocked_git_push: mock.MagicMock,
post_mocker: mock.Mock,
):
cli_cmd = [MAIN_PROG_NAME, VERSION_SUBCMD, "--patch", "--skip-build"]
with mock.patch(
get_func_qual_name(subprocess.run),
return_value=subprocess.CompletedProcess(args=(), returncode=0),
) as patched_subprocess_run:
# Act: force a new version
result = run_cli(cli_cmd[1:])
# Evaluate
assert_successful_exit_code(result, cli_cmd)
patched_subprocess_run.assert_not_called()
assert mocked_git_push.call_count == 2
assert post_mocker.call_count == 1
|
