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
|
from __future__ import annotations
from pathlib import Path
import pytest
from commitizen.changelog import Metadata
from commitizen.changelog_formats.textile import Textile
from commitizen.config.base_config import BaseConfig
CHANGELOG_A = """
h1. Changelog
All notable changes to this project will be documented in this file.
The format is based on "Keep a Changelog":https://keepachangelog.com/en/1.0.0/,
and this project adheres to "Semantic Versioning":https://semver.org/spec/v2.0.0.html.
h2. [Unreleased]
- Start using "changelog" over "change log" since it's the common usage.
h2. [1.0.0] - 2017-06-20
h3. Added
* New visual identity by [@tylerfortune8](https://github.com/tylerfortune8).
* Version navigation.
""".strip()
EXPECTED_A = Metadata(
latest_version="1.0.0",
latest_version_position=10,
unreleased_end=10,
unreleased_start=7,
)
CHANGELOG_B = """
h2. [Unreleased]
* Start using "changelog" over "change log" since it's the common usage.
h2. 1.2.0
""".strip()
EXPECTED_B = Metadata(
latest_version="1.2.0",
latest_version_position=3,
unreleased_end=3,
unreleased_start=0,
)
CHANGELOG_C = """
h1. Unreleased
h2. v1.0.0
"""
EXPECTED_C = Metadata(
latest_version="1.0.0",
latest_version_tag="v1.0.0",
latest_version_position=3,
unreleased_end=3,
unreleased_start=1,
)
CHANGELOG_D = """
h2. Unreleased
* Start using "changelog" over "change log" since it's the common usage.
"""
EXPECTED_D = Metadata(
latest_version=None,
latest_version_position=None,
unreleased_end=2,
unreleased_start=1,
)
CHANGELOG_E = """
h1. Changelog
All notable changes to this project will be documented in this file.
The format is based on "Keep a Changelog":https://keepachangelog.com/en/1.0.0/,
and this project adheres to "Semantic Versioning":https://semver.org/spec/v2.0.0.html.
h2. [Unreleased]
- Start using "changelog" over "change log" since it's the common usage.
h2. [{tag_formatted_version}] - 2017-06-20
h3. Added
* New visual identity by [@tylerfortune8](https://github.com/tylerfortune8).
* Version navigation.
""".strip()
@pytest.fixture
def format(config: BaseConfig) -> Textile:
return Textile(config)
@pytest.fixture
def format_with_tags(config: BaseConfig, request) -> Textile:
config.settings["tag_format"] = request.param
config.settings["legacy_tag_formats"] = ["legacy-${version}"]
return Textile(config)
VERSIONS_EXAMPLES = [
("h2. [1.0.0] - 2017-06-20", ("1.0.0", "1.0.0")),
(
'h1. "10.0.0-next.3":https://github.com/angular/angular/compare/10.0.0-next.2...10.0.0-next.3 (2020-04-22)',
("10.0.0-next.3", "10.0.0-next.3"),
),
("h3. 0.19.1 (Jan 7, 2020)", ("0.19.1", "0.19.1")),
("h2. 1.0.0", ("1.0.0", "1.0.0")),
("h2. v1.0.0", ("1.0.0", "v1.0.0")),
("h2. v1.0.0 - (2012-24-32)", ("1.0.0", "v1.0.0")),
("h1. version 2020.03.24", ("2020.03.24", "2020.03.24")),
("h2. [Unreleased]", None),
("All notable changes to this project will be documented in this file.", None),
("h1. Changelog", None),
("h3. Bug Fixes", None),
]
@pytest.mark.parametrize("line_from_changelog,output_version", VERSIONS_EXAMPLES)
def test_changelog_detect_version(
line_from_changelog: str, output_version: tuple[str, str] | None, format: Textile
):
version = format.parse_version_from_title(line_from_changelog)
assert version == output_version
TITLES_EXAMPLES = [
("h2. [1.0.0] - 2017-06-20", 2),
("h2. [Unreleased]", 2),
("h1. Unreleased", 1),
]
@pytest.mark.parametrize("line_from_changelog,output_title", TITLES_EXAMPLES)
def test_parse_title_type_of_line(
line_from_changelog: str, output_title: str, format: Textile
):
title = format.parse_title_level(line_from_changelog)
assert title == output_title
@pytest.mark.parametrize(
"content, expected",
(
pytest.param(CHANGELOG_A, EXPECTED_A, id="A"),
pytest.param(CHANGELOG_B, EXPECTED_B, id="B"),
pytest.param(CHANGELOG_C, EXPECTED_C, id="C"),
pytest.param(CHANGELOG_D, EXPECTED_D, id="D"),
),
)
def test_get_metadata(
tmp_path: Path, format: Textile, content: str, expected: Metadata
):
changelog = tmp_path / format.default_changelog_file
changelog.write_text(content)
assert format.get_metadata(str(changelog)) == expected
@pytest.mark.parametrize(
"format_with_tags, tag_string, expected, ",
(
pytest.param("${version}-example", "1.0.0-example", "1.0.0"),
pytest.param("${version}example", "1.0.0example", "1.0.0"),
pytest.param("example${version}", "example1.0.0", "1.0.0"),
pytest.param("example-${version}", "example-1.0.0", "1.0.0"),
pytest.param("example-${major}-${minor}-${patch}", "example-1-0-0", "1.0.0"),
pytest.param("example-${major}-${minor}", "example-1-0-0", None),
pytest.param(
"${major}-${minor}-${patch}-${prerelease}-example",
"1-0-0-rc1-example",
"1.0.0-rc1",
),
pytest.param(
"${major}-${minor}-${patch}-${prerelease}${devrelease}-example",
"1-0-0-a1.dev1-example",
"1.0.0-a1.dev1",
),
pytest.param("new-${version}", "legacy-1.0.0", "1.0.0"),
),
indirect=["format_with_tags"],
)
def test_get_metadata_custom_tag_format(
tmp_path: Path, format_with_tags: Textile, tag_string: str, expected: Metadata
):
content = CHANGELOG_E.format(tag_formatted_version=tag_string)
changelog = tmp_path / format_with_tags.default_changelog_file
changelog.write_text(content)
assert format_with_tags.get_metadata(str(changelog)).latest_version == expected
|
