-
Notifications
You must be signed in to change notification settings - Fork 30
/
conftest.py
475 lines (404 loc) · 13.7 KB
/
conftest.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
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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
import datetime
import decimal
import functools
import io
import os
import zipfile
import httpx
import pytest
from coverage_comment import coverage as coverage_module
from coverage_comment import github_client, settings, subprocess
@pytest.fixture
def base_config():
def _(**kwargs):
defaults = {
# GitHub stuff
"GITHUB_TOKEN": "foo",
"GITHUB_PR_RUN_ID": 123,
"GITHUB_REPOSITORY": "py-cov-action/foobar",
# Action settings
"MERGE_COVERAGE_FILES": True,
}
return settings.Config(**(defaults | kwargs))
return _
@pytest.fixture
def push_config(base_config):
def _(**kwargs):
defaults = {
# GitHub stuff
"GITHUB_BASE_REF": "",
"GITHUB_REF": "refs/heads/main",
"GITHUB_EVENT_NAME": "push",
}
return base_config(**(defaults | kwargs))
return _
@pytest.fixture
def pull_request_config(base_config):
def _(**kwargs):
defaults = {
# GitHub stuff
"GITHUB_BASE_REF": "main",
"GITHUB_REF": "refs/pull/2/merge",
"GITHUB_EVENT_NAME": "pull_request",
}
return base_config(**(defaults | kwargs))
return _
@pytest.fixture
def workflow_run_config(base_config):
def _(**kwargs):
defaults = {
# GitHub stuff
"GITHUB_BASE_REF": "",
"GITHUB_REF": "refs/heads/main",
"GITHUB_EVENT_NAME": "workflow_run",
}
return base_config(**(defaults | kwargs))
return _
@pytest.fixture
def coverage_json():
return {
"meta": {
"version": "1.2.3",
"timestamp": "2000-01-01T00:00:00",
"branch_coverage": True,
"show_contexts": False,
},
"files": {
"codebase/code.py": {
"executed_lines": [1, 2, 5, 6, 9],
"summary": {
"covered_lines": 5,
"num_statements": 6,
"percent_covered": 75.0,
"missing_lines": 1,
"excluded_lines": 0,
"num_branches": 2,
"num_partial_branches": 1,
"covered_branches": 1,
"missing_branches": 1,
},
"missing_lines": [7, 9],
"excluded_lines": [],
}
},
"totals": {
"covered_lines": 5,
"num_statements": 6,
"percent_covered": 75.0,
"missing_lines": 1,
"excluded_lines": 0,
"num_branches": 2,
"num_partial_branches": 1,
"covered_branches": 1,
"missing_branches": 1,
},
}
@pytest.fixture
def diff_coverage_json():
return {
"report_name": "XML",
"diff_name": "master...HEAD, staged and unstaged changes",
"src_stats": {
"codebase/code.py": {
"percent_covered": 80.0,
"violation_lines": [9],
"violations": [[9, None]],
}
},
"total_num_lines": 5,
"total_num_violations": 1,
"total_percent_covered": 80,
"num_changed_lines": 39,
}
@pytest.fixture
def coverage_obj():
return coverage_module.Coverage(
meta=coverage_module.CoverageMetadata(
version="1.2.3",
timestamp=datetime.datetime(2000, 1, 1),
branch_coverage=True,
show_contexts=False,
),
info=coverage_module.CoverageInfo(
covered_lines=5,
num_statements=6,
percent_covered=decimal.Decimal("0.75"),
missing_lines=1,
excluded_lines=0,
num_branches=2,
num_partial_branches=1,
covered_branches=1,
missing_branches=1,
),
files={
"codebase/code.py": coverage_module.FileCoverage(
path="codebase/code.py",
executed_lines=[1, 2, 5, 6, 9],
missing_lines=[7, 9],
excluded_lines=[],
info=coverage_module.CoverageInfo(
covered_lines=5,
num_statements=6,
percent_covered=decimal.Decimal("0.75"),
missing_lines=1,
excluded_lines=0,
num_branches=2,
num_partial_branches=1,
covered_branches=1,
missing_branches=1,
),
)
},
)
@pytest.fixture
def coverage_obj_no_branch():
return coverage_module.Coverage(
meta=coverage_module.CoverageMetadata(
version="1.2.3",
timestamp=datetime.datetime(2000, 1, 1),
branch_coverage=False,
show_contexts=False,
),
info=coverage_module.CoverageInfo(
covered_lines=5,
num_statements=6,
percent_covered=decimal.Decimal("0.75"),
missing_lines=1,
excluded_lines=0,
num_branches=None,
num_partial_branches=None,
covered_branches=None,
missing_branches=None,
),
files={
"codebase/code.py": coverage_module.FileCoverage(
path="codebase/code.py",
executed_lines=[1, 2, 5, 6, 9],
missing_lines=[7],
excluded_lines=[],
info=coverage_module.CoverageInfo(
covered_lines=5,
num_statements=6,
percent_covered=decimal.Decimal("0.75"),
missing_lines=1,
excluded_lines=0,
num_branches=None,
num_partial_branches=None,
covered_branches=None,
missing_branches=None,
),
)
},
)
@pytest.fixture
def coverage_obj_many_missing_lines():
return coverage_module.Coverage(
meta=coverage_module.CoverageMetadata(
version="1.2.3",
timestamp=datetime.datetime(2000, 1, 1),
branch_coverage=True,
show_contexts=False,
),
info=coverage_module.CoverageInfo(
covered_lines=7,
num_statements=10,
percent_covered=decimal.Decimal("0.8"),
missing_lines=12,
excluded_lines=0,
num_branches=2,
num_partial_branches=1,
covered_branches=1,
missing_branches=1,
),
files={
"codebase/main.py": coverage_module.FileCoverage(
path="codebase/main.py",
executed_lines=[1, 2, 5, 6, 9],
missing_lines=[3, 7, 13, 21, 123],
excluded_lines=[],
info=coverage_module.CoverageInfo(
covered_lines=5,
num_statements=10,
percent_covered=decimal.Decimal("0.5"),
missing_lines=5,
excluded_lines=0,
num_branches=2,
num_partial_branches=1,
covered_branches=1,
missing_branches=1,
),
),
"codebase/caller.py": coverage_module.FileCoverage(
path="codebase/caller.py",
executed_lines=[1, 2, 5],
missing_lines=[13, 21, 212],
excluded_lines=[],
info=coverage_module.CoverageInfo(
covered_lines=3,
num_statements=6,
percent_covered=decimal.Decimal("0.5"),
missing_lines=3,
excluded_lines=0,
num_branches=2,
num_partial_branches=1,
covered_branches=1,
missing_branches=1,
),
),
},
)
@pytest.fixture
def diff_coverage_obj():
return coverage_module.DiffCoverage(
total_num_lines=5,
total_num_violations=1,
total_percent_covered=decimal.Decimal("0.8"),
num_changed_lines=39,
files={
"codebase/code.py": coverage_module.FileDiffCoverage(
path="codebase/code.py",
percent_covered=decimal.Decimal("0.8"),
violation_lines=[7, 9],
)
},
)
@pytest.fixture
def session(is_failed):
"""
You get a session object. Register responses on it:
session.register(method="GET", path="/a/b")(status_code=200)
or
session.register(method="GET", path="/a/b", json=checker)(status_code=200)
(where checker is a function receiving the json value, and returning True if it
matches)
if session.request(method="GET", path="/a/b") is called, it will return a response
with status_code 200. Also, if not called by the end of the test, it will raise.
"""
class Session:
responses = [] # List[Tuples[request kwargs, response kwargs]]
def request(self, method, path, **kwargs):
request_kwargs = {"method": method, "path": path} | kwargs
for i, (match_kwargs, response_kwargs) in enumerate(self.responses):
match = True
for key, match_value in match_kwargs.items():
if key not in request_kwargs:
match = False
break
request_value = request_kwargs[key]
if hasattr(match_value, "__call__"):
try:
assert match_value(request_value)
except Exception:
match = False
break
else:
if not match_value == request_value:
match = False
break
if match:
self.responses.pop(i)
return httpx.Response(
**response_kwargs,
request=httpx.Request(method=method, url=path),
)
assert (
False
), f"No response found for kwargs {request_kwargs}\nExpected answers are {self.responses}"
def __getattr__(self, value):
if value in ["get", "post", "patch", "delete", "put"]:
return functools.partial(self.request, value.upper())
raise AttributeError(value)
def register(self, method, path, **request_kwargs):
request_kwargs = {"method": method, "path": path} | request_kwargs
def _(**response_kwargs):
response_kwargs.setdefault("status_code", 200)
self.responses.append((request_kwargs, response_kwargs))
return _
session = Session()
yield session
if not is_failed:
assert not session.responses
@pytest.fixture
def gh(session):
return github_client.GitHub(session=session)
@pytest.fixture
def get_logs(caplog):
caplog.set_level("DEBUG")
def _(level=None, match=None):
return [
log.message
for log in caplog.records
if (level is None or level == log.levelname)
and (match is None or match in log.message)
]
return _
@pytest.fixture
def in_tmp_path(tmp_path):
curdir = os.getcwd()
os.chdir(tmp_path)
yield tmp_path
os.chdir(curdir)
@pytest.fixture
def zip_bytes():
def _(filename, content):
file = io.BytesIO()
with zipfile.ZipFile(file, mode="w") as zipf:
with zipf.open(filename, "w") as subfile:
subfile.write(content.encode("utf-8"))
zip_bytes = file.getvalue()
assert zip_bytes.startswith(b"PK")
return zip_bytes
return _
@pytest.fixture
def git(is_failed):
"""
You get a git object. Register calls on it:
git.register("git checkout master")(exit_code=1)
or
session.register("git commit", env={"A": "B"})(stdout="Changed branch")
If the command was not received by the end of the test, it will raise.
"""
class Git:
expected_calls = []
def command(self, command, *args, env=None):
args = " ".join(("git", command, *args))
if not self.expected_calls:
assert (
False
), f"Received command `{args}` with env {env} while expecting nothing."
call = self.expected_calls[0]
exp_args, exp_env, exit_code, stdout = call
if not (args == exp_args and (not exp_env or exp_env == env)):
assert (
False
), f"Expected command is not `{args}` with env {env}\nExpected command is {self.expected_calls[0]}"
self.expected_calls.pop(0)
if exit_code == 0:
return stdout
raise subprocess.GitError
def __getattr__(self, value):
return functools.partial(self.command, value.replace("_", "-"))
def register(self, command, env=None):
def _(*, exit_code=0, stdout=""):
self.expected_calls.append((command, env, exit_code, stdout))
return _
git = Git()
yield git
if not is_failed:
assert not git.expected_calls
@pytest.fixture
def output_file(tmp_path):
file = tmp_path / "temp_output.txt"
file.touch()
return file
_is_failed = []
def pytest_runtest_logreport(report):
if report.outcome == "failed":
_is_failed.append(True)
@pytest.fixture
def is_failed():
_is_failed.clear()
def f():
return bool(_is_failed)
yield f
_is_failed.clear()