Coverage cleanups

.github/workflows/ci.yml

@@ -77,7 +77,7 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        python -m pip install tox coverage[toml]
+        python -m pip install tox coverage[toml]~=6.6.0b1
     - name: Get packages
       uses: actions/download-artifact@v3
       with:
@@ -123,17 +123,11 @@ jobs:
         python-version: ${{ env.max_python_version }}
     - name: Install dependencies
       run: |
-        python -m pip install coverage[toml]
+        python -m pip install coverage[toml]~=6.6.0b1
     - name: Retrieve coverage data
       uses: actions/download-artifact@v3
       with:
         name: core-coverage-data
-    - name: Normalize paths in coverage data
-      run: |
-        # See https://github.com/nedbat/coveragepy/issues/991
-        for coverage in `ls .coverage.*`; do
-          sqlite3 $coverage "update file set path = replace(path, '\\', '/')"
-        done
     - name: Combine coverage
       run: |
         python -m coverage combine
@@ -186,7 +180,7 @@ jobs:
     - name: Install dependencies
       run: |
         ${{ matrix.pre-command }}
-        python -m pip install tox coverage[toml]
+        python -m pip install tox coverage[toml]~=6.6.0b1
     - name: Test
       env:
         TOGA_INSTALL_COMMAND: 'bash -c "pip install ../{core,dummy,${{ matrix.backend }}}/dist/*.whl"'
@@ -220,17 +214,11 @@ jobs:
         python-version: ${{ env.max_python_version }}
     - name: Install dependencies
       run: |
-        python -m pip install coverage[toml]
+        python -m pip install coverage[toml]~=6.6.0b1
     - name: Retrieve coverage data
       uses: actions/download-artifact@v3
       with:
         name: backend-coverage-data
-    - name: Normalize paths in coverage data
-      run: |
-        # See https://github.com/nedbat/coveragepy/issues/991
-        for coverage in `ls .coverage.*`; do
-          sqlite3 $coverage "update file set path = replace(path, '\\', '/')"
-        done
     - name: Combine coverage
       run: |
         python -m coverage combine

android/pyproject.toml

@@ -6,21 +6,7 @@ build-backend = "setuptools.build_meta"
 parallel = true
 branch = true
 relative_files = true
-source_pkgs = ["toga_android"]
-
-[tool.coverage.paths]
-source = [
-    "src",
-    "**/site-packages"
-]
 
-[tool.coverage.report]
-show_missing = true
-skip_covered = true
-skip_empty = true
-precision = 1
-exclude_lines = [
-    "pragma: no cover",
-    "@(abc\\.)?abstractmethod",
-    "NotImplementedError\\(\\)"
-]
+# See notes in the root pyproject.toml file.
+source = ["src"]
+source_pkgs = ["toga_android"]

changes/1673.misc.rst

@@ -0,0 +1 @@
+Corrected coverage path mapping.

cocoa/pyproject.toml

@@ -6,21 +6,7 @@ build-backend = "setuptools.build_meta"
 parallel = true
 branch = true
 relative_files = true
-source_pkgs = ["toga_cocoa"]
-
-[tool.coverage.paths]
-source = [
-    "src",
-    "**/site-packages"
-]
 
-[tool.coverage.report]
-show_missing = true
-skip_covered = true
-skip_empty = true
-precision = 1
-exclude_lines = [
-    "pragma: no cover",
-    "@(abc\\.)?abstractmethod",
-    "NotImplementedError\\(\\)"
-]
+# See notes in the root pyproject.toml file.
+source = ["src"]
+source_pkgs = ["toga_cocoa"]

core/pyproject.toml

@@ -6,21 +6,7 @@ build-backend = "setuptools.build_meta"
 parallel = true
 branch = true
 relative_files = true
-source_pkgs = ["toga", "toga_dummy"]
-
-[tool.coverage.paths]
-source = [
-    "src",
-    "**/site-packages"
-]
 
-[tool.coverage.report]
-show_missing = true
-skip_covered = true
-skip_empty = true
-precision = 1
-exclude_lines = [
-    "pragma: no cover",
-    "@(abc\\.)?abstractmethod",
-    "NotImplementedError\\(\\)"
-]
+# See notes in the root pyproject.toml file.
+source = ["src", "../dummy/src"]
+source_pkgs = ["toga", "toga_dummy"]

gtk/pyproject.toml

@@ -6,21 +6,7 @@ build-backend = "setuptools.build_meta"
 parallel = true
 branch = true
 relative_files = true
-source_pkgs = ["toga_gtk"]
-
-[tool.coverage.paths]
-source = [
-    "src",
-    "**/site-packages"
-]
 
-[tool.coverage.report]
-show_missing = true
-skip_covered = true
-skip_empty = true
-precision = 1
-exclude_lines = [
-    "pragma: no cover",
-    "@(abc\\.)?abstractmethod",
-    "NotImplementedError\\(\\)"
-]
+# See notes in the root pyproject.toml file.
+source = ["src"]
+source_pkgs = ["toga_gtk"]

