feat(tests): Do not include type checking code in coverage report (#3327)

antonpirker · web-flow · commit 081285897e44 · 2024-07-23T16:55:29.000+02:00
This should not count lines (or rather if blocks) that start with if TYPE_CHECKING in the code coverage report, because this code is only evaluated when checking types with mypy.
diff --git a/.github/workflows/test-integrations-ai.yml b/.github/workflows/test-integrations-ai.yml
@@ -39,7 +39,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
@@ -101,7 +101,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
diff --git a/.github/workflows/test-integrations-aws-lambda.yml b/.github/workflows/test-integrations-aws-lambda.yml
@@ -74,7 +74,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
diff --git a/.github/workflows/test-integrations-cloud-computing.yml b/.github/workflows/test-integrations-cloud-computing.yml
@@ -39,7 +39,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
@@ -97,7 +97,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
diff --git a/.github/workflows/test-integrations-common.yml b/.github/workflows/test-integrations-common.yml
@@ -39,7 +39,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
diff --git a/.github/workflows/test-integrations-data-processing.yml b/.github/workflows/test-integrations-data-processing.yml
@@ -41,7 +41,7 @@ jobs:
         uses: supercharge/redis-github-action@1.8.0
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
@@ -109,7 +109,7 @@ jobs:
         uses: supercharge/redis-github-action@1.8.0
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
diff --git a/.github/workflows/test-integrations-databases.yml b/.github/workflows/test-integrations-databases.yml
@@ -58,7 +58,7 @@ jobs:
       - uses: getsentry/action-clickhouse-in-ci@v1
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
@@ -143,7 +143,7 @@ jobs:
       - uses: getsentry/action-clickhouse-in-ci@v1
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
diff --git a/.github/workflows/test-integrations-graphql.yml b/.github/workflows/test-integrations-graphql.yml
@@ -39,7 +39,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
@@ -97,7 +97,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
diff --git a/.github/workflows/test-integrations-miscellaneous.yml b/.github/workflows/test-integrations-miscellaneous.yml
@@ -39,7 +39,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
@@ -101,7 +101,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
diff --git a/.github/workflows/test-integrations-networking.yml b/.github/workflows/test-integrations-networking.yml
@@ -39,7 +39,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
@@ -97,7 +97,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
diff --git a/.github/workflows/test-integrations-web-frameworks-1.yml b/.github/workflows/test-integrations-web-frameworks-1.yml
@@ -57,7 +57,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
@@ -133,7 +133,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
diff --git a/.github/workflows/test-integrations-web-frameworks-2.yml b/.github/workflows/test-integrations-web-frameworks-2.yml
@@ -39,7 +39,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
@@ -117,7 +117,7 @@ jobs:
           allow-prereleases: true
       - name: Setup Test Env
         run: |
-          pip install coverage tox
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase
diff --git a/pyproject.toml b/pyproject.toml
@@ -8,3 +8,7 @@ extend-exclude = '''
     | .*_pb2_grpc.py  # exclude autogenerated Protocol Buffer files anywhere in the project
 )
 '''
+[tool.coverage.report]
+    exclude_also = [
+        "if TYPE_CHECKING:",
+    ]
diff --git a/scripts/split-tox-gh-actions/templates/test_group.jinja b/scripts/split-tox-gh-actions/templates/test_group.jinja
@@ -61,8 +61,7 @@
 
       - name: Setup Test Env
         run: |
-          pip install coverage tox
-
+          pip install "coverage[toml]" tox
       - name: Erase coverage
         run: |
           coverage erase

Original file line number	Diff line number	Diff line change
`@@ -8,3 +8,7 @@ extend-exclude = '''`
`8`	`8`	`\| .*_pb2_grpc.py # exclude autogenerated Protocol Buffer files anywhere in the project`
`9`	`9`	`)`
`10`	`10`	`'''`
	`11`	`+[tool.coverage.report]`
	`12`	`+ exclude_also = [`
	`13`	`+ "if TYPE_CHECKING:",`
	`14`	`+ ]`