Adjust unit test infrastructure to facilitate running tests via IDEs #65
Conversation
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
The previous location worked fine when running pytest directly or via the task. It was also possible to run the tests from the PyCharm UI after a bit of configuration. However, I had no luck with using the VS Code test explorer. VS Code is likely to be the most common development environment of contributors so it will be important to make it easy to use with VS Code. Moving pytest.ini file to the root of the repository allowed the VS Code test explorer to correctly recognize it.
Previously, the python:test task set PYTHONPATH via environment variable. That approach is fine when running the tests via the task, but meant that PYTHONPATH was not correctly configured when running the tests via the interface of an IDE. Each contributor would be forced to configure their IDE in order to allow it to run the tests successfully. Configuring PYTHONPATH via the pytest.ini file makes this universal.
per1234
added
type: enhancement
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #65 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 732 732
=========================================
Hits 732 732 ☔ View full report in Codecov by Sentry. |
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.
The previous configuration worked fine when running pytest directly or via the
python:testtask. However, some complex configuration of Python IDEs was necessary in order to run the tests via their convenient UI, making the project less friendly to contributors.The new configuration should allow IDEs to automatically discover tests and run them correctly without any special configuration.