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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
|
from typing import List, Optional, Callable
import pytest
from debputy.packages import DctrlParser
from debputy.plugin.api.feature_set import PluginProvidedFeatureSet
from lint_tests.lint_tutil import (
requires_levenshtein,
LintWrapper,
)
try:
from lsprotocol.types import Diagnostic, DiagnosticSeverity
except ImportError:
pass
@pytest.fixture
def line_linter(
debputy_plugin_feature_set: PluginProvidedFeatureSet,
lint_dctrl_parser: DctrlParser,
) -> LintWrapper:
return LintWrapper(
"/nowhere/debian/debputy.manifest",
_lint_debian_debputy_manifest,
debputy_plugin_feature_set,
lint_dctrl_parser,
)
def test_debputy_lint_unknown_keys(line_linter: LintWrapper) -> None:
lines = textwrap.dedent(
"""\
manifest-version: 0.1
installations:
- install-something:
sources:
- abc
- def
- install-docs:
source: foo
puff: true # Unknown keyword (assuming install-docs)
when:
negated: cross-compiling
- install-docs:
source: bar
when: ross-compiling # Typo of "cross-compiling"; FIXME not caught
packages:
foo:
blah: qwe # Unknown keyword
"""
).splitlines(keepends=True)
diagnostics = line_linter(lines)
by_severity = group_diagnostics_by_severity(diagnostics)
# This example triggers errors only
assert DiagnosticSeverity.Error in by_severity
assert DiagnosticSeverity.Warning not 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) == 4
first_error, second_error, third_error, fourth_error = errors
msg = 'Unknown or unsupported key "install-something".'
assert first_error.message == msg
assert f"{first_error.range}" == "2:2-2:19"
msg = 'Unknown or unsupported key "puff".'
assert second_error.message == msg
assert f"{second_error.range}" == "8:4-8:8"
msg = 'Unknown or unsupported key "negated".'
assert third_error.message == msg
assert f"{third_error.range}" == "10:6-10:13"
msg = 'Unknown or unsupported key "blah".'
assert fourth_error.message == msg
assert f"{fourth_error.range}" == "16:4-16:8"
@requires_levenshtein
def test_debputy_lint_unknown_keys_spelling(line_linter: LintWrapper) -> None:
lines = textwrap.dedent(
"""\
manifest-version: 0.1
installations:
- install-dcoss: # typo
sources:
- abc
- def
puff: true # Unknown keyword (assuming install-docs)
when:
nut: cross-compiling # Typo of "not"
- install-docs:
source: bar
when: ross-compiling # Typo of "cross-compiling"; FIXME not caught
"""
).splitlines(keepends=True)
diagnostics = line_linter(lines)
by_severity = group_diagnostics_by_severity(diagnostics)
# This example triggers errors only
assert DiagnosticSeverity.Error in by_severity
assert DiagnosticSeverity.Warning not 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 = 'Unknown or unsupported key "install-dcoss". It looks like a typo of "install-docs".'
assert first_error.message == msg
assert f"{first_error.range}" == "2:2-2:15"
msg = 'Unknown or unsupported key "puff".'
assert second_error.message == msg
assert f"{second_error.range}" == "6:4-6:8"
msg = 'Unknown or unsupported key "nut". It looks like a typo of "not".'
assert third_error.message == msg
assert f"{third_error.range}" == "8:6-8:9"
def test_debputy_lint_conflicting_keys(line_linter: LintWrapper) -> None:
lines = textwrap.dedent(
"""\
manifest-version: 0.1
installations:
- install-docs:
sources:
- foo
- bar
as: baz # Conflicts with "sources" (#85)
- install:
source: foo
sources: # Conflicts with "source" (#85)
- bar
- baz
"""
).splitlines(keepends=True)
diagnostics = line_linter(lines)
by_severity = group_diagnostics_by_severity(diagnostics)
# This example triggers errors only
assert DiagnosticSeverity.Error in by_severity
assert DiagnosticSeverity.Warning not 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) == 4
first_error, second_error, third_error, fourth_error = errors
msg = 'The "sources" cannot be used with "as".'
assert first_error.message == msg
assert f"{first_error.range}" == "3:4-3:11"
msg = 'The "as" cannot be used with "sources".'
assert second_error.message == msg
assert f"{second_error.range}" == "6:4-6:6"
msg = 'The "source" cannot be used with "sources".'
assert third_error.message == msg
assert f"{third_error.range}" == "8:4-8:10"
msg = 'The "sources" cannot be used with "source".'
assert fourth_error.message == msg
assert f"{fourth_error.range}" == "9:4-9:11"
import textwrap
from typing import List, Optional, Callable
import pytest
from debputy.lsp.lsp_debian_debputy_manifest import _lint_debian_debputy_manifest
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
TestLintWrapper = Callable[[List[str]], Optional[List["Diagnostic"]]]
@pytest.fixture
def line_linter(
debputy_plugin_feature_set: PluginProvidedFeatureSet,
lint_dctrl_parser: DctrlParser,
) -> LintWrapper:
return LintWrapper(
"/nowhere/debian/debputy.manifest",
_lint_debian_debputy_manifest,
debputy_plugin_feature_set,
lint_dctrl_parser,
)
def test_debputy_lint_unknown_keys(line_linter: LintWrapper) -> None:
lines = textwrap.dedent(
"""\
manifest-version: 0.1
installations:
- install-something:
sources:
- abc
- def
- install-docs:
source: foo
puff: true # Unknown keyword (assuming install-docs)
when:
negated: cross-compiling
- install-docs:
source: bar
when: ross-compiling # Typo of "cross-compiling"; FIXME not caught
packages:
foo:
blah: qwe # Unknown keyword
"""
).splitlines(keepends=True)
diagnostics = line_linter(lines)
by_severity = group_diagnostics_by_severity(diagnostics)
# This example triggers errors only
assert DiagnosticSeverity.Error in by_severity
assert DiagnosticSeverity.Warning not 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) == 4
first_error, second_error, third_error, fourth_error = errors
msg = 'Unknown or unsupported key "install-something".'
assert first_error.message == msg
assert f"{first_error.range}" == "2:2-2:19"
msg = 'Unknown or unsupported key "puff".'
assert second_error.message == msg
assert f"{second_error.range}" == "8:4-8:8"
msg = 'Unknown or unsupported key "negated".'
assert third_error.message == msg
assert f"{third_error.range}" == "10:6-10:13"
msg = 'Unknown or unsupported key "blah".'
assert fourth_error.message == msg
assert f"{fourth_error.range}" == "16:4-16:8"
@requires_levenshtein
def test_debputy_lint_unknown_keys_spelling(line_linter: LintWrapper) -> None:
lines = textwrap.dedent(
"""\
manifest-version: 0.1
installations:
- install-dcoss: # typo
sources:
- abc
- def
puff: true # Unknown keyword (assuming install-docs)
when:
nut: cross-compiling # Typo of "not"
- install-docs:
source: bar
when: ross-compiling # Typo of "cross-compiling"; FIXME not caught
"""
).splitlines(keepends=True)
diagnostics = line_linter(lines)
by_severity = group_diagnostics_by_severity(diagnostics)
# This example triggers errors only
assert DiagnosticSeverity.Error in by_severity
assert DiagnosticSeverity.Warning not 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 = 'Unknown or unsupported key "install-dcoss". It looks like a typo of "install-docs".'
assert first_error.message == msg
assert f"{first_error.range}" == "2:2-2:15"
msg = 'Unknown or unsupported key "puff".'
assert second_error.message == msg
assert f"{second_error.range}" == "6:4-6:8"
msg = 'Unknown or unsupported key "nut". It looks like a typo of "not".'
assert third_error.message == msg
assert f"{third_error.range}" == "8:6-8:9"
def test_debputy_lint_check_package_names(line_linter: LintWrapper) -> None:
lines = textwrap.dedent(
"""\
manifest-version: 0.1
packages:
unknown-package:
binary-version: '1:{{DEB_VERSION_UPSTREAM_REVISION}}'
"""
).splitlines(keepends=True)
line_linter.dctrl_lines = None
diagnostics = line_linter(lines)
print(diagnostics)
# Does nothing without a control file
assert not diagnostics
line_linter.dctrl_lines = textwrap.dedent(
"""\
Source: foo
Package: foo
"""
).splitlines(keepends=True)
diagnostics = line_linter(lines)
assert diagnostics and len(diagnostics) == 1
diag = diagnostics[0]
msg = 'Unknown package "unknown-package".'
assert diag.message == msg
assert f"{diag.range}" == "2:4-2:19"
|
