-
Notifications
You must be signed in to change notification settings - Fork 21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a simple unit test framework with tox
and pytest
#140
base: main
Are you sure you want to change the base?
Conversation
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 10 days. |
996efdf
to
b127ac4
Compare
This encapsulates substantial logic to encapsulate interpretation of the Crucible Common Data Model OpenSearch schema for the use of CPT dashboard API components. By itself, it does nothing.
This uses `black`, `isort` and `flake8` to check code quality, although failure is ignored until we've cleaned it up (which has begin in PR cloud-bulldozer#139 against the `revamp` branch). Minimal unit testing is introduced, generating a code coverage report. The text summary is added to the Action summary page, and the more detailed HTML report is stored as an artifact for download. NOTE: The GitHub Action environment is unhappy with `uvicorn` 0.15; upgrading to the latest 0.32.x seems to work and hasn't obviously broken anything else.
Type of change
Description
This uses
black
,isort
andflake8
to check code quality, although failure is ignored until we've cleaned it up (a process which begins in PR #139 against therevamp
branch).Minimal unit testing is introduced, generating a code coverage report. The text summary is added to the Action summary page, and the more detailed HTML report is stored as an artifact for download.
NOTE: The GitHub Action environment is unhappy with
uvicorn
0.15 for reasons that aren't entirely obvious (pip can't resolve conflicting indirect dependencies); upgrading to the latest 0.32.x seems to work and hasn't obviously broken anything else.This is chained from #122 (Crucible service) -> #140 (unit test framework)
Related Tickets & Documents
PANDA-673
Resolves #121
Checklist before requesting a review
Testing
Tested manually with
tox
CLI in a private branch. If GitHub cooperates, I'll use this draft PR to debug the GitHub Action...