{{ message }}
Repository navigation
Expand file tree
/
Copy pathtest_api.py
More file actions
1708 lines (1454 loc) · 59.6 KB
/
Copy pathtest_api.py
File metadata and controls
1708 lines (1454 loc) · 59.6 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
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
# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
# For details: https://github.com/coveragepy/coveragepy/blob/main/NOTICE.txt
"""Tests for coverage.py's API."""
from __future__ import annotations
import fnmatch
import glob
import io
import os
import os.path
import re
import shutil
import sys
import textwrap
from collections.abc import Callable, Iterable
from contextlib import chdir
from typing import cast
from unittest import mock
import pytest
import coverage
from coverage import Coverage, env
from coverage.data import line_counts, sorted_lines
from coverage.exceptions import ConfigError, CoverageException, NoDataError, NoSource
from coverage.files import abs_file, relative_filename
from coverage.misc import first, import_local_file
from coverage.types import FilePathClasses, FilePathType, TCovKwargs
from tests import testenv
from tests.coveragetest import TESTS_DIR, CoverageTest, UsingModulesMixin
from tests.helpers import (
assert_count_equal,
assert_coverage_warnings,
get_coverage_warnings,
nice_file,
os_sep,
)
# Error messages can differ by version or implementation.
BAD_SQLITE_REGEX = r"file is not a database"
NO_OPEN_REGEX = r"unable to open database file|Could not open database"
class ApiTest(CoverageTest):
"""Api-oriented tests for coverage.py."""
def clean_files(self, files: list[str], pats: list[str]) -> list[str]:
"""Remove names matching `pats` from `files`, a list of file names."""
good = []
for f in files:
for pat in pats:
if fnmatch.fnmatch(f, pat):
break
else:
good.append(f)
return good
def assertFiles(self, files: list[str]) -> None:
"""Assert that the files here are `files`, ignoring the usual junk."""
here = os.listdir(".")
here = self.clean_files(here, ["*.pyc", "__pycache__", "*$py.class"])
assert_count_equal(here, files)
def test_unexecuted_file(self) -> None:
cov = coverage.Coverage()
self.make_file(
"mycode.py",
"""\
a = 1
b = 2
if b == 3:
c = 4
d = 5
""",
)
self.make_file(
"not_run.py",
"""\
fooey = 17
""",
)
# Import the Python file, executing it.
self.start_import_stop(cov, "mycode")
_, statements, missing, _ = cov.analysis("not_run.py")
assert statements == [1]
assert missing == [1]
def test_filenames(self) -> None:
self.make_file(
"mymain.py",
"""\
import mymod
a = 1
""",
)
self.make_file(
"mymod.py",
"""\
fooey = 17
""",
)
# Import the Python file, executing it.
cov = coverage.Coverage()
self.start_import_stop(cov, "mymain")
filename, _, _, _ = cov.analysis("mymain.py")
assert os.path.basename(filename) == "mymain.py"
filename, _, _, _ = cov.analysis("mymod.py")
assert os.path.basename(filename) == "mymod.py"
filename, _, _, _ = cov.analysis(sys.modules["mymain"])
assert os.path.basename(filename) == "mymain.py"
filename, _, _, _ = cov.analysis(sys.modules["mymod"])
assert os.path.basename(filename) == "mymod.py"
# Import the Python file, executing it again, once it's been compiled
# already.
cov = coverage.Coverage()
self.start_import_stop(cov, "mymain")
filename, _, _, _ = cov.analysis("mymain.py")
assert os.path.basename(filename) == "mymain.py"
filename, _, _, _ = cov.analysis("mymod.py")
assert os.path.basename(filename) == "mymod.py"
filename, _, _, _ = cov.analysis(sys.modules["mymain"])
assert os.path.basename(filename) == "mymain.py"
filename, _, _, _ = cov.analysis(sys.modules["mymod"])
assert os.path.basename(filename) == "mymod.py"
@pytest.mark.parametrize("cover_pylib", [False, True])
def test_stdlib(self, cover_pylib: bool) -> None:
self.make_file(
"mymain.py",
"""\
import colorsys
a = 1
hls = colorsys.rgb_to_hls(1.0, 0.5, 0.0)
""",
)
# Measure without the stdlib.
cov1 = coverage.Coverage(cover_pylib=cover_pylib)
self.start_import_stop(cov1, "mymain")
_, statements, missing, _ = cov1.analysis("mymain.py")
assert statements == [1, 2, 3]
assert missing == []
# but none were in colorsys.py
_, statements, missing, _ = cov1.analysis("colorsys.py")
if cover_pylib:
assert statements != missing
else:
assert statements == missing
def test_include_can_measure_stdlib(self) -> None:
self.make_file(
"mymain.py",
"""\
import colorsys, random
a = 1
r, g, b = [random.random() for _ in range(3)]
hls = colorsys.rgb_to_hls(r, g, b)
""",
)
# Measure without the stdlib, but include colorsys.
cov1 = coverage.Coverage(cover_pylib=False, include=["*/colorsys.py"])
self.start_import_stop(cov1, "mymain")
# some statements were marked executed in colorsys.py
_, statements, missing, _ = cov1.analysis("colorsys.py")
assert statements != missing
# but none were in random.py
_, statements, missing, _ = cov1.analysis("random.py")
assert statements == missing
def test_stdlib_symlink(self) -> None:
# Find the stdlib and make a symlink to it.
import colorsys
stdlib_dir = os.path.dirname(colorsys.__file__)
os.symlink(stdlib_dir, "myliblink")
sys.path.insert(0, os.path.abspath("myliblink"))
del sys.modules["colorsys"]
class FakeSysconfig:
"""A fake for the sysconfig module."""
def get_scheme_names(self) -> list[str]: # pylint: disable=missing-function-docstring
return ["xyzzy"]
def get_paths(self, _: str) -> dict[str, str]: # pylint: disable=missing-function-docstring
return {
"stdlib": os.path.abspath("myliblink"),
}
self.make_file(
"mymain.py",
"""\
import colorsys
hls = colorsys.rgb_to_hls(1, 0, 0)
""",
)
with mock.patch.object(coverage.inorout, "sysconfig", FakeSysconfig()):
cov = coverage.Coverage()
self.start_import_stop(cov, "mymain")
files = cov.get_data().measured_files()
assert not any(os.path.basename(f) == "colorsys.py" for f in files)
def test_exclude_list(self) -> None:
cov = coverage.Coverage()
cov.clear_exclude()
assert cov.get_exclude_list() == []
cov.exclude("foo")
assert cov.get_exclude_list() == ["foo"]
cov.exclude("bar")
assert cov.get_exclude_list() == ["foo", "bar"]
assert cov._exclude_regex("exclude") == "(?:foo)|(?:bar)"
cov.clear_exclude()
assert cov.get_exclude_list() == []
def test_exclude_partial_list(self) -> None:
cov = coverage.Coverage()
cov.clear_exclude(which="partial")
assert cov.get_exclude_list(which="partial") == []
cov.exclude("foo", which="partial")
assert cov.get_exclude_list(which="partial") == ["foo"]
cov.exclude("bar", which="partial")
assert cov.get_exclude_list(which="partial") == ["foo", "bar"]
assert cov._exclude_regex(which="partial") == "(?:foo)|(?:bar)"
cov.clear_exclude(which="partial")
assert cov.get_exclude_list(which="partial") == []
def test_exclude_and_partial_are_separate_lists(self) -> None:
cov = coverage.Coverage()
cov.clear_exclude(which="partial")
cov.clear_exclude(which="exclude")
cov.exclude("foo", which="partial")
assert cov.get_exclude_list(which="partial") == ["foo"]
assert cov.get_exclude_list(which="exclude") == []
cov.exclude("bar", which="exclude")
assert cov.get_exclude_list(which="partial") == ["foo"]
assert cov.get_exclude_list(which="exclude") == ["bar"]
cov.exclude("p2", which="partial")
cov.exclude("e2", which="exclude")
assert cov.get_exclude_list(which="partial") == ["foo", "p2"]
assert cov.get_exclude_list(which="exclude") == ["bar", "e2"]
cov.clear_exclude(which="partial")
assert cov.get_exclude_list(which="partial") == []
assert cov.get_exclude_list(which="exclude") == ["bar", "e2"]
cov.clear_exclude(which="exclude")
assert cov.get_exclude_list(which="partial") == []
assert cov.get_exclude_list(which="exclude") == []
def test_datafile_default(self) -> None:
# Default data file behavior: it's .coverage
self.make_file(
"datatest1.py",
"""\
fooey = 17
""",
)
self.assertFiles(["datatest1.py"])
cov = coverage.Coverage()
self.start_import_stop(cov, "datatest1")
cov.save()
self.assertFiles(["datatest1.py", ".coverage"])
@pytest.mark.parametrize("file_class", FilePathClasses)
def test_datafile_specified(self, file_class: FilePathType) -> None:
# You can specify the data file name.
self.make_file(
"datatest2.py",
"""\
fooey = 17
""",
)
self.assertFiles(["datatest2.py"])
cov = coverage.Coverage(data_file=file_class("cov.data"))
self.start_import_stop(cov, "datatest2")
cov.save()
self.assertFiles(["datatest2.py", "cov.data"])
@pytest.mark.parametrize("file_class", FilePathClasses)
def test_datafile_and_suffix_specified(self, file_class: FilePathType) -> None:
# You can specify the data file name and suffix.
self.make_file(
"datatest3.py",
"""\
fooey = 17
""",
)
self.assertFiles(["datatest3.py"])
cov = coverage.Coverage(data_file=file_class("cov.data"), data_suffix="14")
self.start_import_stop(cov, "datatest3")
cov.save()
self.assertFiles(["datatest3.py", "cov.data.14"])
def test_datafile_from_rcfile(self) -> None:
# You can specify the data file name in the .coveragerc file
self.make_file(
"datatest4.py",
"""\
fooey = 17
""",
)
self.make_file(
".coveragerc",
"""\
[run]
data_file = mydata.dat
""",
)
self.assertFiles(["datatest4.py", ".coveragerc"])
cov = coverage.Coverage()
self.start_import_stop(cov, "datatest4")
cov.save()
self.assertFiles(["datatest4.py", ".coveragerc", "mydata.dat"])
def test_deep_datafile(self) -> None:
self.make_file("datatest5.py", "fooey = 17")
self.assertFiles(["datatest5.py"])
cov = coverage.Coverage(data_file="deep/sub/cov.data")
self.start_import_stop(cov, "datatest5")
cov.save()
self.assertFiles(["datatest5.py", "deep"])
self.assert_exists("deep/sub/cov.data")
def test_datafile_none(self) -> None:
cov = coverage.Coverage(data_file=None)
def f1() -> None: # pragma: nested
a = 1 # pylint: disable=unused-variable
one_line_number = f1.__code__.co_firstlineno + 1
lines = []
def run_one_function(f: Callable[[], None]) -> None:
cov.erase()
with cov.collect():
f()
fs = cov.get_data().measured_files()
lines.append(cov.get_data().lines(first(fs)))
run_one_function(f1)
run_one_function(f1)
run_one_function(f1)
assert lines == [[one_line_number]] * 3
self.assert_doesnt_exist(".coverage")
assert os.listdir(".") == []
def test_empty_reporting(self) -> None:
# empty summary reports raise exception, just like the xml report
cov = coverage.Coverage()
cov.erase()
with pytest.raises(NoDataError, match="No data to report."):
cov.report()
def test_completely_zero_reporting(self) -> None:
# https://github.com/coveragepy/coveragepy/issues/884
# If nothing was measured, the file-touching didn't happen properly.
self.make_file("foo/bar.py", "print('Never run')")
self.make_file("test.py", "assert True")
with pytest.warns(Warning) as warns:
cov = coverage.Coverage(source=["foo"])
self.start_import_stop(cov, "test")
cov.report()
assert_coverage_warnings(warns, "No data was collected. (no-data-collected)")
# Name Stmts Miss Cover
# --------------------------------
# foo/bar.py 1 1 0%
# --------------------------------
# TOTAL 1 1 0%
last = self.last_line_squeezed(self.stdout())
assert "TOTAL 1 1 0%" == last
def make_code1_code2(self) -> None:
"""Create the code1.py and code2.py files."""
self.make_file(
"code1.py",
"""\
code1 = 1
""",
)
self.make_file(
"code2.py",
"""\
code2 = 1
code2 = 2
""",
)
def check_code1_code2(self, cov: Coverage) -> None:
"""Check the analysis is correct for code1.py and code2.py."""
_, statements, missing, _ = cov.analysis("code1.py")
assert statements == [1]
assert missing == []
_, statements, missing, _ = cov.analysis("code2.py")
assert statements == [1, 2]
assert missing == []
def test_start_stop_start_stop(self) -> None:
self.make_code1_code2()
cov = coverage.Coverage()
self.start_import_stop(cov, "code1")
cov.save()
self.start_import_stop(cov, "code2")
self.check_code1_code2(cov)
def test_start_save_stop(self) -> None:
self.make_code1_code2()
cov = coverage.Coverage()
with cov.collect():
import_local_file("code1")
cov.save()
import_local_file("code2")
self.check_code1_code2(cov)
def test_start_save_nostop(self) -> None:
self.make_code1_code2()
cov = coverage.Coverage()
with cov.collect():
import_local_file("code1")
cov.save()
import_local_file("code2")
self.check_code1_code2(cov)
def test_two_getdata_only_warn_once(self) -> None:
self.make_code1_code2()
cov = coverage.Coverage(source=["."], omit=["code1.py"])
with cov.collect():
import_local_file("code1")
# We didn't collect any data, so we should get a warning.
with self.assert_warnings(cov, ["No data was collected"]):
cov.get_data()
# But calling get_data a second time with no intervening activity
# won't make another warning.
with self.assert_warnings(cov, []):
cov.get_data()
def test_two_getdata_warn_twice(self) -> None:
self.make_code1_code2()
cov = coverage.Coverage(source=["."], omit=["code1.py", "code2.py"])
with cov.collect():
import_local_file("code1")
# We didn't collect any data, so we should get a warning.
with self.assert_warnings(cov, ["No data was collected"]):
cov.save()
import_local_file("code2")
# Calling get_data a second time after tracing some more will warn again.
with self.assert_warnings(cov, ["No data was collected"]):
cov.get_data()
def make_good_data_files(self) -> None:
"""Make some good data files."""
self.make_code1_code2()
cov = coverage.Coverage(data_suffix=True)
self.start_import_stop(cov, "code1")
cov.save()
cov = coverage.Coverage(data_suffix=True)
self.start_import_stop(cov, "code2")
cov.save()
self.assert_file_count(".coverage.*", 2)
@pytest.mark.parametrize(
"problem, msgpattern",
[
("badcontent", BAD_SQLITE_REGEX),
pytest.param(
"noperms",
NO_OPEN_REGEX,
marks=pytest.mark.xfail(testenv.ROOT_USER, reason="root can read any file"),
),
],
)
def test_combining_bad_data(self, problem: str, msgpattern: str) -> None:
# If you try to combine a bad data file, then you will get a warning,
# and the file will remain.
self.make_good_data_files()
self.make_file(".coverage.foo", """La la la, this isn't coverage data!""")
if problem == "noperms":
if env.WINDOWS:
pytest.skip("os.chmod doesn't work on Windows")
os.chmod(".coverage.foo", 0o000)
cov = coverage.Coverage()
warning_regex = r"Couldn't use data file '.*\.coverage\.foo': " + msgpattern
with self.assert_warnings(cov, [warning_regex]):
cov.combine()
# We got the results from code1 and code2 properly.
self.check_code1_code2(cov)
# The bad file still exists, but it's the only parallel data file left.
self.assert_exists(".coverage.foo")
self.assert_file_count(".coverage.*", 1)
def test_combining_twice(self) -> None:
self.make_good_data_files()
cov1 = coverage.Coverage()
cov1.combine()
assert self.stdout() == ""
cov1.save()
self.check_code1_code2(cov1)
self.assert_file_count(".coverage.*", 0)
self.assert_exists(".coverage")
cov2 = coverage.Coverage()
with pytest.raises(NoDataError, match=r"No data to combine"):
cov2.combine(strict=True, keep=False)
cov3 = coverage.Coverage()
cov3.combine()
assert self.stdout() == ""
# Now the data is empty!
_, statements, missing, _ = cov3.analysis("code1.py")
assert statements == [1]
assert missing == [1]
_, statements, missing, _ = cov3.analysis("code2.py")
assert statements == [1, 2]
assert missing == [1, 2]
def test_combining_with_a_used_coverage(self) -> None:
# Can you use a coverage object to run one shard of a parallel suite,
# and then also combine the data?
self.make_code1_code2()
cov = coverage.Coverage(data_suffix=True)
self.start_import_stop(cov, "code1")
cov.save()
cov = coverage.Coverage(data_suffix=True)
self.start_import_stop(cov, "code2")
cov.save()
cov.combine()
assert self.stdout() == ""
self.check_code1_code2(cov)
def test_combining_after_saving_twice(self) -> None:
# Two parallel runs measure the same code and save while still running,
# then each measures different code and saves again. Combining must
# keep both.
self.make_code1_code2()
self.make_file("code3.py", "code3 = 1\n")
for later in ["code2", "code3"]:
cov = coverage.Coverage(data_suffix=True)
with cov.collect():
import_local_file("code1")
cov.save()
import_local_file(later)
cov.save()
self.assert_file_count(".coverage.*", 2)
cov = coverage.Coverage()
cov.combine()
self.check_code1_code2(cov)
_, statements, missing, _ = cov.analysis("code3.py")
assert statements == [1]
assert missing == []
def test_ordered_combine(self) -> None:
# https://github.com/coveragepy/coveragepy/issues/649
# The order of the [paths] setting used to matter. Now the
# resulting path must exist, so the order doesn't matter.
def make_files() -> None:
self.make_file("plugins/p1.py", "")
self.make_file("girder/g1.py", "")
self.make_data_file(
basename=".coverage.1",
lines={
abs_file("ci/girder/g1.py"): range(10),
abs_file("ci/girder/plugins/p1.py"): range(10),
},
)
def get_combined_filenames() -> set[str]:
cov = coverage.Coverage()
cov.combine()
assert self.stdout() == ""
cov.save()
data = cov.get_data()
filenames = {relative_filename(f).replace("\\", "/") for f in data.measured_files()}
return filenames
# Case 1: get the order right.
make_files()
self.make_file(
".coveragerc",
"""\
[paths]
plugins =
plugins/
ci/girder/plugins/
girder =
girder/
ci/girder/
""",
)
assert get_combined_filenames() == {"girder/g1.py", "plugins/p1.py"}
# Case 2: get the order "wrong".
make_files()
self.make_file(
".coveragerc",
"""\
[paths]
girder =
girder/
ci/girder/
plugins =
plugins/
ci/girder/plugins/
""",
)
assert get_combined_filenames() == {"girder/g1.py", "plugins/p1.py"}
def test_warnings(self) -> None:
self.make_file(
"hello.py",
"""\
import sys, os
print("Hello")
""",
)
with pytest.warns(Warning) as warns:
cov = coverage.Coverage(source=["sys", "xyzzy", "quux"])
self.start_import_stop(cov, "hello")
cov.get_data()
assert "Hello\n" == self.stdout()
assert_coverage_warnings(
warns,
"Module sys has no Python source. (module-not-python)",
"Module xyzzy was never imported. (module-not-imported)",
"Module quux was never imported. (module-not-imported)",
"No data was collected. (no-data-collected)",
)
def test_warnings_suppressed(self) -> None:
self.make_file(
"hello.py",
"""\
import sys, os
print("Hello")
""",
)
self.make_file(
".coveragerc",
"""\
[run]
disable_warnings = no-data-collected, module-not-imported
""",
)
with pytest.warns(Warning) as warns:
cov = coverage.Coverage(source=["sys", "xyzzy", "quux"])
self.start_import_stop(cov, "hello")
cov.get_data()
assert "Hello\n" == self.stdout()
assert_coverage_warnings(warns, "Module sys has no Python source. (module-not-python)")
# No "module-not-imported" in warns
# No "no-data-collected" in warns
def test_warn_once(self) -> None:
with pytest.warns(Warning) as warns:
cov = coverage.Coverage()
cov.load()
cov._warn("Warning, warning 1!", slug="bot", once=True)
cov._warn("Warning, warning 2!", slug="bot", once=True)
assert_coverage_warnings(warns, "Warning, warning 1! (bot)")
# No "Warning, warning 2!" in warns
assert len(get_coverage_warnings(warns)) == 1
def test_warnings_with_urls(self) -> None:
with pytest.warns(Warning) as warns:
cov = coverage.Coverage()
cov.load()
cov._warn("Warning Will Robinson", slug="will-rob")
cov._warn("Warning, warning 2!", slug="second-one")
warnings = get_coverage_warnings(warns)
def url(slug: str) -> str:
return (
f"https://coverage.readthedocs.io/en/{coverage.__version__}"
+ f"/messages.html#warning-{slug}"
)
assert warnings == [
f"Warning Will Robinson (will-rob); see {url('will-rob')}",
f"Warning, warning 2! (second-one); see {url('second-one')}",
]
def test_source_and_include_dont_conflict(self) -> None:
# A bad fix made this case fail: https://github.com/coveragepy/coveragepy/issues/541
self.make_file("a.py", "import b\na = 1")
self.make_file("b.py", "b = 1")
self.make_file(
".coveragerc",
"""\
[run]
source = .
""",
)
# Just like: coverage run a.py
cov = coverage.Coverage()
self.start_import_stop(cov, "a")
cov.save()
# Run the equivalent of: coverage report --include=b.py
cov = coverage.Coverage(include=["b.py"])
cov.load()
# There should be no exception. At one point, report() threw:
# CoverageException: --include and --source are mutually exclusive
cov.report()
expected = textwrap.dedent("""\
Name Stmts Miss Cover
---------------------------
b.py 1 0 100%
---------------------------
TOTAL 1 0 100%
""")
assert expected == self.stdout()
def test_config_crash(self) -> None:
# The internal '[run] _crash' setting can be used to artificially raise
# exceptions from inside Coverage.
cov = coverage.Coverage()
cov.set_option("run:_crash", "test_config_crash")
with pytest.raises(Exception, match="Crashing because called by test_config_crash"):
cov.start()
def test_config_crash_no_crash(self) -> None:
# '[run] _crash' really checks the call stack.
cov = coverage.Coverage()
cov.set_option("run:_crash", "not_my_caller")
cov.start()
cov.stop()
def test_run_debug_sys(self) -> None:
# https://github.com/coveragepy/coveragepy/issues/907
cov = coverage.Coverage()
with cov.collect():
d = dict(cov.sys_info())
assert cast(str, d["data_file"]).endswith(".coverage")
@pytest.mark.skipif(not testenv.SYS_MON, reason="Only sysmon drops dynamic contexts.")
def test_switch_context_sysmon_warning(self) -> None:
cov = coverage.Coverage(config_file=False)
with cov.collect():
with pytest.warns(Warning) as warns:
cov.switch_context("test_a")
cov.switch_context("test_b")
assert_coverage_warnings(
warns,
"Dynamic contexts aren't supported with core=sysmon; "
+ "context data may be incomplete (no-sysmon-context)",
)
@pytest.mark.skipif(not testenv.DYN_CONTEXTS, reason="No dynamic contexts with this core.")
class SwitchContextTest(CoverageTest):
"""Tests of the .switch_context() method."""
def make_test_files(self) -> None:
"""Create a simple file representing a method with two tests."""
self.make_file(
"testsuite.py",
"""\
def timestwo(x):
return x*2
def test_multiply_zero():
assert timestwo(0) == 0
def test_multiply_six():
assert timestwo(6) == 12
""",
)
def test_switch_context_testrunner(self) -> None:
# This test simulates a coverage-aware test runner,
# measuring labeled coverage via public API
self.make_test_files()
# Test runner starts
cov = coverage.Coverage()
with cov.collect():
# Imports the test suite
suite = import_local_file("testsuite")
# Measures test case 1
prev = cov.switch_context("multiply_zero")
assert prev is None
suite.test_multiply_zero()
# Measures test case 2
prev = cov.switch_context("multiply_six")
assert prev == "multiply_zero"
suite.test_multiply_six()
# Runner finishes
cov.save()
# Labeled data is collected
data = cov.get_data()
assert ["", "multiply_six", "multiply_zero"] == sorted(data.measured_contexts())
filenames = self.get_measured_filenames(data)
suite_filename = filenames["testsuite.py"]
data.set_query_context("multiply_six")
assert [2, 8] == sorted_lines(data, suite_filename)
data.set_query_context("multiply_zero")
assert [2, 5] == sorted_lines(data, suite_filename)
def test_switch_context_with_static(self) -> None:
# This test simulates a coverage-aware test runner,
# measuring labeled coverage via public API,
# with static label prefix.
self.make_test_files()
# Test runner starts
cov = coverage.Coverage(context="mysuite")
with cov.collect():
# Imports the test suite
suite = import_local_file("testsuite")
# Measures test case 1
prev = cov.switch_context("multiply_zero")
assert prev == "mysuite"
suite.test_multiply_zero()
# Measures test case 2
prev = cov.switch_context("multiply_six")
assert prev == "mysuite|multiply_zero"
suite.test_multiply_six()
# Runner finishes
cov.save()
# Labeled data is collected
data = cov.get_data()
expected = ["mysuite", "mysuite|multiply_six", "mysuite|multiply_zero"]
assert expected == sorted(data.measured_contexts())
filenames = self.get_measured_filenames(data)
suite_filename = filenames["testsuite.py"]
data.set_query_context("mysuite|multiply_six")
assert [2, 8] == sorted_lines(data, suite_filename)
data.set_query_context("mysuite|multiply_zero")
assert [2, 5] == sorted_lines(data, suite_filename)
def test_dynamic_context_conflict(self) -> None:
cov = coverage.Coverage()
cov.set_option("run:dynamic_context", "test_function")
with cov.collect():
with pytest.warns(Warning) as warns:
# Switch twice, but only get one warning.
cov.switch_context("test1")
cov.switch_context("test2")
assert_coverage_warnings(warns, "Conflicting dynamic contexts (dynamic-conflict)")
def test_unknown_dynamic_context(self) -> None:
cov = coverage.Coverage()
cov.set_option("run:dynamic_context", "no-idea")
with pytest.raises(Exception, match="Don't understand dynamic_context setting: 'no-idea'"):
cov.start()
def test_switch_context_unstarted(self) -> None:
# Coverage must be started to switch context
msg = "Cannot switch context, coverage is not started"
cov = coverage.Coverage()
with pytest.raises(CoverageException, match=msg):
cov.switch_context("test1")
with cov.collect():
cov.switch_context("test2")
with pytest.raises(CoverageException, match=msg):
cov.switch_context("test3")
class CurrentInstanceTest(CoverageTest):
"""Tests of Coverage.current()."""
run_in_temp_dir = False
def assert_current_is_none(self, current: Coverage | None) -> None:
"""Assert that a current we expect to be None is correct."""
# During meta-coverage, the None answers will be wrong because the
# overall coverage measurement will still be on the current-stack.
# Since we know they will be wrong, and we have non-meta test runs
# also, don't assert them.
if not env.METACOV:
assert current is None
def test_current(self) -> None:
cur0 = coverage.Coverage.current()
self.assert_current_is_none(cur0)
# Making an instance doesn't make it current.
cov = coverage.Coverage()
cur1 = coverage.Coverage.current()
self.assert_current_is_none(cur1)
assert cur0 is cur1
# Starting the instance makes it current.
with cov.collect():
cur2 = coverage.Coverage.current()
assert cur2 is cov
# Stopping the instance makes current None again.
cur3 = coverage.Coverage.current()
self.assert_current_is_none(cur3)
assert cur0 is cur3
class NamespaceModuleTest(UsingModulesMixin, CoverageTest):
"""Test PEP-420 namespace modules."""
def test_explicit_namespace_module(self) -> None:
self.make_file("main.py", "import namespace_420\n")
cov = coverage.Coverage()
self.start_import_stop(cov, "main")
with pytest.raises(CoverageException, match=r"Module .* has no file"):
cov.analysis(sys.modules["namespace_420"])
def test_bug_572(self) -> None:
self.make_file("main.py", "import namespace_420\n")
# Use source=namespace_420 to trigger the check that used to fail,
# and use source=main so that something is measured.
cov = coverage.Coverage(source=["namespace_420", "main"])
with self.assert_warnings(cov, []):
self.start_import_stop(cov, "main")
cov.report()
class IncludeOmitTestsMixin(UsingModulesMixin, CoverageTest):
"""Test methods for coverage methods taking include and omit."""
# An abstract method for subclasses to define, to appease mypy.
def coverage_usepkgs(self, **kwargs_unused: TCovKwargs) -> Iterable[str]:
"""Run coverage on usepkgs, return a line summary. kwargs are for Coverage(**kwargs)."""
raise NotImplementedError() # pragma: not covered
def filenames_in(self, summary: Iterable[str], filenames: str) -> None:
"""Assert the `filenames` are in the `summary`."""
for filename in filenames.split():
assert filename in summary
def filenames_not_in(self, summary: Iterable[str], filenames: str) -> None:
"""Assert the `filenames` are not in the `summary`."""
for filename in filenames.split():
assert filename not in summary
def test_nothing_specified(self) -> None:
result = self.coverage_usepkgs()
self.filenames_in(result, "p1a p1b p2a p2b othera otherb osa osb")
self.filenames_not_in(result, "p1c")
# Because there was no source= specified, we don't search for
# un-executed files.
def test_include(self) -> None:
result = self.coverage_usepkgs(include=["*/p1a.py"])
self.filenames_in(result, "p1a")
self.filenames_not_in(result, "p1b p1c p2a p2b othera otherb osa osb")
def test_include_2(self) -> None:
result = self.coverage_usepkgs(include=["*a.py"])
self.filenames_in(result, "p1a p2a othera osa")
self.filenames_not_in(result, "p1b p1c p2b otherb osb")
def test_include_as_string(self) -> None:
result = self.coverage_usepkgs(include="*a.py")
self.filenames_in(result, "p1a p2a othera osa")
self.filenames_not_in(result, "p1b p1c p2b otherb osb")
def test_omit(self) -> None:
result = self.coverage_usepkgs(omit=["*/p1a.py"])
You can’t perform that action at this time.