Try tricking code coverage

Author: znicholls

.github/workflows/ci.yaml

@@ -95,23 +95,15 @@ jobs:
           # we should add a CI step that runs the tests without optional dependencies too.
           # We don't have that right now, because we're not sure this pain point exists.
           uv-dependency-install-flags: "--all-extras --group tests"
-      - name: Show installed tree
-        run: |
-          ls .venv/lib/python3.11/site-packages/example_fgen_basic
       - name: Run tests
         run: |
+          rm -r src/example_fgen_basic
+          ln -s .venv/lib/python3.11/site-packages/example_fgen_basic src/example_fgen_basic
           uv run --no-sync pytest -r a -v tests src --doctest-modules --doctest-report ndiff --cov=src --cov-report=term-missing --cov-report=xml
-          # uv run --no-editable --reinstall-package example-fgen-basic python -c 'import example_fgen_basic;print(example_fgen_basic.__file__)'
-          # cd .venv/lib/python3.11/site-packages/example_fgen_basic
-          # ls
-          # ../../../../bin/python -c 'import exceptions; print("Found exceptions here")'
-          # ../../../../bin/python -c 'import _lib; print("Found _lib here")'
-          # cd ../../../../../
-          # ls
-          # .venv/bin/pytest -r a -v src tests --doctest-modules --cov=src --cov-report=term-missing --cov-report=xml
-          # uv run which pytest
-          # uv run --no-editable --reinstall-package example-fgen-basic pytest -r a -v src tests --doctest-modules --cov=src --cov-report=term-missing --cov-report=xml
           uv run --no-sync coverage report
+          # Just in case, undo the changes to `src`
+          rm -r src/example_fgen_basic
+          git restore --staged . && git restore .
       - name: Upload coverage reports to Codecov with GitHub Action
         uses: codecov/codecov-action@v4.2.0
         env:

Makefile

@@ -40,6 +40,15 @@ ruff-fixes:  ## fix the code using ruff
 
 .PHONY: test
 test:  ## run the tests (re-installs the package every time so you might want to run by hand if you're certain that step isn't needed)
+	# Note: passing `src` to pytest causes the `src` directory to be imported
+	# if the package has not already been installed.
+	# This is a problem, as the package is not importable from `src` by itself because the extension module is not available.
+	# As a result, you have to pass `pytest tests src` rather than `pytest src tests`
+	# to ensure that the package is imported from the venv and not `src`.
+	# The issue with this is that code coverage then doesn't work,
+	# because it is looking for lines in `src` to be run,
+	# but they're not because lines in `.venv` are run instead.
+	# We don't have a solution to this yet.
 	uv run --no-editable --reinstall-package example-fgen-basic pytest -r a -v -tests src -doctest-modules --doctest-report ndiff --cov=src
 
 # Note on code coverage and testing: