Change test suite web server (gunicorn) launch to a proper pytest fixture #3002
Conversation
This file contains 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
Instead of always start/stopping gunicorn at the start/end of an integration test session, this makes it a session fixture that tests can depend on directly. The new fixture is defined at the top-level `conftest.py` in order for it to be reusable by any part of the test suite.
This should be more or less common to all test suites.
This includes removing the unused environment variable TARGETURL, as the URL is more or less decided by the gunicorn fixture and not by some force external to pytest. Also cleans up unused imports, and import order of some imports, because why not?
Most, if not all, the functional tests need a base URL for the web server and already depend on the base_url fixture. The URL is no longer received from the environment, but from the gunicorn fixture, so this simply makes the base_url fixture a proxy for the gunicorn fixture.
The old code would break down if the base url did not contain a trailing slash. Using `urljoin` should be more robust than joining URL strings ourselves.
🦙 MegaLinter status: ✅ SUCCESS
See detailed report in MegaLinter reports MegaLinter is graciously provided by |
Test results 9 files 9 suites 8m 36s ⏱️ Results for commit 74427b1. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3002 +/- ##
==========================================
+ Coverage 56.68% 60.32% +3.63%
==========================================
Files 602 602
Lines 43713 43713
Branches 48 48
==========================================
+ Hits 24778 26368 +1590
+ Misses 18923 17333 -1590
Partials 12 12 ☔ View full report in Codecov by Sentry. |
johannaengland
approved these changes
Sep 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This cleans up the test suite somewhat, by changing how gunicorn is launched to provide a fully operational NAV web ui for the test suite.
Gunicorn is needed both by the integration and the functional test suites, but its launch was duplicated in both suites'
conftest.pyfiles. Also, as part of thepytest_configure()andpytest_unconfigure()functions of those modules, the gunicorn server would always be launches on every test session, regardless of which tests were selected.This changes the mechanism to properly function as a pytest fixture, which means that tests can now explicitly declare a dependency on the gunicorn test web server. This ensures it will only ever be launched when tests that use it are selected.
The PR ensures existing tests that need the web server are made dependent on the new fixture, and removes a bit of cruft in the surrounding code as well.
Anti-cruft measures include removing test suite redundancies by factoring out redundant setup code and moving it to the top-level
tests/conftest.pyfile. This was in some ways necessary for the test suite to continue working.This was extracted and adapted from #2675.