Documentation/Nightly/Developers/Tutorials/CxxTests - Revision history

Lasso at 20:57, 26 October 2015

2015-10-26T20:57:37Z

Lasso: /* Implementation */

2015-03-28T01:57:15Z

Implementation

Lasso: Created page with '{{documentation/versioncheck}} == Goal == Goal of Cxx tests is to test C++ classes as comprehensively as possible in the simplest possible environment (wi…'

2015-03-28T01:51:13Z

Created page with '<noinclude>{{documentation/versioncheck}}</noinclude> == Goal == Goal of Cxx tests is to test C++ classes as comprehensively as possible in the simplest possible environment (wi…'

New page

<noinclude>{{documentation/versioncheck}}</noinclude>
== Goal ==

Goal of Cxx tests is to test C++ classes as comprehensively as possible in the simplest possible environment (with minimum usage of other classes).

The tests are run as part of the nightly test process and submitted to [http://slicer.cdash.org/index.php?project=Slicer4 the slicer dashboard].

== Implementation ==

* Test execution is managed by [http://www.cmake.org/Wiki/CMake/Testing_With_CTest CMake/CTest]
* To reduce the number of individual executable files, typically many test cases are packaged into a single executable using and CTK's [http://www.commontk.org/docs/html/group__CMakeUtilities.html SIMPLE_TEST utilities]
* The test process must exit with zero (EXIT_SUCCESS) error code in case of success and non-zero (EXIT_FAILURE) in case of failure
* It is strongly recommended to exit with failure if any unexpected VTK error or warning messages are logged. To achieve this, us the vtkTestingOutputWindow class (and its convenience macros) defined in the vtkAddon library
** In the CMakeLists.txt of your Cxx tests (See Libs\MRML\Widgets\Testing\CMakeLists.txt as an example):
*** Add TESTING_OUTPUT_INIT(); to CMAKE_TESTDRIVER_BEFORE_TESTMAIN
*** Add TESTING_OUTPUT_ASSERT_WARNINGS_ERRORS(0); to CMAKE_TESTDRIVER_AFTER_TESTMAIN
*** Add #include <vtkTestingOutputWindow.h> to the include EXTRA_INCLUDE header file.
** In your testing code, if you expect errors or warnings: incclude vtkTestingOutputWindow.h and put code that logs errors or warnings between these macros (see examples in Libs\MRML\Widgets\Testing):
*** TESTING_OUTPUT_IGNORE_WARNINGS_ERRORS_BEGIN() / TESTING_OUTPUT_IGNORE_WARNINGS_ERRORS_END() – if errors or warnings may be logged
*** TESTING_OUTPUT_ASSERT_WARNINGS_BEGIN() / TESTING_OUTPUT_ASSERT_WARNINGS_END() – if errors or warnings must be logged

@@ Line 11: / Line 11: @@
 * To reduce the number of individual executable files, typically many test cases are packaged into a single executable using  and CTK's [http://www.commontk.org/docs/html/group__CMakeUtilities.html SIMPLE_TEST utilities]
 * The test process must exit with zero (EXIT_SUCCESS) error code in case of success and non-zero (EXIT_FAILURE) in case of failure
-* It is strongly recommended to exit with failure if any unexpected VTK error or warning messages are logged. To achieve this, us the [https://github.com/Slicer/Slicer/blob/master/Libs/vtkAddon/vtkTestingOutputWindow.h vtkTestingOutputWindow] class (and its convenience macros) defined in the vtkAddon library
+* It is strongly recommended to exit with failure if any unexpected VTK error or warning messages are logged. To achieve this, use the [https://github.com/Slicer/Slicer/blob/master/Libs/vtkAddon/vtkTestingOutputWindow.h vtkTestingOutputWindow] class (and its convenience macros) defined in the vtkAddon library
 ** In the CMakeLists.txt of your Cxx tests (see [https://github.com/Slicer/Slicer/blob/master/Libs/MRML/Widgets/Testing/CMakeLists.txt Libs\MRML\Widgets\Testing\CMakeLists.txt] as an example):
 *** Add ''TESTING_OUTPUT_INIT()'' to ''CMAKE_TESTDRIVER_BEFORE_TESTMAIN''

@@ Line 11: / Line 11: @@
 * To reduce the number of individual executable files, typically many test cases are packaged into a single executable using  and CTK's [http://www.commontk.org/docs/html/group__CMakeUtilities.html SIMPLE_TEST utilities]
 * The test process must exit with zero (EXIT_SUCCESS) error code in case of success and non-zero (EXIT_FAILURE) in case of failure
-* It is strongly recommended to exit with failure if any unexpected VTK error or warning messages are logged. To achieve this, us the vtkTestingOutputWindow class (and its convenience macros) defined in the vtkAddon library
+* It is strongly recommended to exit with failure if any unexpected VTK error or warning messages are logged. To achieve this, us the [https://github.com/Slicer/Slicer/blob/master/Libs/vtkAddon/vtkTestingOutputWindow.h vtkTestingOutputWindow] class (and its convenience macros) defined in the vtkAddon library
-** In the CMakeLists.txt of your Cxx tests (See Libs\MRML\Widgets\Testing\CMakeLists.txt as an example):
+** In the CMakeLists.txt of your Cxx tests (see [https://github.com/Slicer/Slicer/blob/master/Libs/MRML/Widgets/Testing/CMakeLists.txt Libs\MRML\Widgets\Testing\CMakeLists.txt] as an example):
-*** Add TESTING_OUTPUT_INIT(); to CMAKE_TESTDRIVER_BEFORE_TESTMAIN
+*** Add ''TESTING_OUTPUT_INIT()'' to ''CMAKE_TESTDRIVER_BEFORE_TESTMAIN''
-*** Add TESTING_OUTPUT_ASSERT_WARNINGS_ERRORS(0); to CMAKE_TESTDRIVER_AFTER_TESTMAIN
+*** Add ''TESTING_OUTPUT_ASSERT_WARNINGS_ERRORS(0)'' to ''CMAKE_TESTDRIVER_AFTER_TESTMAIN''
-*** Add #include <vtkTestingOutputWindow.h> to the include EXTRA_INCLUDE header file.
+*** Add ''#include <vtkTestingOutputWindow.h>'' to the included ''EXTRA_INCLUDE'' header file.
-** In your testing code, if you expect errors or warnings: incclude vtkTestingOutputWindow.h and put code that logs errors or warnings between these macros (see examples in Libs\MRML\Widgets\Testing):
+** In your testing code, if you expect errors or warnings: include ''vtkTestingOutputWindow.h'' and put code that logs errors or warnings between these macros (see examples in [https://github.com/Slicer/Slicer/blob/master/Libs/MRML/Widgets/Testing/ Libs\MRML\Widgets\Testing]):
-*** TESTING_OUTPUT_IGNORE_WARNINGS_ERRORS_BEGIN() / TESTING_OUTPUT_IGNORE_WARNINGS_ERRORS_END() – if errors or warnings may be logged
+*** ''TESTING_OUTPUT_IGNORE_WARNINGS_ERRORS_BEGIN()'' / ''TESTING_OUTPUT_IGNORE_WARNINGS_ERRORS_END()'' – if errors or warnings may be logged
-*** TESTING_OUTPUT_ASSERT_WARNINGS_BEGIN() / TESTING_OUTPUT_ASSERT_WARNINGS_END() – if errors or warnings must be logged
+*** ''TESTING_OUTPUT_ASSERT_WARNINGS_BEGIN()'' / ''TESTING_OUTPUT_ASSERT_WARNINGS_END()'' – if errors or warnings must be logged