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
|
# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
# For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt
"""Test the config file handling for coverage.py"""
from collections import OrderedDict
from unittest import mock
import pytest
import coverage
from coverage.config import HandyConfigParser
from coverage.exceptions import CoverageException, CoverageWarning
from tests.coveragetest import CoverageTest, UsingModulesMixin
from tests.helpers import without_module
class ConfigTest(CoverageTest):
"""Tests of the different sources of configuration settings."""
def test_default_config(self):
# Just constructing a coverage() object gets the right defaults.
cov = coverage.Coverage()
assert not cov.config.timid
assert not cov.config.branch
assert cov.config.data_file == ".coverage"
def test_arguments(self):
# Arguments to the constructor are applied to the configuration.
cov = coverage.Coverage(timid=True, data_file="fooey.dat", concurrency="multiprocessing")
assert cov.config.timid
assert not cov.config.branch
assert cov.config.data_file == "fooey.dat"
assert cov.config.concurrency == ["multiprocessing"]
def test_config_file(self):
# A .coveragerc file will be read into the configuration.
self.make_file(".coveragerc", """\
# This is just a bogus .rc file for testing.
[run]
timid = True
data_file = .hello_kitty.data
""")
cov = coverage.Coverage()
assert cov.config.timid
assert not cov.config.branch
assert cov.config.data_file == ".hello_kitty.data"
def test_named_config_file(self):
# You can name the config file what you like.
self.make_file("my_cov.ini", """\
[run]
timid = True
; I wouldn't really use this as a data file...
data_file = delete.me
""")
cov = coverage.Coverage(config_file="my_cov.ini")
assert cov.config.timid
assert not cov.config.branch
assert cov.config.data_file == "delete.me"
def test_toml_config_file(self):
# A .coveragerc file will be read into the configuration.
self.make_file("pyproject.toml", """\
# This is just a bogus toml file for testing.
[tool.somethingelse]
authors = ["Joe D'Ávila <joe@gmail.com>"]
[tool.coverage.run]
concurrency = ["a", "b"]
timid = true
data_file = ".hello_kitty.data"
plugins = ["plugins.a_plugin"]
[tool.coverage.report]
precision = 3
fail_under = 90.5
[tool.coverage.html]
title = "tabblo & «ταБЬℓσ»"
[tool.coverage.plugins.a_plugin]
hello = "world"
""")
cov = coverage.Coverage(config_file="pyproject.toml")
assert cov.config.timid
assert not cov.config.branch
assert cov.config.concurrency == ["a", "b"]
assert cov.config.data_file == ".hello_kitty.data"
assert cov.config.plugins == ["plugins.a_plugin"]
assert cov.config.precision == 3
assert cov.config.html_title == "tabblo & «ταБЬℓσ»"
assert round(abs(cov.config.fail_under-90.5), 7) == 0
assert cov.config.get_plugin_options("plugins.a_plugin") == {"hello": "world"}
# Test that our class doesn't reject integers when loading floats
self.make_file("pyproject.toml", """\
# This is just a bogus toml file for testing.
[tool.coverage.report]
fail_under = 90
""")
cov = coverage.Coverage(config_file="pyproject.toml")
assert round(abs(cov.config.fail_under-90), 7) == 0
assert isinstance(cov.config.fail_under, float)
def test_ignored_config_file(self):
# You can disable reading the .coveragerc file.
self.make_file(".coveragerc", """\
[run]
timid = True
data_file = delete.me
""")
cov = coverage.Coverage(config_file=False)
assert not cov.config.timid
assert not cov.config.branch
assert cov.config.data_file == ".coverage"
def test_config_file_then_args(self):
# The arguments override the .coveragerc file.
self.make_file(".coveragerc", """\
[run]
timid = True
data_file = weirdo.file
""")
cov = coverage.Coverage(timid=False, data_file=".mycov")
assert not cov.config.timid
assert not cov.config.branch
assert cov.config.data_file == ".mycov"
def test_data_file_from_environment(self):
# There's an environment variable for the data_file.
self.make_file(".coveragerc", """\
[run]
timid = True
data_file = weirdo.file
""")
self.set_environ("COVERAGE_FILE", "fromenv.dat")
cov = coverage.Coverage()
assert cov.config.data_file == "fromenv.dat"
# But the constructor arguments override the environment variable.
cov = coverage.Coverage(data_file="fromarg.dat")
assert cov.config.data_file == "fromarg.dat"
def test_debug_from_environment(self):
self.make_file(".coveragerc", """\
[run]
debug = dataio, pids
""")
self.set_environ("COVERAGE_DEBUG", "callers, fooey")
cov = coverage.Coverage()
assert cov.config.debug == ["dataio", "pids", "callers", "fooey"]
def test_rcfile_from_environment(self):
self.make_file("here.ini", """\
[run]
data_file = overthere.dat
""")
self.set_environ("COVERAGE_RCFILE", "here.ini")
cov = coverage.Coverage()
assert cov.config.data_file == "overthere.dat"
def test_missing_rcfile_from_environment(self):
self.set_environ("COVERAGE_RCFILE", "nowhere.ini")
msg = "Couldn't read 'nowhere.ini' as a config file"
with pytest.raises(CoverageException, match=msg):
coverage.Coverage()
def test_parse_errors(self):
# Im-parsable values raise CoverageException, with details.
bad_configs_and_msgs = [
("[run]\ntimid = maybe?\n", r"maybe[?]"),
("timid = 1\n", r"no section headers"),
("[run\n", r"\[run"),
("[report]\nexclude_lines = foo(\n",
r"Invalid \[report\].exclude_lines value 'foo\(': "
r"(unbalanced parenthesis|missing \))"),
("[report]\npartial_branches = foo[\n",
r"Invalid \[report\].partial_branches value 'foo\[': "
r"(unexpected end of regular expression|unterminated character set)"),
("[report]\npartial_branches_always = foo***\n",
r"Invalid \[report\].partial_branches_always value "
r"'foo\*\*\*': "
r"multiple repeat"),
]
for bad_config, msg in bad_configs_and_msgs:
print("Trying %r" % bad_config)
self.make_file(".coveragerc", bad_config)
with pytest.raises(CoverageException, match=msg):
coverage.Coverage()
@pytest.mark.parametrize("bad_config,msg", [
("[tool.coverage.run]\ntimid = \"maybe?\"\n", r"maybe[?]"),
("[tool.coverage.run\n", None),
('[tool.coverage.report]\nexclude_lines = ["foo("]\n',
r"Invalid \[tool.coverage.report\].exclude_lines value u?'foo\(': "
r"(unbalanced parenthesis|missing \))"),
('[tool.coverage.report]\npartial_branches = ["foo["]\n',
r"Invalid \[tool.coverage.report\].partial_branches value u?'foo\[': "
r"(unexpected end of regular expression|unterminated character set)"),
('[tool.coverage.report]\npartial_branches_always = ["foo***"]\n',
r"Invalid \[tool.coverage.report\].partial_branches_always value "
r"u?'foo\*\*\*': "
r"multiple repeat"),
('[tool.coverage.run]\nconcurrency="foo"', "not a list"),
("[tool.coverage.report]\nprecision=1.23", "not an integer"),
('[tool.coverage.report]\nfail_under="s"', "not a float"),
])
def test_toml_parse_errors(self, bad_config, msg):
# Im-parsable values raise CoverageException, with details.
self.make_file("pyproject.toml", bad_config)
with pytest.raises(CoverageException, match=msg):
coverage.Coverage()
def test_environment_vars_in_config(self):
# Config files can have $envvars in them.
self.make_file(".coveragerc", """\
[run]
data_file = $DATA_FILE.fooey
branch = $OKAY
[report]
exclude_lines =
the_$$one
another${THING}
x${THING}y
x${NOTHING}y
huh$${X}what
""")
self.set_environ("DATA_FILE", "hello-world")
self.set_environ("THING", "ZZZ")
self.set_environ("OKAY", "yes")
cov = coverage.Coverage()
assert cov.config.data_file == "hello-world.fooey"
assert cov.config.branch is True
assert cov.config.exclude_list == ["the_$one", "anotherZZZ", "xZZZy", "xy", "huh${X}what"]
def test_environment_vars_in_toml_config(self):
# Config files can have $envvars in them.
self.make_file("pyproject.toml", """\
[tool.coverage.run]
data_file = "$DATA_FILE.fooey"
branch = $BRANCH
[tool.coverage.report]
exclude_lines = [
"the_$$one",
"another${THING}",
"x${THING}y",
"x${NOTHING}y",
"huh$${X}what",
]
""")
self.set_environ("BRANCH", "true")
self.set_environ("DATA_FILE", "hello-world")
self.set_environ("THING", "ZZZ")
cov = coverage.Coverage()
assert cov.config.data_file == "hello-world.fooey"
assert cov.config.branch is True
assert cov.config.exclude_list == ["the_$one", "anotherZZZ", "xZZZy", "xy", "huh${X}what"]
def test_tilde_in_config(self):
# Config entries that are file paths can be tilde-expanded.
self.make_file(".coveragerc", """\
[run]
data_file = ~/data.file
[html]
directory = ~joe/html_dir
[xml]
output = ~/somewhere/xml.out
[report]
# Strings that aren't file paths are not tilde-expanded.
exclude_lines =
~/data.file
~joe/html_dir
[paths]
mapping =
~/src
~joe/source
""")
def expanduser(s):
"""Fake tilde expansion"""
s = s.replace("~/", "/Users/me/")
s = s.replace("~joe/", "/Users/joe/")
return s
with mock.patch.object(coverage.config.os.path, 'expanduser', new=expanduser):
cov = coverage.Coverage()
assert cov.config.data_file == "/Users/me/data.file"
assert cov.config.html_dir == "/Users/joe/html_dir"
assert cov.config.xml_output == "/Users/me/somewhere/xml.out"
assert cov.config.exclude_list == ["~/data.file", "~joe/html_dir"]
assert cov.config.paths == {'mapping': ['/Users/me/src', '/Users/joe/source']}
def test_tilde_in_toml_config(self):
# Config entries that are file paths can be tilde-expanded.
self.make_file("pyproject.toml", """\
[tool.coverage.run]
data_file = "~/data.file"
[tool.coverage.html]
directory = "~joe/html_dir"
[tool.coverage.xml]
output = "~/somewhere/xml.out"
[tool.coverage.report]
# Strings that aren't file paths are not tilde-expanded.
exclude_lines = [
"~/data.file",
"~joe/html_dir",
]
""")
def expanduser(s):
"""Fake tilde expansion"""
s = s.replace("~/", "/Users/me/")
s = s.replace("~joe/", "/Users/joe/")
return s
with mock.patch.object(coverage.config.os.path, 'expanduser', new=expanduser):
cov = coverage.Coverage()
assert cov.config.data_file == "/Users/me/data.file"
assert cov.config.html_dir == "/Users/joe/html_dir"
assert cov.config.xml_output == "/Users/me/somewhere/xml.out"
assert cov.config.exclude_list == ["~/data.file", "~joe/html_dir"]
def test_tweaks_after_constructor(self):
# set_option can be used after construction to affect the config.
cov = coverage.Coverage(timid=True, data_file="fooey.dat")
cov.set_option("run:timid", False)
assert not cov.config.timid
assert not cov.config.branch
assert cov.config.data_file == "fooey.dat"
assert not cov.get_option("run:timid")
assert not cov.get_option("run:branch")
assert cov.get_option("run:data_file") == "fooey.dat"
def test_tweaks_paths_after_constructor(self):
self.make_file(".coveragerc", """\
[paths]
first =
/first/1
/first/2
second =
/second/a
/second/b
""")
old_paths = OrderedDict()
old_paths["first"] = ["/first/1", "/first/2"]
old_paths["second"] = ["/second/a", "/second/b"]
cov = coverage.Coverage()
paths = cov.get_option("paths")
assert paths == old_paths
new_paths = OrderedDict()
new_paths['magic'] = ['src', 'ok']
cov.set_option("paths", new_paths)
assert cov.get_option("paths") == new_paths
def test_tweak_error_checking(self):
# Trying to set an unknown config value raises an error.
cov = coverage.Coverage()
with pytest.raises(CoverageException, match="No such option: 'run:xyzzy'"):
cov.set_option("run:xyzzy", 12)
with pytest.raises(CoverageException, match="No such option: 'xyzzy:foo'"):
cov.set_option("xyzzy:foo", 12)
with pytest.raises(CoverageException, match="No such option: 'run:xyzzy'"):
_ = cov.get_option("run:xyzzy")
with pytest.raises(CoverageException, match="No such option: 'xyzzy:foo'"):
_ = cov.get_option("xyzzy:foo")
def test_tweak_plugin_options(self):
# Plugin options have a more flexible syntax.
cov = coverage.Coverage()
cov.set_option("run:plugins", ["fooey.plugin", "xyzzy.coverage.plugin"])
cov.set_option("fooey.plugin:xyzzy", 17)
cov.set_option("xyzzy.coverage.plugin:plugh", ["a", "b"])
with pytest.raises(CoverageException, match="No such option: 'no_such.plugin:foo'"):
cov.set_option("no_such.plugin:foo", 23)
assert cov.get_option("fooey.plugin:xyzzy") == 17
assert cov.get_option("xyzzy.coverage.plugin:plugh") == ["a", "b"]
with pytest.raises(CoverageException, match="No such option: 'no_such.plugin:foo'"):
_ = cov.get_option("no_such.plugin:foo")
def test_unknown_option(self):
self.make_file(".coveragerc", """\
[run]
xyzzy = 17
""")
msg = r"Unrecognized option '\[run\] xyzzy=' in config file .coveragerc"
with pytest.warns(CoverageWarning, match=msg):
_ = coverage.Coverage()
def test_unknown_option_toml(self):
self.make_file("pyproject.toml", """\
[tool.coverage.run]
xyzzy = 17
""")
msg = r"Unrecognized option '\[tool.coverage.run\] xyzzy=' in config file pyproject.toml"
with pytest.warns(CoverageWarning, match=msg):
_ = coverage.Coverage()
def test_misplaced_option(self):
self.make_file(".coveragerc", """\
[report]
branch = True
""")
msg = r"Unrecognized option '\[report\] branch=' in config file .coveragerc"
with pytest.warns(CoverageWarning, match=msg):
_ = coverage.Coverage()
def test_unknown_option_in_other_ini_file(self):
self.make_file("setup.cfg", """\
[coverage:run]
huh = what?
""")
msg = r"Unrecognized option '\[coverage:run\] huh=' in config file setup.cfg"
with pytest.warns(CoverageWarning, match=msg):
_ = coverage.Coverage()
def test_exceptions_from_missing_things(self):
self.make_file("config.ini", """\
[run]
branch = True
""")
config = HandyConfigParser("config.ini")
with pytest.raises(Exception, match="No section: 'xyzzy'"):
config.options("xyzzy")
with pytest.raises(Exception, match="No option 'foo' in section: 'xyzzy'"):
config.get("xyzzy", "foo")
class ConfigFileTest(UsingModulesMixin, CoverageTest):
"""Tests of the config file settings in particular."""
# This sample file tries to use lots of variation of syntax...
# The {section} placeholder lets us nest these settings in another file.
LOTSA_SETTINGS = """\
# This is a settings file for coverage.py
[{section}run]
timid = yes
data_file = something_or_other.dat
branch = 1
cover_pylib = TRUE
parallel = on
concurrency = thread
; this omit is overridden by the omit from [report]
omit = twenty
source = myapp
source_pkgs = ned
plugins =
plugins.a_plugin
plugins.another
debug = callers, pids , dataio
disable_warnings = abcd , efgh
[{section}report]
; these settings affect reporting.
exclude_lines =
if 0:
pragma:?\\s+no cover
another_tab
ignore_errors = TRUE
omit =
one, another, some_more,
yet_more
include = thirty
precision = 3
partial_branches =
pragma:?\\s+no branch
partial_branches_always =
if 0:
while True:
show_missing= TruE
skip_covered = TruE
skip_empty =TruE
[{section}html]
directory = c:\\tricky\\dir.somewhere
extra_css=something/extra.css
title = Title & nums # nums!
[{section}xml]
output=mycov.xml
package_depth = 17
[{section}paths]
source =
.
/home/ned/src/
other = other, /home/ned/other, c:\\Ned\\etc
[{section}plugins.a_plugin]
hello = world
; comments still work.
names = Jane/John/Jenny
[{section}json]
pretty_print = True
show_contexts = True
"""
# Just some sample setup.cfg text from the docs.
SETUP_CFG = """\
[bdist_rpm]
release = 1
packager = Jane Packager <janep@pysoft.com>
doc_files = CHANGES.txt
README.txt
USAGE.txt
doc/
examples/
"""
# Just some sample tox.ini text from the docs.
TOX_INI = """\
[tox]
envlist = py{26,27,33,34,35}-{c,py}tracer
skip_missing_interpreters = True
[testenv]
commands =
# Create tests/zipmods.zip
python igor.py zip_mods
"""
def assert_config_settings_are_correct(self, cov):
"""Check that `cov` has all the settings from LOTSA_SETTINGS."""
assert cov.config.timid
assert cov.config.data_file == "something_or_other.dat"
assert cov.config.branch
assert cov.config.cover_pylib
assert cov.config.debug == ["callers", "pids", "dataio"]
assert cov.config.parallel
assert cov.config.concurrency == ["thread"]
assert cov.config.source == ["myapp"]
assert cov.config.source_pkgs == ["ned"]
assert cov.config.disable_warnings == ["abcd", "efgh"]
assert cov.get_exclude_list() == ["if 0:", r"pragma:?\s+no cover", "another_tab"]
assert cov.config.ignore_errors
assert cov.config.run_omit == ["twenty"]
assert cov.config.report_omit == ["one", "another", "some_more", "yet_more"]
assert cov.config.report_include == ["thirty"]
assert cov.config.precision == 3
assert cov.config.partial_list == [r"pragma:?\s+no branch"]
assert cov.config.partial_always_list == ["if 0:", "while True:"]
assert cov.config.plugins == ["plugins.a_plugin", "plugins.another"]
assert cov.config.show_missing
assert cov.config.skip_covered
assert cov.config.skip_empty
assert cov.config.html_dir == r"c:\tricky\dir.somewhere"
assert cov.config.extra_css == "something/extra.css"
assert cov.config.html_title == "Title & nums # nums!"
assert cov.config.xml_output == "mycov.xml"
assert cov.config.xml_package_depth == 17
assert cov.config.paths == {
'source': ['.', '/home/ned/src/'],
'other': ['other', '/home/ned/other', 'c:\\Ned\\etc']
}
assert cov.config.get_plugin_options("plugins.a_plugin") == {
'hello': 'world',
'names': 'Jane/John/Jenny',
}
assert cov.config.get_plugin_options("plugins.another") == {}
assert cov.config.json_show_contexts is True
assert cov.config.json_pretty_print is True
def test_config_file_settings(self):
self.make_file(".coveragerc", self.LOTSA_SETTINGS.format(section=""))
cov = coverage.Coverage()
self.assert_config_settings_are_correct(cov)
def check_config_file_settings_in_other_file(self, fname, contents):
"""Check config will be read from another file, with prefixed sections."""
nested = self.LOTSA_SETTINGS.format(section="coverage:")
fname = self.make_file(fname, nested + "\n" + contents)
cov = coverage.Coverage()
self.assert_config_settings_are_correct(cov)
def test_config_file_settings_in_setupcfg(self):
self.check_config_file_settings_in_other_file("setup.cfg", self.SETUP_CFG)
def test_config_file_settings_in_toxini(self):
self.check_config_file_settings_in_other_file("tox.ini", self.TOX_INI)
def check_other_config_if_coveragerc_specified(self, fname, contents):
"""Check that config `fname` is read if .coveragerc is missing, but specified."""
nested = self.LOTSA_SETTINGS.format(section="coverage:")
self.make_file(fname, nested + "\n" + contents)
cov = coverage.Coverage(config_file=".coveragerc")
self.assert_config_settings_are_correct(cov)
def test_config_file_settings_in_setupcfg_if_coveragerc_specified(self):
self.check_other_config_if_coveragerc_specified("setup.cfg", self.SETUP_CFG)
def test_config_file_settings_in_tox_if_coveragerc_specified(self):
self.check_other_config_if_coveragerc_specified("tox.ini", self.TOX_INI)
def check_other_not_read_if_coveragerc(self, fname):
"""Check config `fname` is not read if .coveragerc exists."""
self.make_file(".coveragerc", """\
[run]
include = foo
""")
self.make_file(fname, """\
[coverage:run]
omit = bar
branch = true
""")
cov = coverage.Coverage()
assert cov.config.run_include == ["foo"]
assert cov.config.run_omit is None
assert cov.config.branch is False
def test_setupcfg_only_if_not_coveragerc(self):
self.check_other_not_read_if_coveragerc("setup.cfg")
def test_toxini_only_if_not_coveragerc(self):
self.check_other_not_read_if_coveragerc("tox.ini")
def check_other_config_need_prefixes(self, fname):
"""Check that `fname` sections won't be read if un-prefixed."""
self.make_file(fname, """\
[run]
omit = bar
branch = true
""")
cov = coverage.Coverage()
assert cov.config.run_omit is None
assert cov.config.branch is False
def test_setupcfg_only_if_prefixed(self):
self.check_other_config_need_prefixes("setup.cfg")
def test_toxini_only_if_prefixed(self):
self.check_other_config_need_prefixes("tox.ini")
def test_tox_ini_even_if_setup_cfg(self):
# There's a setup.cfg, but no coverage settings in it, so tox.ini
# is read.
nested = self.LOTSA_SETTINGS.format(section="coverage:")
self.make_file("tox.ini", self.TOX_INI + "\n" + nested)
self.make_file("setup.cfg", self.SETUP_CFG)
cov = coverage.Coverage()
self.assert_config_settings_are_correct(cov)
def test_read_prefixed_sections_from_explicit_file(self):
# You can point to a tox.ini, and it will find [coverage:run] sections
nested = self.LOTSA_SETTINGS.format(section="coverage:")
self.make_file("tox.ini", self.TOX_INI + "\n" + nested)
cov = coverage.Coverage(config_file="tox.ini")
self.assert_config_settings_are_correct(cov)
def test_non_ascii(self):
self.make_file(".coveragerc", """\
[report]
exclude_lines =
first
✘${TOX_ENVNAME}
third
[html]
title = tabblo & «ταБЬℓσ» # numbers
""")
self.set_environ("TOX_ENVNAME", "weirdo")
cov = coverage.Coverage()
assert cov.config.exclude_list == ["first", "✘weirdo", "third"]
assert cov.config.html_title == "tabblo & «ταБЬℓσ» # numbers"
def test_unreadable_config(self):
# If a config file is explicitly specified, then it is an error for it
# to not be readable.
bad_files = [
"nosuchfile.txt",
".",
]
for bad_file in bad_files:
msg = "Couldn't read %r as a config file" % bad_file
with pytest.raises(CoverageException, match=msg):
coverage.Coverage(config_file=bad_file)
def test_nocoveragerc_file_when_specified(self):
cov = coverage.Coverage(config_file=".coveragerc")
assert not cov.config.timid
assert not cov.config.branch
assert cov.config.data_file == ".coverage"
def test_note_is_obsolete(self):
self.make_file("main.py", "a = 1")
self.make_file(".coveragerc", """\
[run]
note = I am here I am here I am here!
""")
cov = coverage.Coverage()
with self.assert_warnings(cov, [r"The '\[run] note' setting is no longer supported."]):
self.start_import_stop(cov, "main")
cov.report()
def test_no_toml_installed_no_toml(self):
# Can't read a toml file that doesn't exist.
with without_module(coverage.tomlconfig, 'tomli'):
msg = "Couldn't read 'cov.toml' as a config file"
with pytest.raises(CoverageException, match=msg):
coverage.Coverage(config_file="cov.toml")
def test_no_toml_installed_explicit_toml(self):
# Can't specify a toml config file if toml isn't installed.
self.make_file("cov.toml", "# A toml file!")
with without_module(coverage.tomlconfig, 'tomli'):
msg = "Can't read 'cov.toml' without TOML support"
with pytest.raises(CoverageException, match=msg):
coverage.Coverage(config_file="cov.toml")
def test_no_toml_installed_pyproject_toml(self):
# Can't have coverage config in pyproject.toml without toml installed.
self.make_file("pyproject.toml", """\
# A toml file!
[tool.coverage.run]
xyzzy = 17
""")
with without_module(coverage.tomlconfig, 'tomli'):
msg = "Can't read 'pyproject.toml' without TOML support"
with pytest.raises(CoverageException, match=msg):
coverage.Coverage()
def test_no_toml_installed_pyproject_no_coverage(self):
# It's ok to have non-coverage pyproject.toml without toml installed.
self.make_file("pyproject.toml", """\
# A toml file!
[tool.something]
xyzzy = 17
""")
with without_module(coverage.tomlconfig, 'tomli'):
cov = coverage.Coverage()
# We get default settings:
assert not cov.config.timid
assert not cov.config.branch
assert cov.config.data_file == ".coverage"
|