Skip to content

Commit

Permalink
Added information about unit testing
Browse files Browse the repository at this point in the history
  • Loading branch information
lobis authored Mar 28, 2022
1 parent 1826bb3 commit 43a1e66
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,13 @@ Execute the following command to configure your `.bashrc` to load REST in your s
echo "source ~/rest-framework/install/master/thisREST.sh" >> .bashrc
```

## Unit Testing

REST uses [GoogleTest](https://google.github.io/googletest/) as its testing framework. Unit testing is enabled via the `-DTEST=ON` flag and disabled by default. Required dependencies for testing are managed via [CMake FetchContent](https://cmake.org/cmake/help/git-master/module/FetchContent.html) so the user does not need to install any additional dependencies.

To run all tests go to the build directory (after a successful build) and type: `ctest`. All general tests will be ran for all the compiled modules. You can also run only select tests via the `--gtest_filter=TestPrefix*` which will run only tests whose names match the expression.

Passing all tests is required for all REST release versions and it is part of the pipeline. It is highly encouraged for contributors to run tests before pushing changes. Currently it recommended to use the `-DTEST=ON` only for running the tests and not enabling it otherwise.

## Basic tests of the REST installation

Expand Down

0 comments on commit 43a1e66

Please sign in to comment.