Stop tests reading the developer's personal env file - #66
Merged
Conversation
settings.py loaded src/config/env unconditionally, and pytest.ini points at that same settings module, so the suite ran on whatever the local machine happened to be configured for. The file is gitignored, so CI has none and always runs on the declared defaults. Any locally tuned setting therefore changed what the tests asserted against, failing on one machine while passing in CI. A local IMAGE_MAX_RATING of 2 was breaking four set_images_rating tests this way. load_dotenv now reads whatever FILMCASE_ENV_FILE points at, defaulting to the personal file so runtime behaviour is unchanged. A pytest plugin aims it at os.devnull, an empty file by definition, so every setting falls back to its default. Real environment variables still win over the file, so a contributor whose database differs from the defaults can still use DB_PORT=5433 pytest. This has to be a -p plugin rather than a conftest.py hook. pytest-django sets Django up in pytest_load_initial_conftests, the same hook that loads the root conftest, and it wins that race, so by then the settings module is already imported and the env file already read. Plugins named with -p are imported during preparse, which is early enough. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
settings.py loaded src/config/env unconditionally, and pytest.ini points at that same settings module, so the suite ran on whatever the local machine happened to be configured for. The file is gitignored, so CI has none and always runs on the declared defaults. Any locally tuned setting therefore changed what the tests asserted against, failing on one machine while passing in CI. A local IMAGE_MAX_RATING of 2 was breaking four set_images_rating tests this way.
load_dotenv now reads whatever FILMCASE_ENV_FILE points at, defaulting to the personal file so runtime behaviour is unchanged. A pytest plugin aims it at os.devnull, an empty file by definition, so every setting falls back to its default. Real environment variables still win over the file, so a contributor whose database differs from the defaults can still use DB_PORT=5433 pytest.
This has to be a -p plugin rather than a conftest.py hook. pytest-django sets Django up in pytest_load_initial_conftests, the same hook that loads the root conftest, and it wins that race, so by then the settings module is already imported and the env file already read. Plugins named with -p are imported during preparse, which is early enough.