forked from pantsbuild/pants
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lint_test.py
321 lines (255 loc) · 8.79 KB
/
lint_test.py
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
# Copyright 2019 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).
from __future__ import annotations
from abc import ABCMeta, abstractmethod
from pathlib import Path
from textwrap import dedent
from typing import Iterable, Optional, Sequence, Tuple, Type
import pytest
from pants.core.goals.lint import (
Lint,
LintFilesRequest,
LintResult,
LintResults,
LintSubsystem,
LintTargetsRequest,
lint,
)
from pants.core.util_rules.distdir import DistDir
from pants.engine.addresses import Address
from pants.engine.fs import SpecsSnapshot, Workspace
from pants.engine.target import FieldSet, MultipleSourcesField, Target, Targets
from pants.engine.unions import UnionMembership
from pants.testutil.option_util import create_goal_subsystem
from pants.testutil.rule_runner import MockGet, RuleRunner, mock_console, run_rule_with_mocks
from pants.util.logging import LogLevel
class MockTarget(Target):
alias = "mock_target"
core_fields = (MultipleSourcesField,)
class MockLinterFieldSet(FieldSet):
required_fields = (MultipleSourcesField,)
class MockLintRequest(LintTargetsRequest, metaclass=ABCMeta):
field_set_type = MockLinterFieldSet
@staticmethod
@abstractmethod
def exit_code(_: Iterable[Address]) -> int:
pass
@property
def lint_results(self) -> LintResults:
addresses = [config.address for config in self.field_sets]
return LintResults([LintResult(self.exit_code(addresses), "", "")], linter_name=self.name)
class SuccessfulRequest(MockLintRequest):
name = "SuccessfulLinter"
@staticmethod
def exit_code(_: Iterable[Address]) -> int:
return 0
class FailingRequest(MockLintRequest):
name = "FailingLinter"
@staticmethod
def exit_code(_: Iterable[Address]) -> int:
return 1
class ConditionallySucceedsRequest(MockLintRequest):
name = "ConditionallySucceedsLinter"
@staticmethod
def exit_code(addresses: Iterable[Address]) -> int:
if any(address.target_name == "bad" for address in addresses):
return 127
return 0
class SkippedRequest(MockLintRequest):
name = "SkippedLinter"
@staticmethod
def exit_code(_) -> int:
return 0
@property
def lint_results(self) -> LintResults:
return LintResults([], linter_name=self.name)
class InvalidField(MultipleSourcesField):
pass
class InvalidFieldSet(MockLinterFieldSet):
required_fields = (InvalidField,)
class InvalidRequest(MockLintRequest):
field_set_type = InvalidFieldSet
name = "InvalidLinter"
@staticmethod
def exit_code(_: Iterable[Address]) -> int:
return -1
class MockFilesRequest(LintFilesRequest):
name = "FilesLinter"
@property
def lint_results(self) -> LintResults:
return LintResults([LintResult(0, "", "")], linter_name=self.name)
@pytest.fixture
def rule_runner() -> RuleRunner:
return RuleRunner()
def make_target(address: Optional[Address] = None) -> Target:
return MockTarget({}, address or Address("", target_name="tests"))
def run_lint_rule(
rule_runner: RuleRunner,
*,
lint_request_types: Sequence[Type[LintTargetsRequest]],
targets: list[Target],
run_files_linter: bool = False,
per_file_caching: bool = False,
batch_size: int = 128,
only: list[str] | None = None,
) -> Tuple[int, str]:
union_membership = UnionMembership(
{
LintTargetsRequest: lint_request_types,
LintFilesRequest: [MockFilesRequest] if run_files_linter else [],
}
)
lint_subsystem = create_goal_subsystem(
LintSubsystem,
per_file_caching=per_file_caching,
batch_size=batch_size,
only=only or [],
)
specs_snapshot = SpecsSnapshot(rule_runner.make_snapshot_of_empty_files(["f.txt"]))
with mock_console(rule_runner.options_bootstrapper) as (console, stdio_reader):
result: Lint = run_rule_with_mocks(
lint,
rule_args=[
console,
Workspace(rule_runner.scheduler, _enforce_effects=False),
Targets(targets),
specs_snapshot,
lint_subsystem,
union_membership,
DistDir(relpath=Path("dist")),
],
mock_gets=[
MockGet(
output_type=LintResults,
input_type=LintTargetsRequest,
mock=lambda mock_request: mock_request.lint_results,
),
MockGet(
output_type=LintResults,
input_type=LintFilesRequest,
mock=lambda mock_request: mock_request.lint_results,
),
],
union_membership=union_membership,
)
assert not stdio_reader.get_stdout()
return result.exit_code, stdio_reader.get_stderr()
@pytest.mark.parametrize("per_file_caching", [True, False])
def test_invalid_target_noops(rule_runner: RuleRunner, per_file_caching: bool) -> None:
exit_code, stderr = run_lint_rule(
rule_runner,
lint_request_types=[InvalidRequest],
targets=[make_target()],
per_file_caching=per_file_caching,
)
assert exit_code == 0
assert stderr == ""
@pytest.mark.parametrize("per_file_caching", [True, False])
def test_summary(rule_runner: RuleRunner, per_file_caching: bool) -> None:
"""Test that we render the summary correctly.
This tests that we:
* Merge multiple results belonging to the same linter (`--per-file-caching`).
* Decide correctly between skipped, failed, and succeeded.
"""
good_address = Address("", target_name="good")
bad_address = Address("", target_name="bad")
request_types = [
ConditionallySucceedsRequest,
FailingRequest,
SkippedRequest,
SuccessfulRequest,
]
targets = [make_target(good_address), make_target(bad_address)]
exit_code, stderr = run_lint_rule(
rule_runner,
lint_request_types=request_types,
targets=targets,
per_file_caching=per_file_caching,
run_files_linter=True,
)
assert exit_code == FailingRequest.exit_code([bad_address])
assert stderr == dedent(
"""\
✕ ConditionallySucceedsLinter failed.
✕ FailingLinter failed.
✓ FilesLinter succeeded.
✓ SuccessfulLinter succeeded.
"""
)
exit_code, stderr = run_lint_rule(
rule_runner,
lint_request_types=request_types,
targets=targets,
per_file_caching=per_file_caching,
run_files_linter=True,
only=[FailingRequest.name, MockFilesRequest.name],
)
assert stderr == dedent(
"""\
✕ FailingLinter failed.
✓ FilesLinter succeeded.
"""
)
@pytest.mark.parametrize("batch_size", [1, 32, 128, 1024])
def test_batched(rule_runner: RuleRunner, batch_size: int) -> None:
exit_code, stderr = run_lint_rule(
rule_runner,
lint_request_types=[
ConditionallySucceedsRequest,
FailingRequest,
SkippedRequest,
SuccessfulRequest,
],
targets=[make_target(Address("", target_name=f"good{i}")) for i in range(0, 512)],
batch_size=batch_size,
)
assert exit_code == FailingRequest.exit_code([])
assert stderr == dedent(
"""\
✓ ConditionallySucceedsLinter succeeded.
✕ FailingLinter failed.
✓ SuccessfulLinter succeeded.
"""
)
def test_streaming_output_skip() -> None:
results = LintResults([], linter_name="linter")
assert results.level() == LogLevel.DEBUG
assert results.message() == "linter skipped."
def test_streaming_output_success() -> None:
results = LintResults([LintResult(0, "stdout", "stderr")], linter_name="linter")
assert results.level() == LogLevel.INFO
assert results.message() == dedent(
"""\
linter succeeded.
stdout
stderr
"""
)
def test_streaming_output_failure() -> None:
results = LintResults([LintResult(18, "stdout", "stderr")], linter_name="linter")
assert results.level() == LogLevel.ERROR
assert results.message() == dedent(
"""\
linter failed (exit code 18).
stdout
stderr
"""
)
def test_streaming_output_partitions() -> None:
results = LintResults(
[
LintResult(21, "", "", partition_description="ghc8.1"),
LintResult(0, "stdout", "stderr", partition_description="ghc9.2"),
],
linter_name="linter",
)
assert results.level() == LogLevel.ERROR
assert results.message() == dedent(
"""\
linter failed (exit code 21).
Partition #1 - ghc8.1:
Partition #2 - ghc9.2:
stdout
stderr
"""
)