# coding: utf-8
# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
# For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt
"""Tests for process behavior of coverage.py."""
import glob
import os
import os.path
import re
import shutil
import stat
import sys
import sysconfig
import textwrap
import time
from xml.etree import ElementTree
import pytest
import coverage
from coverage import env
from coverage.data import line_counts
from coverage.files import abs_file, python_reported_file
from coverage.misc import output_encoding
from tests.coveragetest import CoverageTest, TESTS_DIR
from tests.helpers import change_dir, make_file, nice_file, re_lines, run_command
class ProcessTest(CoverageTest):
"""Tests of the per-process behavior of coverage.py."""
def test_save_on_exit(self):
self.make_file("mycode.py", """\
h = "Hello"
w = "world"
""")
self.assert_doesnt_exist(".coverage")
self.run_command("coverage run mycode.py")
self.assert_exists(".coverage")
def test_environment(self):
# Checks that we can import modules from the tests directory at all!
self.make_file("mycode.py", """\
import covmod1
import covmodzip1
a = 1
print('done')
""")
self.assert_doesnt_exist(".coverage")
out = self.run_command("coverage run mycode.py")
self.assert_exists(".coverage")
assert out == 'done\n'
def make_b_or_c_py(self):
"""Create b_or_c.py, used in a few of these tests."""
# "b_or_c.py b" will run 6 lines.
# "b_or_c.py c" will run 7 lines.
# Together, they run 8 lines.
self.make_file("b_or_c.py", """\
import sys
a = 1
if sys.argv[1] == 'b':
b = 1
else:
c = 1
c2 = 2
d = 1
print('done')
""")
def test_combine_parallel_data(self):
self.make_b_or_c_py()
out = self.run_command("coverage run -p b_or_c.py b")
assert out == 'done\n'
self.assert_doesnt_exist(".coverage")
self.assert_file_count(".coverage.*", 1)
out = self.run_command("coverage run -p b_or_c.py c")
assert out == 'done\n'
self.assert_doesnt_exist(".coverage")
# After two -p runs, there should be two .coverage.machine.123 files.
self.assert_file_count(".coverage.*", 2)
# Combine the parallel coverage data files into .coverage .
self.run_command("coverage combine")
self.assert_exists(".coverage")
# After combining, there should be only the .coverage file.
self.assert_file_count(".coverage.*", 0)
# Read the coverage file and see that b_or_c.py has all 8 lines
# executed.
data = coverage.CoverageData()
data.read()
assert line_counts(data)['b_or_c.py'] == 8
# Running combine again should fail, because there are no parallel data
# files to combine.
status, out = self.run_command_status("coverage combine")
assert status == 1
assert out == "No data to combine\n"
# And the originally combined data is still there.
data = coverage.CoverageData()
data.read()
assert line_counts(data)['b_or_c.py'] == 8
def test_combine_parallel_data_with_a_corrupt_file(self):
self.make_b_or_c_py()
out = self.run_command("coverage run -p b_or_c.py b")
assert out == 'done\n'
self.assert_doesnt_exist(".coverage")
self.assert_file_count(".coverage.*", 1)
out = self.run_command("coverage run -p b_or_c.py c")
assert out == 'done\n'
self.assert_doesnt_exist(".coverage")
# After two -p runs, there should be two .coverage.machine.123 files.
self.assert_file_count(".coverage.*", 2)
# Make a bogus data file.
self.make_file(".coverage.bad", "This isn't a coverage data file.")
# Combine the parallel coverage data files into .coverage .
out = self.run_command("coverage combine")
self.assert_exists(".coverage")
self.assert_exists(".coverage.bad")
warning_regex = (
r"Coverage.py warning: Couldn't use data file '.*\.coverage\.bad': "
r"file (is encrypted or )?is not a database"
)
assert re.search(warning_regex, out)
# After combining, those two should be the only data files.
self.assert_file_count(".coverage.*", 1)
# Read the coverage file and see that b_or_c.py has all 8 lines
# executed.
data = coverage.CoverageData()
data.read()
assert line_counts(data)['b_or_c.py'] == 8
def test_combine_no_usable_files(self):
# https://github.com/nedbat/coveragepy/issues/629
self.make_b_or_c_py()
out = self.run_command("coverage run b_or_c.py b")
assert out == 'done\n'
self.assert_exists(".coverage")
self.assert_file_count(".coverage.*", 0)
# Make bogus data files.
self.make_file(".coverage.bad1", "This isn't a coverage data file.")
self.make_file(".coverage.bad2", "This isn't a coverage data file.")
# Combine the parallel coverage data files into .coverage, but nothing is readable.
status, out = self.run_command_status("coverage combine")
assert status == 1
for n in "12":
self.assert_exists(".coverage.bad{}".format(n))
warning_regex = (
r"Coverage.py warning: Couldn't use data file '.*\.coverage.bad{0}': "
r"file (is encrypted or )?is not a database"
.format(n)
)
assert re.search(warning_regex, out)
assert re.search(r"No usable data files", out)
# After combining, we should have a main file and two parallel files.
self.assert_exists(".coverage")
self.assert_file_count(".coverage.*", 2)
# Read the coverage file and see that b_or_c.py has 6 lines
# executed (we only did b, not c).
data = coverage.CoverageData()
data.read()
assert line_counts(data)['b_or_c.py'] == 6
def test_combine_parallel_data_in_two_steps(self):
self.make_b_or_c_py()
out = self.run_command("coverage run -p b_or_c.py b")
assert out == 'done\n'
self.assert_doesnt_exist(".coverage")
self.assert_file_count(".coverage.*", 1)
# Combine the (one) parallel coverage data file into .coverage .
self.run_command("coverage combine")
self.assert_exists(".coverage")
self.assert_file_count(".coverage.*", 0)
out = self.run_command("coverage run -p b_or_c.py c")
assert out == 'done\n'
self.assert_exists(".coverage")
self.assert_file_count(".coverage.*", 1)
# Combine the parallel coverage data files into .coverage .
self.run_command("coverage combine --append")
self.assert_exists(".coverage")
# After combining, there should be only the .coverage file.
self.assert_file_count(".coverage.*", 0)
# Read the coverage file and see that b_or_c.py has all 8 lines
# executed.
data = coverage.CoverageData()
data.read()
assert line_counts(data)['b_or_c.py'] == 8
def test_combine_parallel_data_no_append(self):
self.make_b_or_c_py()
out = self.run_command("coverage run -p b_or_c.py b")
assert out == 'done\n'
self.assert_doesnt_exist(".coverage")
self.assert_file_count(".coverage.*", 1)
# Combine the (one) parallel coverage data file into .coverage .
self.run_command("coverage combine")
self.assert_exists(".coverage")
self.assert_file_count(".coverage.*", 0)
out = self.run_command("coverage run -p b_or_c.py c")
assert out == 'done\n'
self.assert_exists(".coverage")
self.assert_file_count(".coverage.*", 1)
# Combine the parallel coverage data files into .coverage, but don't
# use the data in .coverage already.
self.run_command("coverage combine")
self.assert_exists(".coverage")
# After combining, there should be only the .coverage file.
self.assert_file_count(".coverage.*", 0)
# Read the coverage file and see that b_or_c.py has only 7 lines
# because we didn't keep the data from running b.
data = coverage.CoverageData()
data.read()
assert line_counts(data)['b_or_c.py'] == 7
def test_combine_parallel_data_keep(self):
self.make_b_or_c_py()
out = self.run_command("coverage run -p b_or_c.py b")
assert out == 'done\n'
self.assert_doesnt_exist(".coverage")
self.assert_file_count(".coverage.*", 1)
out = self.run_command("coverage run -p b_or_c.py c")
assert out == 'done\n'
self.assert_doesnt_exist(".coverage")
# After two -p runs, there should be two .coverage.machine.123 files.
self.assert_file_count(".coverage.*", 2)
# Combine the parallel coverage data files into .coverage with the keep flag.
self.run_command("coverage combine --keep")
# After combining, the .coverage file & the original combined file should still be there.
self.assert_exists(".coverage")
self.assert_file_count(".coverage.*", 2)
def test_append_data(self):
self.make_b_or_c_py()
out = self.run_command("coverage run b_or_c.py b")
assert out == 'done\n'
self.assert_exists(".coverage")
self.assert_file_count(".coverage.*", 0)
out = self.run_command("coverage run --append b_or_c.py c")
assert out == 'done\n'
self.assert_exists(".coverage")
self.assert_file_count(".coverage.*", 0)
# Read the coverage file and see that b_or_c.py has all 8 lines
# executed.
data = coverage.CoverageData()
data.read()
assert line_counts(data)['b_or_c.py'] == 8
def test_append_data_with_different_file(self):
self.make_b_or_c_py()
self.make_file(".coveragerc", """\
[run]
data_file = .mycovdata
""")
out = self.run_command("coverage run b_or_c.py b")
assert out == 'done\n'
self.assert_doesnt_exist(".coverage")
self.assert_exists(".mycovdata")
out = self.run_command("coverage run --append b_or_c.py c")
assert out == 'done\n'
self.assert_doesnt_exist(".coverage")
self.assert_exists(".mycovdata")
# Read the coverage file and see that b_or_c.py has all 8 lines
# executed.
data = coverage.CoverageData(".mycovdata")
data.read()
assert line_counts(data)['b_or_c.py'] == 8
def test_append_can_create_a_data_file(self):
self.make_b_or_c_py()
out = self.run_command("coverage run --append b_or_c.py b")
assert out == 'done\n'
self.assert_exists(".coverage")
self.assert_file_count(".coverage.*", 0)
# Read the coverage file and see that b_or_c.py has only 6 lines
# executed.
data = coverage.CoverageData()
data.read()
assert line_counts(data)['b_or_c.py'] == 6
def test_combine_with_rc(self):
self.make_b_or_c_py()
self.make_file(".coveragerc", """\
[run]
source = .
parallel = true
""")
out = self.run_command("coverage run b_or_c.py b")
assert out == 'done\n'
self.assert_doesnt_exist(".coverage")
out = self.run_command("coverage run b_or_c.py c")
assert out == 'done\n'
self.assert_doesnt_exist(".coverage")
# After two runs, there should be two .coverage.machine.123 files.
self.assert_file_count(".coverage.*", 2)
# Combine the parallel coverage data files into .coverage .
self.run_command("coverage combine")
self.assert_exists(".coverage")
self.assert_exists(".coveragerc")
# After combining, there should be only the .coverage file.
self.assert_file_count(".coverage.*", 0)
# Read the coverage file and see that b_or_c.py has all 8 lines
# executed.
data = coverage.CoverageData()
data.read()
assert line_counts(data)['b_or_c.py'] == 8
# Reporting should still work even with the .rc file
out = self.run_command("coverage report")
assert out == textwrap.dedent("""\
Name Stmts Miss Cover
-------------------------------
b_or_c.py 8 0 100%
-------------------------------
TOTAL 8 0 100%
""")
def test_combine_with_aliases(self):
self.make_file("d1/x.py", """\
a = 1
b = 2
print("%s %s" % (a, b))
""")
self.make_file("d2/x.py", """\
# 1
# 2
# 3
c = 4
d = 5
print("%s %s" % (c, d))
""")
self.make_file(".coveragerc", """\
[run]
source = .
parallel = True
[paths]
source =
src
*/d1
*/d2
""")
out = self.run_command("coverage run " + os.path.normpath("d1/x.py"))
assert out == '1 2\n'
out = self.run_command("coverage run " + os.path.normpath("d2/x.py"))
assert out == '4 5\n'
self.assert_file_count(".coverage.*", 2)
self.run_command("coverage combine")
self.assert_exists(".coverage")
# After combining, there should be only the .coverage file.
self.assert_file_count(".coverage.*", 0)
# Read the coverage data file and see that the two different x.py
# files have been combined together.
data = coverage.CoverageData()
data.read()
summary = line_counts(data, fullpath=True)
assert len(summary) == 1
actual = abs_file(list(summary.keys())[0])
expected = abs_file('src/x.py')
assert expected == actual
assert list(summary.values())[0] == 6
def test_erase_parallel(self):
self.make_file(".coveragerc", """\
[run]
data_file = data.dat
parallel = True
""")
self.make_file("data.dat")
self.make_file("data.dat.fooey")
self.make_file("data.dat.gooey")
self.make_file(".coverage")
self.run_command("coverage erase")
self.assert_doesnt_exist("data.dat")
self.assert_doesnt_exist("data.dat.fooey")
self.assert_doesnt_exist("data.dat.gooey")
self.assert_exists(".coverage")
def test_missing_source_file(self):
# Check what happens if the source is missing when reporting happens.
self.make_file("fleeting.py", """\
s = 'goodbye, cruel world!'
""")
self.run_command("coverage run fleeting.py")
os.remove("fleeting.py")
out = self.run_command("coverage html -d htmlcov")
assert re.search("No source for code: '.*fleeting.py'", out)
assert "Traceback" not in out
# It happens that the code paths are different for *.py and other
# files, so try again with no extension.
self.make_file("fleeting", """\
s = 'goodbye, cruel world!'
""")
self.run_command("coverage run fleeting")
os.remove("fleeting")
status, out = self.run_command_status("coverage html -d htmlcov")
assert re.search("No source for code: '.*fleeting'", out)
assert "Traceback" not in out
assert status == 1
def test_running_missing_file(self):
status, out = self.run_command_status("coverage run xyzzy.py")
assert re.search("No file to run: .*xyzzy.py", out)
assert "raceback" not in out
assert "rror" not in out
assert status == 1
def test_code_throws(self):
self.make_file("throw.py", """\
def f1():
raise Exception("hey!")
def f2():
f1()
f2()
""")
# The important thing is for "coverage run" and "python" to report the
# same traceback.
status, out = self.run_command_status("coverage run throw.py")
out2 = self.run_command("python throw.py")
if env.PYPY:
# Pypy has an extra frame in the traceback for some reason
out2 = re_lines(out2, "toplevel", match=False)
assert out == out2
# But also make sure that the output is what we expect.
path = python_reported_file('throw.py')
msg = 'File "{}", line 5,? in f2'.format(re.escape(path))
assert re.search(msg, out)
assert 'raise Exception("hey!")' in out
assert status == 1
def test_code_exits(self):
self.make_file("exit.py", """\
import sys
def f1():
print("about to exit..")
sys.exit(17)
def f2():
f1()
f2()
""")
# The important thing is for "coverage run" and "python" to have the
# same output. No traceback.
status, out = self.run_command_status("coverage run exit.py")
status2, out2 = self.run_command_status("python exit.py")
assert out == out2
assert out == "about to exit..\n"
assert status == status2
assert status == 17
def test_code_exits_no_arg(self):
self.make_file("exit_none.py", """\
import sys
def f1():
print("about to exit quietly..")
sys.exit()
f1()
""")
status, out = self.run_command_status("coverage run exit_none.py")
status2, out2 = self.run_command_status("python exit_none.py")
assert out == out2
assert out == "about to exit quietly..\n"
assert status == status2
assert status == 0
@pytest.mark.skipif(not hasattr(os, "fork"), reason="Can't test os.fork, it doesn't exist.")
def test_fork(self):
self.make_file("fork.py", """\
import os
def child():
print('Child!')
def main():
ret = os.fork()
if ret == 0:
child()
else:
os.waitpid(ret, 0)
main()
""")
out = self.run_command("coverage run -p fork.py")
assert out == 'Child!\n'
self.assert_doesnt_exist(".coverage")
# After running the forking program, there should be two
# .coverage.machine.123 files.
self.assert_file_count(".coverage.*", 2)
# The two data files should have different random numbers at the end of
# the file name.
data_files = glob.glob(".coverage.*")
nums = set(name.rpartition(".")[-1] for name in data_files)
assert len(nums) == 2, "Same random: %s" % (data_files,)
# Combine the parallel coverage data files into .coverage .
self.run_command("coverage combine")
self.assert_exists(".coverage")
# After combining, there should be only the .coverage file.
self.assert_file_count(".coverage.*", 0)
data = coverage.CoverageData()
data.read()
assert line_counts(data)['fork.py'] == 9
def test_warnings_during_reporting(self):
# While fixing issue #224, the warnings were being printed far too
# often. Make sure they're not any more.
self.make_file("hello.py", """\
import sys, os, the_other
print("Hello")
""")
self.make_file("the_other.py", """\
print("What?")
""")
self.make_file(".coveragerc", """\
[run]
source =
.
xyzzy
""")
self.run_command("coverage run hello.py")
out = self.run_command("coverage html")
assert out.count("Module xyzzy was never imported.") == 0
def test_warns_if_never_run(self):
# Note: the name of the function can't have "warning" in it, or the
# absolute path of the file will have "warning" in it, and an assertion
# will fail.
out = self.run_command("coverage run i_dont_exist.py")
path = python_reported_file('i_dont_exist.py')
assert "No file to run: '{}'".format(path) in out
assert "warning" not in out
assert "Exception" not in out
out = self.run_command("coverage run -m no_such_module")
assert (
("No module named no_such_module" in out) or
("No module named 'no_such_module'" in out)
)
assert "warning" not in out
assert "Exception" not in out
@pytest.mark.skipif(env.METACOV, reason="Can't test tracers changing during metacoverage")
def test_warnings_trace_function_changed_with_threads(self):
# https://github.com/nedbat/coveragepy/issues/164
self.make_file("bug164.py", """\
import threading
import time
class MyThread (threading.Thread):
def run(self):
print("Hello")
thr = MyThread()
thr.start()
thr.join()
""")
out = self.run_command("coverage run --timid bug164.py")
assert "Hello\n" in out
assert "warning" not in out
def test_warning_trace_function_changed(self):
self.make_file("settrace.py", """\
import sys
print("Hello")
sys.settrace(None)
print("Goodbye")
""")
out = self.run_command("coverage run --timid settrace.py")
assert "Hello\n" in out
assert "Goodbye\n" in out
assert "Trace function changed" in out
# When meta-coverage testing, this test doesn't work, because it finds
# coverage.py's own trace function.
@pytest.mark.skipif(env.METACOV, reason="Can't test timid during coverage measurement.")
def test_timid(self):
# Test that the --timid command line argument properly swaps the tracer
# function for a simpler one.
#
# This is complicated by the fact that the tests are run twice for each
# version: once with a compiled C-based trace function, and once without
# it, to also test the Python trace function. So this test has to examine
# an environment variable set in igor.py to know whether to expect to see
# the C trace function or not.
self.make_file("showtrace.py", """\
# Show the current frame's trace function, so that we can test what the
# command-line options do to the trace function used.
import sys
# Show what the trace function is. If a C-based function is used, then f_trace
# may be None.
trace_fn = sys._getframe(0).f_trace
if trace_fn is None:
trace_name = "None"
else:
# Get the name of the tracer class. Py3k has a different way to get it.
try:
trace_name = trace_fn.im_class.__name__
except AttributeError:
try:
trace_name = trace_fn.__self__.__class__.__name__
except AttributeError:
# A C-based function could also manifest as an f_trace value
# which doesn't have im_class or __self__.
trace_name = trace_fn.__class__.__name__
print(trace_name)
""")
# When running without coverage, no trace function
py_out = self.run_command("python showtrace.py")
assert py_out == "None\n"
cov_out = self.run_command("coverage run showtrace.py")
if os.environ.get('COVERAGE_TEST_TRACER', 'c') == 'c':
# If the C trace function is being tested, then regular running should have
# the C function, which registers itself as f_trace.
assert cov_out == "CTracer\n"
else:
# If the Python trace function is being tested, then regular running will
# also show the Python function.
assert cov_out == "PyTracer\n"
# When running timidly, the trace function is always Python.
timid_out = self.run_command("coverage run --timid showtrace.py")
assert timid_out == "PyTracer\n"
def test_warn_preimported(self):
self.make_file("hello.py", """\
import goodbye
import coverage
cov = coverage.Coverage(include=["good*"], check_preimported=True)
cov.start()
print(goodbye.f())
cov.stop()
""")
self.make_file("goodbye.py", """\
def f():
return "Goodbye!"
""")
goodbye_path = os.path.abspath("goodbye.py")
out = self.run_command("python hello.py")
assert "Goodbye!" in out
msg = (
"Coverage.py warning: "
"Already imported a file that will be measured: {0} "
"(already-imported)").format(goodbye_path)
assert msg in out
@pytest.mark.expensive
@pytest.mark.skipif(env.METACOV, reason="Can't test fullcoverage when measuring ourselves")
@pytest.mark.skipif(env.PY2, reason="fullcoverage doesn't work on Python 2.")
@pytest.mark.skipif(not env.C_TRACER, reason="fullcoverage only works with the C tracer.")
def test_fullcoverage(self):
# fullcoverage is a trick to get stdlib modules measured from
# the very beginning of the process. Here we import os and
# then check how many lines are measured.
self.make_file("getenv.py", """\
import os
print("FOOEY == %s" % os.getenv("FOOEY"))
""")
fullcov = os.path.join(
os.path.dirname(coverage.__file__), "fullcoverage"
)
self.set_environ("FOOEY", "BOO")
self.set_environ("PYTHONPATH", fullcov)
out = self.run_command("python -m coverage run -L getenv.py")
assert out == "FOOEY == BOO\n"
data = coverage.CoverageData()
data.read()
# The actual number of executed lines in os.py when it's
# imported is 120 or so. Just running os.getenv executes
# about 5.
assert line_counts(data)['os.py'] > 50
# Pypy passes locally, but fails in CI? Perhaps the version of macOS is
# significant? https://foss.heptapod.net/pypy/pypy/-/issues/3074
@pytest.mark.skipif(env.PYPY3, reason="Pypy is unreliable with this test")
# Jython as of 2.7.1rc3 won't compile a filename that isn't utf8.
@pytest.mark.skipif(env.JYTHON, reason="Jython can't handle this test")
def test_lang_c(self):
# LANG=C forces getfilesystemencoding on Linux to 'ascii', which causes
# failures with non-ascii file names. We don't want to make a real file
# with strange characters, though, because that gets the test runners
# tangled up. This will isolate the concerns to the coverage.py code.
# https://github.com/nedbat/coveragepy/issues/533
self.make_file("weird_file.py", r"""
globs = {}
code = "a = 1\nb = 2\n"
exec(compile(code, "wut\xe9\xea\xeb\xec\x01\x02.py", 'exec'), globs)
print(globs['a'])
print(globs['b'])
""")
self.set_environ("LANG", "C")
out = self.run_command("coverage run weird_file.py")
assert out == "1\n2\n"
def test_deprecation_warnings(self):
# Test that coverage doesn't trigger deprecation warnings.
# https://github.com/nedbat/coveragepy/issues/305
self.make_file("allok.py", """\
import warnings
warnings.simplefilter('default')
import coverage
print("No warnings!")
""")
# Some of our testing infrastructure can issue warnings.
# Turn it all off for the sub-process.
self.del_environ("COVERAGE_TESTING")
out = self.run_command("python allok.py")
assert out == "No warnings!\n"
def test_run_twice(self):
# https://github.com/nedbat/coveragepy/issues/353
self.make_file("foo.py", """\
def foo():
pass
""")
self.make_file("run_twice.py", """\
import sys
import coverage
for i in [1, 2]:
sys.stderr.write("Run %s\\n" % i)
inst = coverage.Coverage(source=['foo'])
inst.load()
inst.start()
import foo
inst.stop()
inst.save()
""")
out = self.run_command("python run_twice.py")
expected = (
"Run 1\n" +
"Run 2\n" +
"Coverage.py warning: Module foo was previously imported, but not measured " +
"(module-not-measured)\n"
)
assert expected == out
def test_module_name(self):
# https://github.com/nedbat/coveragepy/issues/478
out = self.run_command("python -m coverage")
assert "Use 'coverage help' for help" in out
TRY_EXECFILE = os.path.join(os.path.dirname(__file__), "modules/process_test/try_execfile.py")
class EnvironmentTest(CoverageTest):
"""Tests using try_execfile.py to test the execution environment."""
def assert_tryexecfile_output(self, expected, actual):
"""Assert that the output we got is a successful run of try_execfile.py.
`expected` and `actual` must be the same, modulo a few slight known
platform differences.
"""
# First, is this even credible try_execfile.py output?
assert '"DATA": "xyzzy"' in actual
if env.JYTHON: # pragma: only jython
# Argv0 is different for Jython, remove that from the comparison.
expected = re_lines(expected, r'\s+"argv0":', match=False)
actual = re_lines(actual, r'\s+"argv0":', match=False)
assert expected == actual
def test_coverage_run_is_like_python(self):
with open(TRY_EXECFILE) as f:
self.make_file("run_me.py", f.read())
expected = self.run_command("python run_me.py")
actual = self.run_command("coverage run run_me.py")
self.assert_tryexecfile_output(expected, actual)
def test_coverage_run_far_away_is_like_python(self):
with open(TRY_EXECFILE) as f:
self.make_file("sub/overthere/prog.py", f.read())
expected = self.run_command("python sub/overthere/prog.py")
actual = self.run_command("coverage run sub/overthere/prog.py")
self.assert_tryexecfile_output(expected, actual)
def test_coverage_run_dashm_is_like_python_dashm(self):
# These -m commands assume the coverage tree is on the path.
expected = self.run_command("python -m process_test.try_execfile")
actual = self.run_command("coverage run -m process_test.try_execfile")
self.assert_tryexecfile_output(expected, actual)
@pytest.mark.skipif(env.PYVERSION == (3, 5, 4, 'final', 0, 0),
reason="3.5.4 broke this: https://bugs.python.org/issue32551"
)
def test_coverage_run_dir_is_like_python_dir(self):
with open(TRY_EXECFILE) as f:
self.make_file("with_main/__main__.py", f.read())
expected = self.run_command("python with_main")
actual = self.run_command("coverage run with_main")
# PyPy includes the current directory in the path when running a
# directory, while CPython and coverage.py do not. Exclude that from
# the comparison also...
if env.PYPY:
ignored = re.escape(os.getcwd())
expected = re_lines(expected, ignored, match=False)
actual = re_lines(actual, ignored, match=False)
self.assert_tryexecfile_output(expected, actual)
def test_coverage_run_dashm_dir_no_init_is_like_python(self):
with open(TRY_EXECFILE) as f:
self.make_file("with_main/__main__.py", f.read())
expected = self.run_command("python -m with_main")
actual = self.run_command("coverage run -m with_main")
if env.PY2:
assert expected.endswith("No module named with_main\n")
assert actual.endswith("No module named with_main\n")
else:
self.assert_tryexecfile_output(expected, actual)
@pytest.mark.skipif(env.PY2,
reason="Python 2 runs __main__ twice, I can't be bothered to make it work."
)
def test_coverage_run_dashm_dir_with_init_is_like_python(self):
with open(TRY_EXECFILE) as f:
self.make_file("with_main/__main__.py", f.read())
self.make_file("with_main/__init__.py", "")
expected = self.run_command("python -m with_main")
actual = self.run_command("coverage run -m with_main")
self.assert_tryexecfile_output(expected, actual)
def test_coverage_run_dashm_equal_to_doubledashsource(self):
"""regression test for #328
When imported by -m, a module's __name__ is __main__, but we need the
--source machinery to know and respect the original name.
"""
# These -m commands assume the coverage tree is on the path.
expected = self.run_command("python -m process_test.try_execfile")
actual = self.run_command(
"coverage run --source process_test.try_execfile -m process_test.try_execfile"
)
self.assert_tryexecfile_output(expected, actual)
def test_coverage_run_dashm_superset_of_doubledashsource(self):
"""Edge case: --source foo -m foo.bar"""
# Ugh: without this config file, we'll get a warning about
# Coverage.py warning: Module process_test was previously imported,
# but not measured (module-not-measured)
#
# This is because process_test/__init__.py is imported while looking
# for process_test.try_execfile. That import happens while setting
# sys.path before start() is called.
self.make_file(".coveragerc", """\
[run]
disable_warnings = module-not-measured
""")
# These -m commands assume the coverage tree is on the path.
expected = self.run_command("python -m process_test.try_execfile")
actual = self.run_command(
"coverage run --source process_test -m process_test.try_execfile"
)
self.assert_tryexecfile_output(expected, actual)
st, out = self.run_command_status("coverage report")
assert st == 0
assert self.line_count(out) == 6, out
def test_coverage_run_script_imports_doubledashsource(self):
# This file imports try_execfile, which compiles it to .pyc, so the
# first run will have __file__ == "try_execfile.py" and the second will
# have __file__ == "try_execfile.pyc", which throws off the comparison.
# Setting dont_write_bytecode True stops the compilation to .pyc and
# keeps the test working.
self.make_file("myscript", """\
import sys; sys.dont_write_bytecode = True
import process_test.try_execfile
""")
expected = self.run_command("python myscript")
actual = self.run_command("coverage run --source process_test myscript")
self.assert_tryexecfile_output(expected, actual)
st, out = self.run_command_status("coverage report")
assert st == 0
assert self.line_count(out) == 6, out
def test_coverage_run_dashm_is_like_python_dashm_off_path(self):
# https://github.com/nedbat/coveragepy/issues/242
self.make_file("sub/__init__.py", "")
with open(TRY_EXECFILE) as f:
self.make_file("sub/run_me.py", f.read())
expected = self.run_command("python -m sub.run_me")
actual = self.run_command("coverage run -m sub.run_me")
self.assert_tryexecfile_output(expected, actual)
def test_coverage_run_dashm_is_like_python_dashm_with__main__207(self):
# https://github.com/nedbat/coveragepy/issues/207
self.make_file("package/__init__.py", "print('init')")
self.make_file("package/__main__.py", "print('main')")
expected = self.run_command("python -m package")
actual = self.run_command("coverage run -m package")
assert expected == actual
def test_coverage_zip_is_like_python(self):
# Test running coverage from a zip file itself. Some environments
# (windows?) zip up the coverage main to be used as the coverage
# command.
with open(TRY_EXECFILE) as f:
self.make_file("run_me.py", f.read())
expected = self.run_command("python run_me.py")
cov_main = os.path.join(TESTS_DIR, "covmain.zip")
actual = self.run_command("python {} run run_me.py".format(cov_main))
self.assert_tryexecfile_output(expected, actual)
def test_coverage_custom_script(self):
# https://github.com/nedbat/coveragepy/issues/678
# If sys.path[0] isn't the Python default, then coverage.py won't
# fiddle with it.
self.make_file("a/b/c/thing.py", """\
SOMETHING = "hello-xyzzy"
""")
abc = os.path.abspath("a/b/c")
self.make_file("run_coverage.py", """\
import sys
sys.path[0:0] = [
r'{abc}',
'/Users/somebody/temp/something/eggs/something-4.5.1-py2.7-xxx-10.13-x86_64.egg',
]
import coverage.cmdline
if __name__ == '__main__':
sys.exit(coverage.cmdline.main())
""".format(abc=abc))
self.make_file("how_is_it.py", """\
import pprint, sys
pprint.pprint(sys.path)
import thing
print(thing.SOMETHING)
""")
# If this test fails, it will be with "can't import thing".
out = self.run_command("python run_coverage.py run how_is_it.py")
assert "hello-xyzzy" in out
out = self.run_command("python -m run_coverage run how_is_it.py")
assert "hello-xyzzy" in out
@pytest.mark.skipif(env.WINDOWS, reason="Windows can't make symlinks")
def test_bug_862(self):
# This simulates how pyenv and pyenv-virtualenv end up creating the
# coverage executable.
self.make_file("elsewhere/bin/fake-coverage", """\
#!{executable}
import sys, pkg_resources
sys.exit(pkg_resources.load_entry_point('coverage', 'console_scripts', 'coverage')())
""".format(executable=sys.executable))
os.chmod("elsewhere/bin/fake-coverage", stat.S_IREAD | stat.S_IEXEC)
os.symlink("elsewhere", "somewhere")
self.make_file("foo.py", "print('inside foo')")
self.make_file("bar.py", "import foo")
out = self.run_command("somewhere/bin/fake-coverage run bar.py")
assert "inside foo\n" == out
def test_bug_909(self):
# https://github.com/nedbat/coveragepy/issues/909
# The __init__ files were being imported before measurement started,
# so the line in __init__.py was being marked as missed, and there were
# warnings about measured files being imported before start.
self.make_file("proj/__init__.py", "print('Init')")
self.make_file("proj/thecode.py", "print('The code')")
self.make_file("proj/tests/__init__.py", "")
self.make_file("proj/tests/test_it.py", "import proj.thecode")
expected = "Init\nThe code\n"
actual = self.run_command("coverage run --source=proj -m proj.tests.test_it")
assert expected == actual
report = self.run_command("coverage report -m")
# Name Stmts Miss Cover Missing
# ------------------------------------------------------
# proj/__init__.py 1 0 100%
# proj/tests/__init__.py 0 0 100%
# proj/tests/test_it.py 1 0 100%
# proj/thecode.py 1 0 100%
# ------------------------------------------------------
# TOTAL 3 0 100%
squeezed = self.squeezed_lines(report)
assert squeezed[2].replace("\\", "/") == "proj/__init__.py 1 0 100%"
class ExcepthookTest(CoverageTest):
"""Tests of sys.excepthook support."""
def test_excepthook(self):
self.make_file("excepthook.py", """\
import sys
def excepthook(*args):
print('in excepthook')
if maybe == 2:
print('definitely')
sys.excepthook = excepthook
maybe = 1
raise RuntimeError('Error Outside')
""")
cov_st, cov_out = self.run_command_status("coverage run excepthook.py")
py_st, py_out = self.run_command_status("python excepthook.py")
if not env.JYTHON:
assert cov_st == py_st
assert cov_st == 1
assert "in excepthook" in py_out
assert cov_out == py_out
# Read the coverage file and see that excepthook.py has 7 lines
# executed.
data = coverage.CoverageData()
data.read()
assert line_counts(data)['excepthook.py'] == 7
@pytest.mark.skipif(not env.CPYTHON,
reason="non-CPython handles excepthook exits differently, punt for now."
)
def test_excepthook_exit(self):
self.make_file("excepthook_exit.py", """\
import sys
def excepthook(*args):
print('in excepthook')
sys.exit(0)
sys.excepthook = excepthook
raise RuntimeError('Error Outside')
""")
cov_st, cov_out = self.run_command_status("coverage run excepthook_exit.py")
py_st, py_out = self.run_command_status("python excepthook_exit.py")
assert cov_st == py_st
assert cov_st == 0
assert "in excepthook" in py_out
assert cov_out == py_out
@pytest.mark.skipif(env.PYPY, reason="PyPy handles excepthook throws differently.")
def test_excepthook_throw(self):
self.make_file("excepthook_throw.py", """\
import sys
def excepthook(*args):
# Write this message to stderr so that we don't have to deal
# with interleaved stdout/stderr comparisons in the assertions
# in the test.
sys.stderr.write('in excepthook\\n')
raise RuntimeError('Error Inside')
sys.excepthook = excepthook
raise RuntimeError('Error Outside')
""")
cov_st, cov_out = self.run_command_status("coverage run excepthook_throw.py")
py_st, py_out = self.run_command_status("python excepthook_throw.py")
if not env.JYTHON:
assert cov_st == py_st
assert cov_st == 1
assert "in excepthook" in py_out
assert cov_out == py_out
@pytest.mark.skipif(env.JYTHON, reason="Coverage command names don't work on Jython")
class AliasedCommandTest(CoverageTest):
"""Tests of the version-specific command aliases."""
run_in_temp_dir = False
def test_major_version_works(self):
# "coverage2" works on py2
cmd = "coverage%d" % sys.version_info[0]
out = self.run_command(cmd)
assert "Code coverage for Python" in out
def test_wrong_alias_doesnt_work(self):
# "coverage3" doesn't work on py2
assert sys.version_info[0] in [2, 3] # Let us know when Python 4 is out...
badcmd = "coverage%d" % (5 - sys.version_info[0])
out = self.run_command(badcmd)
assert "Code coverage for Python" not in out
def test_specific_alias_works(self):
# "coverage-2.7" works on py2.7
cmd = "coverage-%d.%d" % sys.version_info[:2]
out = self.run_command(cmd)
assert "Code coverage for Python" in out
def test_aliases_used_in_messages(self):
cmds = [
"coverage",
"coverage%d" % sys.version_info[0],
"coverage-%d.%d" % sys.version_info[:2],
]
for cmd in cmds:
out = self.run_command("%s foobar" % cmd)
assert "Unknown command: 'foobar'" in out
assert "Use '%s help' for help" % cmd in out
class PydocTest(CoverageTest):
"""Test that pydoc can get our information."""
run_in_temp_dir = False
def assert_pydoc_ok(self, name, thing):
"""Check that pydoc of `name` finds the docstring from `thing`."""
# Run pydoc.
out = self.run_command("python -m pydoc " + name)
# It should say "Help on..", and not have a traceback
assert out.startswith("Help on ")
assert "Traceback" not in out
# All of the lines in the docstring should be there somewhere.
for line in thing.__doc__.splitlines():
assert line.strip() in out
def test_pydoc_coverage(self):
self.assert_pydoc_ok("coverage", coverage)
def test_pydoc_coverage_coverage(self):
self.assert_pydoc_ok("coverage.Coverage", coverage.Coverage)
class FailUnderTest(CoverageTest):
"""Tests of the --fail-under switch."""
def setup_test(self):
super(FailUnderTest, self).setup_test()
self.make_file("forty_two_plus.py", """\
# I have 42.857% (3/7) coverage!
a = 1
b = 2
if a > 3:
b = 4
c = 5
d = 6
e = 7
""")
st, _ = self.run_command_status("coverage run --source=. forty_two_plus.py")
assert st == 0
def test_report_43_is_ok(self):
st, out = self.run_command_status("coverage report --fail-under=43")
assert st == 0
assert self.last_line_squeezed(out) == "TOTAL 7 4 43%"
def test_report_43_is_not_ok(self):
st, out = self.run_command_status("coverage report --fail-under=44")
assert st == 2
expected = "Coverage failure: total of 43 is less than fail-under=44"
assert expected == self.last_line_squeezed(out)
def test_report_42p86_is_not_ok(self):
self.make_file(".coveragerc", "[report]\nprecision = 2")
st, out = self.run_command_status("coverage report --fail-under=42.88")
assert st == 2
expected = "Coverage failure: total of 42.86 is less than fail-under=42.88"
assert expected == self.last_line_squeezed(out)
class FailUnderNoFilesTest(CoverageTest):
"""Test that nothing to report results in an error exit status."""
def test_report(self):
self.make_file(".coveragerc", "[report]\nfail_under = 99\n")
st, out = self.run_command_status("coverage report")
assert 'No data to report.' in out
assert st == 1
class FailUnderEmptyFilesTest(CoverageTest):
"""Test that empty files produce the proper fail_under exit status."""
def test_report(self):
self.make_file(".coveragerc", "[report]\nfail_under = 99\n")
self.make_file("empty.py", "")
st, _ = self.run_command_status("coverage run empty.py")
assert st == 0
st, _ = self.run_command_status("coverage report")
assert st == 2
@pytest.mark.skipif(env.JYTHON, reason="Jython doesn't like accented file names")
class UnicodeFilePathsTest(CoverageTest):
"""Tests of using non-ascii characters in the names of files."""
def test_accented_dot_py(self):
# Make a file with a non-ascii character in the filename.
self.make_file(u"h\xe2t.py", "print('accented')")
out = self.run_command(u"coverage run --source=. h\xe2t.py")
assert out == "accented\n"
# The HTML report uses ascii-encoded HTML entities.
out = self.run_command("coverage html")
assert out == ""
self.assert_exists(u"htmlcov/h\xe2t_py.html")
with open("htmlcov/index.html") as indexf:
index = indexf.read()
assert 'hât.py' in index
# The XML report is always UTF8-encoded.
out = self.run_command("coverage xml")
assert out == ""
with open("coverage.xml", "rb") as xmlf:
xml = xmlf.read()
assert u' filename="h\xe2t.py"'.encode('utf8') in xml
assert u' name="h\xe2t.py"'.encode('utf8') in xml
report_expected = (
u"Name Stmts Miss Cover\n"
u"----------------------------\n"
u"h\xe2t.py 1 0 100%\n"
u"----------------------------\n"
u"TOTAL 1 0 100%\n"
)
if env.PY2:
report_expected = report_expected.encode(output_encoding())
out = self.run_command("coverage report")
assert out == report_expected
def test_accented_directory(self):
# Make a file with a non-ascii character in the directory name.
self.make_file(u"\xe2/accented.py", "print('accented')")
out = self.run_command(u"coverage run --source=. \xe2/accented.py")
assert out == "accented\n"
# The HTML report uses ascii-encoded HTML entities.
out = self.run_command("coverage html")
assert out == ""
self.assert_exists(u"htmlcov/\xe2_accented_py.html")
with open("htmlcov/index.html") as indexf:
index = indexf.read()
assert 'â%saccented.py' % os.sep in index
# The XML report is always UTF8-encoded.
out = self.run_command("coverage xml")
assert out == ""
with open("coverage.xml", "rb") as xmlf:
xml = xmlf.read()
assert b' filename="\xc3\xa2/accented.py"' in xml
assert b' name="accented.py"' in xml
dom = ElementTree.parse("coverage.xml")
elts = dom.findall(u".//package[@name='â']")
assert len(elts) == 1
assert elts[0].attrib == {
"branch-rate": u"0",
"complexity": u"0",
"line-rate": u"1",
"name": u"â",
}
report_expected = (
u"Name Stmts Miss Cover\n"
u"-----------------------------------\n"
u"\xe2%saccented.py 1 0 100%%\n"
u"-----------------------------------\n"
u"TOTAL 1 0 100%%\n"
) % os.sep
if env.PY2:
report_expected = report_expected.encode(output_encoding())
out = self.run_command("coverage report")
assert out == report_expected
@pytest.mark.skipif(env.WINDOWS, reason="Windows can't delete the directory in use.")
class YankedDirectoryTest(CoverageTest):
"""Tests of what happens when the current directory is deleted."""
BUG_806 = """\
import os
import sys
import tempfile
tmpdir = tempfile.mkdtemp()
os.chdir(tmpdir)
os.rmdir(tmpdir)
print(sys.argv[1])
"""
def test_removing_directory(self):
self.make_file("bug806.py", self.BUG_806)
out = self.run_command("coverage run bug806.py noerror")
assert out == "noerror\n"
def test_removing_directory_with_error(self):
self.make_file("bug806.py", self.BUG_806)
out = self.run_command("coverage run bug806.py")
path = python_reported_file('bug806.py')
assert out == textwrap.dedent("""\
Traceback (most recent call last):
File "{}", line 8, in
print(sys.argv[1])
IndexError: list index out of range
""".format(path))
def possible_pth_dirs():
"""Produce a sequence of directories for trying to write .pth files."""
# First look through sys.path, and if we find a .pth file, then it's a good
# place to put ours.
for pth_dir in sys.path: # pragma: part covered
pth_files = glob.glob(os.path.join(pth_dir, "*.pth"))
if pth_files:
yield pth_dir
# If we're still looking, then try the Python library directory.
# https://github.com/nedbat/coveragepy/issues/339
yield sysconfig.get_python_lib() # pragma: cant happen
def find_writable_pth_directory():
"""Find a place to write a .pth file."""
for pth_dir in possible_pth_dirs(): # pragma: part covered
try_it = os.path.join(pth_dir, "touch_{}.it".format(WORKER))
with open(try_it, "w") as f:
try:
f.write("foo")
except (IOError, OSError): # pragma: cant happen
continue
os.remove(try_it)
return pth_dir
return None # pragma: cant happen
WORKER = os.environ.get('PYTEST_XDIST_WORKER', '')
PTH_DIR = find_writable_pth_directory()
def persistent_remove(path):
"""Remove a file, and retry for a while if you can't."""
tries = 100
while tries: # pragma: part covered
try:
os.remove(path)
except OSError:
tries -= 1
time.sleep(.05)
else:
return
raise Exception("Sorry, couldn't remove {!r}".format(path)) # pragma: cant happen
class ProcessCoverageMixin(object):
"""Set up a .pth file to coverage-measure all sub-processes."""
def setup_test(self):
super(ProcessCoverageMixin, self).setup_test()
# Create the .pth file.
assert PTH_DIR
pth_contents = "import coverage; coverage.process_startup()\n"
pth_path = os.path.join(PTH_DIR, "subcover_{}.pth".format(WORKER))
with open(pth_path, "w") as pth:
pth.write(pth_contents)
self.addCleanup(persistent_remove, pth_path)
@pytest.mark.skipif(env.METACOV, reason="Can't test sub-process pth file during metacoverage")
class ProcessStartupTest(ProcessCoverageMixin, CoverageTest):
"""Test that we can measure coverage in sub-processes."""
def setup_test(self):
super(ProcessStartupTest, self).setup_test()
# Main will run sub.py
self.make_file("main.py", """\
import os, os.path, sys
ex = os.path.basename(sys.executable)
os.system(ex + " sub.py")
""")
# sub.py will write a few lines.
self.make_file("sub.py", """\
f = open("out.txt", "w")
f.write("Hello, world!\\n")
f.close()
""")
def test_subprocess_with_pth_files(self):
# An existing data file should not be read when a subprocess gets
# measured automatically. Create the data file here with bogus data in
# it.
data = coverage.CoverageData(".mycovdata")
data.add_lines({os.path.abspath('sub.py'): dict.fromkeys(range(100))})
data.write()
self.make_file("coverage.ini", """\
[run]
data_file = .mycovdata
""")
self.set_environ("COVERAGE_PROCESS_START", "coverage.ini")
import main # pylint: disable=unused-import, import-error
with open("out.txt") as f:
assert f.read() == "Hello, world!\n"
# Read the data from .coverage
self.assert_exists(".mycovdata")
data = coverage.CoverageData(".mycovdata")
data.read()
assert line_counts(data)['sub.py'] == 3
def test_subprocess_with_pth_files_and_parallel(self):
# https://github.com/nedbat/coveragepy/issues/492
self.make_file("coverage.ini", """\
[run]
parallel = true
""")
self.set_environ("COVERAGE_PROCESS_START", "coverage.ini")
self.run_command("coverage run main.py")
with open("out.txt") as f:
assert f.read() == "Hello, world!\n"
self.run_command("coverage combine")
# assert that the combined .coverage data file is correct
self.assert_exists(".coverage")
data = coverage.CoverageData()
data.read()
assert line_counts(data)['sub.py'] == 3
# assert that there are *no* extra data files left over after a combine
data_files = glob.glob(os.getcwd() + '/.coverage*')
msg = (
"Expected only .coverage after combine, looks like there are " +
"extra data files that were not cleaned up: %r" % data_files
)
assert len(data_files) == 1, msg
class ProcessStartupWithSourceTest(ProcessCoverageMixin, CoverageTest):
"""Show that we can configure {[run]source} during process-level coverage.
There are three interesting variables, for a total of eight tests:
1. -m versus a simple script argument (for example, `python myscript`),
2. filtering for the top-level (main.py) or second-level (sub.py)
module, and
3. whether the files are in a package or not.
"""
def assert_pth_and_source_work_together(
self, dashm, package, source
):
"""Run the test for a particular combination of factors.
The arguments are all strings:
* `dashm`: Either "" (run the program as a file) or "-m" (run the
program as a module).
* `package`: Either "" (put the source at the top level) or a
package name to use to hold the source.
* `source`: Either "main" or "sub", which file to use as the
``--source`` argument.
"""
def fullname(modname):
"""What is the full module name for `modname` for this test?"""
if package and dashm:
return '.'.join((package, modname))
else:
return modname
def path(basename):
"""Where should `basename` be created for this test?"""
return os.path.join(package, basename)
# Main will run sub.py.
self.make_file(path("main.py"), """\
import %s
a = 2
b = 3
""" % fullname('sub'))
if package:
self.make_file(path("__init__.py"), "")
# sub.py will write a few lines.
self.make_file(path("sub.py"), """\
# Avoid 'with' so Jython can play along.
f = open("out.txt", "w")
f.write("Hello, world!")
f.close()
""")
self.make_file("coverage.ini", """\
[run]
source = %s
""" % fullname(source))
self.set_environ("COVERAGE_PROCESS_START", "coverage.ini")
if dashm:
cmd = "python -m %s" % fullname('main')
else:
cmd = "python %s" % path('main.py')
self.run_command(cmd)
with open("out.txt") as f:
assert f.read() == "Hello, world!"
# Read the data from .coverage
self.assert_exists(".coverage")
data = coverage.CoverageData()
data.read()
summary = line_counts(data)
print(summary)
assert summary[source + '.py'] == 3
assert len(summary) == 1
def test_dashm_main(self):
self.assert_pth_and_source_work_together('-m', '', 'main')
def test_script_main(self):
self.assert_pth_and_source_work_together('', '', 'main')
def test_dashm_sub(self):
self.assert_pth_and_source_work_together('-m', '', 'sub')
def test_script_sub(self):
self.assert_pth_and_source_work_together('', '', 'sub')
def test_dashm_pkg_main(self):
self.assert_pth_and_source_work_together('-m', 'pkg', 'main')
def test_script_pkg_main(self):
self.assert_pth_and_source_work_together('', 'pkg', 'main')
def test_dashm_pkg_sub(self):
self.assert_pth_and_source_work_together('-m', 'pkg', 'sub')
def test_script_pkg_sub(self):
self.assert_pth_and_source_work_together('', 'pkg', 'sub')
def run_in_venv(cmd):
r"""Run `cmd` in the virtualenv at `venv`.
The first word of the command will be adjusted to run it from the
venv/bin or venv\Scripts directory.
Returns the text output of the command.
"""
words = cmd.split()
if env.WINDOWS:
words[0] = r"{}\Scripts\{}.exe".format("venv", words[0])
else:
words[0] = "{}/bin/{}".format("venv", words[0])
status, output = run_command(" ".join(words))
assert status == 0
return output
@pytest.fixture(scope="session", name="venv_world")
def venv_world_fixture(tmp_path_factory):
"""Create a virtualenv with a few test packages for VirtualenvTest to use.
Returns the directory containing the "venv" virtualenv.
"""
venv_world = tmp_path_factory.mktemp("venv_world")
with change_dir(venv_world):
# Create a virtualenv.
run_command("python -m virtualenv venv")
# A third-party package that installs two different packages.
make_file("third_pkg/third/__init__.py", """\
import fourth
def third(x):
return 3 * x
""")
make_file("third_pkg/fourth/__init__.py", """\
def fourth(x):
return 4 * x
""")
make_file("third_pkg/setup.py", """\
import setuptools
setuptools.setup(name="third", packages=["third", "fourth"])
""")
# Install the third-party packages.
run_in_venv("python -m pip install --no-index ./third_pkg")
shutil.rmtree("third_pkg")
# Install coverage.
coverage_src = nice_file(TESTS_DIR, "..")
run_in_venv("python -m pip install --no-index {}".format(coverage_src))
return venv_world
@pytest.fixture(params=[
"coverage",
"python -m coverage",
], name="coverage_command")
def coverage_command_fixture(request):
"""Parametrized fixture to use multiple forms of "coverage" command."""
return request.param
class VirtualenvTest(CoverageTest):
"""Tests of virtualenv considerations."""
@pytest.fixture(autouse=True)
def in_venv_world_fixture(self, venv_world):
"""For running tests inside venv_world, and cleaning up made files."""
with change_dir(venv_world):
self.make_file("myproduct.py", """\
import colorsys
import third
print(third.third(11))
print(sum(colorsys.rgb_to_hls(1, 0, 0)))
""")
self.expected_stdout = "33\n1.5\n" # pylint: disable=attribute-defined-outside-init
self.del_environ("COVERAGE_TESTING") # To avoid needing contracts installed.
self.set_environ("COVERAGE_DEBUG_FILE", "debug_out.txt")
self.set_environ("COVERAGE_DEBUG", "trace")
yield
for fname in os.listdir("."):
if fname != "venv":
os.remove(fname)
def get_trace_output(self):
"""Get the debug output of coverage.py"""
with open("debug_out.txt") as f:
return f.read()
def test_third_party_venv_isnt_measured(self, coverage_command):
out = run_in_venv(coverage_command + " run --source=. myproduct.py")
# In particular, this warning doesn't appear:
# Already imported a file that will be measured: .../coverage/__main__.py
assert out == self.expected_stdout
# Check that our tracing was accurate. Files are mentioned because
# --source refers to a file.
debug_out = self.get_trace_output()
assert re_lines(
debug_out,
r"^Not tracing .*\bexecfile.py': inside --source, but is part of coverage.py"
)
assert re_lines(debug_out, r"^Tracing .*\bmyproduct.py")
assert re_lines(
debug_out,
r"^Not tracing .*\bcolorsys.py': falls outside the --source spec"
)
out = run_in_venv("python -m coverage report")
assert "myproduct.py" in out
assert "third" not in out
assert "coverage" not in out
assert "colorsys" not in out
def test_us_in_venv_isnt_measured(self, coverage_command):
out = run_in_venv(coverage_command + " run --source=third myproduct.py")
assert out == self.expected_stdout
# Check that our tracing was accurate. Modules are mentioned because
# --source refers to a module.
debug_out = self.get_trace_output()
assert re_lines(
debug_out,
r"^Not tracing .*\bexecfile.py': " +
"module 'coverage.execfile' falls outside the --source spec"
)
print(re_lines(debug_out, "myproduct"))
assert re_lines(
debug_out,
r"^Not tracing .*\bmyproduct.py': module u?'myproduct' falls outside the --source spec"
)
assert re_lines(
debug_out,
r"^Not tracing .*\bcolorsys.py': module u?'colorsys' falls outside the --source spec"
)
out = run_in_venv("python -m coverage report")
assert "myproduct.py" not in out
assert "third" in out
assert "coverage" not in out
assert "colorsys" not in out
def test_venv_isnt_measured(self, coverage_command):
out = run_in_venv(coverage_command + " run myproduct.py")
assert out == self.expected_stdout
debug_out = self.get_trace_output()
assert re_lines(debug_out, r"^Not tracing .*\bexecfile.py': is part of coverage.py")
assert re_lines(debug_out, r"^Tracing .*\bmyproduct.py")
assert re_lines(debug_out, r"^Not tracing .*\bcolorsys.py': is in the stdlib")
out = run_in_venv("python -m coverage report")
assert "myproduct.py" in out
assert "third" not in out
assert "coverage" not in out
assert "colorsys" not in out