-
-
Notifications
You must be signed in to change notification settings - Fork 175
/
test_action_script.py
1056 lines (915 loc) · 59.8 KB
/
test_action_script.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
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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import io
import json
import logging
import os
import pathlib
import re
import sys
import tempfile
import unittest
from typing import Optional, Union, List, Type
import mock
from packaging.version import Version
from publish import pull_request_build_mode_merge, fail_on_mode_failures, fail_on_mode_errors, \
fail_on_mode_nothing, comment_modes, comment_mode_always, \
pull_request_build_modes, punctuation_space
from publish.github_action import GithubAction
from publish.unittestresults import ParsedUnitTestResults, ParseError
from publish_test_results import get_conclusion, get_commit_sha, get_var, \
check_var, check_var_condition, deprecate_var, deprecate_val, log_parse_errors, \
get_settings, get_annotations_config, Settings, get_files, throttle_gh_request_raw, is_float, parse_files, main
from test_utils import chdir
test_files_path = pathlib.Path(__file__).resolve().parent / 'files'
event = dict(pull_request=dict(head=dict(sha='event_sha')))
class Test(unittest.TestCase):
def test_get_conclusion_success(self):
for fail_on_errors in [True, False]:
for fail_on_failures in [True, False]:
with self.subTest(fail_on_errors=fail_on_errors, fail_on_failures=fail_on_failures):
actual = get_conclusion(ParsedUnitTestResults(
files=1,
errors=[],
suites=1,
suite_tests=4,
suite_skipped=1,
suite_failures=0,
suite_errors=0,
suite_time=10,
cases=[]
), fail_on_errors=fail_on_errors, fail_on_failures=fail_on_failures)
self.assertEqual('success', actual)
def test_get_conclusion_failures(self):
for fail_on_errors in [True, False]:
for fail_on_failures in [True, False]:
with self.subTest(fail_on_errors=fail_on_errors, fail_on_failures=fail_on_failures):
actual = get_conclusion(ParsedUnitTestResults(
files=1,
errors=[],
suites=1,
suite_tests=4,
suite_skipped=1,
suite_failures=1,
suite_errors=0,
suite_time=10,
cases=[]
), fail_on_errors=fail_on_errors, fail_on_failures=fail_on_failures)
self.assertEqual('failure' if fail_on_failures else 'success', actual)
def test_get_conclusion_errors(self):
for fail_on_errors in [True, False]:
for fail_on_failures in [True, False]:
with self.subTest(fail_on_errors=fail_on_errors, fail_on_failures=fail_on_failures):
actual = get_conclusion(ParsedUnitTestResults(
files=1,
errors=[],
suites=1,
suite_tests=4,
suite_skipped=1,
suite_failures=0,
suite_errors=1,
suite_time=10,
cases=[]
), fail_on_errors=fail_on_errors, fail_on_failures=fail_on_failures)
self.assertEqual('failure' if fail_on_errors else 'success', actual)
def test_get_conclusion_no_files(self):
for fail_on_errors in [True, False]:
for fail_on_failures in [True, False]:
with self.subTest(fail_on_errors=fail_on_errors, fail_on_failures=fail_on_failures):
actual = get_conclusion(ParsedUnitTestResults(
files=0,
errors=[],
suites=0,
suite_tests=0,
suite_skipped=0,
suite_failures=0,
suite_errors=0,
suite_time=0,
cases=[]
), fail_on_errors=fail_on_errors, fail_on_failures=fail_on_failures)
self.assertEqual('neutral', actual)
def test_get_conclusion_parse_errors(self):
for fail_on_errors in [True, False]:
for fail_on_failures in [True, False]:
with self.subTest(fail_on_errors=fail_on_errors, fail_on_failures=fail_on_failures):
actual = get_conclusion(ParsedUnitTestResults(
files=2,
errors=[ParseError(file='file', message='error', exception=ValueError("Invalid value"))],
suites=1,
suite_tests=4,
suite_skipped=1,
suite_failures=0,
suite_errors=0,
suite_time=10,
cases=[]
), fail_on_errors=fail_on_errors, fail_on_failures=fail_on_failures)
self.assertEqual('failure' if fail_on_errors else 'success', actual)
def test_env_sha_events(self):
options = dict(GITHUB_SHA='env_sha')
for event_name in ['push', 'workflow_dispatch', 'repository_dispatch',
'release', 'schedule', 'future_event']:
actual = get_commit_sha(event, event_name, options)
self.assertEqual('env_sha', actual)
def test_event_sha(self):
options = dict(GITHUB_SHA='env_sha')
for event_name in ['pull_request', 'pull_request_target',
'pull_request_review', 'pull_request_review_comment',
'pull_request_future_event']:
actual = get_commit_sha(event, event_name, options)
self.assertEqual('event_sha', actual)
def test_get_var(self):
self.assertIsNone(get_var('NAME', dict()))
self.assertIsNone(get_var('NAME', dict(name='case sensitive')))
self.assertEqual(get_var('NAME', dict(NAME='value')), 'value')
self.assertEqual(get_var('NAME', dict(INPUT_NAME='precedence', NAME='value')), 'precedence')
self.assertIsNone(get_var('NAME', dict(NAME='')))
@classmethod
def get_settings_no_default_files(cls,
junit_files_glob=None,
nunit_files_glob=None,
xunit_files_glob=None,
trx_files_glob=None) -> Settings:
return cls.get_settings(junit_files_glob=junit_files_glob,
nunit_files_glob=nunit_files_glob,
xunit_files_glob=xunit_files_glob,
trx_files_glob=trx_files_glob)
@staticmethod
def get_settings(token='token',
api_url='http://github.api.url/',
graphql_url='http://github.graphql.url/',
retries=2,
event={},
event_file=None,
event_name='event name',
repo='repo',
commit='commit',
fail_on_errors=True,
fail_on_failures=True,
junit_files_glob='junit-files',
nunit_files_glob='nunit-files',
xunit_files_glob='xunit-files',
trx_files_glob='trx-files',
time_factor=1.0,
check_name='check name',
comment_title='title',
comment_mode=comment_mode_always,
job_summary=True,
compare_earlier=True,
test_changes_limit=10,
pull_request_build=pull_request_build_mode_merge,
report_individual_runs=True,
dedup_classes_by_file_name=True,
ignore_runs=False,
check_run_annotation=[],
seconds_between_github_reads=1.5,
seconds_between_github_writes=2.5,
json_file=None,
json_thousands_separator=punctuation_space,
json_test_case_results=False) -> Settings:
return Settings(
token=token,
api_url=api_url,
graphql_url=graphql_url,
api_retries=retries,
event=event.copy(),
event_file=event_file,
event_name=event_name,
repo=repo,
commit=commit,
json_file=json_file,
json_thousands_separator=json_thousands_separator,
json_test_case_results=json_test_case_results,
fail_on_errors=fail_on_errors,
fail_on_failures=fail_on_failures,
junit_files_glob=junit_files_glob,
nunit_files_glob=nunit_files_glob,
xunit_files_glob=xunit_files_glob,
trx_files_glob=trx_files_glob,
time_factor=time_factor,
check_name=check_name,
comment_title=comment_title,
comment_mode=comment_mode,
job_summary=job_summary,
compare_earlier=compare_earlier,
pull_request_build=pull_request_build,
test_changes_limit=test_changes_limit,
report_individual_runs=report_individual_runs,
dedup_classes_by_file_name=dedup_classes_by_file_name,
ignore_runs=ignore_runs,
check_run_annotation=check_run_annotation.copy(),
seconds_between_github_reads=seconds_between_github_reads,
seconds_between_github_writes=seconds_between_github_writes
)
def test_get_settings(self):
options = self.do_test_get_settings()
options = {f'INPUT_{key}': value
for key, value in options.items()
if key not in {'GITHUB_API_URL', 'GITHUB_GRAPHQL_URL', 'GITHUB_SHA', 'GITHUB_EVENT_PATH'}}
self.do_test_get_settings(**options)
def test_get_settings_event_file(self):
self.do_test_get_settings(expected=self.get_settings(event_file=None))
self.do_test_get_settings(EVENT_FILE='', expected=self.get_settings(event_file=None))
self.do_test_get_settings(EVENT_FILE=None, expected=self.get_settings(event_file=None))
with tempfile.TemporaryDirectory() as path:
event = {"key": "val"}
filepath = os.path.join(path, 'event.json')
with open(filepath, 'wt', encoding='utf-8') as w:
w.write(json.dumps(event, ensure_ascii=False))
self.do_test_get_settings(EVENT_FILE=filepath, expected=self.get_settings(event=event, event_file=filepath))
def test_get_settings_github_api_url(self):
self.do_test_get_settings(GITHUB_API_URL='https://api.github.onpremise.com', expected=self.get_settings(api_url='https://api.github.onpremise.com'))
self.do_test_get_settings(GITHUB_API_URL=None, expected=self.get_settings(api_url='https://api.github.com'))
def test_get_settings_github_graphql_url(self):
self.do_test_get_settings(GITHUB_GRAPHQL_URL='https://api.github.onpremise.com/graphql', expected=self.get_settings(graphql_url='https://api.github.onpremise.com/graphql'))
self.do_test_get_settings(GITHUB_GRAPHQL_URL=None, expected=self.get_settings(graphql_url='https://api.github.com/graphql'))
def test_get_settings_github_retries(self):
self.do_test_get_settings(GITHUB_RETRIES='0', expected=self.get_settings(retries=0))
self.do_test_get_settings(GITHUB_RETRIES='1', expected=self.get_settings(retries=1))
self.do_test_get_settings(GITHUB_RETRIES='123', expected=self.get_settings(retries=123))
self.do_test_get_settings(GITHUB_RETRIES=None, expected=self.get_settings(retries=10))
for retries in ['-1', '12e', 'none']:
with self.subTest(retries=retries):
with self.assertRaises(RuntimeError) as re:
self.do_test_get_settings(GITHUB_RETRIES=retries, expected=None)
self.assertIn(f'GITHUB_RETRIES must be a positive integer or 0: {retries}', re.exception.args)
def test_get_settings_any_files(self):
for junit in [None, 'junit-file']:
for nunit in [None, 'nunit-file']:
for xunit in [None, 'xunit-file']:
for trx in [None, 'trx-file']:
with self.subTest(junit=junit, nunit=nunit, xunit=xunit, trx=trx):
any_flavour_set = any([flavour is not None for flavour in [junit, nunit, xunit, trx]])
expected = self.get_settings(junit_files_glob=junit if any_flavour_set else '*.xml',
nunit_files_glob=nunit,
xunit_files_glob=xunit,
trx_files_glob=trx)
warnings = None if any_flavour_set else 'At least one of the *_FILES options has to be set! ' \
'Falling back to deprecated default "*.xml"'
self.do_test_get_settings(JUNIT_FILES=junit, NUNIT_FILES=nunit, XUNIT_FILES=xunit, TRX_FILES=trx,
expected=expected, warning=warnings)
def test_get_settings_junit_files(self):
self.do_test_get_settings_no_default_files(JUNIT_FILES='file', expected=self.get_settings_no_default_files(junit_files_glob='file'))
self.do_test_get_settings_no_default_files(JUNIT_FILES='file\nfile2', expected=self.get_settings_no_default_files(junit_files_glob='file\nfile2'))
self.do_test_get_settings_no_default_files(JUNIT_FILES=None, expected=self.get_settings_no_default_files(junit_files_glob='*.xml'), warning='At least one of the *_FILES options has to be set! Falling back to deprecated default "*.xml"')
# this is the deprecated version of JUNIT_FILES
self.do_test_get_settings_no_default_files(JUNIT_FILES='junit-file', FILES='file', expected=self.get_settings_no_default_files(junit_files_glob='junit-file'), warning='Option FILES is deprecated, please use JUNIT_FILES instead!')
self.do_test_get_settings_no_default_files(JUNIT_FILES=None, FILES='file', expected=self.get_settings_no_default_files(junit_files_glob='file'), warning='Option FILES is deprecated, please use JUNIT_FILES instead!')
self.do_test_get_settings_no_default_files(JUNIT_FILES=None, FILES='file\nfile2', expected=self.get_settings_no_default_files(junit_files_glob='file\nfile2'), warning='Option FILES is deprecated, please use JUNIT_FILES instead!')
self.do_test_get_settings_no_default_files(JUNIT_FILES=None, FILES=None, expected=self.get_settings_no_default_files(junit_files_glob='*.xml'), warning='At least one of the *_FILES options has to be set! Falling back to deprecated default "*.xml"')
def test_get_settings_nunit_files(self):
self.do_test_get_settings_no_default_files(NUNIT_FILES='file', expected=self.get_settings_no_default_files(nunit_files_glob='file'))
self.do_test_get_settings_no_default_files(NUNIT_FILES='file\nfile2', expected=self.get_settings_no_default_files(nunit_files_glob='file\nfile2'))
self.do_test_get_settings_no_default_files(NUNIT_FILES=None, expected=self.get_settings_no_default_files(nunit_files_glob=None, junit_files_glob='*.xml'), warning='At least one of the *_FILES options has to be set! Falling back to deprecated default "*.xml"')
def test_get_settings_xunit_files(self):
self.do_test_get_settings_no_default_files(XUNIT_FILES='file', expected=self.get_settings_no_default_files(xunit_files_glob='file'))
self.do_test_get_settings_no_default_files(XUNIT_FILES='file\nfile2', expected=self.get_settings_no_default_files(xunit_files_glob='file\nfile2'))
self.do_test_get_settings_no_default_files(XUNIT_FILES=None, expected=self.get_settings_no_default_files(xunit_files_glob=None, junit_files_glob='*.xml'), warning='At least one of the *_FILES options has to be set! Falling back to deprecated default "*.xml"')
def test_get_settings_trx_files(self):
self.do_test_get_settings_no_default_files(TRX_FILES='file', expected=self.get_settings_no_default_files(trx_files_glob='file'))
self.do_test_get_settings_no_default_files(TRX_FILES='file\nfile2', expected=self.get_settings_no_default_files(trx_files_glob='file\nfile2'))
self.do_test_get_settings_no_default_files(TRX_FILES=None, expected=self.get_settings_no_default_files(trx_files_glob=None, junit_files_glob='*.xml'), warning='At least one of the *_FILES options has to be set! Falling back to deprecated default "*.xml"')
def test_get_settings_time_unit(self):
self.do_test_get_settings(TIME_UNIT=None, expected=self.get_settings(time_factor=1.0))
self.do_test_get_settings(TIME_UNIT='milliseconds', expected=self.get_settings(time_factor=0.001))
self.do_test_get_settings(TIME_UNIT='seconds', expected=self.get_settings(time_factor=1.0))
with self.assertRaises(RuntimeError) as re:
self.do_test_get_settings(TIME_UNIT='minutes', expected=None)
self.assertIn('TIME_UNIT minutes is not supported. It is optional, '
'but when given must be one of these values: seconds, milliseconds', re.exception.args)
def test_get_settings_commit(self):
event = {'pull_request': {'head': {'sha': 'sha2'}}}
self.do_test_get_settings(INPUT_COMMIT='sha', GITHUB_EVENT_NAME='pull_request', event=event, GITHUB_SHA='default', expected=self.get_settings(commit='sha', event=event, event_name='pull_request'))
self.do_test_get_settings(COMMIT='sha', GITHUB_EVENT_NAME='pull_request', event=event, GITHUB_SHA='default', expected=self.get_settings(commit='sha', event=event, event_name='pull_request'))
self.do_test_get_settings(COMMIT=None, GITHUB_EVENT_NAME='pull_request', event=event, GITHUB_SHA='default', expected=self.get_settings(commit='sha2', event=event, event_name='pull_request'))
self.do_test_get_settings(COMMIT=None, INPUT_GITHUB_EVENT_NAME='pull_request', event=event, GITHUB_SHA='default', expected=self.get_settings(commit='sha2', event=event, event_name='pull_request'))
self.do_test_get_settings(COMMIT=None, GITHUB_EVENT_NAME='push', event=event, GITHUB_SHA='default', expected=self.get_settings(commit='default', event=event, event_name='push'))
with self.assertRaises(RuntimeError) as re:
self.do_test_get_settings(COMMIT=None, GITHUB_EVENT_NAME='pull_request', event={}, GITHUB_SHA='default', expected=None)
self.assertIn('Commit SHA must be provided via action input or environment variable COMMIT, GITHUB_SHA or event file', re.exception.args)
with self.assertRaises(RuntimeError) as re:
self.do_test_get_settings(COMMIT=None, GITHUB_EVENT_NAME='push', event=event, GITHUB_SHA=None, expected=None)
self.assertIn('Commit SHA must be provided via action input or environment variable COMMIT, GITHUB_SHA or event file', re.exception.args)
with self.assertRaises(RuntimeError) as re:
self.do_test_get_settings(COMMIT=None, expected=None)
self.assertEqual('Commit SHA must be provided via action input or environment variable COMMIT, GITHUB_SHA or event file', str(re.exception))
def test_get_settings_fail_on(self):
self.do_test_get_settings(FAIL_ON=None, expected=self.get_settings(fail_on_errors=True, fail_on_failures=True))
self.do_test_get_settings(FAIL_ON=fail_on_mode_failures, expected=self.get_settings(fail_on_errors=True, fail_on_failures=True))
self.do_test_get_settings(FAIL_ON=fail_on_mode_errors, expected=self.get_settings(fail_on_errors=True, fail_on_failures=False))
self.do_test_get_settings(FAIL_ON=fail_on_mode_nothing, expected=self.get_settings(fail_on_errors=False, fail_on_failures=False))
def test_get_settings_pull_request_build(self):
for mode in pull_request_build_modes:
with self.subTest(mode=mode):
self.do_test_get_settings(PULL_REQUEST_BUILD=mode, expected=self.get_settings(pull_request_build=mode))
self.do_test_get_settings(PULL_REQUEST_BUILD=None, expected=self.get_settings(pull_request_build=pull_request_build_mode_merge))
with self.assertRaises(RuntimeError) as re:
self.do_test_get_settings(PULL_REQUEST_BUILD='build')
self.assertEqual("Value 'build' is not supported for variable PULL_REQUEST_BUILD, expected: commit, merge", str(re.exception))
def test_get_settings_test_changes_limit(self):
self.do_test_get_settings(TEST_CHANGES_LIMIT='0', expected=self.get_settings(test_changes_limit=0))
self.do_test_get_settings(TEST_CHANGES_LIMIT='1', expected=self.get_settings(test_changes_limit=1))
self.do_test_get_settings(TEST_CHANGES_LIMIT=None, expected=self.get_settings(test_changes_limit=10))
for limit in ['-1', '1.0', '12e', 'string']:
with self.subTest(limit=limit):
with self.assertRaises(RuntimeError) as re:
self.do_test_get_settings(TEST_CHANGES_LIMIT=limit, expected=self.get_settings(test_changes_limit=10))
self.assertIn(f'TEST_CHANGES_LIMIT must be a positive integer or 0: {limit}', re.exception.args)
def test_get_settings_check_name(self):
self.do_test_get_settings(CHECK_NAME='name', expected=self.get_settings(check_name='name'))
self.do_test_get_settings(CHECK_NAME=None, expected=self.get_settings(check_name='Test Results'))
def test_get_settings_comment_title(self):
self.do_test_get_settings(COMMENT_TITLE=None, CHECK_NAME=None, expected=self.get_settings(comment_title='Test Results', check_name='Test Results'))
self.do_test_get_settings(COMMENT_TITLE='title', CHECK_NAME=None, expected=self.get_settings(comment_title='title', check_name='Test Results'))
self.do_test_get_settings(COMMENT_TITLE='title', CHECK_NAME='name', expected=self.get_settings(comment_title='title', check_name='name'))
self.do_test_get_settings(COMMENT_TITLE=None, CHECK_NAME='name', expected=self.get_settings(comment_title='name', check_name='name'))
def test_get_settings_comment_mode(self):
for mode in comment_modes:
with self.subTest(mode=mode):
self.do_test_get_settings(COMMENT_MODE=mode, expected=self.get_settings(comment_mode=mode))
self.do_test_get_settings(COMMENT_MODE=None, expected=self.get_settings(comment_mode=comment_mode_always))
with self.assertRaises(RuntimeError) as re:
self.do_test_get_settings(COMMENT_MODE='mode')
self.assertEqual("Value 'mode' is not supported for variable COMMENT_MODE, expected: off, always, changes, changes in failures, changes in errors, failures, errors", str(re.exception))
def test_get_settings_compare_to_earlier_commit(self):
warning = 'Option compare_to_earlier_commit has to be boolean, so either "true" or "false": foo'
self.do_test_get_settings(COMPARE_TO_EARLIER_COMMIT='false', expected=self.get_settings(compare_earlier=False))
self.do_test_get_settings(COMPARE_TO_EARLIER_COMMIT='False', expected=self.get_settings(compare_earlier=False))
self.do_test_get_settings(COMPARE_TO_EARLIER_COMMIT='true', expected=self.get_settings(compare_earlier=True))
self.do_test_get_settings(COMPARE_TO_EARLIER_COMMIT='True', expected=self.get_settings(compare_earlier=True))
self.do_test_get_settings(COMPARE_TO_EARLIER_COMMIT='foo', expected=self.get_settings(compare_earlier=True), warning=warning, exception=RuntimeError)
self.do_test_get_settings(COMPARE_TO_EARLIER_COMMIT=None, expected=self.get_settings(compare_earlier=True))
def test_get_settings_job_summary(self):
warning = 'Option job_summary has to be boolean, so either "true" or "false": foo'
self.do_test_get_settings(JOB_SUMMARY='false', expected=self.get_settings(job_summary=False))
self.do_test_get_settings(JOB_SUMMARY='False', expected=self.get_settings(job_summary=False))
self.do_test_get_settings(JOB_SUMMARY='true', expected=self.get_settings(job_summary=True))
self.do_test_get_settings(JOB_SUMMARY='True', expected=self.get_settings(job_summary=True))
self.do_test_get_settings(JOB_SUMMARY='foo', expected=self.get_settings(job_summary=True), warning=warning, exception=RuntimeError)
self.do_test_get_settings(JOB_SUMMARY=None, expected=self.get_settings(job_summary=True))
def test_get_settings_report_individual_runs(self):
warning = 'Option report_individual_runs has to be boolean, so either "true" or "false": foo'
self.do_test_get_settings(REPORT_INDIVIDUAL_RUNS='false', expected=self.get_settings(report_individual_runs=False))
self.do_test_get_settings(REPORT_INDIVIDUAL_RUNS='False', expected=self.get_settings(report_individual_runs=False))
self.do_test_get_settings(REPORT_INDIVIDUAL_RUNS='true', expected=self.get_settings(report_individual_runs=True))
self.do_test_get_settings(REPORT_INDIVIDUAL_RUNS='True', expected=self.get_settings(report_individual_runs=True))
self.do_test_get_settings(REPORT_INDIVIDUAL_RUNS='foo', expected=self.get_settings(report_individual_runs=False), warning=warning, exception=RuntimeError)
self.do_test_get_settings(REPORT_INDIVIDUAL_RUNS=None, expected=self.get_settings(report_individual_runs=False))
def test_get_settings_dedup_classes_by_file_name(self):
warning = 'Option deduplicate_classes_by_file_name has to be boolean, so either "true" or "false": foo'
self.do_test_get_settings(DEDUPLICATE_CLASSES_BY_FILE_NAME='false', expected=self.get_settings(dedup_classes_by_file_name=False))
self.do_test_get_settings(DEDUPLICATE_CLASSES_BY_FILE_NAME='False', expected=self.get_settings(dedup_classes_by_file_name=False))
self.do_test_get_settings(DEDUPLICATE_CLASSES_BY_FILE_NAME='true', expected=self.get_settings(dedup_classes_by_file_name=True))
self.do_test_get_settings(DEDUPLICATE_CLASSES_BY_FILE_NAME='True', expected=self.get_settings(dedup_classes_by_file_name=True))
self.do_test_get_settings(DEDUPLICATE_CLASSES_BY_FILE_NAME='foo', expected=self.get_settings(dedup_classes_by_file_name=False), warning=warning, exception=RuntimeError)
self.do_test_get_settings(DEDUPLICATE_CLASSES_BY_FILE_NAME=None, expected=self.get_settings(dedup_classes_by_file_name=False))
def test_get_settings_ignore_runs(self):
warning = 'Option ignore_runs has to be boolean, so either "true" or "false": foo'
self.do_test_get_settings(IGNORE_RUNS='false', expected=self.get_settings(ignore_runs=False))
self.do_test_get_settings(IGNORE_RUNS='False', expected=self.get_settings(ignore_runs=False))
self.do_test_get_settings(IGNORE_RUNS='true', expected=self.get_settings(ignore_runs=True))
self.do_test_get_settings(IGNORE_RUNS='True', expected=self.get_settings(ignore_runs=True))
self.do_test_get_settings(IGNORE_RUNS='foo', expected=self.get_settings(ignore_runs=False), warning=warning, exception=RuntimeError)
self.do_test_get_settings(IGNORE_RUNS=None, expected=self.get_settings(ignore_runs=False))
def test_get_settings_check_run_annotations(self):
# Note: more tests in test_get_annotations_config*
with self.assertRaises(RuntimeError) as re:
self.do_test_get_settings(CHECK_RUN_ANNOTATIONS='annotation', expected=None)
self.assertEqual("Some values in 'annotation' are not supported for variable CHECK_RUN_ANNOTATIONS, allowed: all tests, skipped tests, none", str(re.exception))
def test_get_settings_seconds_between_github_reads(self):
self.do_test_get_settings_seconds_between_github_requests('SECONDS_BETWEEN_GITHUB_READS', 'seconds_between_github_reads', 1.0)
def test_get_settings_seconds_between_github_writes(self):
self.do_test_get_settings_seconds_between_github_requests('SECONDS_BETWEEN_GITHUB_WRITES', 'seconds_between_github_writes', 2.0)
def do_test_get_settings_seconds_between_github_requests(self, env_var_name: str, settings_var_name: str, default: float):
self.do_test_get_settings(**{env_var_name: '0.001', 'expected': self.get_settings(**{settings_var_name: 0.001})})
self.do_test_get_settings(**{env_var_name: '1', 'expected': self.get_settings(**{settings_var_name: 1.0})})
self.do_test_get_settings(**{env_var_name: '1.0', 'expected': self.get_settings(**{settings_var_name: 1.0})})
self.do_test_get_settings(**{env_var_name: '2.5', 'expected': self.get_settings(**{settings_var_name: 2.5})})
self.do_test_get_settings(**{env_var_name: None, 'expected': self.get_settings(**{settings_var_name: default})})
for val in ['0', '0.0', '-1', 'none', '12e']:
with self.subTest(reads=val):
with self.assertRaises(RuntimeError) as re:
self.do_test_get_settings(**{env_var_name: val, 'expected': None})
self.assertIn(f'{env_var_name} must be a positive number: {val}', re.exception.args)
def test_get_settings_json_file(self):
for json_file in [None, 'file.json', '/path/file.json']:
with self.subTest(json_file=json_file):
self.do_test_get_settings(JSON_FILE=json_file, expected=self.get_settings(json_file=json_file))
def test_get_settings_json_thousands_separator(self):
self.do_test_get_settings(JSON_THOUSANDS_SEPARATOR=None, expected=self.get_settings(json_thousands_separator=punctuation_space))
self.do_test_get_settings(JSON_THOUSANDS_SEPARATOR=',', expected=self.get_settings(json_thousands_separator=','))
self.do_test_get_settings(JSON_THOUSANDS_SEPARATOR='.', expected=self.get_settings(json_thousands_separator='.'))
self.do_test_get_settings(JSON_THOUSANDS_SEPARATOR=' ', expected=self.get_settings(json_thousands_separator=' '))
def test_get_settings_missing_github_vars(self):
with self.assertRaises(RuntimeError) as re:
self.do_test_get_settings(GITHUB_EVENT_PATH=None)
self.assertEqual('GitHub event file path must be provided via action input or environment variable GITHUB_EVENT_PATH', str(re.exception))
with self.assertRaises(RuntimeError) as re:
self.do_test_get_settings(GITHUB_TOKEN=None)
self.assertEqual('GitHub token must be provided via action input or environment variable GITHUB_TOKEN', str(re.exception))
with self.assertRaises(RuntimeError) as re:
self.do_test_get_settings(GITHUB_REPOSITORY=None)
self.assertEqual('GitHub repository must be provided via action input or environment variable GITHUB_REPOSITORY', str(re.exception))
def do_test_get_settings_no_default_files(self,
event: dict = {},
gha: Optional[GithubAction] = None,
warning: Optional[Union[str, List[str]]] = None,
expected: Settings = get_settings.__func__(),
**kwargs):
options = dict(**kwargs)
for flavour in ['JUNIT', 'NUNIT', 'XUNIT', 'TRX']:
if f'{flavour}_FILES' not in kwargs:
options[f'{flavour}_FILES'] = None
self.do_test_get_settings(event, gha, warning=warning, expected=expected, **options)
def do_test_get_settings(self,
event: Optional[dict] = None,
gha: Optional[GithubAction] = None,
warning: Optional[Union[str, List[str]]] = None,
exception: Optional[Type[Exception]] = None,
expected: Settings = get_settings.__func__(),
**kwargs):
if event is None:
event = {}
with tempfile.TemporaryDirectory() as path:
# default options
options = dict(
GITHUB_EVENT_NAME='event name',
GITHUB_API_URL='http://github.api.url/', #defaults to github
GITHUB_GRAPHQL_URL='http://github.graphql.url/', #defaults to github
GITHUB_RETRIES='2',
TEST_CHANGES_LIMIT='10', # not an int
CHECK_NAME='check name', # defaults to 'Test Results'
GITHUB_TOKEN='token',
GITHUB_REPOSITORY='repo',
COMMIT='commit', # defaults to get_commit_sha(event, event_name)
JUNIT_FILES='junit-files',
NUNIT_FILES='nunit-files',
XUNIT_FILES='xunit-files',
TRX_FILES='trx-files',
COMMENT_TITLE='title', # defaults to check name
COMMENT_MODE='always',
JOB_SUMMARY='true',
REPORT_INDIVIDUAL_RUNS='true', # false unless 'true'
DEDUPLICATE_CLASSES_BY_FILE_NAME='true', # false unless 'true'
# annotations config tested in test_get_annotations_config*
SECONDS_BETWEEN_GITHUB_READS='1.5',
SECONDS_BETWEEN_GITHUB_WRITES='2.5'
)
# provide event via GITHUB_EVENT_PATH when there is no EVENT_FILE given
if 'EVENT_FILE' not in kwargs or not kwargs['EVENT_FILE']:
filepath = os.path.join(path, 'event.json')
with open(filepath, 'wt', encoding='utf-8') as w:
w.write(json.dumps(event, ensure_ascii=False))
options.update(GITHUB_EVENT_PATH=filepath)
# overwrite default options
options.update(**kwargs)
for arg in kwargs:
if arg.startswith('INPUT_'):
del options[arg[6:]]
# Note: functionality of get_annotations_config is simplified here,
# its true behaviour is tested in get_annotations_config*
annotations_config = options.get('CHECK_RUN_ANNOTATIONS').split(',') \
if options.get('CHECK_RUN_ANNOTATIONS') is not None else []
with mock.patch('publish_test_results.get_annotations_config', return_value=annotations_config) as m:
if gha is None:
gha = mock.MagicMock()
if exception:
with self.assertRaises(exception) as e:
get_settings(options, gha)
self.assertEqual((warning, ), e.exception.args)
return None
actual = get_settings(options, gha)
m.assert_called_once_with(options, expected.event)
if warning:
if isinstance(warning, list):
gha.warning.assert_has_calls([mock.call(w) for w in warning], any_order=False)
else:
gha.warning.assert_called_once_with(warning)
else:
gha.warning.assert_not_called()
self.assertEqual(expected, actual)
return options
def test_get_annotations_config(self):
options = {
'CHECK_RUN_ANNOTATIONS': 'one,two, three'
}
config = get_annotations_config(options, None)
self.assertEqual(['one', 'two', 'three'], config)
def test_get_annotations_config_in_specific_branch(self):
options = {
'CHECK_RUN_ANNOTATIONS': 'one,two, three',
'CHECK_RUN_ANNOTATIONS_BRANCH': 'release, develop',
'GITHUB_REF': 'refs/heads/release'
}
config = get_annotations_config(options, None)
self.assertEqual(['one', 'two', 'three'], config)
def test_get_annotations_config_not_in_specific_branch(self):
options = {
'CHECK_RUN_ANNOTATIONS': 'one,two, three',
'CHECK_RUN_ANNOTATIONS_BRANCH': 'release, develop',
'GITHUB_REF': 'refs/heads/branch'
}
config = get_annotations_config(options, None)
self.assertEqual([], config)
def test_get_annotations_config_in_default_branch(self):
options = {
'CHECK_RUN_ANNOTATIONS': 'one,two, three',
'GITHUB_REF': 'refs/heads/develop'
}
event = {'repository': {'default_branch': 'develop'}}
config = get_annotations_config(options, event)
self.assertEqual(['one', 'two', 'three'], config)
def test_get_annotations_config_not_in_default_branch(self):
options = {
'CHECK_RUN_ANNOTATIONS': 'one,two, three',
'GITHUB_REF': 'refs/heads/branch'
}
event = {'repository': {'default_branch': 'develop'}}
config = get_annotations_config(options, event)
self.assertEqual([], config)
def test_get_annotations_config_in_standard_default_branch(self):
options = {
'CHECK_RUN_ANNOTATIONS': 'one,two, three',
'GITHUB_REF': 'refs/heads/main'
}
config = get_annotations_config(options, None)
self.assertEqual(['one', 'two', 'three'], config)
def test_get_annotations_config_not_in_standard_default_branch(self):
options = {
'CHECK_RUN_ANNOTATIONS': 'one,two, three',
'GITHUB_REF': 'refs/heads/branch'
}
config = get_annotations_config(options, None)
self.assertEqual([], config)
def test_get_annotations_config_in_all_branches(self):
options = {
'CHECK_RUN_ANNOTATIONS': 'one,two, three',
'CHECK_RUN_ANNOTATIONS_BRANCH': '*',
'GITHUB_REF': 'refs/heads/release'
}
config = get_annotations_config(options, None)
self.assertEqual(['one', 'two', 'three'], config)
def test_get_annotations_config_default(self):
config = get_annotations_config({}, None)
self.assertEqual(['all tests', 'skipped tests'], config)
def test_get_files_single(self):
filenames = ['file1.txt', 'file2.txt', 'file3.bin']
with tempfile.TemporaryDirectory() as path:
with chdir(path):
for filename in filenames:
with open(filename, mode='w'):
pass
files = get_files('file1.txt')
self.assertEqual(['file1.txt'], sorted(files))
def test_get_files_multi(self):
for sep in ['\n', '\r\n', '\n\r', '\n\n', '\r\n\r\n']:
with self.subTest(sep=sep):
filenames = ['file1.txt', 'file2.txt', 'file3.bin']
with tempfile.TemporaryDirectory() as path:
with chdir(path):
for filename in filenames:
with open(filename, mode='w'):
pass
files = get_files(f'file1.txt{sep}file2.txt')
self.assertEqual(['file1.txt', 'file2.txt'], sorted(files))
def test_get_files_single_wildcard(self):
filenames = ['file1.txt', 'file2.txt', 'file3.bin']
for wildcard in ['*.txt', 'file?.txt']:
with self.subTest(wildcard=wildcard):
with tempfile.TemporaryDirectory() as path:
with chdir(path):
for filename in filenames:
with open(filename, mode='w'):
pass
files = get_files(wildcard)
self.assertEqual(['file1.txt', 'file2.txt'], sorted(files))
def test_get_files_multi_wildcard(self):
for sep in ['\n', '\r\n', '\n\r', '\n\n', '\r\n\r\n']:
with self.subTest(sep=sep):
filenames = ['file1.txt', 'file2.txt', 'file3.bin']
with tempfile.TemporaryDirectory() as path:
with chdir(path):
for filename in filenames:
with open(filename, mode='w'):
pass
files = get_files(f'*1.txt{sep}*3.bin')
self.assertEqual(['file1.txt', 'file3.bin'], sorted(files))
def test_get_files_subdir_and_wildcard(self):
filenames = [os.path.join('sub', 'file1.txt'),
os.path.join('sub', 'file2.txt'),
os.path.join('sub', 'file3.bin'),
os.path.join('sub2', 'file4.txt'),
'file5.txt']
with tempfile.TemporaryDirectory() as path:
with chdir(path):
os.mkdir('sub')
os.mkdir('sub2')
for filename in filenames:
with open(filename, mode='w'):
pass
files = get_files('sub/*.txt')
self.assertEqual([os.path.join('sub', 'file1.txt'),
os.path.join('sub', 'file2.txt')], sorted(files))
def test_get_files_recursive_wildcard(self):
for pattern, expected in [('**/*.txt', ['file6.txt', os.path.join('sub', 'file1.txt'), os.path.join('sub', 'file2.txt'), os.path.join('sub2', 'file4.txt'), os.path.join('sub2', 'sub3', 'sub4', 'file5.txt')]),
('./**/*.txt', [os.path.join('.', 'file6.txt'), os.path.join('.', 'sub', 'file1.txt'), os.path.join('.', 'sub', 'file2.txt'), os.path.join('.', 'sub2', 'file4.txt'), os.path.join('.', 'sub2', 'sub3', 'sub4', 'file5.txt')]),
('*/**/*.txt', [os.path.join('sub', 'file1.txt'), os.path.join('sub', 'file2.txt'), os.path.join('sub2', 'file4.txt'), os.path.join('sub2', 'sub3', 'sub4', 'file5.txt')])]:
with self.subTest(pattern=pattern):
filenames = [os.path.join('sub', 'file1.txt'),
os.path.join('sub', 'file2.txt'),
os.path.join('sub', 'file3.bin'),
os.path.join('sub2', 'file4.txt'),
os.path.join('sub2', 'sub3', 'sub4', 'file5.txt'),
'file6.txt']
with tempfile.TemporaryDirectory() as path:
with chdir(path):
os.mkdir('sub')
os.mkdir('sub2')
os.mkdir(os.path.join('sub2', 'sub3'))
os.mkdir(os.path.join('sub2', 'sub3', 'sub4'))
for filename in filenames:
with open(filename, mode='w'):
pass
files = get_files(pattern)
self.assertEqual(sorted(expected), sorted(files))
def test_get_files_symlinks(self):
for pattern, expected in [('**/*.txt', [os.path.join('sub1', 'file1.txt'), os.path.join('sub2', 'file2.txt'), os.path.join('sub1', 'sub2', 'file2.txt')]),
('./**/*.txt', [os.path.join('.', 'sub1', 'file1.txt'), os.path.join('.', 'sub2', 'file2.txt'), os.path.join('.', 'sub1', 'sub2', 'file2.txt')]),
('*/*.txt', [os.path.join('sub1', 'file1.txt'), os.path.join('sub2', 'file2.txt')])]:
with self.subTest(pattern=pattern):
with tempfile.TemporaryDirectory() as path:
filenames = [os.path.join('sub1', 'file1.txt'),
os.path.join('sub2', 'file2.txt')]
with chdir(path):
os.mkdir('sub1')
os.mkdir('sub2')
for filename in filenames:
with open(filename, mode='w'):
pass
os.symlink(os.path.join(path, 'sub2'), os.path.join(path, 'sub1', 'sub2'), target_is_directory=True)
files = get_files(pattern)
self.assertEqual(sorted(expected), sorted(files))
def test_get_files_character_range(self):
filenames = ['file1.txt', 'file2.txt', 'file3.bin']
with tempfile.TemporaryDirectory() as path:
with chdir(path):
for filename in filenames:
with open(filename, mode='w'):
pass
files = get_files('file[0-2].*')
self.assertEqual(['file1.txt', 'file2.txt'], sorted(files))
def test_get_files_multi_match(self):
filenames = ['file1.txt', 'file2.txt', 'file3.bin']
with tempfile.TemporaryDirectory() as path:
with chdir(path):
for filename in filenames:
with open(filename, mode='w'):
pass
files = get_files('*.txt\nfile*.txt\nfile2.*')
self.assertEqual(['file1.txt', 'file2.txt'], sorted(files))
def test_get_files_absolute_path_and_wildcard(self):
filenames = ['file1.txt', 'file2.txt', 'file3.bin']
with tempfile.TemporaryDirectory() as path:
with chdir(path):
for filename in filenames:
with open(filename, mode='w'):
pass
files = get_files(os.path.join(path, '*'))
self.assertEqual([os.path.join(path, file) for file in filenames], sorted(files))
def test_get_files_exclude_only(self):
filenames = ['file1.txt', 'file2.txt', 'file3.bin']
with tempfile.TemporaryDirectory() as path:
with chdir(path):
for filename in filenames:
with open(filename, mode='w'):
pass
files = get_files('!file*.txt')
self.assertEqual([], sorted(files))
def test_get_files_include_and_exclude(self):
filenames = ['file1.txt', 'file2.txt', 'file3.bin']
with tempfile.TemporaryDirectory() as path:
with chdir(path):
for filename in filenames:
with open(filename, mode='w'):
pass
files = get_files('*.txt\n!file1.txt')
self.assertEqual(['file2.txt'], sorted(files))
def test_get_files_with_mock(self):
with mock.patch('publish_test_results.glob') as m:
files = get_files('*.txt\n!file1.txt')
self.assertEqual([], files)
self.assertEqual([mock.call('*.txt', recursive=True), mock.call('file1.txt', recursive=True)], m.call_args_list)
def test_parse_files(self):
gha = mock.MagicMock()
settings = self.get_settings(junit_files_glob=str(test_files_path / 'junit-xml' / '**' / '*.xml'),
nunit_files_glob=str(test_files_path / 'nunit' / '**' / '*.xml'),
xunit_files_glob=str(test_files_path / 'xunit' / '**' / '*.xml'),
trx_files_glob=str(test_files_path / 'trx' / '**' / '*.trx'))
with mock.patch('publish_test_results.logger') as l:
actual = parse_files(settings, gha)
self.assertEqual(5, len(l.info.call_args_list))
self.assertTrue(any([call.args[0].startswith(f'Reading JUnit files {settings.junit_files_glob} (26 files, ') for call in l.info.call_args_list]))
self.assertTrue(any([call.args[0].startswith(f'Reading NUnit files {settings.nunit_files_glob} (24 files, ') for call in l.info.call_args_list]))
self.assertTrue(any([call.args[0].startswith(f'Reading XUnit files {settings.xunit_files_glob} (8 files, ') for call in l.info.call_args_list]))
self.assertTrue(any([call.args[0].startswith(f'Reading TRX files {settings.trx_files_glob} (9 files, ') for call in l.info.call_args_list]))
self.assertTrue(any([call.args[0].startswith(f'Finished reading 67 files in ') for call in l.info.call_args_list]))
self.assertEqual(4, len(l.debug.call_args_list))
self.assertTrue(any([call.args[0].startswith('reading JUnit files [') for call in l.debug.call_args_list]))
self.assertTrue(any([call.args[0].startswith('reading NUnit files [') for call in l.debug.call_args_list]))
self.assertTrue(any([call.args[0].startswith('reading XUnit files [') for call in l.debug.call_args_list]))
self.assertTrue(any([call.args[0].startswith('reading TRX files [') for call in l.debug.call_args_list]))
self.assertEqual([], gha.method_calls)
print(actual.errors)
self.assertEqual(67, actual.files)
if Version(sys.version.split(' ')[0]) >= Version('3.10.0') and sys.platform.startswith('darwin'):
# on macOS and Python 3.10 we see one particular error
self.assertEqual(8, len(actual.errors))
self.assertEqual(356, actual.suites)
self.assertEqual(1925, actual.suite_tests)
self.assertEqual(106, actual.suite_skipped)
self.assertEqual(224, actual.suite_failures)
self.assertEqual(8, actual.suite_errors)
self.assertEqual(3966, actual.suite_time)
self.assertEqual(1913, len(actual.cases))
else:
self.assertEqual(6, len(actual.errors))
self.assertEqual(358, actual.suites)
self.assertEqual(1929, actual.suite_tests)
self.assertEqual(106, actual.suite_skipped)
self.assertEqual(226, actual.suite_failures)
self.assertEqual(8, actual.suite_errors)
self.assertEqual(3966, actual.suite_time)
self.assertEqual(1917, len(actual.cases))
self.assertEqual('commit', actual.commit)
with io.StringIO() as string:
gha = GithubAction(file=string)
with mock.patch('publish.github_action.logger') as m:
log_parse_errors(actual.errors, gha)
self.maxDiff = None
expected = [
"::error::lxml.etree.XMLSyntaxError: Start tag expected, '<' not found, line 1, column 1",
"::error file=non-xml.xml::Error processing result file: Start tag expected, '<' not found, line 1, column 1 (non-xml.xml, line 1)",
"::error::Exception: File is empty.",
"::error file=empty.xml::Error processing result file: File is empty.",
"::error::lxml.etree.XMLSyntaxError: Premature end of data in tag skipped line 9, line 11, column 22",
"::error file=corrupt-xml.xml::Error processing result file: Premature end of data in tag skipped line 9, line 11, column 22 (corrupt-xml.xml, line 11)",
"::error::junitparser.junitparser.JUnitXmlError: Invalid format.",
"::error file=non-junit.xml::Error processing result file: Invalid format.",
"::error::lxml.etree.XMLSyntaxError: Char 0x0 out of allowed range, line 33, column 16",
"::error file=NUnit-issue17521.xml::Error processing result file: Char 0x0 out of allowed range, line 33, column 16 (NUnit-issue17521.xml, line 33)",
"::error::lxml.etree.XMLSyntaxError: attributes construct error, line 5, column 109",
"::error file=NUnit-issue47367.xml::Error processing result file: attributes construct error, line 5, column 109 (NUnit-issue47367.xml, line 5)"
]
if Version(sys.version.split(' ')[0]) >= Version('3.10.0') and sys.platform.startswith('darwin'):
expected.extend([
'::error::lxml.etree.XMLSyntaxError: Failure to process entity xxe, line 17, column 51',
'::error file=NUnit-sec1752-file.xml::Error processing result file: Failure to process entity xxe, line 17, column 51 (NUnit-sec1752-file.xml, line 17)',
'::error::lxml.etree.XMLSyntaxError: Failure to process entity xxe, line 17, column 51',
'::error file=NUnit-sec1752-https.xml::Error processing result file: Failure to process entity xxe, line 17, column 51 (NUnit-sec1752-https.xml, line 17)'
])
self.assertEqual(
sorted(expected),
sorted([re.sub(r'file=.*[/\\]', 'file=', re.sub(r'[(]file:.*/', '(', line))
for line in string.getvalue().split(os.linesep) if line])
)
# self.assertEqual([], m.method_calls)
def test_parse_files_no_matches(self):
gha = mock.MagicMock()
with tempfile.TemporaryDirectory() as path:
missing_junit = str(pathlib.Path(path) / 'junit-not-there')
missing_nunit = str(pathlib.Path(path) / 'nunit-not-there')
missing_xunit = str(pathlib.Path(path) / 'xunit-not-there')
missing_trx = str(pathlib.Path(path) / 'trx-not-there')
settings = self.get_settings(junit_files_glob=missing_junit,
nunit_files_glob=missing_nunit,
xunit_files_glob=missing_xunit,
trx_files_glob=missing_trx)
actual = parse_files(settings, gha)
gha.warning.assert_has_calls([
mock.call(f'Could not find any JUnit files for {missing_junit}'),
mock.call(f'Could not find any NUnit files for {missing_nunit}'),
mock.call(f'Could not find any XUnit files for {missing_xunit}'),
mock.call(f'Could not find any TRX files for {missing_trx}')
])
gha.error.assert_not_called()
self.assertEqual(0, actual.files)
self.assertEqual(0, len(actual.errors))
self.assertEqual(0, actual.suites)
self.assertEqual(0, actual.suite_tests)
self.assertEqual(0, actual.suite_skipped)
self.assertEqual(0, actual.suite_failures)
self.assertEqual(0, actual.suite_errors)
self.assertEqual(0, actual.suite_time)
self.assertEqual(0, len(actual.cases))
self.assertEqual('commit', actual.commit)
def test_throttle_gh_request_raw(self):
logging.root.level = logging.getLevelName('INFO')
logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)5s - %(message)s', datefmt='%Y-%m-%d %H:%M:%S %z')
method = mock.Mock(return_value='response')
throttled_method = throttle_gh_request_raw(2, 5, method)
def test_request(verb: str, expected_sleep: Optional[float]):
with mock.patch('publish_test_results.time.sleep') as sleep:
response = throttled_method('cnx', verb, 'url', 'headers', 'input')
self.assertEqual('response', response)
method.assert_called_once_with('cnx', verb, 'url', 'headers', 'input')
method.reset_mock()
if expected_sleep is not None:
sleep.assert_called_once()
slept = sleep.call_args[0][0]
self.assertLessEqual(slept, expected_sleep)
self.assertGreater(slept, expected_sleep - 0.5)
else:
sleep.assert_not_called()
test_request('GET', None)
test_request('GET', 2.0)
test_request('GET', 2.0)
test_request('POST', 2.0)
test_request('POST', 5.0)
test_request('POST', 5.0)
test_request('GET', 2.0)
# these five seconds are since last write, and they include the 2 seconds of last read,
# but those 2 seconds have not been waited so it still sleeps 5 seconds
test_request('POST', 5.0)
def test_throttle_gh_request_raw_exception(self):
def exc(*args, **kwargs):
raise RuntimeError('request fails')
method = mock.Mock(side_effect=exc)
throttled_method = throttle_gh_request_raw(2, 5, method)
with self.assertRaises(RuntimeError) as re:
throttled_method('cnx', 'GET', 'url', 'headers', 'input')
self.assertIn('request fails', re.exception.args)
def test_is_float(self):
for value, expected in [
('0', True), ('0.0', True), ('.0', True), ('0.', True),
('1.2', True), ('-2.3', True), ('+1.3', True),
('.', False), ('+1', True), ('-2', True), ('+1.', True), ('-2.', True), ('+.1', True), ('-.2', True),
('a1', False), ('1a', False), ('1a2', False), ('12e45', False),
]:
with self.subTest(value=value):
self.assertEqual(expected, is_float(value), value)
def test_main_fork_pr_check(self):
with tempfile.TemporaryDirectory() as path:
filepath = os.path.join(path, 'file')
with open(filepath, 'wt', encoding='utf-8') as file:
file.write('{ "pull_request": { "head": { "repo": { "full_name": "fork/repo" } } } }')
gha = mock.MagicMock()
settings = get_settings(dict(
COMMIT='commit',
GITHUB_TOKEN='********',
GITHUB_EVENT_PATH=file.name,
GITHUB_EVENT_NAME='pull_request',
GITHUB_REPOSITORY='repo',
EVENT_FILE=None
), gha)
def do_raise(*args):
# if this is raised, the tested main method did not return where expected but continued
raise RuntimeError('This is not expected to be called')
with mock.patch('publish_test_results.get_files') as m:
m.side_effect = do_raise
main(settings, gha)
gha.warning.assert_has_calls([
mock.call('This action is running on a pull_request event for a fork repository. '
'It cannot do anything useful like creating check runs or pull request '
'comments. To run the action on fork repository pull requests, see '
'https://github.com/EnricoMi/publish-unit-test-result-action/blob/v1.20'
'/README.md#support-fork-repositories-and-dependabot-branches'),
mock.call('At least one of the *_FILES options has to be set! '