iOS/pyproject.toml

@@ -6,21 +6,7 @@ build-backend = "setuptools.build_meta"
 parallel = true
 branch = true
 relative_files = true
-source_pkgs = ["toga_iOS"]
-
-[tool.coverage.paths]
-source = [
-    "src",
-    "**/site-packages"
-]
 
-[tool.coverage.report]
-show_missing = true
-skip_covered = true
-skip_empty = true
-precision = 1
-exclude_lines = [
-    "pragma: no cover",
-    "@(abc\\.)?abstractmethod",
-    "NotImplementedError\\(\\)"
-]
+# See notes in the root pyproject.toml file.
+source = ["src"]
+source_pkgs = ["toga_iOS"]

pyproject.toml

@@ -1,58 +1,58 @@
+# The coverage settings in this file only control `coverage combine` and `coverage report`.
+# `coverage run` is controlled by the pyproject.toml files in each package's subdirectory.
+#
+# To view coverage reports locally, run something like this in the repository root
+# directory:
+#
+#     tox -c core -e py && coverage combine core/.coverage* && coverage report
+
 [tool.coverage.run]
-parallel = true
-branch = true
 relative_files = true
-source = [
-    "android",
-    "cocoa",
-    "core",
-    "dummy",
-    "gtk",
-    "iOS",
-    "web",
-    "winforms",
-]
 
+# In each subdirectory's pyproject.toml, we use both of the following settings:
+#   * `source_pkgs`: detects the given packages no matter where they're imported from.
+#   * `source`: detects all files in the given directory, including files that are
+#      never imported by the tests.
+#
+# When running through `tox`, this will produce duplicate entries which must be merged
+# with `coverage combine` using the lists below. In each list, the first item is a path to
+# a source code directory, and the other items are paths in the coverage data which will
+# be mapped to that directory. The order of the lists is significant, but their names are
+# not.
 [tool.coverage.paths]
 android = [
     "android/src/toga_android",
-    "src/toga_android",
-    "**/site-packages/toga_android",
+    "**/toga_android",
 ]
 cocoa = [
     "cocoa/src/toga_cocoa",
-    "src/toga_cocoa",
-    "**/site-packages/toga_cocoa",
-]
-core = [
-    "core/src/toga",
-    "src/toga",
-    "**/site-packages/toga",
+    "**/toga_cocoa",
 ]
 dummy = [
     "dummy/src/toga_dummy",
-    "src/toga_dummy",
-    "**/site-packages/toga_dummy",
+    "**/toga_dummy",
 ]
 gtk = [
     "gtk/src/toga_gtk",
-    "src/toga_gtk",
-    "**/site-packages/toga_gtk",
+    "**/toga_gtk",
 ]
 iOS = [
     "iOS/src/toga_iOS",
-    "src/toga_iOS",
-    "**/site-packages/toga_iOS",
+    "**/toga_iOS",
 ]
 web = [
     "web/src/toga_web",
-    "src/toga_web",
-    "**/site-packages/toga_web",
+    "**/toga_web",
 ]
 winforms = [
     "winforms/src/toga_winforms",
-    "src/toga_winforms",
-    "**/site-packages/toga_winforms",
+    "**/toga_winforms",
+]
+# This one must come last, otherwise the wildcard would match too much, because the
+# repository root directory is probably also called "toga".
+core = [
+    "core/src/toga",
+    "**/toga",
 ]
 
 [tool.coverage.report]

web/pyproject.toml

@@ -6,21 +6,7 @@ build-backend = "setuptools.build_meta"
 parallel = true
 branch = true
 relative_files = true
-source_pkgs = ["toga_web"]
-
-[tool.coverage.paths]
-source = [
-    "src",
-    "**/site-packages"
-]
 
-[tool.coverage.report]
-show_missing = true
-skip_covered = true
-skip_empty = true
-precision = 1
-exclude_lines = [
-    "pragma: no cover",
-    "@(abc\\.)?abstractmethod",
-    "NotImplementedError\\(\\)"
-]
+# See notes in the root pyproject.toml file.
+source = ["src"]
+source_pkgs = ["toga_web"]

winforms/pyproject.toml

@@ -6,21 +6,7 @@ build-backend = "setuptools.build_meta"
 parallel = true
 branch = true
 relative_files = true
-source_pkgs = ["toga_winforms"]
-
-[tool.coverage.paths]
-source = [
-    "src",
-    "**/site-packages"
-]
 
-[tool.coverage.report]
-show_missing = true
-skip_covered = true
-skip_empty = true
-precision = 1
-exclude_lines = [
-    "pragma: no cover",
-    "@(abc\\.)?abstractmethod",
-    "NotImplementedError\\(\\)"
-]
+# See notes in the root pyproject.toml file.
+source = ["src"]
+source_pkgs = ["toga_winforms"]