Coverage for tests / test_prepare_release.py: 100%
97 statements
« prev ^ index » next coverage.py v7.13.1, created at 2026-11-18 11:12 +0000
« prev ^ index » next coverage.py v7.13.1, created at 2026-11-18 11:12 +0000
1from datetime import date 1abcdefghij
2from pathlib import Path 1abcdefghij
4import pytest 1abcdefghij
5from typer.testing import CliRunner 1abcdefghij
7from scripts.prepare_release import ( 1abcdefghij
8 BumpType,
9 app,
10 bump_version,
11 get_release_notes_body,
12 update_release_notes,
13 update_version_file,
14)
16runner = CliRunner() 1abcdefghij
19@pytest.mark.parametrize( 1abcdefghij
20 ("current_version", "bump", "new_version"),
21 [
22 ("0.26.2", "major", "1.0.0"),
23 ("0.26.2", "minor", "0.27.0"),
24 ("0.26.2", "patch", "0.26.3"),
25 ],
26)
27def test_bump_version(current_version: str, bump: BumpType, new_version: str) -> None: 1abcdefghij
28 assert bump_version(current_version, bump) == new_version 1abcdefghij
31def test_update_version_file() -> None: 1abcdefghij
32 content = '"""Typer."""\n\n__version__ = "0.26.2"\n' 1abcdefghij
34 new_content = update_version_file(content, "0.26.3", Path("typer/__init__.py")) 1abcdefghij
36 assert new_content == '"""Typer."""\n\n__version__ = "0.26.3"\n' 1abcdefghij
39def test_update_version_file_requires_newer_version() -> None: 1abcdefghij
40 content = '__version__ = "0.26.2"\n' 1abcdefghij
42 with pytest.raises(RuntimeError, match="must be greater"): 1abcdefghij
43 update_version_file(content, "0.26.2", Path("typer/__init__.py")) 1abcdefghij
46def test_update_release_notes() -> None: 1abcdefghij
47 content = """# Release Notes 1abcdefghij
49## Latest Changes
51### Fixes
53* Fix something.
55## 0.26.2 (2026-05-27)
57### Fixes
59* Previous fix.
60"""
62 new_content = update_release_notes( 1abcdefghij
63 content, "0.26.3", date(2026, 5, 28), Path("docs/release-notes.md")
64 )
66 assert ( 1abcdefghij
67 new_content
68 == """# Release Notes
70## Latest Changes
72## 0.26.3 (2026-05-28)
74### Fixes
76* Fix something.
78## 0.26.2 (2026-05-27)
80### Fixes
82* Previous fix.
83"""
84 )
87def test_update_release_notes_rejects_existing_version() -> None: 1abcdefghij
88 content = """# Release Notes 1abcdefghij
90## Latest Changes
92## 0.26.3 (2026-05-28)
93"""
95 with pytest.raises(RuntimeError, match="already contain"): 1abcdefghij
96 update_release_notes( 1abcdefghij
97 content, "0.26.3", date(2026, 5, 28), Path("docs/release-notes.md")
98 )
101def test_get_release_notes_body_with_dated_heading() -> None: 1abcdefghij
102 content = """# Release Notes 1abcdefghij
104## Latest Changes
106## 0.26.3 (2026-05-28)
108### Fixes
110* Fix something.
112## 0.26.2 (2026-05-27)
114### Fixes
116* Previous fix.
117"""
119 body = get_release_notes_body(content, "0.26.3", Path("docs/release-notes.md")) 1abcdefghij
121 assert ( 1abcdefghij
122 body
123 == """### Fixes
125* Fix something.
126"""
127 )
130def test_get_release_notes_body_with_plain_heading() -> None: 1abcdefghij
131 content = """# Release Notes 1abcdefghij
133## Latest Changes
135## 0.26.3
137### Fixes
139* Fix something.
140"""
142 body = get_release_notes_body(content, "0.26.3", Path("docs/release-notes.md")) 1abcdefghij
144 assert body == "### Fixes\n\n* Fix something.\n" 1abcdefghij
147def test_get_release_notes_body_allows_non_version_h2_content() -> None: 1abcdefghij
148 content = """# Release Notes 1abcdefghij
150## Latest Changes
152## 0.26.3
154## Highlights
156* Fix something.
158## 0.26.2
160* Previous fix.
161"""
163 body = get_release_notes_body(content, "0.26.3", Path("docs/release-notes.md")) 1abcdefghij
165 assert body == "## Highlights\n\n* Fix something.\n" 1abcdefghij
168def test_get_release_notes_body_requires_version_section() -> None: 1abcdefghij
169 content = "# Release Notes\n\n## Latest Changes\n" 1abcdefghij
171 with pytest.raises(RuntimeError, match="Could not find"): 1abcdefghij
172 get_release_notes_body(content, "0.26.3", Path("docs/release-notes.md")) 1abcdefghij
175def test_get_release_notes_body_requires_non_empty_section() -> None: 1abcdefghij
176 content = """# Release Notes 1abcdefghij
178## Latest Changes
180## 0.26.3
182## 0.26.2
184* Previous fix.
185"""
187 with pytest.raises(RuntimeError, match="is empty"): 1abcdefghij
188 get_release_notes_body(content, "0.26.3", Path("docs/release-notes.md")) 1abcdefghij
191def test_cli_updates_configured_files(tmp_path: Path) -> None: 1abcdefghij
192 version_file = tmp_path / "package" / "__init__.py" 1abcdefghij
193 version_file.parent.mkdir() 1abcdefghij
194 version_file.write_text('__version__ = "0.26.2"\n') 1abcdefghij
195 release_notes_file = tmp_path / "release-notes.md" 1abcdefghij
196 release_notes_file.write_text( 1abcdefghij
197 """# Release Notes
199## Latest Changes
201### Fixes
203* Fix something.
204"""
205 )
207 result = runner.invoke( 1abcdefghij
208 app,
209 [
210 "prepare",
211 "patch",
212 "--version-file",
213 str(version_file),
214 "--release-notes-file",
215 str(release_notes_file),
216 "--date",
217 "2026-05-28",
218 ],
219 )
221 assert result.exit_code == 0, result.output 1abcdefghij
222 assert "Prepared release 0.26.3 (2026-05-28)" in result.output 1abcdefghij
223 assert version_file.read_text() == '__version__ = "0.26.3"\n' 1abcdefghij
224 assert "## 0.26.3 (2026-05-28)" in release_notes_file.read_text() 1abcdefghij
227def test_cli_accepts_env_vars(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None: 1abcdefghij
228 version_file = tmp_path / "package" / "__init__.py" 1abcdefghij
229 version_file.parent.mkdir() 1abcdefghij
230 version_file.write_text('__version__ = "0.26.2"\n') 1abcdefghij
231 release_notes_file = tmp_path / "docs" / "release-notes.md" 1abcdefghij
232 release_notes_file.parent.mkdir() 1abcdefghij
233 release_notes_file.write_text("# Release Notes\n\n## Latest Changes\n") 1abcdefghij
234 monkeypatch.setenv("PREPARE_RELEASE_BUMP", "minor") 1abcdefghij
235 monkeypatch.setenv("PREPARE_RELEASE_VERSION_FILE", str(version_file)) 1abcdefghij
236 monkeypatch.setenv("PREPARE_RELEASE_RELEASE_NOTES_FILE", str(release_notes_file)) 1abcdefghij
237 monkeypatch.setenv("PREPARE_RELEASE_DATE", "2026-05-28") 1abcdefghij
239 result = runner.invoke(app, ["prepare"]) 1abcdefghij
241 assert result.exit_code == 0, result.output 1abcdefghij
242 assert "Prepared release 0.27.0 (2026-05-28)" in result.output 1abcdefghij
243 assert version_file.read_text() == '__version__ = "0.27.0"\n' 1abcdefghij
244 assert "## 0.27.0 (2026-05-28)" in release_notes_file.read_text() 1abcdefghij
247def test_cli_prints_current_version(tmp_path: Path) -> None: 1abcdefghij
248 version_file = tmp_path / "package" / "__init__.py" 1abcdefghij
249 version_file.parent.mkdir() 1abcdefghij
250 version_file.write_text('__version__ = "0.26.2"\n') 1abcdefghij
252 result = runner.invoke( 1abcdefghij
253 app,
254 [
255 "current-version",
256 "--version-file",
257 str(version_file),
258 ],
259 )
261 assert result.exit_code == 0, result.output 1abcdefghij
262 assert result.output == "0.26.2\n" 1abcdefghij
265def test_cli_prints_release_notes_with_agent_skills_note(tmp_path: Path) -> None: 1abcdefghij
266 version_file = tmp_path / "package" / "__init__.py" 1abcdefghij
267 version_file.parent.mkdir() 1abcdefghij
268 version_content = '__version__ = "0.26.3"\n' 1abcdefghij
269 version_file.write_text(version_content) 1abcdefghij
270 release_notes_file = tmp_path / "release-notes.md" 1abcdefghij
271 notes_content = """# Release Notes 1abcdefghij
273## Latest Changes
275### Fixes
277* Unreleased fix.
279## 0.26.3 (2026-05-28)
281### Fixes
283* Fix something.
285## 0.26.2 (2026-05-23)
287### Fixes
289* Previous fix.
290"""
291 release_notes_file.write_text(notes_content) 1abcdefghij
293 result = runner.invoke( 1abcdefghij
294 app,
295 [
296 "release-notes",
297 "--version-file",
298 str(version_file),
299 "--release-notes-file",
300 str(release_notes_file),
301 ],
302 )
304 assert result.exit_code == 0, result.output 1abcdefghij
305 note, separator, body = result.output.partition("\n\n") 1abcdefghij
306 assert note.startswith("> Typer includes an official skill") 1abcdefghij
307 assert note.count("`uvx library-skills`") == 1 1abcdefghij
308 assert "[Develop with AI](https://typer.tiangolo.com/ai-development/)" in note 1abcdefghij
309 assert separator 1abcdefghij
310 assert body == "### Fixes\n\n* Fix something.\n" 1abcdefghij
311 assert release_notes_file.read_text() == notes_content 1abcdefghij
312 assert version_file.read_text() == version_content 1abcdefghij