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
|
import textwrap
from typing import List, Optional
import pytest
from debputy.lsp.lsp_debian_control import _lint_debian_control
from debputy.packages import DctrlParser
from debputy.plugin.api.feature_set import PluginProvidedFeatureSet
from lint_tests.lint_tutil import (
group_diagnostics_by_severity,
requires_levenshtein,
LintWrapper,
)
try:
from lsprotocol.types import Diagnostic, DiagnosticSeverity
except ImportError:
pass
STANDARDS_VERSION = "4.7.0"
class DctrlLintWrapper(LintWrapper):
def __call__(self, lines: List[str]) -> Optional[List["Diagnostic"]]:
try:
self.dctrl_lines = lines
return super().__call__(lines)
finally:
self.dctrl_lines = None
@pytest.fixture
def line_linter(
debputy_plugin_feature_set: PluginProvidedFeatureSet,
lint_dctrl_parser: DctrlParser,
) -> LintWrapper:
return DctrlLintWrapper(
"/nowhere/debian/control",
_lint_debian_control,
debputy_plugin_feature_set,
lint_dctrl_parser,
)
def test_dctrl_lint(line_linter: LintWrapper) -> None:
lines = textwrap.dedent(
"""\
Source: foo
Some-Other-Field: bar
Build-Depends: debhelper-compat (= 13)
Package: foo
Architecture: all
# Unknown section
Section: base
"""
).splitlines(keepends=True)
diagnostics = line_linter(lines)
by_severity = group_diagnostics_by_severity(diagnostics)
# This example triggers errors and warnings, but no hint of info
assert DiagnosticSeverity.Error in by_severity
assert DiagnosticSeverity.Warning in by_severity
assert DiagnosticSeverity.Hint not in by_severity
assert DiagnosticSeverity.Information not in by_severity
errors = by_severity[DiagnosticSeverity.Error]
print(errors)
assert len(errors) == 3
first_error, second_error, third_error = errors
msg = "Stanza is missing field Standards-Version"
assert first_error.message == msg
assert f"{first_error.range}" == "0:0-1:0"
msg = "Stanza is missing field Maintainer"
assert second_error.message == msg
assert f"{second_error.range}" == "0:0-1:0"
msg = "Stanza is missing field Priority"
assert third_error.message == msg
assert f"{third_error.range}" == "4:0-5:0"
warnings = by_severity[DiagnosticSeverity.Warning]
assert len(warnings) == 2
first_warn, second_warn = warnings
msg = "Stanza is missing field Description"
assert first_warn.message == msg
assert f"{first_warn.range}" == "4:0-5:0"
msg = 'The value "base" is not supported in Section.'
assert second_warn.message == msg
assert f"{second_warn.range}" == "7:9-7:13"
@requires_levenshtein
def test_dctrl_lint_typos(line_linter: LintWrapper) -> None:
lines = textwrap.dedent(
f"""\
Source: foo
Standards-Version: {STANDARDS_VERSION}
Priority: optional
Section: devel
Maintainer: Jane Developer <jane@example.com>
# Typo
Build-Dpends: debhelper-compat (= 13)
Package: foo
Architecture: all
Description: Some very interesting synopsis
A very interesting description
that spans multiple lines
.
Just so be clear, this is for a test.
"""
).splitlines(keepends=True)
diagnostics = line_linter(lines)
print(diagnostics)
assert diagnostics and len(diagnostics) == 1
diag = diagnostics[0]
msg = 'The "Build-Dpends" looks like a typo of "Build-Depends".'
assert diag.message == msg
assert diag.severity == DiagnosticSeverity.Warning
assert f"{diag.range}" == "6:0-6:12"
@requires_levenshtein
def test_dctrl_lint_mx_value_with_typo(line_linter: LintWrapper) -> None:
lines = textwrap.dedent(
f"""\
Source: foo
Standards-Version: {STANDARDS_VERSION}
Priority: optional
Section: devel
Maintainer: Jane Developer <jane@example.com>
Build-Depends: debhelper-compat (= 13)
Package: foo
# Typo of `all`
Architecture: linux-any alle
Description: Some very interesting synopsis
A very interesting description
that spans multiple lines
.
Just so be clear, this is for a test.
"""
).splitlines(keepends=True)
diagnostics = line_linter(lines)
print(diagnostics)
assert diagnostics is not None
assert len(diagnostics) == 2
by_severity = group_diagnostics_by_severity(diagnostics)
assert DiagnosticSeverity.Error in by_severity
assert DiagnosticSeverity.Warning in by_severity
typo_diag = by_severity[DiagnosticSeverity.Warning][0]
mx_diag = by_severity[DiagnosticSeverity.Error][0]
mx_msg = 'The value "all" cannot be used with other values.'
typo_msg = 'It is possible that the value is a typo of "all".'
assert mx_diag.message == mx_msg
assert typo_diag.message == typo_msg
assert f"{mx_diag.range}" == "9:24-9:28"
assert f"{typo_diag.range}" == "9:24-9:28"
def test_dctrl_lint_mx_value(line_linter: LintWrapper) -> None:
lines = textwrap.dedent(
f"""\
Source: foo
Standards-Version: {STANDARDS_VERSION}
Priority: optional
Section: devel
Maintainer: Jane Developer <jane@example.com>
Build-Depends: debhelper-compat (= 13)
Package: foo
Architecture: all linux-any
Description: Some very interesting synopsis
A very interesting description
that spans multiple lines
.
Just so be clear, this is for a test.
"""
).splitlines(keepends=True)
diagnostics = line_linter(lines)
print(diagnostics)
assert diagnostics and len(diagnostics) == 1
diag = diagnostics[0]
msg = 'The value "all" cannot be used with other values.'
assert diag.message == msg
assert diag.severity == DiagnosticSeverity.Error
assert f"{diag.range}" == "8:14-8:17"
lines = textwrap.dedent(
f"""\
Source: foo
Standards-Version: {STANDARDS_VERSION}
Priority: optional
Section: devel
Maintainer: Jane Developer <jane@example.com>
Build-Depends: debhelper-compat (= 13)
Package: foo
Architecture: linux-any any
Description: Some very interesting synopsis
A very interesting description
that spans multiple lines
.
Just so be clear, this is for a test.
"""
).splitlines(keepends=True)
diagnostics = line_linter(lines)
print(diagnostics)
assert diagnostics and len(diagnostics) == 1
diag = diagnostics[0]
msg = 'The value "any" cannot be used with other values.'
assert diag.message == msg
assert diag.severity == DiagnosticSeverity.Error
assert f"{diag.range}" == "8:24-8:27"
def test_dctrl_lint_dup_sep(line_linter: LintWrapper) -> None:
lines = textwrap.dedent(
f"""\
Source: foo
Section: devel
Priority: optional
Standards-Version: {STANDARDS_VERSION}
Maintainer: Jane Developer <jane@example.com>
Build-Depends: debhelper-compat (= 13)
Package: foo
Architecture: all
Depends: foo,
, bar
Description: Some very interesting synopsis
A very interesting description
that spans multiple lines
.
Just so be clear, this is for a test.
"""
).splitlines(keepends=True)
diagnostics = line_linter(lines)
print(diagnostics)
assert diagnostics and len(diagnostics) == 1
error = diagnostics[0]
msg = "Duplicate separator"
assert error.message == msg
assert f"{error.range}" == "10:1-10:2"
assert error.severity == DiagnosticSeverity.Error
|
