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
|
from __future__ import annotations
import json
import tempfile
import unittest
from pathlib import Path
from scripts.changelog import (
ChangelogError,
archived_releases_from_current_manifest,
build_latest_json,
canonicalize_manifest,
DEFAULT_PRODUCT_ANNOUNCEMENT_PATH,
default_release_assets,
ensure_current_release_assets_are_mirrored,
ensure_manifest_is_outdated,
ensure_manifest_matches_expected,
extract_section_body,
infer_protocol_from_notes,
load_product_announcement,
manifest_from_release_payload,
prepare_release,
read_protocol_version,
)
class ChangelogScriptTests(unittest.TestCase):
def test_prepare_release_moves_unreleased_into_versioned_section(self) -> None:
original = """# Changelog\n\n## Unreleased\n\n### Fixed\n- Smoothed Claude flapping.\n\n## [0.1.0] - 2026-03-27\n\n### Added\n- Initial release.\n"""
updated = prepare_release(original, "0.1.1", "2026-03-28")
self.assertIn("## Unreleased\n\n## [0.1.1] - 2026-03-28", updated)
self.assertIn("### Fixed\n- Smoothed Claude flapping.", updated)
self.assertIn("## [0.1.0] - 2026-03-27", updated)
def test_prepare_release_accepts_bracketed_unreleased_heading(self) -> None:
original = """# Changelog\n\n## [Unreleased]\n\n### Added\n- Added sounds.\n"""
updated = prepare_release(original, "0.1.1", "2026-03-28")
self.assertIn("## Unreleased\n\n## [0.1.1] - 2026-03-28", updated)
self.assertIn("### Added\n- Added sounds.", updated)
def test_extract_section_body_returns_requested_version_only(self) -> None:
changelog = """# Changelog\n\n## Unreleased\n\n## [0.1.1] - 2026-03-28\n\n### Fixed\n- Smoothed Claude flapping.\n\n## [0.1.0] - 2026-03-27\n\n### Added\n- Initial release.\n"""
body = extract_section_body(changelog, "0.1.1")
self.assertEqual(body, "### Fixed\n- Smoothed Claude flapping.\n")
def test_build_latest_json_trims_notes(self) -> None:
manifest = json.loads(
build_latest_json(
"0.1.1",
"\n### Fixed\n- One\n\n",
default_release_assets("0.1.1"),
)
)
self.assertEqual(manifest["protocol"], read_protocol_version())
self.assertEqual(manifest["notes"], "### Fixed\n- One")
def test_build_latest_json_embeds_notes_and_release_assets(self) -> None:
manifest = json.loads(
build_latest_json(
"v0.1.1",
"### Fixed\n- Smoothed Claude flapping.\n",
default_release_assets("0.1.1"),
)
)
self.assertEqual(manifest["version"], "0.1.1")
self.assertEqual(manifest["protocol"], read_protocol_version())
self.assertEqual(manifest["notes"], "### Fixed\n- Smoothed Claude flapping.")
self.assertEqual(
manifest["assets"],
{
"linux-x86_64": "https://github.com/ogulcancelik/herdr/releases/download/v0.1.1/herdr-linux-x86_64",
"linux-aarch64": "https://github.com/ogulcancelik/herdr/releases/download/v0.1.1/herdr-linux-aarch64",
"macos-x86_64": "https://github.com/ogulcancelik/herdr/releases/download/v0.1.1/herdr-macos-x86_64",
"macos-aarch64": "https://github.com/ogulcancelik/herdr/releases/download/v0.1.1/herdr-macos-aarch64",
},
)
self.assertEqual(manifest["releases"]["0.1.1"]["assets"], manifest["assets"])
def test_build_latest_json_embeds_product_announcement(self) -> None:
manifest = json.loads(
build_latest_json(
"0.1.1",
"### Fixed\n- One",
default_release_assets("0.1.1"),
announcement={"id": "keybinding-v2", "title": "Keybind Refactor", "body": "body"},
)
)
self.assertEqual(
manifest["announcement"],
{"id": "keybinding-v2", "title": "Keybind Refactor", "body": "body"},
)
self.assertEqual(
manifest["releases"]["0.1.1"]["announcement"],
{"id": "keybinding-v2", "title": "Keybind Refactor", "body": "body"},
)
def test_build_latest_json_preserves_previous_release_metadata(self) -> None:
manifest = json.loads(
build_latest_json(
"0.1.2",
"### Fixed\n- Two",
default_release_assets("0.1.2"),
releases={"0.1.1": {"notes": "### Fixed\n- One"}},
)
)
self.assertEqual(list(manifest["releases"]), ["0.1.2", "0.1.1"])
self.assertEqual(manifest["releases"]["0.1.2"]["notes"], "### Fixed\n- Two")
self.assertEqual(manifest["releases"]["0.1.2"]["protocol"], read_protocol_version())
self.assertEqual(manifest["releases"]["0.1.2"]["assets"], default_release_assets("0.1.2"))
self.assertEqual(manifest["releases"]["0.1.1"]["notes"], "### Fixed\n- One")
self.assertEqual(manifest["releases"]["0.1.1"]["assets"], default_release_assets("0.1.1"))
def test_build_latest_json_accepts_release_metadata_assets(self) -> None:
assets = default_release_assets("0.1.1")
manifest = json.loads(
build_latest_json(
"0.1.2",
"### Fixed\n- Two",
default_release_assets("0.1.2"),
releases={"0.1.1": {"notes": "### Fixed\n- One", "assets": assets}},
)
)
self.assertEqual(manifest["releases"]["0.1.1"]["assets"], assets)
def test_build_latest_json_preserves_release_metadata_protocol(self) -> None:
manifest = json.loads(
build_latest_json(
"0.1.2",
"### Fixed\n- Two",
default_release_assets("0.1.2"),
releases={"0.1.1": {"notes": "### Fixed\n- One", "protocol": 7}},
)
)
self.assertEqual(manifest["releases"]["0.1.1"]["protocol"], 7)
def test_build_latest_json_infers_release_metadata_protocol_from_notes(self) -> None:
manifest = json.loads(
build_latest_json(
"0.1.2",
"### Fixed\n- Two",
default_release_assets("0.1.2"),
releases={
"0.1.1": {
"notes": "### Breaking Changes\n- The client/server protocol is now version 7."
}
},
)
)
self.assertEqual(manifest["releases"]["0.1.1"]["protocol"], 7)
def test_archived_releases_from_current_manifest_seeds_legacy_root(self) -> None:
releases = archived_releases_from_current_manifest(
{
"version": "0.1.1",
"protocol": 3,
"notes": "### Fixed\n- One",
"announcement": {
"id": "one",
"title": "One",
"body": "body",
},
}
)
self.assertEqual(
releases,
{
"0.1.1": {
"notes": "### Fixed\n- One",
"protocol": 3,
"assets": default_release_assets("0.1.1"),
"announcement": {
"id": "one",
"title": "One",
"body": "body",
},
}
},
)
def test_archived_releases_from_current_manifest_prefers_root_for_current_version(self) -> None:
releases = archived_releases_from_current_manifest(
{
"version": "0.1.2",
"protocol": read_protocol_version(),
"notes": "### Fixed\n- Root",
"releases": {
"0.1.2": {"notes": "### Fixed\n- Stale"},
"0.1.1": {"notes": "### Fixed\n- One"},
},
}
)
self.assertEqual(releases["0.1.2"]["notes"], "### Fixed\n- Root")
self.assertEqual(releases["0.1.1"]["notes"], "### Fixed\n- One")
self.assertEqual(releases["0.1.2"]["protocol"], read_protocol_version())
self.assertEqual(releases["0.1.2"]["assets"], default_release_assets("0.1.2"))
self.assertEqual(releases["0.1.1"]["assets"], default_release_assets("0.1.1"))
def test_infer_protocol_from_notes(self) -> None:
self.assertEqual(
infer_protocol_from_notes("The client/server protocol is now version 10."),
10,
)
self.assertEqual(
infer_protocol_from_notes("The client/server protocol version 9."),
9,
)
self.assertIsNone(infer_protocol_from_notes("No wire changes."))
def write_temp_json(self, content: str) -> Path:
tmp = tempfile.NamedTemporaryFile("w", delete=False, encoding="utf-8")
with tmp:
tmp.write(content)
return Path(tmp.name)
def test_checked_in_product_announcement_is_valid_or_null(self) -> None:
self.assertTrue(DEFAULT_PRODUCT_ANNOUNCEMENT_PATH.is_file())
load_product_announcement(DEFAULT_PRODUCT_ANNOUNCEMENT_PATH)
def test_load_product_announcement_accepts_null(self) -> None:
path = self.write_temp_json("null\n")
try:
self.assertIsNone(load_product_announcement(path))
finally:
path.unlink(missing_ok=True)
def test_load_product_announcement_accepts_valid_object(self) -> None:
path = self.write_temp_json(
json.dumps({"id": "keybinding-v2", "title": "Keybind Refactor", "body": "Body"})
)
try:
self.assertEqual(
load_product_announcement(path),
{"id": "keybinding-v2", "title": "Keybind Refactor", "body": "Body"},
)
finally:
path.unlink(missing_ok=True)
def test_load_product_announcement_rejects_missing_file(self) -> None:
path = Path(tempfile.gettempdir()) / "herdr-missing-product-announcement.json"
path.unlink(missing_ok=True)
with self.assertRaisesRegex(ChangelogError, "file not found"):
load_product_announcement(path)
def test_load_product_announcement_rejects_missing_empty_or_extra_fields(self) -> None:
cases = [
({"id": "keybinding-v2", "title": "Keybind Refactor"}, "body"),
({"id": "", "title": "Keybind Refactor", "body": "Body"}, "id"),
({"id": "keybinding-v2", "title": "Keybind Refactor", "body": "Body", "cta": "x"}, "unsupported"),
]
for payload, expected in cases:
path = self.write_temp_json(json.dumps(payload))
try:
with self.assertRaisesRegex(ChangelogError, expected):
load_product_announcement(path)
finally:
path.unlink(missing_ok=True)
def test_load_product_announcement_rejects_invalid_id(self) -> None:
path = self.write_temp_json(
json.dumps({"id": "Keybinding V2", "title": "Keybind Refactor", "body": "Body"})
)
try:
with self.assertRaisesRegex(ChangelogError, "invalid id"):
load_product_announcement(path)
finally:
path.unlink(missing_ok=True)
def test_manifest_from_release_payload_uses_release_body_and_asset_urls(self) -> None:
manifest = manifest_from_release_payload(
{
"tagName": "v0.1.1",
"isDraft": False,
"isPrerelease": False,
"body": "### Fixed\n- One\n",
"assets": [
{"name": "herdr-linux-x86_64", "url": "https://example.com/linux-x86_64"},
{"name": "herdr-linux-aarch64", "url": "https://example.com/linux-aarch64"},
{"name": "herdr-macos-x86_64", "url": "https://example.com/macos-x86_64"},
{"name": "herdr-macos-aarch64", "url": "https://example.com/macos-aarch64"},
],
},
"0.1.1",
)
self.assertEqual(
manifest,
{
"version": "0.1.1",
"protocol": read_protocol_version(),
"notes": "### Fixed\n- One",
"assets": {
"linux-x86_64": "https://example.com/linux-x86_64",
"linux-aarch64": "https://example.com/linux-aarch64",
"macos-x86_64": "https://example.com/macos-x86_64",
"macos-aarch64": "https://example.com/macos-aarch64",
},
},
)
def test_manifest_from_release_payload_uses_explicit_protocol(self) -> None:
manifest = manifest_from_release_payload(
{
"tagName": "v0.1.1",
"isDraft": False,
"isPrerelease": False,
"body": "### Fixed\n- One\n",
"assets": [
{"name": "herdr-linux-x86_64", "url": "https://example.com/linux-x86_64"},
{"name": "herdr-linux-aarch64", "url": "https://example.com/linux-aarch64"},
{"name": "herdr-macos-x86_64", "url": "https://example.com/macos-x86_64"},
{"name": "herdr-macos-aarch64", "url": "https://example.com/macos-aarch64"},
],
},
"0.1.1",
protocol=42,
)
self.assertEqual(manifest["protocol"], 42)
def test_manifest_from_release_payload_rejects_missing_asset(self) -> None:
with self.assertRaisesRegex(ChangelogError, "missing asset herdr-macos-aarch64"):
manifest_from_release_payload(
{
"tagName": "v0.1.1",
"isDraft": False,
"isPrerelease": False,
"body": "### Fixed\n- One\n",
"assets": [
{"name": "herdr-linux-x86_64", "url": "https://example.com/linux-x86_64"},
{"name": "herdr-linux-aarch64", "url": "https://example.com/linux-aarch64"},
{"name": "herdr-macos-x86_64", "url": "https://example.com/macos-x86_64"},
],
},
"0.1.1",
)
def test_ensure_manifest_is_outdated_rejects_same_or_newer_version(self) -> None:
with self.assertRaisesRegex(ChangelogError, "already at v0.1.1"):
ensure_manifest_is_outdated({"version": "0.1.1"}, "0.1.1")
with self.assertRaisesRegex(ChangelogError, "already at v0.1.2"):
ensure_manifest_is_outdated({"version": "0.1.2"}, "0.1.1")
def test_ensure_manifest_is_outdated_allows_older_version(self) -> None:
ensure_manifest_is_outdated({"version": "0.1.0"}, "0.1.1")
def test_canonicalize_manifest_requires_all_asset_targets(self) -> None:
with self.assertRaisesRegex(ChangelogError, "missing asset URL for macos-aarch64"):
canonicalize_manifest(
{
"version": "0.1.1",
"protocol": read_protocol_version(),
"notes": "### Fixed\n- One",
"assets": {
"linux-x86_64": "https://example.com/linux-x86_64",
"linux-aarch64": "https://example.com/linux-aarch64",
"macos-x86_64": "https://example.com/macos-x86_64",
},
},
"test manifest",
)
def test_ensure_manifest_matches_expected_normalizes_whitespace(self) -> None:
actual = {
"version": "v0.1.1",
"protocol": read_protocol_version(),
"notes": "\n### Fixed\n- One\n",
"assets": {
"linux-x86_64": " https://example.com/linux-x86_64 ",
"linux-aarch64": "https://example.com/linux-aarch64",
"macos-x86_64": "https://example.com/macos-x86_64",
"macos-aarch64": "https://example.com/macos-aarch64",
},
}
expected = {
"version": "0.1.1",
"protocol": read_protocol_version(),
"notes": "### Fixed\n- One",
"assets": {
"linux-x86_64": "https://example.com/linux-x86_64",
"linux-aarch64": "https://example.com/linux-aarch64",
"macos-x86_64": "https://example.com/macos-x86_64",
"macos-aarch64": "https://example.com/macos-aarch64",
},
}
canonical = ensure_manifest_matches_expected(actual, expected, "test manifest")
self.assertEqual(canonical, expected)
def test_current_release_assets_must_be_mirrored(self) -> None:
assets = default_release_assets("0.1.1")
ensure_current_release_assets_are_mirrored(
{
"version": "0.1.1",
"protocol": read_protocol_version(),
"notes": "### Fixed\n- One",
"assets": assets,
"releases": {
"0.1.1": {
"notes": "### Fixed\n- One",
"assets": assets,
}
},
},
"test manifest",
)
def test_current_release_assets_must_match_top_level_assets(self) -> None:
with self.assertRaisesRegex(ChangelogError, "assets must match top-level assets"):
ensure_current_release_assets_are_mirrored(
{
"version": "0.1.1",
"protocol": read_protocol_version(),
"notes": "### Fixed\n- One",
"assets": default_release_assets("0.1.1"),
"releases": {
"0.1.1": {
"notes": "### Fixed\n- One",
"assets": default_release_assets("0.1.0"),
}
},
},
"test manifest",
)
def test_ensure_manifest_matches_expected_rejects_different_notes(self) -> None:
with self.assertRaisesRegex(ChangelogError, "does not match the published GitHub release manifest"):
ensure_manifest_matches_expected(
{
"version": "0.1.1",
"protocol": read_protocol_version(),
"notes": "### Fixed\n- Different",
"assets": {
"linux-x86_64": "https://example.com/linux-x86_64",
"linux-aarch64": "https://example.com/linux-aarch64",
"macos-x86_64": "https://example.com/macos-x86_64",
"macos-aarch64": "https://example.com/macos-aarch64",
},
},
{
"version": "0.1.1",
"protocol": read_protocol_version(),
"notes": "### Fixed\n- One",
"assets": {
"linux-x86_64": "https://example.com/linux-x86_64",
"linux-aarch64": "https://example.com/linux-aarch64",
"macos-x86_64": "https://example.com/macos-x86_64",
"macos-aarch64": "https://example.com/macos-aarch64",
},
},
"test manifest",
)
def test_canonicalize_manifest_requires_protocol(self) -> None:
with self.assertRaisesRegex(ChangelogError, "missing an integer protocol"):
canonicalize_manifest(
{
"version": "0.1.1",
"notes": "### Fixed\n- One",
"assets": default_release_assets("0.1.1"),
},
"test manifest",
)
def test_ensure_manifest_matches_expected_rejects_different_protocol(self) -> None:
actual = {
"version": "0.1.1",
"protocol": read_protocol_version() + 1,
"notes": "### Fixed\n- One",
"assets": default_release_assets("0.1.1"),
}
expected = {
"version": "0.1.1",
"protocol": read_protocol_version(),
"notes": "### Fixed\n- One",
"assets": default_release_assets("0.1.1"),
}
with self.assertRaisesRegex(ChangelogError, "does not match"):
ensure_manifest_matches_expected(actual, expected, "test manifest")
if __name__ == "__main__":
unittest.main()
|
