test_definitions.py: Load YAML files only once #388
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
Instead of loading the YAML files in @pytest.mark.parametrize expression of each test case (i.e. we're parsing 169 YAML files three times over), preload the files into a global variable that we use in the test parametrization. This decreases the execution time by about 65%. Also, by passing the "ids" kwarg to @pytest.mark.parametrize we can choose the name of each parametrized test so that's it's useful description rather than just a generic string with an autoincremented integer at the end. This allowed us to cut back on some assertion failure messages since they no longer have to be so verbose.
e-backmark-ericsson
added a commit
to e-backmark-ericsson/eiffel
that referenced
this pull request
Jan 8, 2024
e-backmark-ericsson
approved these changes
Jan 8, 2024
e-backmark-ericsson
added a commit
to e-backmark-ericsson/eiffel
that referenced
this pull request
Jan 8, 2024
m-linner-ericsson
approved these changes
Jan 9, 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.
Applicable Issues
Fixed #386
Description of the Change
Previously, test_definitions.py has loaded all the YAML files in the @pytest.mark.parametrize expression of each test case (i.e. we're parsing 169 YAML files three times over). Instead, preload the files into a global variable that we use in the test parametrization. This decreases the execution time by about 65%.
Also, by passing the "ids" kwarg to @pytest.mark.parametrize we can choose the name of each parametrized test so that's it's useful description rather than just a generic string with an autoincremented integer at the end. This allowed us to cut back on some assertion failure messages since they no longer have to be so verbose.
Alternate Designs
None. Extracting common subexpressions is pretty standard fare.
Benefits
Faster test execution and slightly less boilerplate in the tests.
Possible Drawbacks
None.
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
Signed-off-by: Magnus Bäck <[email protected]>