chore: Add test coverage reports (#1612)

- Add a code coverage badge to the README.
- Update the `pre_release` and `run_code_checks` test pipeline
invocations.
- Remove the unit test call from the `release` workflow. Since this
workflow is triggered only manually, the caller should ensure the
package is OK (and also often the flakiness factor).
- Update pytest invocations in the Makefile.
- `CODECOV_TOKEN` is a repository-level secret.
- Relates to: #767

Author: vdusek

.github/workflows/release.yaml

@@ -55,17 +55,9 @@ jobs:
     with:
       python-versions: '["3.10", "3.11", "3.12", "3.13", "3.14"]'
 
-  unit_tests:
-    name: Unit tests
-    uses: apify/workflows/.github/workflows/python_unit_tests.yaml@main
-    secrets:
-      httpbin_url: ${{ secrets.APIFY_HTTPBIN_TOKEN && format('https://httpbin.apify.actor?token={0}', secrets.APIFY_HTTPBIN_TOKEN) || 'https://httpbin.org'}}
-    with:
-      python-versions: '["3.10", "3.11", "3.12", "3.13", "3.14"]'
-
   update_changelog:
     name: Update changelog
-    needs: [release_metadata, lint_check, type_check, unit_tests]
+    needs: [release_metadata, lint_check, type_check]
     uses: apify/workflows/.github/workflows/python_bump_and_update_changelog.yaml@main
     with:
       version_number: ${{ needs.release_metadata.outputs.version_number }}

.github/workflows/run_code_checks.yaml

@@ -17,6 +17,15 @@ on:
   workflow_dispatch:
 
 jobs:
+  actions_lint_check:
+    name: Actions lint check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+      - name: Run actionlint
+        uses: rhysd/[email protected]
+
   lint_check:
     name: Lint check
     uses: apify/workflows/.github/workflows/python_lint_check.yaml@main
@@ -33,10 +42,13 @@ jobs:
     name: Unit tests
     uses: apify/workflows/.github/workflows/python_unit_tests.yaml@main
     secrets:
-      httpbin_url: ${{ secrets.APIFY_HTTPBIN_TOKEN && format('https://httpbin.apify.actor?token={0}', secrets.APIFY_HTTPBIN_TOKEN) || 'https://httpbin.org'}}
+      httpbin_url: ${{ secrets.APIFY_HTTPBIN_TOKEN && format('https://httpbin.apify.actor?token={0}', secrets.APIFY_HTTPBIN_TOKEN) || 'https://httpbin.org' }}
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
     with:
       python-versions: '["3.10", "3.11", "3.12", "3.13", "3.14"]'
-      os: '["ubuntu-latest", "windows-latest", "macos-latest"]'
+      operating-systems: '["ubuntu-latest", "windows-latest", "macos-latest"]'
+      python-version-for-codecov: "3.14"
+      operating-system-for-codecov: ubuntu-latest
 
   docs_check:
     name: Docs check

.gitignore

@@ -27,6 +27,8 @@ build/
 # Coverage reports
 .coverage*
 htmlcov
+coverage-unit.xml
+coverage-integration.xml
 
 # IDE, editors
 .vscode

Makefile

@@ -30,15 +30,36 @@ type-check:
 	uv run mypy
 
 unit-tests:
-	uv run pytest --numprocesses=1 -vv tests/unit -m "run_alone"
-	uv run pytest --numprocesses=auto -vv tests/unit -m "not run_alone"
+	uv run pytest \
+		--numprocesses=1 \
+		--verbose \
+		-m "run_alone" \
+		tests/unit
+	uv run pytest \
+		--numprocesses=auto \
+		--verbose \
+		-m "not run_alone" \
+		tests/unit
 
 unit-tests-cov:
-	uv run pytest --numprocesses=1 -vv --cov=src/crawlee tests/unit -m "run_alone"
-	uv run pytest --numprocesses=auto -vv --cov=src/crawlee --cov-append --cov-report=html tests/unit -m "not run_alone"
+	uv run pytest \
+		--numprocesses=1 \
+		--verbose \
+		-m "run_alone" \
+		--cov=src/crawlee \
+		--cov-report=xml:coverage-unit.xml \
+		tests/unit
+	uv run pytest \
+		--numprocesses=auto \
+		--verbose \
+		-m "not run_alone" \
+		--cov=src/crawlee \
+		--cov-report=xml:coverage-unit.xml \
+		--cov-append \
+		tests/unit
 
 e2e-templates-tests $(args):
-	uv run pytest --numprocesses=$(E2E_TESTS_CONCURRENCY) -vv tests/e2e/project_template "$(args)" --timeout=600
+	uv run pytest --numprocesses=$(E2E_TESTS_CONCURRENCY) --verbose tests/e2e/project_template "$(args)" --timeout=600
 
 format:
 	uv run ruff check --fix

README.md

@@ -20,6 +20,9 @@
     <a href="https://pypi.org/project/crawlee/" rel="nofollow">
         <img src="https://img.shields.io/pypi/dm/crawlee" alt="PyPI - Downloads" style="max-width: 100%;">
     </a>
+    <a href="https://codecov.io/gh/apify/crawlee-python" >
+        <img src="https://codecov.io/gh/apify/crawlee-python/graph/badge.svg?token=cCju61iPQG" alt="Code cov report" style="max-width: 100%;"/>
+    </a>
     <a href="https://pypi.org/project/crawlee/" rel="nofollow">
         <img src="https://img.shields.io/pypi/pyversions/crawlee" alt="PyPI - Python Version" style="max-width: 100%;">
     </a>