wavepeek 0.5.0

Command-line tool for RTL waveform inspection with deterministic machine-friendly output.
Documentation 
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

#!/usr/bin/env python3

from __future__ import annotations

import pathlib
import subprocess
import tempfile
import textwrap
import unittest


SCRIPT_PATH = pathlib.Path(__file__).with_name("extract_release_notes.py")


class ExtractReleaseNotesCliTest(unittest.TestCase):
    def run_script(self, changelog_text: str, version: str) -> subprocess.CompletedProcess[str]:
        with tempfile.TemporaryDirectory() as temp_dir:
            changelog_path = pathlib.Path(temp_dir) / "CHANGELOG.md"
            changelog_path.write_text(changelog_text, encoding="utf-8")
            return subprocess.run(
                [
                    "python3",
                    str(SCRIPT_PATH),
                    "--changelog",
                    str(changelog_path),
                    "--version",
                    version,
                ],
                check=False,
                capture_output=True,
                text=True,
            )

    def test_extracts_matching_version_section_body_only(self) -> None:
        result = self.run_script(
            textwrap.dedent(
                """\
                # Changelog

                ## [Unreleased]

                ### Added
                - Future work.

                ## [1.2.3] - 2026-03-07

                ### Added
                - First shipped item.

                ### Fixed
                - Second shipped item.

                ## [1.2.2] - 2026-03-01

                ### Fixed
                - Older item.
                """
            ),
            "1.2.3",
        )

        self.assertEqual(result.returncode, 0, result.stderr)
        self.assertEqual(
            result.stdout,
            textwrap.dedent(
                """\
                ### Added
                - First shipped item.

                ### Fixed
                - Second shipped item.
                """
            ),
        )

    def test_fails_when_version_heading_is_missing(self) -> None:
        result = self.run_script(
            textwrap.dedent(
                """\
                # Changelog

                ## [Unreleased]

                ### Added
                - Future work.
                """
            ),
            "9.9.9",
        )

        self.assertEqual(result.returncode, 1)
        self.assertIn("error: release-notes: version 9.9.9 not found", result.stderr)

    def test_fails_when_version_section_has_no_release_notes(self) -> None:
        result = self.run_script(
            textwrap.dedent(
                """\
                # Changelog

                ## [1.2.3] - 2026-03-07

                ## [1.2.2] - 2026-03-01

                ### Fixed
                - Older item.
                """
            ),
            "1.2.3",
        )

        self.assertEqual(result.returncode, 1)
        self.assertIn("error: release-notes: version 1.2.3 section is empty", result.stderr)

    def test_ignores_changelog_reference_links_after_last_release_section(self) -> None:
        result = self.run_script(
            textwrap.dedent(
                """\
                # Changelog

                ## [1.2.3] - 2026-03-07

                ### Fixed
                - Last shipped item.

                [Unreleased]: https://example.com/compare/v1.2.3...HEAD
                [1.2.3]: https://example.com/releases/tag/v1.2.3
                """
            ),
            "1.2.3",
        )

        self.assertEqual(result.returncode, 0, result.stderr)
        self.assertEqual(
            result.stdout,
            textwrap.dedent(
                """\
                ### Fixed
                - Last shipped item.
                """
            ),
        )


if __name__ == "__main__":
    unittest.main()