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
|
import json
import sys
from functools import partial
from textwrap import dedent
import pytest
from pkgcheck import base, reporters
from pkgcheck.checks import codingstyle, git, metadata, metadata_xml, pkgdir, profiles
from pkgcore.test.misc import FakePkg
from snakeoil.formatters import PlainTextFormatter
class BaseReporter:
reporter_cls = reporters.Reporter
@pytest.fixture(autouse=True)
def _setup(self):
self.log_warning = profiles.ProfileWarning(Exception("profile warning"))
self.log_error = profiles.ProfileError(Exception("profile error"))
pkg = FakePkg("dev-libs/foo-0")
self.commit_result = git.InvalidCommitMessage("no commit message", commit="8d86269bb4c7")
self.category_result = metadata_xml.CatMissingMetadataXml("metadata.xml", pkg=pkg)
self.package_result = pkgdir.InvalidPN(("bar", "baz"), pkg=pkg)
self.versioned_result = metadata.BadFilename(("0.tar.gz", "foo.tar.gz"), pkg=pkg)
self.line_result = codingstyle.ReadonlyVariable("P", line="P=6", lineno=7, pkg=pkg)
self.lines_result = codingstyle.EbuildUnquotedVariable("D", lines=(5, 7), pkg=pkg)
def mk_reporter(self, **kwargs):
out = PlainTextFormatter(sys.stdout)
return self.reporter_cls(out, **kwargs)
add_report_output = None
def test_add_report(self, capsys):
with self.mk_reporter() as reporter:
reporter.report(self.commit_result)
reporter.report(self.log_warning)
reporter.report(self.category_result)
reporter.report(self.package_result)
reporter.report(self.versioned_result)
reporter.report(self.line_result)
reporter.report(self.lines_result)
out, err = capsys.readouterr()
assert not err
assert out == self.add_report_output
class TestStrReporter(BaseReporter):
reporter_cls = reporters.StrReporter
add_report_output = dedent(
"""\
commit 8d86269bb4c7: no commit message
profile warning
dev-libs: category is missing metadata.xml
dev-libs/foo: invalid package names: [ bar, baz ]
dev-libs/foo-0: bad filenames: [ 0.tar.gz, foo.tar.gz ]
dev-libs/foo-0: read-only variable 'P' assigned, line 7: P=6
dev-libs/foo-0: unquoted variable D on lines: 5, 7
"""
)
class TestFancyReporter(BaseReporter):
reporter_cls = reporters.FancyReporter
add_report_output = dedent(
"""\
commit
InvalidCommitMessage: commit 8d86269bb4c7: no commit message
profiles
ProfileWarning: profile warning
dev-libs
CatMissingMetadataXml: category is missing metadata.xml
dev-libs/foo
InvalidPN: invalid package names: [ bar, baz ]
BadFilename: version 0: bad filenames: [ 0.tar.gz, foo.tar.gz ]
ReadonlyVariable: version 0: read-only variable 'P' assigned, line 7: P=6
UnquotedVariable: version 0: unquoted variable D on lines: 5, 7
"""
)
class TestJsonReporter(BaseReporter):
reporter_cls = reporters.JsonReporter
add_report_output = dedent(
"""\
{"_style": {"InvalidCommitMessage": "commit 8d86269bb4c7: no commit message"}}
{"_warning": {"ProfileWarning": "profile warning"}}
{"dev-libs": {"_error": {"CatMissingMetadataXml": "category is missing metadata.xml"}}}
{"dev-libs": {"foo": {"_error": {"InvalidPN": "invalid package names: [ bar, baz ]"}}}}
{"dev-libs": {"foo": {"0": {"_warning": {"BadFilename": "bad filenames: [ 0.tar.gz, foo.tar.gz ]"}}}}}
{"dev-libs": {"foo": {"0": {"_warning": {"ReadonlyVariable": "read-only variable 'P' assigned, line 7: P=6"}}}}}
{"dev-libs": {"foo": {"0": {"_warning": {"UnquotedVariable": "unquoted variable D on lines: 5, 7"}}}}}
"""
)
class TestXmlReporter(BaseReporter):
reporter_cls = reporters.XmlReporter
add_report_output = dedent(
"""\
<checks>
<result><class>InvalidCommitMessage</class><msg>commit 8d86269bb4c7: no commit message</msg></result>
<result><class>ProfileWarning</class><msg>profile warning</msg></result>
<result><category>dev-libs</category><class>CatMissingMetadataXml</class><msg>category is missing metadata.xml</msg></result>
<result><category>dev-libs</category><package>foo</package><class>InvalidPN</class><msg>invalid package names: [ bar, baz ]</msg></result>
<result><category>dev-libs</category><package>foo</package><version>0</version><class>BadFilename</class><msg>bad filenames: [ 0.tar.gz, foo.tar.gz ]</msg></result>
<result><category>dev-libs</category><package>foo</package><version>0</version><class>ReadonlyVariable</class><msg>read-only variable 'P' assigned, line 7: P=6</msg></result>
<result><category>dev-libs</category><package>foo</package><version>0</version><class>UnquotedVariable</class><msg>unquoted variable D on lines: 5, 7</msg></result>
</checks>
"""
)
class TestCsvReporter(BaseReporter):
reporter_cls = reporters.CsvReporter
add_report_output = dedent(
"""\
,,,commit 8d86269bb4c7: no commit message
,,,profile warning
dev-libs,,,category is missing metadata.xml
dev-libs,foo,,"invalid package names: [ bar, baz ]"
dev-libs,foo,0,"bad filenames: [ 0.tar.gz, foo.tar.gz ]"
dev-libs,foo,0,"read-only variable 'P' assigned, line 7: P=6"
dev-libs,foo,0,"unquoted variable D on lines: 5, 7"
"""
)
class TestFormatReporter(BaseReporter):
reporter_cls = partial(reporters.FormatReporter, "")
def test_add_report(self, capsys):
for format_str, expected in (
("r", "r\n" * 7),
("{category}", "dev-libs\n" * 5),
("{category}/{package}", "/\n/\ndev-libs/\n" + "dev-libs/foo\n" * 4),
(
"{category}/{package}-{version}",
"/-\n/-\ndev-libs/-\ndev-libs/foo-\n" + "dev-libs/foo-0\n" * 3,
),
(
"{name}",
"InvalidCommitMessage\nProfileWarning\nCatMissingMetadataXml\nInvalidPN\nBadFilename\nReadonlyVariable\nUnquotedVariable\n",
),
("{foo}", ""),
):
self.reporter_cls = partial(reporters.FormatReporter, format_str)
self.add_report_output = expected
super().test_add_report(capsys)
def test_unsupported_index(self, capsys):
self.reporter_cls = partial(reporters.FormatReporter, "{0}")
with self.mk_reporter() as reporter:
with pytest.raises(base.PkgcheckUserException) as excinfo:
reporter.report(self.versioned_result)
assert "integer indexes are not supported" in str(excinfo.value)
class TestJsonStream(BaseReporter):
reporter_cls = reporters.JsonStream
def test_add_report(self, capsys):
with self.mk_reporter() as reporter:
for result in (
self.log_warning,
self.log_error,
self.commit_result,
self.category_result,
self.package_result,
self.versioned_result,
):
reporter.report(result)
out, err = capsys.readouterr()
assert not err
deserialized_result = next(reporter.from_iter([out]))
assert str(deserialized_result) == str(result)
def test_deserialize_error(self):
with self.mk_reporter() as reporter:
# deserializing non-result objects raises exception
obj = reporter.to_json(["result"])
with pytest.raises(reporters.DeserializationError, match="failed loading"):
next(reporter.from_iter([obj]))
# deserializing mangled JSON result objects raises exception
obj = reporter.to_json(self.versioned_result)
del obj["__class__"]
json_obj = json.dumps(obj)
with pytest.raises(reporters.DeserializationError, match="unknown result"):
next(reporter.from_iter([json_obj]))
class TestFlycheckReporter(BaseReporter):
reporter_cls = reporters.FlycheckReporter
add_report_output = dedent(
"""\
-.ebuild:0:style:InvalidCommitMessage: commit 8d86269bb4c7: no commit message
-.ebuild:0:warning:ProfileWarning: profile warning
-.ebuild:0:error:CatMissingMetadataXml: category is missing metadata.xml
foo-.ebuild:0:error:InvalidPN: invalid package names: [ bar, baz ]
foo-0.ebuild:0:warning:BadFilename: bad filenames: [ 0.tar.gz, foo.tar.gz ]
foo-0.ebuild:7:warning:ReadonlyVariable: read-only variable 'P' assigned, line 7: P=6
foo-0.ebuild:5:warning:UnquotedVariable: unquoted variable D
foo-0.ebuild:7:warning:UnquotedVariable: unquoted variable D
"""
)
|
GitWeb