code_coverage

Code Coverage

The test coverage and reporting are very important metrics to understand the quality of the code in the repository. To gain more insight into these metrics, coverage reports are generated after all of the tests are run as part of the continuous integration for this project. When the CI service builds and runs the test suite, another command will be run to generate the coverage metrics and then upload them to Code Climate. Code Climate is a service that process the coverage report and analyzes the code in the repo to give greater insight into potential problems with the code that is being tested. The results displayed in Code Climate are only for the develop branch of the repository. When making contributions you should try to maintain the existing level of code coverage or increase it in any location that is lacking.

To get code coverage results for work that isn't on develop yet, you should run the make report command. This will generate an HTML report of what code is covered by the unit tests. This command does not provide the same static analysis reporting that Code Climate does, but should provide enough detail to understand if more tests need to be added.