[Python] Increase verbosity of API compliance suite #1032
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
It's very easy for manager plugin authors to accidentally miss defining a fixture, causing a test to be skipped erroneously. With the default report, it is difficult to discern which tests were skipped. So increase the verbosity, so that all tests are printed along with their status, including the reason given for skipping a test. Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech
force-pushed
the
work/verboseAPIComplianceReport
branch
from
d2ce6c4
to
6466c27
Compare
elliotcmorris
approved these changes
Aug 8, 2023
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
It's very easy for manager plugin authors to accidentally miss defining a fixture, causing a test to be skipped erroneously. With the default report, it is difficult to discern which tests were skipped.
So increase the verbosity, so that all tests are printed along with their status, including the reason given for skipping a test.
I have updated all relevant user documentation.Reviewer Notes
This was highlighted when, on a hunch, I increased verbosity to find that BAL's fixtures file seems to be missing some definitions that should be there (see OpenAssetIO/OpenAssetIO-Manager-BAL#61). Hopefully permanently increasing verbosity will help prevent this in future.
Test Instructions
Run the API compliance suite against, say, BAL, and note that all test names are printed alongside their status.