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 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
|
from __future__ import annotations
from itertools import chain, zip_longest
from textwrap import dedent
from typing import TYPE_CHECKING
import pytest
from semantic_release.commit_parser.scipy import ScipyCommitParser
from semantic_release.enums import LevelBump
if TYPE_CHECKING:
from typing import Protocol
from semantic_release.commit_parser.scipy import ScipyParserOptions
class FormatScipyCommitFn(Protocol):
def __call__(
self, scipy_tag: str, subject: str, body_parts: list[str]
) -> str: ...
@pytest.fixture(scope="session")
def format_scipy_commit():
def _format_scipy_commit(
scipy_tag: str, subject: str, body_parts: list[str]
) -> str:
body = str.join("\n\n", body_parts)
return f"{scipy_tag}: {subject}\n\n{body}"
return _format_scipy_commit
@pytest.fixture(scope="session")
def default_scipy_parser() -> ScipyCommitParser:
return ScipyCommitParser()
@pytest.fixture(scope="session")
def default_scipy_parser_options(
default_scipy_parser: ScipyCommitParser,
) -> ScipyParserOptions:
return default_scipy_parser.get_default_options()
@pytest.fixture(scope="session")
def scipy_chore_commit_types(
default_scipy_parser_options: ScipyParserOptions,
) -> list[str]:
return [
k
for k, v in default_scipy_parser_options.tag_to_level.items()
if v < LevelBump.PATCH
]
@pytest.fixture(scope="session")
def scipy_patch_commit_types(
default_scipy_parser_options: ScipyParserOptions,
) -> list[str]:
return [
k
for k, v in default_scipy_parser_options.tag_to_level.items()
if v is LevelBump.PATCH
]
@pytest.fixture(scope="session")
def scipy_minor_commit_types(
default_scipy_parser_options: ScipyParserOptions,
) -> list[str]:
return [
k
for k, v in default_scipy_parser_options.tag_to_level.items()
if v is LevelBump.MINOR
]
@pytest.fixture(scope="session")
def scipy_major_commit_types(
default_scipy_parser_options: ScipyParserOptions,
) -> list[str]:
return [
k
for k, v in default_scipy_parser_options.tag_to_level.items()
if v is LevelBump.MAJOR
]
@pytest.fixture(scope="session")
def scipy_nonparseable_commits() -> list[str]:
return [
"Initial Commit",
"Merge pull request #14447 from AnirudhDagar/rename_ndimage_modules",
]
@pytest.fixture(scope="session")
def scipy_chore_subjects(scipy_chore_commit_types: list[str]) -> list[str]:
subjects = {
"BENCH": "disable very slow benchmark in optimize_milp.py",
"DEV": "add unicode check to pre-commit-hook",
"DOC": "change approx_fprime doctest (#20568)",
"STY": "fixed ruff & mypy issues",
"TST": "Skip Cython tests for editable installs",
"REL": "set version to 1.0.0",
"TEST": "Add Cython tests for editable installs",
}
# Test fixture modification failure prevention
assert len(subjects.keys()) == len(scipy_chore_commit_types)
return [subjects[k] for k in scipy_chore_commit_types]
@pytest.fixture(scope="session")
def scipy_patch_subjects(scipy_patch_commit_types: list[str]) -> list[str]:
subjects = {
"BLD": "move the optimize build steps earlier into the build sequence",
"BUG": "Fix invalid default bracket selection in _bracket_minimum (#20563)",
"MAINT": "optimize.linprog: fix bug when integrality is a list of all zeros (#20586)",
}
# Test fixture modification failure prevention
assert len(subjects.keys()) == len(scipy_patch_commit_types)
return [subjects[k] for k in scipy_patch_commit_types]
@pytest.fixture(scope="session")
def scipy_minor_subjects(scipy_minor_commit_types: list[str]) -> list[str]:
subjects = {
"ENH": "stats.ttest_1samp: add array-API support (#20545)",
# "REV": "reverted a previous commit",
"FEAT": "added a new feature",
}
# Test fixture modification failure prevention
assert len(subjects.keys()) == len(scipy_minor_commit_types)
return [subjects[k] for k in scipy_minor_commit_types]
@pytest.fixture(scope="session")
def scipy_major_subjects(scipy_major_commit_types: list[str]) -> list[str]:
subjects = {
"API": "dropped support for python 3.7",
"DEP": "stats: switch kendalltau to kwarg-only, remove initial_lexsort",
}
# Test fixture modification failure prevention
assert len(subjects.keys()) == len(scipy_major_commit_types)
return [subjects[k] for k in scipy_major_commit_types]
@pytest.fixture(scope="session")
def scipy_brk_change_commit_bodies() -> list[list[str]]:
brk_chg_msg = dedent(
"""
BREAKING CHANGE: a description of what is now different
with multiple lines
"""
).strip()
one_line_desc = "resolves bug related to windows incompatiblity"
return [
# No regular change description
[brk_chg_msg],
# regular change description & breaking change message
[one_line_desc, brk_chg_msg],
# regular change description & breaking change message with footer
[one_line_desc, brk_chg_msg, "Resolves: #666"],
]
@pytest.fixture(scope="session")
def scipy_nonbrking_commit_bodies() -> list[list[str]]:
# a GitHub squash merge that preserved PR commit messages (all chore-like)
github_squash_merge_body = str.join(
"\n\n",
[
"* DOC: import ropy.transform to test for numpy error",
"* DOC: lower numpy version",
"* DOC: lower numpy version further",
"* STY: resolve linting issues",
],
)
one_block_desc = dedent(
"""
Bug spotted on Fedora, see https://src.fedoraproject.org/rpms/scipy/pull-request/22
with an additional multiline description
"""
).strip()
return [
github_squash_merge_body.split("\n\n"), # split into blocks
# empty body
[],
[""],
# formatted body (ie dependabot)
dedent(
"""
Bumps [package](https://github.com/namespace/project) from 3.5.3 to 4.1.1.
- [Release notes](https://github.com/namespace/project/releases)
- [Changelog](https://github.com/namespace/project/blob/4.x/CHANGES)
- [Commits](https://github.com/namespace/project/commits/v4.1.1)
---
updated-dependencies:
- dependency-name: package
dependency-type: direct:development
update-type: version-update:semver-major
"""
)
.lstrip()
.split("\n\n"),
# 1 block description
one_block_desc.split("\n\n"),
# keywords
["[skip azp] [skip actions]"],
# Resolving an issue on GitHub
["Resolves: #127"],
[one_block_desc, "Closes: #1024"],
]
@pytest.fixture(scope="session")
def scipy_chore_commit_parts(
scipy_chore_commit_types: list[str],
scipy_chore_subjects: list[str],
scipy_nonbrking_commit_bodies: list[list[str]],
) -> list[tuple[str, str, list[str]]]:
# Test fixture modification failure prevention
assert len(scipy_chore_commit_types) == len(scipy_chore_subjects)
# build full commit messages with commit type prefix, subject, and body variant
# for all body variants
return [
(commit_type, subject, commit_body_blocks)
for commit_type, subject in zip(scipy_chore_commit_types, scipy_chore_subjects)
for commit_body_blocks in scipy_nonbrking_commit_bodies
]
@pytest.fixture(scope="session")
def scipy_chore_commits(
scipy_chore_commit_parts: list[tuple[str, str, list[str]]],
format_scipy_commit: FormatScipyCommitFn,
) -> list[str]:
# build full commit messages with commit type prefix, subject, and body variant
# for all body variants
return [
format_scipy_commit(commit_type, subject, commit_body)
for commit_type, subject, commit_body in scipy_chore_commit_parts
]
@pytest.fixture(scope="session")
def scipy_patch_commit_parts(
scipy_patch_commit_types: list[str],
scipy_patch_subjects: list[str],
scipy_nonbrking_commit_bodies: list[list[str]],
) -> list[tuple[str, str, list[str]]]:
# Test fixture modification failure prevention
assert len(scipy_patch_commit_types) == len(scipy_patch_subjects)
# build full commit messages with commit type prefix, subject, and body variant
# for all body variants
return [
(commit_type, subject, commit_body_blocks)
for commit_type, subject in zip(scipy_patch_commit_types, scipy_patch_subjects)
for commit_body_blocks in scipy_nonbrking_commit_bodies
]
@pytest.fixture(scope="session")
def scipy_patch_commits(
scipy_patch_commit_parts: list[tuple[str, str, list[str]]],
format_scipy_commit: FormatScipyCommitFn,
) -> list[str]:
# build full commit messages with commit type prefix, subject, and body variant
# for all body variants
return [
format_scipy_commit(commit_type, subject, commit_body)
for commit_type, subject, commit_body in scipy_patch_commit_parts
]
@pytest.fixture(scope="session")
def scipy_minor_commit_parts(
scipy_minor_commit_types: list[str],
scipy_minor_subjects: list[str],
scipy_nonbrking_commit_bodies: list[list[str]],
) -> list[tuple[str, str, list[str]]]:
# Test fixture modification failure prevention
assert len(scipy_minor_commit_types) == len(scipy_minor_subjects)
# build full commit messages with commit type prefix, subject, and body variant
# for all body variants
return [
(commit_type, subject, commit_body_blocks)
for commit_type, subject in zip(scipy_minor_commit_types, scipy_minor_subjects)
for commit_body_blocks in scipy_nonbrking_commit_bodies
]
@pytest.fixture(scope="session")
def scipy_minor_commits(
scipy_minor_commit_parts: list[tuple[str, str, list[str]]],
format_scipy_commit: FormatScipyCommitFn,
) -> list[str]:
# build full commit messages with commit type prefix, subject, and body variant
# for all body variants
return [
format_scipy_commit(commit_type, subject, commit_body)
for commit_type, subject, commit_body in scipy_minor_commit_parts
]
@pytest.fixture(scope="session")
def scipy_major_commit_parts(
scipy_major_commit_types: list[str],
scipy_major_subjects: list[str],
scipy_brk_change_commit_bodies: list[list[str]],
) -> list[tuple[str, str, list[str]]]:
# Test fixture modification failure prevention
assert len(scipy_major_commit_types) == len(scipy_major_subjects)
# build full commit messages with commit type prefix, subject, and body variant
# for all body variants
return [
(commit_type, subject, commit_body_blocks)
for commit_type, subject in zip(scipy_major_commit_types, scipy_major_subjects)
for commit_body_blocks in scipy_brk_change_commit_bodies
]
@pytest.fixture(scope="session")
def scipy_major_commits(
scipy_major_commit_parts: list[tuple[str, str, list[str]]],
format_scipy_commit: FormatScipyCommitFn,
) -> list[str]:
# build full commit messages with commit type prefix, subject, and body variant
# for all body variants
return [
format_scipy_commit(commit_type, subject, commit_body)
for commit_type, subject, commit_body in scipy_major_commit_parts
]
@pytest.fixture(scope="session")
def scipy_patch_mixed_commits(
scipy_patch_commits: list[str],
scipy_chore_commits: list[str],
) -> list[str]:
return list(
filter(
None,
chain.from_iterable(zip_longest(scipy_patch_commits, scipy_chore_commits)),
)
)
@pytest.fixture(scope="session")
def scipy_minor_mixed_commits(
scipy_minor_commits: list[str],
scipy_patch_commits: list[str],
scipy_chore_commits: list[str],
) -> list[str]:
return list(
chain.from_iterable(
zip_longest(
scipy_minor_commits,
scipy_patch_commits,
scipy_chore_commits,
fillvalue="uninteresting",
)
)
)
@pytest.fixture(scope="session")
def scipy_major_mixed_commits(
scipy_major_commits: list[str],
scipy_minor_commits: list[str],
scipy_patch_commits: list[str],
scipy_chore_commits: list[str],
) -> list[str]:
return list(
filter(
None,
chain.from_iterable(
zip_longest(
scipy_major_commits,
scipy_minor_commits,
scipy_patch_commits,
scipy_chore_commits,
)
),
)
)
|