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
|
from __future__ import annotations
import os
from pathlib import Path
from re import IGNORECASE, MULTILINE, compile as regexp
from typing import TYPE_CHECKING
from unittest.mock import MagicMock
import pytest
from requests_mock import ANY
from semantic_release.cli import config as cli_config_module
from semantic_release.cli.config import (
GlobalCommandLineOptions,
RawConfig,
RuntimeContext,
)
from semantic_release.cli.const import DEFAULT_CONFIG_FILE
from semantic_release.cli.util import load_raw_config_file
from tests.util import prepare_mocked_git_command_wrapper_type
if TYPE_CHECKING:
from re import Pattern
from typing import Protocol
from git.repo import Repo
from pytest import MonkeyPatch
from requests_mock.mocker import Mocker
from tests.fixtures.example_project import ExProjectDir
class GetSanitizedChangelogContentFn(Protocol):
def __call__(
self,
repo_dir: Path,
remove_insertion_flag: bool = True,
) -> str: ...
class ReadConfigFileFn(Protocol):
"""Read the raw config file from `config_path`."""
def __call__(self, file: Path | str) -> RawConfig: ...
class RetrieveRuntimeContextFn(Protocol):
"""Retrieve the runtime context for a repo."""
def __call__(self, repo: Repo) -> RuntimeContext: ...
class StripLoggingMessagesFn(Protocol):
def __call__(self, log: str) -> str: ...
@pytest.hookimpl(tryfirst=True)
def pytest_collection_modifyitems(items: list[pytest.Item]) -> None:
"""Apply the e2e marker to all tests in the end-to-end test directory."""
cli_test_directory = Path(__file__).parent
for item in items:
if cli_test_directory in item.path.parents:
item.add_marker(pytest.mark.e2e)
@pytest.fixture
def post_mocker(requests_mock: Mocker) -> Mocker:
"""Patch all POST requests, mocking a response body for VCS release creation."""
requests_mock.register_uri("POST", ANY, json={"id": 999})
return requests_mock
@pytest.fixture
def mocked_git_push(monkeypatch: MonkeyPatch) -> MagicMock:
"""Mock the `Repo.git.push()` method in `semantic_release.cli.main`."""
mocked_push = MagicMock()
cls = prepare_mocked_git_command_wrapper_type(push=mocked_push)
monkeypatch.setattr(cli_config_module.Repo, "GitCommandWrapperType", cls)
return mocked_push
@pytest.fixture
def config_path(example_project_dir: ExProjectDir) -> Path:
return example_project_dir / DEFAULT_CONFIG_FILE
@pytest.fixture
def read_config_file() -> ReadConfigFileFn:
def _read_config_file(file: Path | str) -> RawConfig:
config_text = load_raw_config_file(file)
return RawConfig.model_validate(config_text)
return _read_config_file
@pytest.fixture
def cli_options(config_path: Path) -> GlobalCommandLineOptions:
return GlobalCommandLineOptions(
noop=False,
verbosity=0,
strict=False,
config_file=str(config_path),
)
@pytest.fixture
def retrieve_runtime_context(
read_config_file: ReadConfigFileFn,
cli_options: GlobalCommandLineOptions,
) -> RetrieveRuntimeContextFn:
def _retrieve_runtime_context(repo: Repo) -> RuntimeContext:
cwd = os.getcwd()
repo_dir = str(Path(repo.working_dir).resolve())
os.chdir(repo_dir)
try:
raw_config = read_config_file(cli_options.config_file)
return RuntimeContext.from_raw_config(raw_config, cli_options)
finally:
os.chdir(cwd)
return _retrieve_runtime_context
@pytest.fixture(scope="session")
def strip_logging_messages() -> StripLoggingMessagesFn:
"""Fixture to strip logging messages from the output."""
# Log levels match SemanticReleaseLogLevel enum values
logger_msg_pattern = regexp(
r"^\s*(?:\[\d\d:\d\d:\d\d\])?\s*(FATAL|CRITICAL|ERROR|WARNING|INFO|DEBUG|SILLY).*?\n(?:\s+\S.*?\n)*(?!\n[ ]{11})",
MULTILINE,
)
def _strip_logging_messages(log: str) -> str:
# Make sure it ends with a newline
return logger_msg_pattern.sub("", log.rstrip("\n") + "\n")
return _strip_logging_messages
@pytest.fixture(scope="session")
def long_hash_pattern() -> Pattern:
return regexp(r"\b([0-9a-f]{40})\b", IGNORECASE)
@pytest.fixture(scope="session")
def short_hash_pattern() -> Pattern:
return regexp(r"\b([0-9a-f]{7})\b", IGNORECASE)
@pytest.fixture(scope="session")
def get_sanitized_rst_changelog_content(
changelog_rst_file: Path,
default_rst_changelog_insertion_flag: str,
long_hash_pattern: Pattern,
short_hash_pattern: Pattern,
) -> GetSanitizedChangelogContentFn:
rst_short_hash_link_pattern = regexp(r"(_[0-9a-f]{7})\b", IGNORECASE)
def _get_sanitized_rst_changelog_content(
repo_dir: Path,
remove_insertion_flag: bool = False,
) -> str:
# Note that our repo generation fixture includes the insertion flag automatically
# toggle remove_insertion_flag to True to remove the insertion flag, applies to Init mode repos
with (repo_dir / changelog_rst_file).open(newline=os.linesep) as rfd:
# use os.linesep here because the insertion flag is os-specific
# but convert the content to universal newlines for comparison
changelog_content = (
rfd.read().replace(
f"{default_rst_changelog_insertion_flag}{os.linesep}", ""
)
if remove_insertion_flag
else rfd.read()
).replace("\r", "")
changelog_content = long_hash_pattern.sub("0" * 40, changelog_content)
changelog_content = short_hash_pattern.sub("0" * 7, changelog_content)
return rst_short_hash_link_pattern.sub(f'_{"0" * 7}', changelog_content)
return _get_sanitized_rst_changelog_content
@pytest.fixture(scope="session")
def get_sanitized_md_changelog_content(
changelog_md_file: Path,
default_md_changelog_insertion_flag: str,
long_hash_pattern: Pattern,
short_hash_pattern: Pattern,
) -> GetSanitizedChangelogContentFn:
def _get_sanitized_md_changelog_content(
repo_dir: Path,
remove_insertion_flag: bool = False,
) -> str:
# Note that our repo generation fixture includes the insertion flag automatically
# toggle remove_insertion_flag to True to remove the insertion flag, applies to Init mode repos
with (repo_dir / changelog_md_file).open(newline=os.linesep) as rfd:
# use os.linesep here because the insertion flag is os-specific
# but convert the content to universal newlines for comparison
changelog_content = (
rfd.read().replace(
f"{default_md_changelog_insertion_flag}{os.linesep}", ""
)
if remove_insertion_flag
else rfd.read()
).replace("\r", "")
changelog_content = long_hash_pattern.sub("0" * 40, changelog_content)
return short_hash_pattern.sub("0" * 7, changelog_content)
return _get_sanitized_md_changelog_content
|
