Add unit tests for the benchmark repo #147
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
berroar
force-pushed
the
add-unit-tests-for-scripts
branch
from
8e2c2d1 to
173da4d
Compare
rmccar
approved these changes
Feb 14, 2024
VirajP1002
reviewed
Feb 19, 2024
VirajP1002
approved these changes
Feb 19, 2024
liamtoozer
reviewed
Feb 20, 2024
liamtoozer
reviewed
Feb 20, 2024
liamtoozer
reviewed
Feb 20, 2024
liamtoozer
approved these changes
Feb 22, 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.
What is the context of this PR?
Adds unit tests for our scripts in our benchmark repo, including a mock output directory. The benchmark repo was initially created without any tests, so it is difficult to gain 100% coverage as a first pass.
We could look at amending some of the logic in future, for example, extracting some of the code from main, which I have done as part of this PR in
visualise_results.pyto enable better testing. There are some methods that still have no coverage, for example the google_cloud_storage get_files method, as although it is possible to mock the GCS client is difficult to add meaningful tests.Adds the tests to our actions workflow on PR and enforces coverage at 80%.
Adds isort to benchmark and runs as part of
make format.How to review
Run the unit tests with
make test. Check the tests added to make sure they make sense, can any other tests be added?Check the benchmark is still working.