exclude eggsupport.py from coverage

[d-maurer]

This PR excludes eggsupport.py from the coverage analysis:
the eggsupport.py functionality is available only for older setuptools versions and the GH testrunnter uses a newer one. As a consequence, eggsupport.py is no longer covered by the test suite and the coverage check fails.

[d-maurer]

Help needed:
The PR wants to exclude eggsupport.py from the coverage analysis. There are several possibilities: tox.ini, .coveragerc, setup.cfg, pyproject.toml.

It started with a tox.ini modification (successful) but tox.ini is generated by meta. I failed to see how to adjust the configuration for this generation to get the wanted tox.ini change because the corrent tox.ini seems not to have been generated by the current meta configuration: the coverage report call in tox.ini has parameters not present in the template's tox.ini.j2.

Using .coveragerc succeeded locally but failed on GH with a not understood problem relating to coveralls.

I switched back to the tox.ini approach. This will be lost when tox.ini is regenerated. I hope someone can give me a hint how to get the change into the generation configuration.

[perrinjerome]

I don't know this well, but I'll try to help anyway.

The examples from https://zopemeta.readthedocs.io/en/latest/narr.html#options show that we can have some local additional config specific for a package. According to this, it would be a patch like this:

diff --git a/.meta.toml b/.meta.toml
index 2c2ebc9..8f90dc5 100644
--- a/.meta.toml
+++ b/.meta.toml
@@ -15,6 +15,12 @@ with-macos = false
 [coverage]
 fail-under = 84
 
+[coverage-run]
+additional-config = [
+    "omit =",
+    "    eggsupport.py",
+    ]
+
 [manifest]
 additional-rules = [
     "include *.md",

if I run with the same version of meta (

zope.testrunner/.meta.toml

Line 5 in 02c6af3

commit-id = "08a3cc69"

) it generates

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index 03cea90..a8cc240 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -39,7 +39,7 @@ jobs:
         - ["3.10",  "py310-subunit"]
         - ["3.11",  "py311-subunit"]
         - ["3.12",  "py312-subunit"]
-        - ["3.13.0-alpha - 3.13.0",  "py313-subunit"] 
+        - ["3.13.0-alpha - 3.13.0",  "py313-subunit"]
         - ["pypy-3.9", "pypy3-subunit"]
         exclude:
           - { os: ["windows", "windows-latest"], config: ["3.9",   "release-check"] }
diff --git a/tox.ini b/tox.ini
index 441ad7e..5754728 100644
--- a/tox.ini
+++ b/tox.ini
@@ -85,13 +85,15 @@ deps =
     coverage
 commands =
     mkdir -p {toxinidir}/parts/htmlcov
-    coverage run --omit eggsupport.py -m zope.testrunner --test-path=src {posargs:-vc}
+    coverage run -m zope.testrunner --test-path=src {posargs:-vc}
     coverage html --ignore-errors
     coverage report --ignore-errors --show-missing --fail-under=84
 
 [coverage:run]
 branch = True
 source = zope.testrunner
+omit =
+    eggsupport.py
 
 [coverage:report]
 precision = 2

but if I run with the current latest version it generates lots of changes, it seems @icemac is already handling these changes in #183

[d-maurer]

Jérome Perrin wrote at 2024-10-14 07:28 -0700:

I don't know this well, but I'll try to help anyway.

Tkank you!

... but if I run with the current latest version it generates lots of changes, it seems @icemac is already handling these changes in #183

My main problem has been that the geenrated `tox.ini` did not match the `tox.ini` template in the current `meta`. I should have recognized that it likely was generated by an older `meta` version. Thank you for pointing me to #183.

[icemac]

For how old setuptools versions we need eggsupport.py? Could it be a way foreward to remove it and use the setuptools version which no longer needs it as minimum version?

[d-maurer]

Michael Howitz wrote at 2024-10-14 23:40 -0700:

For how old `setuptools` versions we need `eggsupport.py`?

I have never used this `eggsupport` and frankly even found the corresponding documentation difficult to understand. But someone took the effort to implement it.

Could it be a way foreward to remove it and use the `setuptools` version which no longer needs it as minimum version?

Removing it everywhere (implementation, tests, doc, ...) is more work than just not include it in the `coverage` analysis. But, I would not mind if it went away.

[d-maurer]

Issue solved by #183