{{ message }}
Repository navigation
Expand file tree
/
Copy pathtest_upload_coverage.py
More file actions
611 lines (457 loc) · 22.8 KB
/
Copy pathtest_upload_coverage.py
File metadata and controls
611 lines (457 loc) · 22.8 KB
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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
import base64
import gzip
import io
import json
import re
import shutil
import unittest
from contextlib import redirect_stdout
from pathlib import Path
from tempfile import mkdtemp
from unittest import mock
from unittest.mock import patch
from urllib.error import URLError
import upload_coverage
class FakeResponse:
def __init__(self, status=201, body=b""):
self.status = status
self.body = body
def __enter__(self):
return self
def __exit__(self, exc_type, exc, tb):
return False
def read(self):
return self.body
def getcode(self):
return self.status
class FakeTime:
def __init__(self):
self.now = 0.0
def monotonic(self):
return self.now
def sleep(self, seconds):
self.now += seconds
class UploadCoverageTests(unittest.TestCase):
def setUp(self):
self.test_dir = Path(mkdtemp(dir=Path(__file__).parent))
self.coverage_file = self.test_dir / "coverage.xml"
self.coverage_contents = b'<coverage branch-rate="0.5" />\n'
self.coverage_file.write_bytes(self.coverage_contents)
self.base_env = {
"INPUT_FILE": str(self.coverage_file),
"INPUT_LANGUAGE": "Python",
"INPUT_LABEL": "code-coverage/test",
"COMMIT_OID": "deadbeef",
"REF": "refs/heads/main",
"PR_NUMBER": "",
"GITHUB_REPOSITORY": "octo-org/octo-repo",
"GITHUB_API_URL": "https://api.github.com",
"GH_TOKEN": "test-token",
"FAIL_ON_ERROR": "true",
"WAIT_FOR_PROCESSING_TIMEOUT": "0",
}
def tearDown(self):
shutil.rmtree(self.test_dir)
def successful_opener(self):
return mock.Mock(
side_effect=[
FakeResponse(status=201, body=b'{"id":"b814ebc9-8d00-47b7-b08e-575796cccd03"}'),
FakeResponse(status=200, body=b'{"processing_status":"succeeded","errors":[]}'),
]
)
def run_main(self, env=None, opener=None, status_opener=None):
stdout = io.StringIO()
opener = opener or self.successful_opener()
status_opener = status_opener or mock.Mock(return_value=FakeResponse())
with redirect_stdout(stdout):
fake_time = FakeTime()
with (
patch("upload_coverage.time.monotonic", side_effect=fake_time.monotonic),
patch("upload_coverage.time.sleep", side_effect=fake_time.sleep),
):
exit_code = upload_coverage.main(
environ=env or self.base_env,
opener=opener,
status_opener=status_opener,
)
return exit_code, stdout.getvalue(), opener
def request_payload(self, opener):
request = opener.call_args.args[0]
return json.loads(request.data.decode("utf-8"))
# --- File validation ---
def test_file_not_found_exits_with_error_annotation(self):
env = dict(self.base_env, INPUT_FILE=str(self.test_dir / "missing.xml"))
exit_code, output, opener = self.run_main(env=env)
self.assertEqual(1, exit_code)
self.assertIn("::error::Coverage file not found", output)
opener.assert_not_called()
# --- Successful uploads ---
def test_successful_with_pr_number_uses_pull_request_number(self):
env = dict(self.base_env, REF="", PR_NUMBER="42")
exit_code, _, opener = self.run_main(env=env)
payload = self.request_payload(opener)
self.assertEqual(0, exit_code)
self.assertEqual(42, payload["pull_request_number"])
self.assertNotIn("ref", payload)
def test_successful_with_ref_uses_ref_and_omits_pull_request_number(self):
exit_code, _, opener = self.run_main()
payload = self.request_payload(opener)
self.assertEqual("refs/heads/main", payload["ref"])
self.assertNotIn("pull_request_number", payload)
# --- Waiting for processing ---
def test_200_without_coverage_id_skips_processing(self):
env = dict(self.base_env, WAIT_FOR_PROCESSING_TIMEOUT="10")
opener = mock.Mock(
return_value=FakeResponse(
status=200,
body=b'{"message":"commit is not the latest commit on the branch"}',
)
)
exit_code, output, _ = self.run_main(opener=opener, env=env)
self.assertEqual(0, exit_code)
self.assertIn("::warning::Skipped coverage processing", output)
self.assertIn("commit is not the latest commit on the branch", output)
self.assertNotIn("Waiting for processing to finish", output)
opener.assert_called_once()
def test_200_without_coverage_id_warns_when_waiting_is_disabled(self):
opener = mock.Mock(return_value=FakeResponse(status=200, body=b"{}"))
exit_code, output, _ = self.run_main(opener=opener)
self.assertEqual(0, exit_code)
self.assertIn("::warning::Skipped coverage processing", output)
opener.assert_called_once()
def test_201_without_coverage_id_fails(self):
opener = mock.Mock(return_value=FakeResponse(status=201, body=b"{}"))
exit_code, output, _ = self.run_main(opener=opener)
self.assertEqual(1, exit_code)
self.assertIn("response did not include an upload id", output)
def test_waits_for_processing_after_successful_upload(self):
env = dict(self.base_env, WAIT_FOR_PROCESSING_TIMEOUT="10")
opener = mock.Mock(
side_effect=[
FakeResponse(status=201, body=b'{"id":"b814ebc9-8d00-47b7-b08e-575796cccd03"}'),
FakeResponse(status=200, body=b'{"processing_status":"pending","errors":[]}'),
FakeResponse(status=200, body=b'{"processing_status":"succeeded","errors":[]}'),
]
)
exit_code, output, _ = self.run_main(env=env, opener=opener)
self.assertRegex(
output,
re.compile(
r"Starting\ coverage\ upload\.\."
r".*Coverage\ report\ uploaded\ successfully\."
r".*Waiting\ for\ processing\ to\ finish"
r".*Coverage\ report\ processing\ status:\ pending\."
r".*Coverage\ report\ processing\ status:\ succeeded\."
r".*Coverage\ report\ processing\ finished\ successfully\.",
re.DOTALL,
),
)
self.assertEqual(0, exit_code)
self.assertEqual(3, opener.call_count)
def test_processing_failure_exits_with_error_by_default(self):
env = dict(self.base_env, WAIT_FOR_PROCESSING_TIMEOUT="10")
opener = mock.Mock(
side_effect=[
FakeResponse(status=201, body=b'{"id":"b814ebc9-8d00-47b7-b08e-575796cccd03"}'),
FakeResponse(
status=200,
body=b'{"processing_status":"failed","errors":["invalid coverage payload"]}',
),
]
)
exit_code, output, _ = self.run_main(opener=opener, env=env)
self.assertIn("Coverage report processing failed: invalid coverage payload", output)
self.assertEqual(1, exit_code)
def test_processing_failure_respects_fail_on_error_false(self):
env = dict(self.base_env, FAIL_ON_ERROR="false", WAIT_FOR_PROCESSING_TIMEOUT="10")
opener = mock.Mock(
side_effect=[
FakeResponse(status=201, body=b'{"id":"b814ebc9-8d00-47b7-b08e-575796cccd03"}'),
FakeResponse(
status=200,
body=b'{"processing_status":"failed","errors":["invalid coverage payload"]}',
),
]
)
exit_code, output, _ = self.run_main(env=env, opener=opener)
self.assertEqual(0, exit_code)
self.assertIn("::error::Coverage report processing failed", output)
def test_waiting_for_processing_can_be_disabled(self):
env = dict(self.base_env, WAIT_FOR_PROCESSING_TIMEOUT="0")
opener = mock.Mock(
return_value=FakeResponse(
status=201, body=b'{"id":"b814ebc9-8d00-47b7-b08e-575796cccd03"}'
)
)
exit_code, output, _ = self.run_main(env=env, opener=opener)
self.assertEqual(0, exit_code)
self.assertNotIn("Waiting for processing to finish", output)
opener.assert_called_once()
def test_processing_timeout_exits_with_error(self):
env = dict(self.base_env, WAIT_FOR_PROCESSING_TIMEOUT="40")
opener = mock.Mock(
side_effect=[
FakeResponse(status=201, body=b'{"id":"b814ebc9-8d00-47b7-b08e-575796cccd03"}'),
FakeResponse(status=200, body=b'{"processing_status":"pending","errors":[]}'),
FakeResponse(status=200, body=b'{"processing_status":"pending","errors":[]}'),
FakeResponse(status=200, body=b'{"processing_status":"pending","errors":[]}'),
FakeResponse(status=200, body=b'{"processing_status":"pending","errors":[]}'),
]
)
exit_code, output, _ = self.run_main(env=env, opener=opener)
self.assertEqual(1, exit_code)
self.assertIn("Timed out waiting 40 seconds", output)
def test_invalid_wait_timeout_exits_with_user_error(self):
env = dict(self.base_env, WAIT_FOR_PROCESSING_TIMEOUT="zero")
exit_code, output, opener = self.run_main(env=env)
self.assertEqual(1, exit_code)
self.assertIn("WAIT_FOR_PROCESSING_TIMEOUT must be a non-negative integer", output)
opener.assert_not_called()
# --- HTTP 403 (permissions) ---
def test_403_not_authorized_exits_with_permissions_error(self):
opener = mock.Mock(
return_value=FakeResponse(status=403, body=b'{"message":"not authorized"}')
)
exit_code, output, _ = self.run_main(opener=opener)
self.assertEqual(1, exit_code)
self.assertIn("code-quality: write", output)
self.assertIn("HTTP 403", output)
def test_403_other_message_exits_with_generic_error(self):
opener = mock.Mock(return_value=FakeResponse(status=403, body=b'{"message":"forbidden"}'))
exit_code, output, _ = self.run_main(opener=opener)
self.assertEqual(1, exit_code)
self.assertIn("Coverage upload failed (HTTP 403)", output)
self.assertIn("forbidden", output)
# --- Other error codes ---
def test_400_bad_request_exits_with_status_and_body(self):
opener = mock.Mock(return_value=FakeResponse(status=400, body=b'{"message":"bad request"}'))
exit_code, output, _ = self.run_main(opener=opener)
self.assertEqual(1, exit_code)
self.assertIn("HTTP 400", output)
self.assertIn("bad request", output)
def test_500_server_error_exits_with_status_and_body(self):
opener = mock.Mock(return_value=FakeResponse(status=500, body=b'{"message":"boom"}'))
exit_code, output, _ = self.run_main(opener=opener)
self.assertEqual(1, exit_code)
self.assertIn("HTTP 500", output)
self.assertIn("boom", output)
# --- Network errors ---
def test_network_error_exits_with_error(self):
opener = mock.Mock(side_effect=URLError("connection refused"))
exit_code, output, _ = self.run_main(opener=opener)
self.assertEqual(1, exit_code)
self.assertIn("::error::", output)
self.assertIn("could not reach the API", output)
# --- fail-on-error: true (default) ---
def test_fail_on_error_true_exits_1_on_4xx(self):
env = dict(self.base_env, FAIL_ON_ERROR="true")
opener = mock.Mock(return_value=FakeResponse(status=400, body=b'{"message":"nope"}'))
exit_code, output, _ = self.run_main(env=env, opener=opener)
self.assertEqual(1, exit_code)
self.assertIn("fail-on-error", output)
def test_fail_on_error_true_exits_1_on_5xx(self):
env = dict(self.base_env, FAIL_ON_ERROR="true")
opener = mock.Mock(return_value=FakeResponse(status=502, body=b"bad gateway"))
exit_code, output, _ = self.run_main(env=env, opener=opener)
self.assertEqual(1, exit_code)
def test_fail_on_error_true_exits_1_on_network_error(self):
env = dict(self.base_env, FAIL_ON_ERROR="true")
opener = mock.Mock(side_effect=URLError("timeout"))
exit_code, output, _ = self.run_main(env=env, opener=opener)
self.assertEqual(1, exit_code)
# --- fail-on-error: false ---
def test_fail_on_error_false_exits_0_on_4xx(self):
env = dict(self.base_env, FAIL_ON_ERROR="false")
opener = mock.Mock(return_value=FakeResponse(status=400, body=b'{"message":"nope"}'))
exit_code, output, _ = self.run_main(env=env, opener=opener)
self.assertEqual(0, exit_code)
self.assertIn("::error::", output)
self.assertIn("fail-on-error", output)
def test_fail_on_error_false_exits_0_on_5xx(self):
env = dict(self.base_env, FAIL_ON_ERROR="false")
opener = mock.Mock(return_value=FakeResponse(status=500, body=b"error"))
exit_code, output, _ = self.run_main(env=env, opener=opener)
self.assertEqual(0, exit_code)
self.assertIn("::error::", output)
def test_fail_on_error_false_exits_0_on_network_error(self):
env = dict(self.base_env, FAIL_ON_ERROR="false")
opener = mock.Mock(side_effect=URLError("connection refused"))
exit_code, output, _ = self.run_main(env=env, opener=opener)
self.assertEqual(0, exit_code)
self.assertIn("::error::", output)
def test_fail_on_error_false_exits_0_on_403(self):
env = dict(self.base_env, FAIL_ON_ERROR="false")
opener = mock.Mock(
return_value=FakeResponse(status=403, body=b'{"message":"not authorized"}')
)
exit_code, output, _ = self.run_main(env=env, opener=opener)
self.assertEqual(0, exit_code)
self.assertIn("::error::", output)
self.assertIn("code-quality: write", output)
def test_fail_on_error_false_still_exits_1_on_missing_file(self):
"""File-not-found is a local config error, not an upload failure."""
env = dict(self.base_env, FAIL_ON_ERROR="false", INPUT_FILE="/nonexistent")
opener = mock.Mock()
exit_code, output, _ = self.run_main(env=env, opener=opener)
self.assertEqual(1, exit_code)
opener.assert_not_called()
def test_fail_on_error_false_still_exits_1_on_missing_ref_and_pr(self):
"""Missing ref/PR is a config error, not an upload failure."""
env = dict(self.base_env, FAIL_ON_ERROR="false", REF="", PR_NUMBER="")
opener = mock.Mock()
exit_code, output, _ = self.run_main(env=env, opener=opener)
self.assertEqual(1, exit_code)
opener.assert_not_called()
# --- Diagnostic logging ---
def test_upload_parameters_logged_in_group(self):
exit_code, output, _ = self.run_main()
self.assertIn("::group::Upload parameters", output)
self.assertIn("commit_oid: deadbeef", output)
self.assertIn("ref: refs/heads/main", output)
self.assertIn("pr_number: <not set>", output)
self.assertIn("language: Python", output)
self.assertIn("label: code-coverage/test", output)
self.assertIn("::endgroup::", output)
def test_upload_parameters_shows_pr_number_when_set(self):
env = dict(self.base_env, REF="", PR_NUMBER="99")
exit_code, output, _ = self.run_main(env=env)
self.assertIn("pr_number: 99", output)
self.assertIn("ref: <not set>", output)
# --- Payload structure ---
def test_payload_structure_and_encoding(self):
exit_code, _, opener = self.run_main()
request = opener.call_args_list[0].args[0]
payload = self.request_payload(opener)
decoded = gzip.decompress(base64.b64decode(payload["coverage_report"]))
self.assertEqual(0, exit_code)
self.assertEqual("PUT", request.get_method())
self.assertEqual("Bearer test-token", request.headers["Authorization"])
self.assertEqual("deadbeef", payload["commit_oid"])
self.assertEqual("Python", payload["language_name"])
self.assertEqual("code-coverage/test", payload["label"])
self.assertEqual(self.coverage_contents, decoded)
def test_neither_ref_nor_pr_number_exits_with_error(self):
env = dict(self.base_env, REF="", PR_NUMBER="")
exit_code, output, opener = self.run_main(env=env)
self.assertEqual(1, exit_code)
self.assertIn("::error::", output)
self.assertIn("Either PR_NUMBER or REF must be provided", output)
opener.assert_not_called()
# --- Error annotations include fail-on-error hint ---
def test_error_annotations_include_fail_on_error_hint(self):
opener = mock.Mock(return_value=FakeResponse(status=500, body=b"oops"))
exit_code, output, _ = self.run_main(opener=opener)
self.assertIn("fail-on-error: false", output)
def test_network_error_annotation_includes_fail_on_error_hint(self):
opener = mock.Mock(side_effect=URLError("dns failure"))
exit_code, output, _ = self.run_main(opener=opener)
self.assertIn("fail-on-error: false", output)
def test_403_permissions_error_includes_fail_on_error_hint(self):
opener = mock.Mock(
return_value=FakeResponse(status=403, body=b'{"message":"not authorized"}')
)
exit_code, output, _ = self.run_main(opener=opener)
self.assertIn("fail-on-error: false", output)
# --- Only warnings and error annotations include the docs link ---
def test_successful_upload_omits_docs_url(self):
exit_code, output, _ = self.run_main()
self.assertEqual(0, exit_code)
self.assertNotIn(upload_coverage.DOCS_URL, output)
def test_errors_responses_includes_docs_url(self):
opener = mock.Mock(side_effect=URLError("dns failure"))
exit_code, output, _ = self.run_main(opener=opener)
self.assertIn(upload_coverage.DOCS_URL, output)
def test_warning_annotation_includes_docs_url(self):
env = dict(self.base_env, WAIT_FOR_PROCESSING_TIMEOUT="10")
opener = mock.Mock(return_value=FakeResponse(status=201, body=b'{"id":"abc"}'))
exit_code, output, _ = self.run_main(opener=opener, env=env)
warning_lines = [line for line in output.splitlines() if line.startswith("::warning::")]
self.assertTrue(warning_lines)
self.assertIn(upload_coverage.DOCS_URL, warning_lines[0])
# --- Telemetry integration ---
def test_telemetry_sends_starting_and_success_reports(self):
opener = self.successful_opener()
status_opener = mock.Mock(return_value=FakeResponse())
stdout = io.StringIO()
with redirect_stdout(stdout):
upload_coverage.main(environ=self.base_env, opener=opener, status_opener=status_opener)
# Two telemetry calls: starting + success
self.assertEqual(2, status_opener.call_count)
starting_request = status_opener.call_args_list[0].args[0]
starting_body = json.loads(starting_request.data)
self.assertEqual("starting", starting_body["status"])
completed_request = status_opener.call_args_list[1].args[0]
completed_body = json.loads(completed_request.data)
self.assertEqual("success", completed_body["status"])
self.assertIn("completed_at", completed_body)
self.assertIn("upload_duration_ms", completed_body)
self.assertIn("payload_size_bytes", completed_body)
def test_telemetry_reports_skipped_processing_as_success(self):
opener = mock.Mock(
return_value=FakeResponse(
status=200,
body=b'{"message":"commit is not the latest commit on the branch"}',
)
)
status_opener = mock.Mock(return_value=FakeResponse())
exit_code, _, _ = self.run_main(
env=dict(self.base_env, WAIT_FOR_PROCESSING_TIMEOUT="10"),
opener=opener,
status_opener=status_opener,
)
self.assertEqual(0, exit_code)
completed_request = status_opener.call_args_list[1].args[0]
completed_body = json.loads(completed_request.data)
self.assertEqual("success", completed_body["status"])
self.assertNotIn("error_type", completed_body)
def test_telemetry_sends_failure_report_on_upload_error(self):
opener = mock.Mock(return_value=FakeResponse(status=500, body=b'{"message":"boom"}'))
status_opener = mock.Mock(return_value=FakeResponse())
stdout = io.StringIO()
with redirect_stdout(stdout):
upload_coverage.main(environ=self.base_env, opener=opener, status_opener=status_opener)
completed_request = status_opener.call_args_list[1].args[0]
completed_body = json.loads(completed_request.data)
self.assertEqual("failure", completed_body["status"])
self.assertEqual("http_500", completed_body["error_type"])
def test_telemetry_sends_user_error_on_4xx_upload_response(self):
"""4xx HTTP responses report user-error even when fail-on-error is false."""
env = dict(self.base_env, FAIL_ON_ERROR="false")
opener = mock.Mock(
return_value=FakeResponse(status=403, body=b'{"message":"Code quality is not enabled"}')
)
status_opener = mock.Mock(return_value=FakeResponse())
stdout = io.StringIO()
with redirect_stdout(stdout):
exit_code = upload_coverage.main(
environ=env, opener=opener, status_opener=status_opener
)
self.assertEqual(0, exit_code)
completed_request = status_opener.call_args_list[1].args[0]
completed_body = json.loads(completed_request.data)
self.assertEqual("user-error", completed_body["status"])
self.assertEqual("http_403", completed_body["error_type"])
def test_telemetry_sends_user_error_on_missing_file(self):
env = dict(self.base_env, INPUT_FILE="/nonexistent")
status_opener = mock.Mock(return_value=FakeResponse())
stdout = io.StringIO()
with redirect_stdout(stdout):
upload_coverage.main(environ=env, opener=mock.Mock(), status_opener=status_opener)
completed_request = status_opener.call_args_list[1].args[0]
completed_body = json.loads(completed_request.data)
self.assertEqual("user-error", completed_body["status"])
self.assertEqual("file_not_found", completed_body["error_type"])
def test_telemetry_failure_does_not_affect_action_exit_code(self):
"""Status reporting errors must never cause the action to fail."""
opener = self.successful_opener()
status_opener = mock.Mock(side_effect=Exception("telemetry boom"))
stdout = io.StringIO()
with redirect_stdout(stdout):
exit_code = upload_coverage.main(
environ=self.base_env,
opener=opener,
status_opener=status_opener,
)
self.assertEqual(0, exit_code)
if __name__ == "__main__":
unittest.main()
You can’t perform that action at this time.