PyTest Inner Workings Overhaul #377
Merged
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
This PR makes an overhaul to the nuances of our PyTest framework.
* In order to ship around the testing configuration (the contents of
`conftest.py`), this PR ports all of those features to the `testing.py`
file which is now treated as a first class PyTest Plugin.
* The `pytest11` entry point for the `testing.py` file has been added
to the `setup.py` file so it will be detected automatically by any
installed PyTest, allowing transferring of the `--runslow` and
`--runexamples` CLI flags into PyTest on its own.
* This also enables the ability to access these flags anywhere
* Due to the removal of the [pytest.config global](https://docs.pytest.org/en/latest/deprecations.html#pytest-config-global) in the Version 5+ of PyTest, I had to
rework how some of our `mark` functions behave. Instead of writing
our own decorators, I instead am using the PyTest recommended method
of `pytest_collection_modifyitems`, an example of which can be found
[here](https://docs.pytest.org/en/latest/example/simple.html#control-skipping-of-tests-according-to-command-line-option).
I have also based this off the implementation this from Dask Distributed
dask/distributed#2677.
* Due to the previous change, the `mark_slow` and `mark_example`
decorators are no more. We now just use `pytest.mark.slow` and
`pytest.mark.example` respectively. This change has been propagated
through the tests.
* I fixed a bug in the `test_visualization` where the `_has_plotly` flag
was always being set to `True`.
* I have tested this with both PyTest 5 and PyTest 4.6.3
And finally, all of this, was so we could install QCFractal and run
`pytest --pyargs qcfractal` from anywhere and still have access to the
optional `--runslow` flag (and it solved a PyTest 5 deprecation)
Lnaden
added
Bug
dgasmith
approved these changes
Aug 20, 2019
| @@ -8,6 +8,7 @@ | |||
| from . import portal | |||
|
|
|||
| try: | |||
| import plotly | |||
| "flag to run.") | ||
|
|
||
|
|
||
| def pytest_unconfigure(config): |
There was a problem hiding this comment.
I see you have found the magic incantation. Was it on the bottom of a snake?
There was a problem hiding this comment.
In certain interpretations, it could be. Moreover it required me to sacrifice a Lantern of Diogenes which could only be used in the daytime to summon a bridge across Cocytus to find it.
It also might be left over from the conftest.py and I don't know if it actually does anything.
ONE OR MORE OF THOSE TWO STATEMENTS IS TRUE.
| @@ -201,7 +201,7 @@ def test_service_torsiondrive_option_energy_upper_limit(torsiondrive_fixture): | |||
| assert pytest.approx(0.0007991274441437338, abs=1e-6) == final_energies[(-60, )] | |||
|
|
|||
|
|
|||
| @mark_slow | |||
| @pytest.mark.slow | |||
There was a problem hiding this comment.
Ah, I see this approach. Ok, should work!
There was a problem hiding this comment.
We can also extend it with the 3 functions in the plugin in the future.
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.
Description
This PR makes an overhaul to the nuances of our PyTest framework.
conftest.py), this PR ports all of those features to thetesting.pyfile which is now treated as a first class PyTest Plugin.pytest11entry point for thetesting.pyfile has been added to thesetup.pyfile so it will be detected automatically by any installed PyTest, allowing transferring of the--runslowand--runexamplesCLI flags into PyTest on its own.markfunctions behave. Instead of writing our own decorators, I instead am using the PyTest recommended method ofpytest_collection_modifyitems, an example of which can be found here. I have also based this off the implementation this from Dask Distributed Fix pytest.config deprecation warning dask/distributed#2677.mark_slowandmark_exampledecorators are no more. We now just usepytest.mark.slowandpytest.mark.examplerespectively. This change has been propagated through the tests.test_visualizationwhere the_has_plotlyflag was always being set toTrue.And finally, all of this, was so we could install QCFractal and run
pytest --pyargs qcfractalfrom anywhere and still have access to the optional--runslowflag (and it solved a PyTest 5 deprecation)Status