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

Implement 100% test coverage. #27

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

RodneyCodess
Copy link

@RodneyCodess RodneyCodess commented Jun 14, 2024

Description

This PR updates codes and adds tests to sustain 100% code coverage by using a library Coverage.py.

This PR makes changes, adds extra steps, and overall improves readability to the docs/developing.md to ensure correct procedure.

Motivation and Context

The reason for this PR is to have completely 100% code coverage so that we can confidently change code knowing it won't break anything.

For any code that couldn't be tested, we used # pragma: no cover to bypass the coverage report.

Tests performed

We ran our initial test and did a coverage report to figure out how much code we needed to cover. To completely cover our code, we added more tests and kept doing coverage reports until we finally got to 100% code coverage.

Types of changes

  • Refactoring / documentation update (non-breaking change which does not change functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • CHANGELOG.md has been updated
  • The milestone is set correctly on the pull request
  • The appropriate labels have been added to the pull request
  • Running the automated tests (see docs/developing.md) produces no errors
  • Updates have been made to the xdmod-notebooks repository as necessary, and the notebooks all run successfully

docs/developing.md Outdated Show resolved Hide resolved
docs/developing.md Outdated Show resolved Hide resolved
tests/regression/test_datawarehouse_regression.py Outdated Show resolved Hide resolved
tests/regression/test_datawarehouse_regression.py Outdated Show resolved Hide resolved
tests/regression/test_datawarehouse_regression.py Outdated Show resolved Hide resolved
tests/regression/test_datawarehouse_regression.py Outdated Show resolved Hide resolved
tests/regression/test_datawarehouse_regression.py Outdated Show resolved Hide resolved
xdmod_data/_http_requester.py Outdated Show resolved Hide resolved
xdmod_data/_validator.py Outdated Show resolved Hide resolved
xdmod_data/_validator.py Outdated Show resolved Hide resolved
@aaronweeden aaronweeden added this to the 1.1.0 milestone Jun 17, 2024
@aaronweeden aaronweeden added the qa/testing Updates/additions to tests label Jun 17, 2024
@aaronweeden aaronweeden changed the title Test coverage Implement 100% test coverage. Jun 24, 2024
@aaronweeden aaronweeden modified the milestones: 1.1.0, 2.0.0 Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
qa/testing Updates/additions to tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants