Skip to content
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

Express coverage results in README #15

Closed
nicholascar opened this issue Jan 7, 2019 · 4 comments
Closed

Express coverage results in README #15

nicholascar opened this issue Jan 7, 2019 · 4 comments
Assignees

Comments

@nicholascar
Copy link
Member

Assume this requires the deployment of coverage.py or similar package? Assume that's not already implemented?

@ashleysommer
Copy link
Collaborator

@nicholascar Do you mean code coverage stats in the sense of what proportion of code is touched during testing? That is something I've had in mind for a while, I can include it in the next release.

@nicholascar
Copy link
Member Author

Yes. Perhaps using coverage.py

@ashleysommer
Copy link
Collaborator

Pycharm has coverage.py capabilities built in, I'm just using that for now.
As part of the 0.9.9 release I've fixed some coverage issues, added a bunch more tests, and got reported coverage up to 84%.
I've manually added a coverage tag to the README with "84%" hardcoded in the tag. If we want a dynamically updating one, we will need to deploy the coverage test to an online service like Travis, where we can always point to the results of the most recent coverage test run.

@wrobell
Copy link

wrobell commented Jan 9, 2019

If the project recommends use of pytest, then it can show coverage after running unit tests. Just put something like the following into the setup.cfg project

[pytest]
addopts=--cov=pyshacl

[coverage:report]
show_missing=1
partial_branches=1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants