Testing

Table of contents

  1. Unit tests
  2. Check coverage

tl;dr: make before_commit will run most of the checks by magic, VERBOSE=true make before_commit will do the same but print more information about what it’s doing.

The following tests can be run to test your code in insights-results-smart-proxy. Detailed information about each type of test is included in the corresponding subsection:

  1. Unit tests: checks behavior of all units in source code (methods, functions)
  2. REST API Tests: test the real REST API of locally deployed application
  3. Metrics tests: test whether Prometheus metrics are exposed as expected

Unit tests

Set of unit tests checks all units of source code. Additionally the code coverage is computed and displayed. Code coverage is stored in a file coverage.out and can be checked by a script named check_coverage.sh.

To run unit tests use the following command:

make test

Check coverage

If you want to check the percentage of code reached by the unit tests, you can use ./check_coverage.sh script after running the unit tests.

It will check if the coverage of the code is bellow the threshold.