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 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
|
"""Tests for the `build` module."""
from __future__ import annotations
from time import sleep
from typing import TYPE_CHECKING, Literal
import pytest
from git_changelog import AngularConvention, BasicConvention, Changelog
if TYPE_CHECKING:
from git_changelog import Version
from tests.helpers import GitRepo
@pytest.mark.parametrize(
("versioning", "bump", "expected"),
[
("semver", "auto", "0.0.1"), # chore commit
("semver", "major", "1.0.0"),
("semver", "minor", "0.1.0"),
("semver", "patch", "0.0.1"),
("semver", "1.1.1", "1.1.1"),
("pep440", "auto", "0.0.1"), # chore commit
("pep440", "major", "1.0.0"),
("pep440", "minor+dev", "0.1.0.dev0"),
("pep440", "micro+alpha+dev", "0.0.1a0.dev0"),
("pep440", "1.1.1", "1.1.1"),
],
)
def test_bump_with_semver_on_new_repo(
repo: GitRepo,
versioning: Literal["pep440", "semver"],
bump: str,
expected: str,
) -> None:
"""Bump to user specified version on new Git repo.
Parameters:
repo: GitRepo to a temporary repository.
bump: The bump parameter value.
expected: Expected version for the new changelog entry.
"""
changelog = Changelog(
repo.path,
convention=AngularConvention,
bump=bump,
versioning=versioning,
zerover=False,
)
assert len(changelog.versions_list) == 1
assert changelog.versions_list[0].planned_tag == expected
@pytest.mark.parametrize("bump", ["auto", "major", "minor", "2.0.0"])
def test_no_bump_on_first_tag(repo: GitRepo, bump: str) -> None:
"""Ignore bump on new git repo without unreleased commits.
Parameters:
repo: GitRepo to a temporary repository.
bump: The bump parameter value.
"""
repo.tag("1.1.1")
changelog = Changelog(repo.path, convention=AngularConvention, bump=bump)
assert len(changelog.versions_list) == 1
assert changelog.versions_list[0].tag == "1.1.1"
def test_one_release_branch_with_feat_branch(repo: GitRepo) -> None:
r"""Test parsing and grouping commits to versions.
Commit graph:
1.0.0
|
main A-B---D
\ /
feat --C
Expected:
- 1.0.0: D B C A
Parameters:
repo: GitRepo to a temporary repository.
"""
commit_a = repo.first_hash
repo.branch("develop")
commit_b = repo.commit("fix: B")
repo.checkout("develop")
commit_c = repo.commit("feat: C")
repo.checkout("main")
commit_d = repo.merge("develop")
repo.tag("1.0.0")
changelog = Changelog(repo.path, convention=AngularConvention)
assert len(changelog.versions_list) == 1
_assert_version(
changelog.versions_list[0],
expected_tag="1.0.0",
expected_prev_tag=None,
expected_commits=[commit_d, commit_b, commit_c, commit_a],
)
def test_one_release_branch_with_two_versions(repo: GitRepo) -> None:
r"""Test parsing and grouping commits to versions.
Commit graph:
1.1.0
1.0.0 |
| |
main A-B---D
\ /
feat --C
Expected:
- 1.1.0: D C
- 1.0.0: B A
Parameters:
repo: GitRepo to a temporary repository.
"""
commit_a = repo.first_hash
repo.branch("develop")
commit_b = repo.commit("fix: B")
repo.tag("1.0.0")
repo.checkout("develop")
commit_c = repo.commit("feat: C")
repo.checkout("main")
commit_d = repo.merge("develop")
repo.tag("1.1.0")
changelog = Changelog(repo.path, convention=AngularConvention)
assert len(changelog.versions_list) == 2
_assert_version(
changelog.versions_list[0],
expected_tag="1.1.0",
expected_prev_tag="1.0.0",
expected_commits=[commit_d, commit_c],
)
_assert_version(
changelog.versions_list[1],
expected_tag="1.0.0",
expected_prev_tag=None,
expected_commits=[commit_b, commit_a],
)
def test_two_release_branches(repo: GitRepo) -> None:
r"""Test parsing and grouping commits to versions.
Commit graph:
1.1.0
1.0.0 |
| |
main A-B---D-----G
\ \ /
develop --C---E-F
|
2.0.0
Expected:
- Unreleased: G F
- 2.0.0: E C
- 1.1.0: D
- 1.0.0: B A
Parameters:
repo: GitRepo to a temporary repository.
"""
commit_a = repo.first_hash
repo.branch("develop")
commit_b = repo.commit("fix: B")
repo.tag("1.0.0")
repo.checkout("develop")
commit_c = repo.commit("feat: C")
repo.checkout("main")
commit_d = repo.commit("fix: C")
repo.tag("1.1.0")
repo.checkout("develop")
# Git timestamp only has second precision,
# so we delay to ensure git-log lists it before commit C.
sleep(1)
commit_e = repo.merge("main")
repo.tag("2.0.0")
commit_f = repo.commit("feat: F")
repo.checkout("main")
commit_g = repo.merge("develop")
changelog = Changelog(repo.path, convention=AngularConvention)
assert len(changelog.versions_list) == 4
versions = iter(changelog.versions_list)
_assert_version(
next(versions),
expected_tag="",
expected_prev_tag="2.0.0",
expected_commits=[commit_g, commit_f],
)
_assert_version(
next(versions),
expected_tag="2.0.0",
expected_prev_tag="1.1.0",
expected_commits=[commit_e, commit_c],
)
_assert_version(
next(versions),
expected_tag="1.1.0",
expected_prev_tag="1.0.0",
expected_commits=[commit_d],
)
_assert_version(
next(versions),
expected_tag="1.0.0",
expected_prev_tag=None,
expected_commits=[commit_b, commit_a],
)
def _assert_version(
version: Version,
expected_tag: str,
expected_prev_tag: str | None,
expected_commits: list[str],
) -> None:
assert expected_tag in (version.tag, version.planned_tag)
if expected_prev_tag:
assert version.previous_version is not None, f"Expected previous version '{expected_prev_tag}', but was None"
assert version.previous_version.tag == expected_prev_tag
else:
assert version.previous_version is None
hashes = [commit.hash for commit in version.commits]
assert hashes == expected_commits
def test_no_remote_url(repo: GitRepo) -> None:
"""Test parsing and grouping commits to versions without a git remote.
Parameters:
repo: GitRepo to a temporary repository.
"""
repo.git("remote", "remove", "origin")
commit_a = repo.first_hash
repo.tag("1.0.0")
changelog = Changelog(repo.path, convention=AngularConvention)
assert len(changelog.versions_list) == 1
_assert_version(
changelog.versions_list[0],
expected_tag="1.0.0",
expected_prev_tag=None,
expected_commits=[commit_a],
)
def test_merge_into_unreleased(repo: GitRepo) -> None:
r"""Test parsing and grouping commits to versions.
Commit graph:
main A---C---E
\ / \ /
feat B D
Expected:
- Unreleased: E D C B A
Parameters:
repo: GitRepo to a temporary repository.
"""
commit_a = repo.first_hash
repo.branch("feat/1")
repo.checkout("feat/1")
commit_b = repo.commit("feat: B")
repo.checkout("main")
commit_c = repo.merge("feat/1")
repo.branch("feat/2")
repo.checkout("feat/2")
commit_d = repo.commit("feat: D")
repo.checkout("main")
commit_e = repo.merge("feat/2")
changelog = Changelog(repo.path, convention=AngularConvention)
assert len(changelog.versions_list) == 1
version = changelog.versions_list[0]
_assert_version(
version,
expected_tag="",
expected_prev_tag=None,
expected_commits=[commit_e, commit_c, commit_d, commit_a, commit_b],
)
def test_build_changelog_with_pep440_versions(repo: GitRepo) -> None:
"""Test parsing and grouping commits to PEP440 versions.
Parameters:
repo: GitRepo to a temporary repository.
"""
repo.commit("feat: Feature")
repo.tag("1.0.0")
repo.commit("fix: Fix")
repo.tag("1.0.0.post0")
repo.commit("feat: Feat")
changelog = Changelog(repo.path, convention=AngularConvention, versioning="pep440")
assert len(changelog.versions_list) == 3
assert changelog.versions_list[1].tag == "1.0.0.post0"
def test_ignore_nonsemver_tag(repo: GitRepo) -> None:
"""Test parsing and grouping commits to versions.
Commit graph:
1.0.0
|
main A-B-C
|
dummy
Expected:
- 1.0.0: C B A
Parameters:
repo: GitRepo to a temporary repository.
"""
commit_a = repo.first_hash
commit_b = repo.commit("fix: B")
repo.tag("dummy")
commit_c = repo.commit("feat: C")
repo.tag("1.0.0")
changelog = Changelog(repo.path, convention=AngularConvention)
assert len(changelog.versions_list) == 1
_assert_version(
changelog.versions_list[0],
expected_tag="1.0.0",
expected_prev_tag=None,
expected_commits=[commit_c, commit_b, commit_a],
)
def test_untyped_commits(repo: GitRepo) -> None:
"""Test capture of untyped (i.e. uncategorizable) commits.
Parameters:
repo: GitRepo to a temporary repository.
"""
commit_a = repo.first_hash
commit_b = repo.commit(
"this commit is untyped and therefore does not have a section!",
)
repo.tag("1.0.0")
changelog = Changelog(repo.path, convention=AngularConvention)
assert len(changelog.versions_list) == 1
(version,) = changelog.versions_list
assert len(version.sections_list) == 2
typed_sections = changelog.versions_dict[version.tag].typed_sections
assert len(typed_sections) == 1
untyped = changelog.versions_dict[version.tag].untyped_section
assert untyped is not None
(typed,) = typed_sections
assert len(untyped.commits) == 1
assert len(typed.commits) == 1
(untyped_commit,) = untyped.commits
(typed_commit,) = typed.commits
assert untyped_commit.hash == commit_b
assert typed_commit.hash == commit_a
def test_include_all_false_excludes_untyped(repo: GitRepo) -> None:
"""Test that untyped commits are excluded from sections when include_all=False (default).
Parameters:
repo: GitRepo to a temporary repository.
"""
repo.commit("feat: Feature A")
repo.commit("Random commit message without convention")
repo.commit("fix: Fix B")
repo.commit("Another random message")
repo.tag("1.0.0")
changelog = Changelog(repo.path, convention=AngularConvention, include_all=False)
assert len(changelog.versions_list) == 1
version = changelog.versions_list[0]
# Empty string ("") should NOT be in sections when include_all=False.
assert "" not in changelog.sections
# Only conventional commits should be in the rendered sections.
sections_dict = version.sections_dict
# Should only have sections for typed commits (feat, fix, and chore from initial commit).
assert "Features" in sections_dict
assert "Bug Fixes" in sections_dict
assert "Chore" in sections_dict
# The untyped commits are captured but not rendered (empty string not in sections),
# so they won't appear in the changelog output.
def test_include_all_true_includes_untyped(repo: GitRepo) -> None:
"""Test that untyped commits are included in sections when include_all=True.
Parameters:
repo: GitRepo to a temporary repository.
"""
repo.commit("feat: Feature A")
commit_b = repo.commit("Random commit message without convention")
repo.commit("fix: Fix C")
commit_d = repo.commit("Another random message")
repo.tag("1.0.0")
changelog = Changelog(repo.path, convention=AngularConvention, include_all=True)
assert len(changelog.versions_list) == 1
version = changelog.versions_list[0]
# Empty string ("") SHOULD be in sections when include_all=True.
assert "" in changelog.sections
# All sections should be present.
sections_dict = version.sections_dict
assert "Features" in sections_dict
assert "Bug Fixes" in sections_dict
assert "Chore" in sections_dict # From initial commit
assert "" in sections_dict # Untyped section
# Check that untyped section contains the non-conventional commits.
untyped_section = sections_dict[""]
assert len(untyped_section.commits) == 2
untyped_hashes = [commit.hash for commit in untyped_section.commits]
assert commit_b in untyped_hashes
assert commit_d in untyped_hashes
def test_include_all_with_sections_parameter(repo: GitRepo) -> None:
"""Test that include_all works correctly with explicit sections parameter.
Parameters:
repo: GitRepo to a temporary repository.
"""
repo.commit("feat: Feature A")
commit_b = repo.commit("Random commit message")
repo.commit("fix: Fix C")
repo.tag("1.0.0")
# Specify only feat and fix sections, but with include_all=True.
changelog = Changelog(
repo.path,
convention=AngularConvention,
sections=["feat", "fix"],
include_all=True,
)
# Empty string should be added at the end.
assert "" in changelog.sections
# The specified sections should be present.
assert "Features" in [s for s in changelog.sections if s]
assert "Bug Fixes" in [s for s in changelog.sections if s]
version = changelog.versions_list[0]
sections_dict = version.sections_dict
# Untyped section should be present.
assert "" in sections_dict
untyped_section = sections_dict[""]
assert len(untyped_section.commits) == 1
assert untyped_section.commits[0].hash == commit_b
def test_sections_all_expands_to_all_types(repo: GitRepo) -> None:
"""Test that :all: expands to all available section types for the convention.
Parameters:
repo: GitRepo to a temporary repository.
"""
repo.tag("1.0.0")
changelog = Changelog(repo.path, convention=AngularConvention, sections=[":all:"])
# AngularConvention.TYPES contains all available section types.
expected_sections = list(dict.fromkeys(AngularConvention.TYPES.values()))
assert changelog.sections == expected_sections
def test_sections_all_with_basic_convention(repo: GitRepo) -> None:
"""Test that :all: works with BasicConvention.
Parameters:
repo: GitRepo to a temporary repository.
"""
repo.tag("1.0.0")
changelog = Changelog(repo.path, convention=BasicConvention, sections=[":all:"])
# BasicConvention.TYPES contains all available section types.
expected_sections = list(BasicConvention.TYPES.values())
assert changelog.sections == expected_sections
def test_sections_explicit_list_still_works(repo: GitRepo) -> None:
"""Test that explicit section list still works as before.
Parameters:
repo: GitRepo to a temporary repository.
"""
repo.tag("1.0.0")
changelog = Changelog(
repo.path,
convention=AngularConvention,
sections=["feat", "fix"],
)
# Should map to full section names.
assert changelog.sections == ["Features", "Bug Fixes"]
|