Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Preserve source roots with Pytest output #10165

Merged
merged 9 commits into from Jul 7, 2020
Merged

Preserve source roots with Pytest output #10165

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4a6d149
Preserve source roots with Pytest
Eric-Arellano Jun 25, 2020
1201dfc
Unskip coverage test
Eric-Arellano Jun 25, 2020
6f7f672
Merge branch 'master' of github.com:pantsbuild/pants into pytest-dont…
Eric-Arellano Jun 26, 2020
3ef4e4b
Merge branch 'master' of github.com:pantsbuild/pants into pytest-dont…
Eric-Arellano Jun 26, 2020
3e5db45
Merge branch 'master' and ensure all discovered `__init__.py` files s…
Eric-Arellano Jun 29, 2020
e36fb84
Delete `coverage_plugin/__init__.py`
Eric-Arellano Jun 29, 2020
1343b5b
Merge branch 'master' of github.com:pantsbuild/pants into pytest-dont…
Eric-Arellano Jul 6, 2020
6266a53
Fix copyright years
Eric-Arellano Jul 6, 2020
ac1a843
Shorten path in pantsd test to avoid colliding with the pythonpath of…
stuhood Jul 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion src/python/pants/backend/python/rules/BUILD
View file
Open in desktop
Expand Up @@ -6,7 +6,6 @@ python_library(
'3rdparty/python:dataclasses',
'3rdparty/python:setuptools',
'src/python/pants/backend/python:target_types',
'src/python/pants/backend/python/rules/coverage_plugin:plugin',
'src/python/pants/backend/python/subsystems',
'src/python/pants/backend/python/subsystems/ipex',
'src/python/pants/build_graph',
Expand Down
102 changes: 27 additions & 75 deletions src/python/pants/backend/python/rules/coverage.py
View file
Open in desktop
Expand Up @@ -2,16 +2,12 @@
# Licensed under the Apache License, Version 2.0 (see LICENSE).

import configparser
import itertools
import json
from dataclasses import dataclass
from io import StringIO
from pathlib import PurePath
from textwrap import dedent
from typing import Optional, Tuple, cast

import pkg_resources

from pants.backend.python.rules.pex import (
Pex,
PexInterpreterConstraints,
Expand All @@ -30,12 +26,15 @@
FilesystemCoverageReport,
)
from pants.core.util_rules.determine_source_files import AllSourceFilesRequest, SourceFiles
from pants.core.util_rules.strip_source_roots import (
SourceRootStrippedSources,
StripSourcesFieldRequest,
)
from pants.engine.addresses import Address
from pants.engine.fs import AddPrefix, Digest, FileContent, InputFilesContent, MergeDigests
from pants.engine.fs import (
EMPTY_SNAPSHOT,
AddPrefix,
Digest,
FileContent,
InputFilesContent,
MergeDigests,
)
from pants.engine.process import Process, ProcessResult
from pants.engine.rules import SubsystemRule, rule
from pants.engine.selectors import Get, MultiGet
Expand All @@ -45,14 +44,14 @@
from pants.util.logging import LogLevel
from pants.util.ordered_set import FrozenOrderedSet


"""
An overview of how Pytest Coverage works with Pants:
An overview:

Step 1: Run each test with the appropriate `--cov` arguments.
In `python_test_runner.py`, we pass options so that the pytest-cov plugin runs and records which
lines were encountered in the test. For each test, it will save a `.coverage` file (SQLite DB
format). The files stored in `.coverage` will be stripped of source roots. Our plugin records which
files are "owned" by the plugin.
format).

Step 2: Merge the results with `coverage combine`.
We now have a bunch of individual `PytestCoverageData` values, each with their own `.coverage` file.
Expand All @@ -61,14 +60,11 @@
Step 3: Generate the report with `coverage {html,xml,console}`.
All the files in the single merged `.coverage` file are still stripped, and we want to generate a
report with the source roots restored. Coverage requires that the files it's reporting on be present
when it generates the report, so we populate all the stripped source files. Our plugin then uses
the stripped filename -> source root mapping to determine the correct file name for the report.
when it generates the report, so we populate all the source files.

Step 4: `test.py` outputs the final report.
"""

COVERAGE_PLUGIN_MODULE_NAME = "__pants_coverage_plugin__"


class CoverageSubsystem(PythonToolBase):
options_scope = "coverage-py"
Expand Down Expand Up @@ -132,21 +128,6 @@ def omit_test_sources(self) -> bool:
return cast(bool, self.options.omit_test_sources)


@dataclass(frozen=True)
class CoveragePlugin:
digest: Digest


@rule
async def prepare_coverage_plugin() -> CoveragePlugin:
plugin_file = FileContent(
f"{COVERAGE_PLUGIN_MODULE_NAME}.py",
pkg_resources.resource_string(__name__, "coverage_plugin/plugin.py"),
)
digest = await Get(Digest, InputFilesContent([plugin_file]))
return CoveragePlugin(digest)


@dataclass(frozen=True)
class PytestCoverageData(CoverageData):
address: Address
Expand All @@ -171,28 +152,6 @@ class CoverageConfig:
async def create_coverage_config(
request: CoverageConfigRequest, coverage_subsystem: CoverageSubsystem, log_level: LogLevel
) -> CoverageConfig:
all_stripped_sources = await MultiGet(
Get(SourceRootStrippedSources, StripSourcesFieldRequest(tgt[PythonSources]))
for tgt in request.targets
if tgt.has_field(PythonSources)
)
all_stripped_test_sources: Tuple[SourceRootStrippedSources, ...] = ()
if coverage_subsystem.omit_test_sources:
all_stripped_test_sources = await MultiGet(
Get(SourceRootStrippedSources, StripSourcesFieldRequest(tgt[PythonTestsSources]))
for tgt in request.targets
if tgt.has_field(PythonTestsSources)
)

# We map stripped file names to their source roots so that we can map back to the actual
# sources file when generating coverage reports. For example,
# {'helloworld/project.py': 'src/python'}.
stripped_files_to_source_roots = {}
for stripped_sources in all_stripped_sources:
stripped_files_to_source_roots.update(
{f: root for root, files in stripped_sources.root_to_relfiles.items() for f in files}
)

default_config = dedent(
"""
[run]
Expand All @@ -203,25 +162,25 @@ async def create_coverage_config(
cp = configparser.ConfigParser()
cp.read_string(default_config)

if coverage_subsystem.omit_test_sources:
test_files = itertools.chain.from_iterable(
stripped_test_sources.snapshot.files
for stripped_test_sources in all_stripped_test_sources
test_sources = (
await Get(
SourceFiles,
AllSourceFilesRequest(
tgt[PythonTestsSources]
for tgt in request.targets
if tgt.has_field(PythonTestsSources)
),
)
cp.set("run", "omit", ",".join(sorted(test_files)))
if coverage_subsystem.omit_test_sources
else SourceFiles(EMPTY_SNAPSHOT)
)
if coverage_subsystem.omit_test_sources:
cp.set("run", "omit", ",".join(test_sources.files))

if log_level in (LogLevel.DEBUG, LogLevel.TRACE):
# See https://coverage.readthedocs.io/en/coverage-5.1/cmd.html?highlight=debug#diagnostics.
cp.set("run", "debug", "\n\ttrace\n\tconfig")

cp.set("run", "plugins", COVERAGE_PLUGIN_MODULE_NAME)
cp.add_section(COVERAGE_PLUGIN_MODULE_NAME)
cp.set(
COVERAGE_PLUGIN_MODULE_NAME,
"stripped_files_to_source_roots",
json.dumps(stripped_files_to_source_roots),
)

config_stream = StringIO()
cp.write(config_stream)
config_content = config_stream.getvalue()
Expand All @@ -238,7 +197,7 @@ class CoverageSetup:


@rule
async def setup_coverage(coverage: CoverageSubsystem, plugin: CoveragePlugin) -> CoverageSetup:
async def setup_coverage(coverage: CoverageSubsystem) -> CoverageSetup:
pex = await Get(
Pex,
PexRequest(
Expand All @@ -248,7 +207,6 @@ async def setup_coverage(coverage: CoverageSubsystem, plugin: CoveragePlugin) ->
coverage.default_interpreter_constraints
),
entry_point=coverage.get_entry_point(),
sources=plugin.digest,
),
)
return CoverageSetup(pex)
Expand Down Expand Up @@ -302,12 +260,7 @@ async def generate_coverage_report(
sources_request = Get(
SourceFiles,
AllSourceFilesRequest(
(
tgt[PythonSources]
for tgt in transitive_targets.closure
if tgt.has_field(PythonSources)
),
strip_source_roots=True,
tgt[PythonSources] for tgt in transitive_targets.closure if tgt.has_field(PythonSources)
),
)
coverage_config, sources = await MultiGet(coverage_config_request, sources_request)
Expand Down Expand Up @@ -357,7 +310,6 @@ async def generate_coverage_report(

def rules():
return [
prepare_coverage_plugin,
create_coverage_config,
generate_coverage_report,
merge_coverage_data,
Expand Down
13 changes: 5 additions & 8 deletions src/python/pants/backend/python/rules/coverage_integration_test.py
View file
Open in desktop
Expand Up @@ -141,32 +141,29 @@ def test_arithmetic():
# report would work properly.
assert "Failed to generate report" not in result.stderr_data

# TODO(#10064): Fix Coverage so that `random.py` shows up in the output.
assert (
dedent(
f"""\
Name Stmts Miss Branch BrPart Cover
-----------------------------------------------------------------------------------------------
{tmpdir_relative}/src/python/project/lib.py 6 0 0 0 100%
{tmpdir_relative}/src/python/project/lib_test.py 3 0 0 0 100%
{tmpdir_relative}/src/python/project/random.py 2 2 0 0 0%
{tmpdir_relative}/tests/python/project_test/no_src/test_no_src.py 2 0 0 0 100%
{tmpdir_relative}/tests/python/project_test/test_arithmetic.py 3 0 0 0 100%
{tmpdir_relative}/tests/python/project_test/test_multiply.py 3 0 0 0 100%
-----------------------------------------------------------------------------------------------
TOTAL 19 2 0 0 89%
TOTAL 17 0 0 0 100%
"""
)
in default_result.stderr_data
)
assert (
dedent(
f"""\
Name Stmts Miss Branch BrPart Cover
----------------------------------------------------------------------------
{tmpdir_relative}/src/python/project/lib.py 6 0 0 0 100%
{tmpdir_relative}/src/python/project/random.py 2 2 0 0 0%
----------------------------------------------------------------------------
TOTAL 8 2 0 0 75%
Name Stmts Miss Branch BrPart Cover
-------------------------------------------------------------------------
{tmpdir_relative}/src/python/project/lib.py 6 0 0 0 100%
"""
)
in omit_test_result.stderr_data
Expand Down
8 changes: 0 additions & 8 deletions src/python/pants/backend/python/rules/coverage_plugin/BUILD
View file
Open in desktop

This file was deleted.

92 changes: 0 additions & 92 deletions src/python/pants/backend/python/rules/coverage_plugin/plugin.py
View file
Open in desktop

This file was deleted.