Skip to content

Support coverage for py_test #43

Closed

Description

@hwright

bazel coverage should generate a coverage report for the python tests it runs. Ideally, it gathers the list of dependencies, and then computes coverage over that for a given test. When multiple tests are run in the same Bazel invocation, their reports should be merged into a single one.

I'm dropping this here mostly as a python-specific version of bazelbuild/bazel#1118. I know that the py_test rule is currently implemented natively in Bazel, and the implementation in rules_python just forwards there, but this is fundamentally a python issue, so this repo feels appropriate.

The general plan is to modify the python test runner within Bazel to use coverage.py to generate reports when running under coverage. I suspect it is a journey fraught with peril.

Alternatively, if it is possible to invoke coverage.py in ways other than modifying core Bazel, I'm open to suggestions.

Activity

  1. mattmoor commented on Nov 27, 2017

    @mattmoor
    Contributor

    @damienmg assigning to you to redirect appropriately.

  2. hwright commented on Nov 27, 2017

    @hwright
    Author

    fwiw, I've also been poking at this as documented here: https://groups.google.com/d/msg/bazel-discuss/LC97zBrMG84/cfVNdus-AwAJ

    It's been slow going, as I'm pretty unfamiliar with Bazel internals, and haven't been able to get the ear of somebody who is.

  3. removed their assignment
    on Dec 14, 2017
  4. brandjon commented on Nov 9, 2018

    @brandjon
    Contributor

    Setting P4 because this isn't a blocker for 1.0 support.

  5. JoshSullivan11 commented on Jun 25, 2019

    @JoshSullivan11

    Has this feature been implemented yet? If so, in what release version? It seems like coverage has been able to cover every other bit of our code repo except for all python files which is makes up most of our code base. Please let me know!

  6. siddharthab commented on Aug 14, 2019

    @siddharthab
    Contributor

    Is there a way to make bazel coverage //some_py_test not fail even if it does not collect coverage information. Currently, it fails because :lcov_merger attribute is not defined in py_test rules.

    This is kind of important because we want to be able to run bazel coverage ... on a monorepo.

  7. 9 remaining items

  8. EnergySRE commented on Oct 28, 2021

    @EnergySRE

    Boop. We still desire this 🙂

  9. mihaigalos commented on Oct 28, 2021

    @mihaigalos

    Boop. We still desire this 🙂

    Then implement it, perhaps? 🙃

  10. self-assigned this
    on Nov 1, 2021
  11. adam-azarchs commented on Apr 29, 2022

    @adam-azarchs

    At this point upstream coveragepy has lcov support. I think the main piece that's missing is that there needs to be a way to specify a target for coveragepy in py_runtime for hermetic python toolchains.

  12. chrislovecnm commented on Jul 11, 2023

    @chrislovecnm
    Contributor

    @aignas do we have more work to do on this?

  13. sgammon commented on Aug 20, 2023

    @sgammon

    this issue has been open for 6 years

  14. aignas commented on Aug 20, 2023

    @aignas
    Collaborator

    I think we can safely close it now as we have docs and there are quite a few versions supporting toolchain with coverage.py enabled.

  15. sgammon commented on Aug 20, 2023

    @sgammon

    @aignas I just set up a brand new project on top of rules_python, using Bazel 7 and Bzlmod, and coverage still doesn't work out of the box.

    Where do you see toolchains supporting coverage?

  16. aignas commented on Nov 5, 2023

    @aignas
    Collaborator
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions