Commit 366132fd authored by Emmanuel Promayon's avatar Emmanuel Promayon
Browse files

Update docs/Getting Started/CamiTK Overviews/Testing-Framework-Whitepaper.md

parent 1e8d2b69
Pipeline #20073 passed with stages
in 26 seconds
......@@ -111,7 +111,7 @@ Not only the test results are visible, but CamiTK also offers a way to check the
## CamiTK testing framework
The CamiTK testing framework is defined As a layer on top of CMake/CTest, and provides _five_ different type of tests:
The CamiTK testing framework is defined as a layer on top of CMake/CTest, and provides _five_ different type of tests:
1. Automatic test for action and component extensions
2. Automatic test using a pipeline of actions
......@@ -122,7 +122,7 @@ The CamiTK testing framework is defined As a layer on top of CMake/CTest, and pr
The following sections describes these five different types of tests.
!!! Note
Automatic test for action and component extensions and pipeline of actions as well as test coverage procedures can be also used in any CamiTK Extension Project. Please check [the CamiTK developer guide](https://camitk.gricad-pages.univ-grenoble-alpes.fr/Docs/Highlighted%20Features/Automatic-Tests/) for more information about how to use the CamiTK testing framework for your CEP.
Automatic test for action and component extensions and pipeline of actions as well as test coverage procedures can also be used in any CamiTK Extension Project. Please check [the CamiTK developer guide](https://camitk.gricad-pages.univ-grenoble-alpes.fr/Docs/Highlighted%20Features/Automatic-Tests/) for more information about how to use the CamiTK testing framework for your CEP.
### Automatic test of action and component extensions
......@@ -237,6 +237,19 @@ Note that many different cep core schema XML examples are tested. All the XML ex
You can also create your own example from a tweaked core schema XML if your CEP provide a component or action extension than can be used itself by other developers In external CEP.
### Disabling tests depending on the environment
_Since CamiTK 4.2_
In some specific cases, some automatic tests have to be disabled, for instance when a test depends on a specific platform or OS or version of a library and you know, by design that it can only fail if some environment requirements are not met.
There are two ways to disable some of the automatically generated tests:
- disable test unconditionnally
- set specific requirements to run tests (if the requirements are not met, the tests will be disabled)
Check [the automatic test documentation](../../Highlighted Features/Automatic-Tests/#disabling-tests) for more information
## CamiTK Community Edition Code Coverage
You can easily generate and check a test coverage report for the CamiTK Community Edition or your own extension.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment