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
|
# 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 text-based summary reporting for coverage.py"""
import glob
import io
import math
import os
import os.path
import py_compile
import re
import pytest
import coverage
from coverage import env
from coverage.control import Coverage
from coverage.data import CoverageData
from coverage.exceptions import ConfigError, NoDataError, NotPython
from coverage.files import abs_file
from coverage.summary import SummaryReporter
from tests.coveragetest import CoverageTest, TESTS_DIR, UsingModulesMixin
from tests.helpers import assert_coverage_warnings
class SummaryTest(UsingModulesMixin, CoverageTest):
"""Tests of the text summary reporting for coverage.py."""
def make_mycode(self):
"""Make the mycode.py file when needed."""
self.make_file("mycode.py", """\
import covmod1
import covmodzip1
a = 1
print('done')
""")
def test_report(self):
self.make_mycode()
cov = coverage.Coverage()
self.start_import_stop(cov, "mycode")
assert self.stdout() == 'done\n'
report = self.get_report(cov)
# Name Stmts Miss Cover
# ------------------------------------------------------------------
# c:/ned/coverage/tests/modules/covmod1.py 2 0 100%
# c:/ned/coverage/tests/zipmods.zip/covmodzip1.py 2 0 100%
# mycode.py 4 0 100%
# ------------------------------------------------------------------
# TOTAL 8 0 100%
assert "/coverage/__init__/" not in report
assert "/tests/modules/covmod1.py " in report
assert "/tests/zipmods.zip/covmodzip1.py " in report
assert "mycode.py " in report
assert self.last_line_squeezed(report) == "TOTAL 8 0 100%"
def test_report_just_one(self):
# Try reporting just one module
self.make_mycode()
cov = coverage.Coverage()
self.start_import_stop(cov, "mycode")
report = self.get_report(cov, morfs=["mycode.py"])
# Name Stmts Miss Cover
# -------------------------------
# mycode.py 4 0 100%
# -------------------------------
# TOTAL 4 0 100%
assert self.line_count(report) == 5
assert "/coverage/" not in report
assert "/tests/modules/covmod1.py " not in report
assert "/tests/zipmods.zip/covmodzip1.py " not in report
assert "mycode.py " in report
assert self.last_line_squeezed(report) == "TOTAL 4 0 100%"
def test_report_wildcard(self):
# Try reporting using wildcards to get the modules.
self.make_mycode()
# Wildcard is handled by shell or cmdline.py, so use real commands
self.run_command("coverage run mycode.py")
report = self.report_from_command("coverage report my*.py")
# Name Stmts Miss Cover
# -------------------------------
# mycode.py 4 0 100%
# -------------------------------
# TOTAL 4 0 100%
assert self.line_count(report) == 5
assert "/coverage/" not in report
assert "/tests/modules/covmod1.py " not in report
assert "/tests/zipmods.zip/covmodzip1.py " not in report
assert "mycode.py " in report
assert self.last_line_squeezed(report) == "TOTAL 4 0 100%"
def test_report_omitting(self):
# Try reporting while omitting some modules
self.make_mycode()
cov = coverage.Coverage()
self.start_import_stop(cov, "mycode")
report = self.get_report(cov, omit=[f"{TESTS_DIR}/*", "*/site-packages/*"])
# Name Stmts Miss Cover
# -------------------------------
# mycode.py 4 0 100%
# -------------------------------
# TOTAL 4 0 100%
assert self.line_count(report) == 5
assert "/coverage/" not in report
assert "/tests/modules/covmod1.py " not in report
assert "/tests/zipmods.zip/covmodzip1.py " not in report
assert "mycode.py " in report
assert self.last_line_squeezed(report) == "TOTAL 4 0 100%"
def test_report_including(self):
# Try reporting while including some modules
self.make_mycode()
cov = coverage.Coverage()
self.start_import_stop(cov, "mycode")
report = self.get_report(cov, include=["mycode*"])
# Name Stmts Miss Cover
# -------------------------------
# mycode.py 4 0 100%
# -------------------------------
# TOTAL 4 0 100%
assert self.line_count(report) == 5
assert "/coverage/" not in report
assert "/tests/modules/covmod1.py " not in report
assert "/tests/zipmods.zip/covmodzip1.py " not in report
assert "mycode.py " in report
assert self.last_line_squeezed(report) == "TOTAL 4 0 100%"
def test_run_source_vs_report_include(self):
# https://github.com/nedbat/coveragepy/issues/621
self.make_file(".coveragerc", """\
[run]
source = .
[report]
include = mod/*,tests/*
""")
# It should be OK to use that configuration.
cov = coverage.Coverage()
with self.assert_warnings(cov, []):
cov.start()
cov.stop() # pragma: nested
def test_run_omit_vs_report_omit(self):
# https://github.com/nedbat/coveragepy/issues/622
# report:omit shouldn't clobber run:omit.
self.make_mycode()
self.make_file(".coveragerc", """\
[run]
omit = */covmodzip1.py
[report]
omit = */covmod1.py
""")
self.run_command("coverage run mycode.py")
# Read the data written, to see that the right files have been omitted from running.
covdata = CoverageData()
covdata.read()
files = [os.path.basename(p) for p in covdata.measured_files()]
assert "covmod1.py" in files
assert "covmodzip1.py" not in files
def test_report_branches(self):
self.make_file("mybranch.py", """\
def branch(x):
if x:
print("x")
return x
branch(1)
""")
cov = coverage.Coverage(source=["."], branch=True)
self.start_import_stop(cov, "mybranch")
assert self.stdout() == 'x\n'
report = self.get_report(cov)
# Name Stmts Miss Branch BrPart Cover
# -----------------------------------------------
# mybranch.py 5 0 2 1 86%
# -----------------------------------------------
# TOTAL 5 0 2 1 86%
assert self.line_count(report) == 5
assert "mybranch.py " in report
assert self.last_line_squeezed(report) == "TOTAL 5 0 2 1 86%"
def test_report_show_missing(self):
self.make_file("mymissing.py", """\
def missing(x, y):
if x:
print("x")
return x
if y:
print("y")
try:
print("z")
1/0
print("Never!")
except ZeroDivisionError:
pass
return x
missing(0, 1)
""")
cov = coverage.Coverage(source=["."])
self.start_import_stop(cov, "mymissing")
assert self.stdout() == 'y\nz\n'
report = self.get_report(cov, show_missing=True)
# Name Stmts Miss Cover Missing
# --------------------------------------------
# mymissing.py 14 3 79% 3-4, 10
# --------------------------------------------
# TOTAL 14 3 79% 3-4, 10
assert self.line_count(report) == 5
squeezed = self.squeezed_lines(report)
assert squeezed[2] == "mymissing.py 14 3 79% 3-4, 10"
assert squeezed[4] == "TOTAL 14 3 79%"
def test_report_show_missing_branches(self):
self.make_file("mybranch.py", """\
def branch(x, y):
if x:
print("x")
if y:
print("y")
branch(1, 1)
""")
cov = coverage.Coverage(branch=True)
self.start_import_stop(cov, "mybranch")
assert self.stdout() == 'x\ny\n'
report = self.get_report(cov, show_missing=True)
# Name Stmts Miss Branch BrPart Cover Missing
# ----------------------------------------------------------
# mybranch.py 6 0 4 2 80% 2->4, 4->exit
# ----------------------------------------------------------
# TOTAL 6 0 4 2 80%
assert self.line_count(report) == 5
squeezed = self.squeezed_lines(report)
assert squeezed[2] == "mybranch.py 6 0 4 2 80% 2->4, 4->exit"
assert squeezed[4] == "TOTAL 6 0 4 2 80%"
def test_report_show_missing_branches_and_lines(self):
self.make_file("main.py", """\
import mybranch
""")
self.make_file("mybranch.py", """\
def branch(x, y, z):
if x:
print("x")
if y:
print("y")
if z:
if x and y:
print("z")
return x
branch(1, 1, 0)
""")
cov = coverage.Coverage(branch=True)
self.start_import_stop(cov, "main")
assert self.stdout() == 'x\ny\n'
report_lines = self.get_report(cov, squeeze=False, show_missing=True).splitlines()
expected = [
'Name Stmts Miss Branch BrPart Cover Missing',
'---------------------------------------------------------',
'main.py 1 0 0 0 100%',
'mybranch.py 10 2 8 3 61% 2->4, 4->6, 7-8',
'---------------------------------------------------------',
'TOTAL 11 2 8 3 63%',
]
assert expected == report_lines
def test_report_skip_covered_no_branches(self):
self.make_file("main.py", """
import not_covered
def normal():
print("z")
normal()
""")
self.make_file("not_covered.py", """
def not_covered():
print("n")
""")
# --fail-under is handled by cmdline.py, use real commands.
out = self.run_command("coverage run main.py")
assert out == "z\n"
report = self.report_from_command("coverage report --skip-covered --fail-under=70")
# Name Stmts Miss Cover
# ------------------------------------
# not_covered.py 2 1 50%
# ------------------------------------
# TOTAL 6 1 83%
#
# 1 file skipped due to complete coverage.
assert self.line_count(report) == 7, report
squeezed = self.squeezed_lines(report)
assert squeezed[2] == "not_covered.py 2 1 50%"
assert squeezed[4] == "TOTAL 6 1 83%"
assert squeezed[6] == "1 file skipped due to complete coverage."
assert self.last_command_status == 0
def test_report_skip_covered_branches(self):
self.make_file("main.py", """
import not_covered, covered
def normal(z):
if z:
print("z")
normal(True)
normal(False)
""")
self.make_file("not_covered.py", """
def not_covered(n):
if n:
print("n")
not_covered(True)
""")
self.make_file("covered.py", """
def foo():
pass
foo()
""")
cov = coverage.Coverage(branch=True)
self.start_import_stop(cov, "main")
assert self.stdout() == "n\nz\n"
report = self.get_report(cov, skip_covered=True)
# Name Stmts Miss Branch BrPart Cover
# --------------------------------------------------
# not_covered.py 4 0 2 1 83%
# --------------------------------------------------
# TOTAL 13 0 4 1 94%
#
# 2 files skipped due to complete coverage.
assert self.line_count(report) == 7, report
squeezed = self.squeezed_lines(report)
assert squeezed[2] == "not_covered.py 4 0 2 1 83%"
assert squeezed[4] == "TOTAL 13 0 4 1 94%"
assert squeezed[6] == "2 files skipped due to complete coverage."
def test_report_skip_covered_branches_with_totals(self):
self.make_file("main.py", """
import not_covered
import also_not_run
def normal(z):
if z:
print("z")
normal(True)
normal(False)
""")
self.make_file("not_covered.py", """
def not_covered(n):
if n:
print("n")
not_covered(True)
""")
self.make_file("also_not_run.py", """
def does_not_appear_in_this_film(ni):
print("Ni!")
""")
cov = coverage.Coverage(branch=True)
self.start_import_stop(cov, "main")
assert self.stdout() == "n\nz\n"
report = self.get_report(cov, skip_covered=True)
# Name Stmts Miss Branch BrPart Cover
# --------------------------------------------------
# also_not_run.py 2 1 0 0 50%
# not_covered.py 4 0 2 1 83%
# --------------------------------------------------
# TOTAL 13 1 4 1 88%
#
# 1 file skipped due to complete coverage.
assert self.line_count(report) == 8, report
squeezed = self.squeezed_lines(report)
assert squeezed[2] == "also_not_run.py 2 1 0 0 50%"
assert squeezed[3] == "not_covered.py 4 0 2 1 83%"
assert squeezed[5] == "TOTAL 13 1 4 1 88%"
assert squeezed[7] == "1 file skipped due to complete coverage."
def test_report_skip_covered_all_files_covered(self):
self.make_file("main.py", """
def foo():
pass
foo()
""")
cov = coverage.Coverage(source=["."], branch=True)
self.start_import_stop(cov, "main")
assert self.stdout() == ""
report = self.get_report(cov, skip_covered=True)
# Name Stmts Miss Branch BrPart Cover
# -------------------------------------------
# -----------------------------------------
# TOTAL 3 0 0 0 100%
#
# 1 file skipped due to complete coverage.
assert self.line_count(report) == 6, report
squeezed = self.squeezed_lines(report)
assert squeezed[5] == "1 file skipped due to complete coverage."
def test_report_skip_covered_longfilename(self):
self.make_file("long_______________filename.py", """
def foo():
pass
foo()
""")
cov = coverage.Coverage(source=["."], branch=True)
self.start_import_stop(cov, "long_______________filename")
assert self.stdout() == ""
report = self.get_report(cov, squeeze=False, skip_covered=True)
# Name Stmts Miss Branch BrPart Cover
# -----------------------------------------
# -----------------------------------------
# TOTAL 3 0 0 0 100%
#
# 1 file skipped due to complete coverage.
assert self.line_count(report) == 6, report
lines = self.report_lines(report)
assert lines[0] == "Name Stmts Miss Branch BrPart Cover"
squeezed = self.squeezed_lines(report)
assert squeezed[5] == "1 file skipped due to complete coverage."
def test_report_skip_covered_no_data(self):
cov = coverage.Coverage()
cov.load()
with pytest.raises(NoDataError, match="No data to report."):
self.get_report(cov, skip_covered=True)
self.assert_doesnt_exist(".coverage")
def test_report_skip_empty(self):
self.make_file("main.py", """
import submodule
def normal():
print("z")
normal()
""")
self.make_file("submodule/__init__.py", "")
cov = coverage.Coverage()
self.start_import_stop(cov, "main")
assert self.stdout() == "z\n"
report = self.get_report(cov, skip_empty=True)
# Name Stmts Miss Cover
# ------------------------------------
# main.py 4 0 100%
# ------------------------------------
# TOTAL 4 0 100%
#
# 1 empty file skipped.
assert self.line_count(report) == 7, report
squeezed = self.squeezed_lines(report)
assert squeezed[2] == "main.py 4 0 100%"
assert squeezed[4] == "TOTAL 4 0 100%"
assert squeezed[6] == "1 empty file skipped."
def test_report_skip_empty_no_data(self):
self.make_file("__init__.py", "")
cov = coverage.Coverage()
self.start_import_stop(cov, "__init__")
assert self.stdout() == ""
report = self.get_report(cov, skip_empty=True)
# Name Stmts Miss Cover
# ------------------------------------
#
# 1 empty file skipped.
assert self.line_count(report) == 6, report
squeezed = self.squeezed_lines(report)
assert squeezed[3] == "TOTAL 0 0 100%"
assert squeezed[5] == "1 empty file skipped."
def test_report_precision(self):
self.make_file(".coveragerc", """\
[report]
precision = 3
omit = */site-packages/*
""")
self.make_file("main.py", """
import not_covered, covered
def normal(z):
if z:
print("z")
normal(True)
normal(False)
""")
self.make_file("not_covered.py", """
def not_covered(n):
if n:
print("n")
not_covered(True)
""")
self.make_file("covered.py", """
def foo():
pass
foo()
""")
cov = coverage.Coverage(branch=True)
self.start_import_stop(cov, "main")
assert self.stdout() == "n\nz\n"
report = self.get_report(cov)
# Name Stmts Miss Branch BrPart Cover
# ------------------------------------------------------
# covered.py 3 0 0 0 100.000%
# main.py 6 0 2 0 100.000%
# not_covered.py 4 0 2 1 83.333%
# ------------------------------------------------------
# TOTAL 13 0 4 1 94.118%
assert self.line_count(report) == 7, report
squeezed = self.squeezed_lines(report)
assert squeezed[2] == "covered.py 3 0 0 0 100.000%"
assert squeezed[4] == "not_covered.py 4 0 2 1 83.333%"
assert squeezed[6] == "TOTAL 13 0 4 1 94.118%"
def test_dotpy_not_python(self):
# We run a .py file, and when reporting, we can't parse it as Python.
# We should get an error message in the report.
self.make_data_file(lines={"mycode.py": [1]})
self.make_file("mycode.py", "This isn't python at all!")
cov = coverage.Coverage()
cov.load()
msg = r"Couldn't parse '.*[/\\]mycode.py' as Python source: '.*' at line 1"
with pytest.raises(NotPython, match=msg):
self.get_report(cov, morfs=["mycode.py"])
def test_accented_directory(self):
# Make a file with a non-ascii character in the directory name.
self.make_file("\xe2/accented.py", "print('accented')")
self.make_data_file(lines={abs_file("\xe2/accented.py"): [1]})
report_expected = (
"Name Stmts Miss Cover\n" +
"-----------------------------------\n" +
"\xe2/accented.py 1 0 100%\n" +
"-----------------------------------\n" +
"TOTAL 1 0 100%\n"
)
cov = coverage.Coverage()
cov.load()
output = self.get_report(cov, squeeze=False)
assert output == report_expected
@pytest.mark.skipif(env.JYTHON, reason="Jython doesn't like accented file names")
def test_accenteddotpy_not_python(self):
# We run a .py file with a non-ascii name, and when reporting, we can't
# parse it as Python. We should get an error message in the report.
self.make_data_file(lines={"accented\xe2.py": [1]})
self.make_file("accented\xe2.py", "This isn't python at all!")
cov = coverage.Coverage()
cov.load()
msg = r"Couldn't parse '.*[/\\]accented\xe2.py' as Python source: '.*' at line 1"
with pytest.raises(NotPython, match=msg):
self.get_report(cov, morfs=["accented\xe2.py"])
def test_dotpy_not_python_ignored(self):
# We run a .py file, and when reporting, we can't parse it as Python,
# but we've said to ignore errors, so there's no error reported,
# though we still get a warning.
self.make_file("mycode.py", "This isn't python at all!")
self.make_data_file(lines={"mycode.py": [1]})
cov = coverage.Coverage()
cov.load()
with pytest.raises(NoDataError, match="No data to report."):
with pytest.warns(Warning) as warns:
self.get_report(cov, morfs=["mycode.py"], ignore_errors=True)
assert_coverage_warnings(
warns,
re.compile(r"Couldn't parse Python file '.*[/\\]mycode.py' \(couldnt-parse\)"),
)
def test_dothtml_not_python(self):
# We run a .html file, and when reporting, we can't parse it as
# Python. Since it wasn't .py, no error is reported.
# Pretend to run an html file.
self.make_file("mycode.html", "<h1>This isn't python at all!</h1>")
self.make_data_file(lines={"mycode.html": [1]})
cov = coverage.Coverage()
cov.load()
with pytest.raises(NoDataError, match="No data to report."):
self.get_report(cov, morfs=["mycode.html"])
def test_report_no_extension(self):
self.make_file("xxx", """\
# This is a python file though it doesn't look like it, like a main script.
a = b = c = d = 0
a = 3
b = 4
if not b:
c = 6
d = 7
print(f"xxx: {a} {b} {c} {d}")
""")
self.make_data_file(lines={abs_file("xxx"): [2, 3, 4, 5, 7, 8]})
cov = coverage.Coverage()
cov.load()
report = self.get_report(cov)
assert self.last_line_squeezed(report) == "TOTAL 7 1 86%"
def test_report_with_chdir(self):
self.make_file("chdir.py", """\
import os
print("Line One")
os.chdir("subdir")
print("Line Two")
print(open("something").read())
""")
self.make_file("subdir/something", "hello")
out = self.run_command("coverage run --source=. chdir.py")
assert out == "Line One\nLine Two\nhello\n"
report = self.report_from_command("coverage report")
assert self.last_line_squeezed(report) == "TOTAL 5 0 100%"
def test_bug_156_file_not_run_should_be_zero(self):
# https://github.com/nedbat/coveragepy/issues/156
self.make_file("mybranch.py", """\
def branch(x):
if x:
print("x")
return x
branch(1)
""")
self.make_file("main.py", """\
print("y")
""")
cov = coverage.Coverage(branch=True, source=["."])
self.start_import_stop(cov, "main")
report = self.get_report(cov).splitlines()
assert "mybranch.py 5 5 2 0 0%" in report
def run_TheCode_and_report_it(self):
"""A helper for the next few tests."""
cov = coverage.Coverage()
self.start_import_stop(cov, "TheCode")
return self.get_report(cov)
def test_bug_203_mixed_case_listed_twice_with_rc(self):
self.make_file("TheCode.py", "a = 1\n")
self.make_file(".coveragerc", "[run]\nsource = .\n")
report = self.run_TheCode_and_report_it()
assert "TheCode" in report
assert "thecode" not in report
def test_bug_203_mixed_case_listed_twice(self):
self.make_file("TheCode.py", "a = 1\n")
report = self.run_TheCode_and_report_it()
assert "TheCode" in report
assert "thecode" not in report
@pytest.mark.skipif(not env.WINDOWS, reason=".pyw files are only on Windows.")
def test_pyw_files(self):
# https://github.com/nedbat/coveragepy/issues/261
self.make_file("start.pyw", """\
import mod
print("In start.pyw")
""")
self.make_file("mod.pyw", """\
print("In mod.pyw")
""")
cov = coverage.Coverage()
# start_import_stop can't import the .pyw file, so use the long form.
cov.start()
import start # pragma: nested # pylint: disable=import-error, unused-import
cov.stop() # pragma: nested
report = self.get_report(cov)
assert "NoSource" not in report
report = report.splitlines()
assert "start.pyw 2 0 100%" in report
assert "mod.pyw 1 0 100%" in report
def test_tracing_pyc_file(self):
# Create two Python files.
self.make_file("mod.py", "a = 1\n")
self.make_file("main.py", "import mod\n")
# Make one into a .pyc.
py_compile.compile("mod.py")
# Run the program.
cov = coverage.Coverage()
self.start_import_stop(cov, "main")
report = self.get_report(cov).splitlines()
assert "mod.py 1 0 100%" in report
def test_missing_py_file_during_run(self):
# Create two Python files.
self.make_file("mod.py", "a = 1\n")
self.make_file("main.py", "import mod\n")
# Make one into a .pyc, and remove the .py.
py_compile.compile("mod.py")
os.remove("mod.py")
# Python 3 puts the .pyc files in a __pycache__ directory, and will
# not import from there without source. It will import a .pyc from
# the source location though.
if not env.JYTHON:
pycs = glob.glob("__pycache__/mod.*.pyc")
assert len(pycs) == 1
os.rename(pycs[0], "mod.pyc")
# Run the program.
cov = coverage.Coverage()
self.start_import_stop(cov, "main")
# Put back the missing Python file.
self.make_file("mod.py", "a = 1\n")
report = self.get_report(cov).splitlines()
assert "mod.py 1 0 100%" in report
def test_empty_files(self):
# Shows that empty files like __init__.py are listed as having zero
# statements, not one statement.
cov = coverage.Coverage(branch=True)
cov.start()
import usepkgs # pragma: nested # pylint: disable=import-error, unused-import
cov.stop() # pragma: nested
report = self.get_report(cov)
assert "tests/modules/pkg1/__init__.py 1 0 0 0 100%" in report
assert "tests/modules/pkg2/__init__.py 0 0 0 0 100%" in report
class ReportingReturnValueTest(CoverageTest):
"""Tests of reporting functions returning values."""
def run_coverage(self):
"""Run coverage on doit.py and return the coverage object."""
self.make_file("doit.py", """\
a = 1
b = 2
c = 3
d = 4
if a > 10:
f = 6
g = 7
""")
cov = coverage.Coverage()
self.start_import_stop(cov, "doit")
return cov
def test_report(self):
cov = self.run_coverage()
val = cov.report(include="*/doit.py")
assert math.isclose(val, 6 / 7 * 100)
def test_html(self):
cov = self.run_coverage()
val = cov.html_report(include="*/doit.py")
assert math.isclose(val, 6 / 7 * 100)
def test_xml(self):
cov = self.run_coverage()
val = cov.xml_report(include="*/doit.py")
assert math.isclose(val, 6 / 7 * 100)
class SummaryReporterConfigurationTest(CoverageTest):
"""Tests of SummaryReporter."""
def make_rigged_file(self, filename, stmts, miss):
"""Create a file that will have specific results.
`stmts` and `miss` are ints, the number of statements, and
missed statements that should result.
"""
run = stmts - miss - 1
dont_run = miss
source = ""
source += "a = 1\n" * run
source += "if a == 99:\n"
source += " a = 2\n" * dont_run
self.make_file(filename, source)
def get_summary_text(self, *options):
"""Get text output from the SummaryReporter.
The arguments are tuples: (name, value) for Coverage.set_option.
"""
self.make_rigged_file("file1.py", 339, 155)
self.make_rigged_file("file2.py", 13, 3)
self.make_rigged_file("file10.py", 234, 228)
self.make_file("doit.py", "import file1, file2, file10")
cov = Coverage(source=["."], omit=["doit.py"])
self.start_import_stop(cov, "doit")
for name, value in options:
cov.set_option(name, value)
printer = SummaryReporter(cov)
destination = io.StringIO()
printer.report([], destination)
return destination.getvalue()
def test_test_data(self):
# We use our own test files as test data. Check that our assumptions
# about them are still valid. We want the three columns of numbers to
# sort in three different orders.
report = self.get_summary_text()
print(report)
# Name Stmts Miss Cover
# ------------------------------
# file1.py 339 155 54%
# file2.py 13 3 77%
# file10.py 234 228 3%
# ------------------------------
# TOTAL 586 386 34%
lines = report.splitlines()[2:-2]
assert len(lines) == 3
nums = [list(map(int, l.replace('%', '').split()[1:])) for l in lines]
# [
# [339, 155, 54],
# [ 13, 3, 77],
# [234, 228, 3]
# ]
assert nums[1][0] < nums[2][0] < nums[0][0]
assert nums[1][1] < nums[0][1] < nums[2][1]
assert nums[2][2] < nums[0][2] < nums[1][2]
def test_defaults(self):
"""Run the report with no configuration options."""
report = self.get_summary_text()
assert 'Missing' not in report
assert 'Branch' not in report
def test_print_missing(self):
"""Run the report printing the missing lines."""
report = self.get_summary_text(('report:show_missing', True))
assert 'Missing' in report
assert 'Branch' not in report
def assert_ordering(self, text, *words):
"""Assert that the `words` appear in order in `text`."""
indexes = list(map(text.find, words))
assert -1 not in indexes
msg = f"The words {words!r} don't appear in order in {text!r}"
assert indexes == sorted(indexes), msg
def test_default_sort_report(self):
# Sort the text report by the default (Name) column.
report = self.get_summary_text()
self.assert_ordering(report, "file1.py", "file2.py", "file10.py")
def test_sort_report_by_name(self):
# Sort the text report explicitly by the Name column.
report = self.get_summary_text(('report:sort', 'Name'))
self.assert_ordering(report, "file1.py", "file2.py", "file10.py")
def test_sort_report_by_stmts(self):
# Sort the text report by the Stmts column.
report = self.get_summary_text(('report:sort', 'Stmts'))
self.assert_ordering(report, "file2.py", "file10.py", "file1.py")
def test_sort_report_by_missing(self):
# Sort the text report by the Missing column.
report = self.get_summary_text(('report:sort', 'Miss'))
self.assert_ordering(report, "file2.py", "file1.py", "file10.py")
def test_sort_report_by_cover(self):
# Sort the text report by the Cover column.
report = self.get_summary_text(('report:sort', 'Cover'))
self.assert_ordering(report, "file10.py", "file1.py", "file2.py")
def test_sort_report_by_cover_plus(self):
# Sort the text report by the Cover column, including the explicit + sign.
report = self.get_summary_text(('report:sort', '+Cover'))
self.assert_ordering(report, "file10.py", "file1.py", "file2.py")
def test_sort_report_by_cover_reversed(self):
# Sort the text report by the Cover column reversed.
report = self.get_summary_text(('report:sort', '-Cover'))
self.assert_ordering(report, "file2.py", "file1.py", "file10.py")
def test_sort_report_by_invalid_option(self):
# Sort the text report by a nonsense column.
msg = "Invalid sorting option: 'Xyzzy'"
with pytest.raises(ConfigError, match=msg):
self.get_summary_text(('report:sort', 'Xyzzy'))
|