Don't show the omitted files in the Test Coverage Toolbar

[paduszyk]

I like the new Test Coverage Toolbar feature. I use it with Python and Coverage.py run via pytest and pytest-cov plugin.

Coverage.py enables omitting some files using globs (e.g. configuration modules or development scripts; see docs). I think that NOT showing those files in the toolbar could be an interesting enhancement.

Sorry if you find this issue biased to Python. I am not so familiar with other languages and testing tools available for them.

[eleanorjboyd]

good idea yes! I can do this specifically on the python side. This will need development time so just putting it for community feedback to see how many people are hitting this issue

[github-actions]

Thanks for the feature request! We are going to give the community 60 days from when this issue was created to provide 7 👍 upvotes on the opening comment to gauge general interest in this idea. If there's enough upvotes then we will consider this feature request in our future planning. If there's unfortunately not enough upvotes then we will close this issue.

[eleanorjboyd]

"Run Test with Coverage" should allow omitting files from the report. Ideally, honor the "omit" setting in the coverage configuration. Some default arguments may be set, such as .venv.

It seems this can be done using a workaround, namely, by using tool.coverage.run.omit (as opposed to tool.coverage.report.omit, which I tried previously).

[tool.coverage.run]
omit = [
    ".venv/*",
    # https://github.com/nedbat/coveragepy/issues/1392
    "pyscript",
    "shibokensupport/*",
    "signature_bootstrap.py",
]

copied from #24309 as both are related to omitting files for coverage

[eleanorjboyd]

Hi @paduszyk! In what way did you configure your file to omit? I did the most basic setup and it worked for me:

[paduszyk]

@eleanorjboyd Actually, I configure the omit option in [report] section, not [run]. In fact, Coverage.py accepts both cases:

https://coverage.readthedocs.io/en/7.6.5/config.html#run-omit
https://coverage.readthedocs.io/en/7.6.5/config.html#report-omit

But, to be honest, the difference is not clear to me. I use the latter, as it sounds more logical to me to use report section to affect the behavior referred to coverage reports.

Besides, I prefer pyproject.toml as the configuration "hub". I don't think however this can be an issue here.

[paduszyk]

@eleanorjboyd Indeed, if I move omit to [run] section, the omitted files are not shown by GUI (the desired behavior). So it looks like the problem is probably with Coverage.py.

[eleanorjboyd]

hm yes this is a good point about the [report] vs [run], I am not entirely sure which should control the behavior of the coverage view in vscode. The reason I lean towards [run] is we are not actually producing a [report] but after further investigate i see that the output from coverage (just when run in the terminal like with python -m pytest --cov=. does omit files listed under [report]. Since the extension goal is to always best mirror real behavior- I think omit for report should be respected. Let me investigate how difficult this would be and I will let you know. If it requires a coverage.py API change I will likely talk with Ned at coverage and get his thoughts specifically.