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
|
# SPDX-FileCopyrightText: 2024-present Hinrich Mahler <chango@mahlerhome.de>
#
# SPDX-License-Identifier: MIT
import pytest
from chango.concrete.sections import (
GitHubSectionChangeNote,
PullRequest,
Section,
SectionChangeNote,
SectionVersionNote,
)
from chango.error import UnsupportedMarkupError
class DummySectionChangeNote(
GitHubSectionChangeNote.with_sections(
[
Section(uid="req_section", title="Required Section", is_required=True, sort_order=10),
Section(uid="opt_section", title="Optional Section", render_pr_details=False),
]
)
):
OWNER = "my-username"
REPOSITORY = "my-repo"
OtherSectionChangeNote = GitHubSectionChangeNote.with_sections(
[Section(uid="req_section", title="Required Section", is_required=True)]
)
@pytest.fixture
def section_version_note():
return SectionVersionNote(None, DummySectionChangeNote)
class TestSectionVersionNote:
def test_init_invalid_markup(self):
class InvalidSectionChangeNote(SectionChangeNote):
MARKUP = "invalid"
with pytest.raises(UnsupportedMarkupError, match="only supports reStructuredText"):
SectionVersionNote(None, InvalidSectionChangeNote)
def test_setitem_invalid_type(self, section_version_note):
other_section_change_note = OtherSectionChangeNote(slug="slug", req_section="req_section")
with pytest.raises(TypeError, match="Expected a"):
section_version_note["key"] = other_section_change_note
with pytest.raises(TypeError, match="Expected a"):
section_version_note.add_change_note(other_section_change_note)
def test_render_unknown_markup(self, section_version_note):
with pytest.raises(UnsupportedMarkupError, match="unknown"):
section_version_note.render("unknown")
def test_render_unsupported_markup(self, section_version_note):
with pytest.raises(UnsupportedMarkupError, match="markdown"):
section_version_note.render("markdown")
def test_render(self, section_version_note):
section_version_note.add_change_note(
DummySectionChangeNote(
slug="slug1",
uid="uid1",
req_section="change note 1 req.\nWith multiple lines.",
opt_section="change note 1 opt.",
pull_requests=[
PullRequest(
uid="pr1", closes_threads=("thread1", "thread2"), author_uids=("author1",)
),
PullRequest(uid="pr2", author_uids=("author2",)),
],
)
)
section_version_note.add_change_note(
DummySectionChangeNote(slug="slug2", uid="uid2", req_section="change note 2 req.")
)
section_version_note.add_change_note(
DummySectionChangeNote(
slug="slug3",
uid="uid3",
req_section="change note 3 req.",
pull_requests=[PullRequest(uid="pr_a", author_uids=("author_b", "author_c"))],
)
)
assert (
section_version_note.render("rst")
== """\
Optional Section
----------------
- change note 1 opt.
Required Section
----------------
- change note 1 req.
With multiple lines.
(`#pr1 <https://github.com/my-username/my-repo/pull/pr1>`_ by `@author1 \
<https://github.com/author1>`_ closes `#thread1 \
<https://github.com/my-username/my-repo/issues/thread1>`_, `#thread2 \
<https://github.com/my-username/my-repo/issues/thread2>`_; `#pr2 \
<https://github.com/my-username/my-repo/pull/pr2>`_ by `@author2 <https://github.com/author2>`_)
- change note 2 req.
- change note 3 req. (`#pr_a <https://github.com/my-username/my-repo/pull/pr_a>`_ by \
`@author_b <https://github.com/author_b>`_, `@author_c <https://github.com/author_c>`_)\
"""
)
|
