lithops
lithops copied to clipboard
Add code coverage feature
This pull request adds a code coverage feature to the repository. This feature is intended to be automated via GitHub Workflows. By default it runs on pull requests and pushes to the branch, but it can be changed to whatever is desired.
The coverage is done line by line using Pytest module and Codecov framework, where the report is uploaded. It can be monitored there, checking where the coverage is already satisfactory and where can be improved in future contributions.
For testing purposes, I have been using personal accounts, which should be changed before merging into master branch. AWS, Docker Hub and Codecov accounts are required.
There are some things that should be changed before merging, since this work depends on GitHub environment:
-
[ ] Include all necessary repository secrets
- DOCKER_USER
- DOCKER_TOKEN
- DOCKER_RUNTIME ('acanadilla/k8s_internal' image can be used)
- AWS_KEY_ID
- AWS_SECRET_KEY
- AWS_EXECUTION_ROLE
- CODECOV_TOKEN
-
[ ] Change the working branch of the workflows yml files to 'master'
-
[ ] Change the Codecov slug value to the new one
-
[ ] Change README.md badge values for current repository
-
[ ] Change github_coverage.py hardcoded DockerHub image values
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 Apache License 2.0; 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.