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
|
from __future__ import annotations
from datetime import timedelta
from textwrap import dedent
from typing import TYPE_CHECKING
import pytest
from git import Commit, Object, Repo
from semantic_release.changelog.release_history import Release, ReleaseHistory
from semantic_release.commit_parser.token import ParsedCommit
from semantic_release.enums import LevelBump
from semantic_release.version.version import Version
if TYPE_CHECKING:
from git import Actor
from tests.conftest import GetStableDateNowFn
@pytest.fixture
def artificial_release_history(
commit_author: Actor,
stable_now_date: GetStableDateNowFn,
) -> ReleaseHistory:
current_datetime = stable_now_date()
first_version = Version.parse("1.0.0")
second_version = first_version.bump(LevelBump.MINOR)
fix_commit_subject = "fix a problem"
fix_commit_type = "fix"
fix_commit_scope = "cli"
fix_commit = Commit(
Repo("."),
Object.NULL_HEX_SHA[:20].encode("utf-8"),
message=f"{fix_commit_type}({fix_commit_scope}): {fix_commit_subject}",
)
fix_commit_parsed = ParsedCommit(
bump=LevelBump.PATCH,
type="fix",
scope=fix_commit_scope,
descriptions=[fix_commit_subject],
breaking_descriptions=[],
commit=fix_commit,
)
fix_commit_2_subject = "alphabetically first to solve a non-scoped problem"
fix_commit_2_type = "fix"
fix_commit_2_scope = ""
fix_commit_2 = Commit(
Repo("."),
Object.NULL_HEX_SHA[:20].encode("utf-8"),
message=f"{fix_commit_2_type}: {fix_commit_2_subject}",
)
fix_commit_2_parsed = ParsedCommit(
bump=LevelBump.PATCH,
type="fix",
scope=fix_commit_2_scope,
descriptions=[fix_commit_2_subject],
breaking_descriptions=[],
commit=fix_commit_2,
)
fix_commit_3_subject = "alphabetically first to solve a scoped problem"
fix_commit_3_type = "fix"
fix_commit_3_scope = "cli"
fix_commit_3 = Commit(
Repo("."),
Object.NULL_HEX_SHA[:20].encode("utf-8"),
message=f"{fix_commit_3_type}({fix_commit_3_scope}): {fix_commit_3_subject}",
)
fix_commit_3_parsed = ParsedCommit(
bump=LevelBump.PATCH,
type="fix",
scope=fix_commit_3_scope,
descriptions=[fix_commit_3_subject],
breaking_descriptions=[],
commit=fix_commit_3,
)
feat_commit_subject = "add a new feature"
feat_commit_type = "feat"
feat_commit_scope = "cli"
feat_commit = Commit(
Repo("."),
Object.NULL_HEX_SHA[:20].encode("utf-8"),
message=f"{feat_commit_type}({feat_commit_scope}): {feat_commit_subject}",
)
feat_commit_parsed = ParsedCommit(
bump=LevelBump.MINOR,
type="feature",
scope=feat_commit_scope,
descriptions=[feat_commit_subject],
breaking_descriptions=[],
commit=feat_commit,
)
return ReleaseHistory(
unreleased={"feature": [feat_commit_parsed]},
released={
second_version: Release(
tagger=commit_author,
committer=commit_author,
tagged_date=current_datetime,
elements={
# Purposefully inserted out of order, should be dictsorted in templates
"fix": [
# Purposefully inserted out of alphabetical order, should be sorted in templates
fix_commit_parsed,
fix_commit_2_parsed, # has no scope
fix_commit_3_parsed, # has same scope as 1
],
"feature": [feat_commit_parsed],
},
version=second_version,
),
first_version: Release(
tagger=commit_author,
committer=commit_author,
tagged_date=current_datetime - timedelta(minutes=1),
elements={"feature": [feat_commit_parsed]},
version=first_version,
),
},
)
@pytest.fixture
def release_history_w_brk_change(
artificial_release_history: ReleaseHistory,
stable_now_date: GetStableDateNowFn,
) -> ReleaseHistory:
current_datetime = stable_now_date()
latest_version = next(iter(artificial_release_history.released.keys()))
next_version = latest_version.bump(LevelBump.MAJOR)
brk_commit_subject = "fix a problem"
brk_commit_type = "fix"
brk_commit_scope = "cli"
brk_change_msg = "this is a breaking change"
brk_commit = Commit(
Repo("."),
Object.NULL_BIN_SHA,
message=str.join(
"\n\n",
[
f"{brk_commit_type}({brk_commit_scope}): {brk_commit_subject}",
f"BREAKING CHANGE: {brk_change_msg}",
],
),
)
brk_commit_parsed = ParsedCommit(
bump=LevelBump.MAJOR,
type=brk_commit_type,
scope=brk_commit_scope,
descriptions=[brk_commit_subject],
breaking_descriptions=[brk_change_msg],
commit=brk_commit,
)
return ReleaseHistory(
unreleased={},
released={
next_version: Release(
tagger=artificial_release_history.released[latest_version]["tagger"],
committer=artificial_release_history.released[latest_version][
"committer"
],
tagged_date=current_datetime,
elements={"Bug Fixes": [brk_commit_parsed]},
version=next_version,
),
**artificial_release_history.released,
},
)
@pytest.fixture
def release_history_w_multiple_brk_changes(
release_history_w_brk_change: ReleaseHistory,
stable_now_date: GetStableDateNowFn,
) -> ReleaseHistory:
current_datetime = stable_now_date()
latest_version = next(iter(release_history_w_brk_change.released.keys()))
brk_commit_subject = "adding a revolutionary feature"
brk_commit_type = "feat"
brk_change_msg = "The feature changes everything in a breaking way"
brk_commit = Commit(
Repo("."),
Object.NULL_BIN_SHA,
message=str.join(
"\n\n",
[
f"{brk_commit_type}: {brk_commit_subject}",
f"BREAKING CHANGE: {brk_change_msg}",
],
),
)
brk_commit_parsed = ParsedCommit(
bump=LevelBump.MAJOR,
type=brk_commit_type,
scope="", # No scope in this commit
descriptions=[brk_commit_subject],
breaking_descriptions=[brk_change_msg],
commit=brk_commit,
)
return ReleaseHistory(
unreleased={},
released={
**release_history_w_brk_change.released,
# Replaces and inserts a new commit of different type with breaking changes
latest_version: Release(
tagger=release_history_w_brk_change.released[latest_version]["tagger"],
committer=release_history_w_brk_change.released[latest_version][
"committer"
],
tagged_date=current_datetime,
elements={
**release_history_w_brk_change.released[latest_version]["elements"],
"Features": [brk_commit_parsed],
},
version=latest_version,
),
},
)
@pytest.fixture
def single_release_history(
artificial_release_history: ReleaseHistory,
) -> ReleaseHistory:
version = list(artificial_release_history.released.keys())[-1]
return ReleaseHistory(
unreleased={},
released={
version: artificial_release_history.released[version],
},
)
@pytest.fixture
def release_history_w_a_notice(
artificial_release_history: ReleaseHistory,
stable_now_date: GetStableDateNowFn,
) -> ReleaseHistory:
current_datetime = stable_now_date()
latest_version = next(iter(artificial_release_history.released.keys()))
next_version = latest_version.bump(LevelBump.PATCH)
notice_commit_subject = "deprecate a type"
notice_commit_type = "refactor"
notice_commit_scope = "cli"
release_notice = dedent(
"""\
This is a multline release notice that is made
up of two lines.
"""
)
notice_commit = Commit(
Repo("."),
Object.NULL_BIN_SHA,
message=str.join(
"\n\n",
[
f"{notice_commit_type}({notice_commit_scope}): {notice_commit_subject}",
f"NOTICE: {release_notice}",
],
),
)
notice_commit_parsed = ParsedCommit(
bump=LevelBump.NO_RELEASE,
type=notice_commit_type,
scope=notice_commit_scope,
descriptions=[notice_commit_subject],
breaking_descriptions=[],
release_notices=(release_notice.replace("\n", " ").strip(),),
commit=notice_commit,
)
return ReleaseHistory(
unreleased={},
released={
next_version: Release(
tagger=artificial_release_history.released[latest_version]["tagger"],
committer=artificial_release_history.released[latest_version][
"committer"
],
tagged_date=current_datetime,
elements={"Refactoring": [notice_commit_parsed]},
version=next_version,
),
**artificial_release_history.released,
},
)
@pytest.fixture
def release_history_w_notice_n_brk_change(
artificial_release_history: ReleaseHistory,
release_history_w_a_notice: ReleaseHistory,
stable_now_date: GetStableDateNowFn,
) -> ReleaseHistory:
current_datetime = stable_now_date()
latest_version = next(iter(artificial_release_history.released.keys()))
next_version = latest_version.bump(LevelBump.MAJOR)
brk_commit_subject = "fix a problem"
brk_commit_type = "fix"
brk_commit_scope = "cli"
brk_change_msg = "this is a breaking change"
brk_commit = Commit(
Repo("."),
Object.NULL_BIN_SHA,
message=str.join(
"\n\n",
[
f"{brk_commit_type}({brk_commit_scope}): {brk_commit_subject}",
f"BREAKING CHANGE: {brk_change_msg}",
],
),
)
brk_commit_parsed = ParsedCommit(
bump=LevelBump.MAJOR,
type=brk_commit_type,
scope=brk_commit_scope,
descriptions=[brk_commit_subject],
breaking_descriptions=[brk_change_msg],
commit=brk_commit,
)
last_notice_release = next(iter(release_history_w_a_notice.released.keys()))
return ReleaseHistory(
unreleased={},
released={
next_version: Release(
tagger=artificial_release_history.released[latest_version]["tagger"],
committer=artificial_release_history.released[latest_version][
"committer"
],
tagged_date=current_datetime,
elements={
"Bug Fixes": [brk_commit_parsed],
**release_history_w_a_notice.released[last_notice_release][
"elements"
],
},
version=next_version,
),
**artificial_release_history.released,
},
)
@pytest.fixture
def release_history_w_multiple_notices(
release_history_w_a_notice: ReleaseHistory,
stable_now_date: GetStableDateNowFn,
) -> ReleaseHistory:
current_datetime = stable_now_date()
latest_version = next(iter(release_history_w_a_notice.released.keys()))
notice_commit_subject = "add a configurable feature"
notice_commit_type = "feat"
notice_commit_scope = "cli-config"
release_notice = dedent(
"""\
This is a multline release notice that is its own
paragraph to detail the configurable feature.
"""
)
notice_commit = Commit(
Repo("."),
Object.NULL_BIN_SHA,
message=str.join(
"\n\n",
[
f"{notice_commit_type}({notice_commit_scope}): {notice_commit_subject}",
f"NOTICE: {release_notice}",
],
),
)
notice_commit_parsed = ParsedCommit(
bump=LevelBump.MINOR,
type=notice_commit_type,
scope=notice_commit_scope,
descriptions=[notice_commit_subject],
breaking_descriptions=[],
release_notices=(release_notice.replace("\n", " ").strip(),),
commit=notice_commit,
)
return ReleaseHistory(
unreleased={},
released={
**release_history_w_a_notice.released,
# Replaces and inserts a new commit of different type with breaking changes
latest_version: Release(
tagger=release_history_w_a_notice.released[latest_version]["tagger"],
committer=release_history_w_a_notice.released[latest_version][
"committer"
],
tagged_date=current_datetime,
elements={
"Features": [notice_commit_parsed],
**release_history_w_a_notice.released[latest_version]["elements"],
},
version=latest_version,
),
},
)
|
