Documentation/Nightly/Developers/FAQ/Testing - Revision history

JChris.FillionR: /* Developer FAQ: {{{1}}} */

2016-07-11T14:47:24Z

Developer FAQ: {{{1}}}

JChris.FillionR: /* What is the difference between add_test, simple_test, slicer_add_python_test, and slicer_add_python_unittest CMake macros/functions ? */

2016-05-31T16:43:17Z

What is the difference between add_test, simple_test, slicer_add_python_test, and slicer_add_python_unittest CMake macros/functions ?

JChris.FillionR: Created page with "{{documentation/versioncheck}} TOC ={{#titleparts: {{PAGENAME}} | | -1 }}= ='''Developer FAQ: {{{1}}}'''=
2016-05-31T16:38:18Z

Created page with "<noinclude>{{documentation/versioncheck}}</noinclude> <noinclude>TOC ={{#titleparts: {{PAGENAME}} | | -1 }}=</noinclude><includeonly> ='''Developer FAQ: {{{1}}}'''= </incl..."

New page
<noinclude>{{documentation/versioncheck}}</noinclude>
<noinclude>TOC
={{#titleparts: {{PAGENAME}} | | -1 }}=</noinclude><includeonly>
='''Developer FAQ: {{{1}}}'''=
</includeonly>

== What is the difference between add_test, simple_test, slicer_add_python_test, and slicer_add_python_unittest CMake macros/functions ? ==

* [https://cmake.org/cmake/help/latest/command/add_test.html add_test]: provided by CMake and allows to add a test that can be executed using [https://cmake.org/cmake/help/latest/manual/ctest.1.html ctest].

* <code>simple_test(testname)</code>:
Accept the same arguments as <code>add_test</code>.
Conveniently call [https://cmake.org/cmake/help/latest/module/ExternalData.html#command:externaldata_add_test ExternalData_add_test] with the appropriate parameters.
Set the <code>LABELS</code> test property.
Invoke test driver using <code>${Slicer_LAUNCH_COMMAND}</code>


* <code>slicer_add_python_test(SCRIPT script [TESTNAME_PREFIX prefix] [SLICER_ARGS slicer_arg1 [slicer_arg2 [...]]] [SCRIPT_ARGS script_arg1 [script_arg2 [..]]])</code>:
Run Slicer with the given <code>script</code>.
Slicer arguments systematically passed are <code>--testing</code> and <code>--no-splash</code>.
** Conveniently call [https://cmake.org/cmake/help/latest/module/ExternalData.html#command:externaldata_add_test ExternalData_add_test] with the appropriate parameters.

* <code>slicer_add_python_unittest(SCRIPT script [TESTNAME_PREFIX prefix] [SLICER_ARGS slicer_arg1 [slicer_arg2 [...]]])</code>:
Run unittests with Slicer using <code>--python-code "import slicer.testing\\; slicer.testing.runUnitTest(['${CMAKE_CURRENT_BINARY_DIR}', '${_script_source_dir}'], '${test_name}')"</code>.
Slicer arguments systematically passed are <code>--testing</code> and <code>--no-splash</code>.
** Conveniently call [https://cmake.org/cmake/help/latest/module/ExternalData.html#command:externaldata_add_test ExternalData_add_test] with the appropriate parameters.

← Older revision		Revision as of 14:47, 11 July 2016
Line 31:		Line 31:
	** Slicer arguments systematically passed are <code>--testing</code> and <code>--no-splash</code>.		** Slicer arguments systematically passed are <code>--testing</code> and <code>--no-splash</code>.
	** Conveniently call [https://cmake.org/cmake/help/latest/module/ExternalData.html#command:externaldata_add_test ExternalData_add_test] with the appropriate parameters.		** Conveniently call [https://cmake.org/cmake/help/latest/module/ExternalData.html#command:externaldata_add_test ExternalData_add_test] with the appropriate parameters.
		+
		+	== What is the meaning of prefix py_ in test name ? ==
		+
		+	It means that the test is implemented in python.

@@ Line 11: / Line 11: @@
 * <code>simple_test(testname)</code>:
 ** Accept the same arguments as <code>add_test</code>.
 ** Conveniently call [https://cmake.org/cmake/help/latest/module/ExternalData.html#command:externaldata_add_test ExternalData_add_test] with the appropriate parameters.
@@ Line 20: / Line 21: @@
 -->
-* <code>slicer_add_python_test(SCRIPT script [TESTNAME_PREFIX prefix] [SLICER_ARGS slicer_arg1 [slicer_arg2 [...]]] [SCRIPT_ARGS script_arg1 [script_arg2 [..]]])</code>:
+* <code>slicer_add_python_unittest(SCRIPT script [TESTNAME_PREFIX prefix] [SLICER_ARGS slicer_arg1 [slicer_arg2 [...]]])</code>:
-** Run Slicer with the given <code>script</code>.
+** Run unittests with Slicer using <code>--python-code "import slicer.testing\\; slicer.testing.runUnitTest(['${CMAKE_CURRENT_BINARY_DIR}', '${_script_source_dir}'], '${test_name}')"</code>.
 ** Slicer arguments systematically passed are <code>--testing</code> and <code>--no-splash</code>.
 ** Conveniently call [https://cmake.org/cmake/help/latest/module/ExternalData.html#command:externaldata_add_test ExternalData_add_test] with the appropriate parameters.
-* <code>slicer_add_python_unittest(SCRIPT script [TESTNAME_PREFIX prefix] [SLICER_ARGS slicer_arg1 [slicer_arg2 [...]]])</code>:
+* <code>slicer_add_python_test(SCRIPT script [TESTNAME_PREFIX prefix] [SLICER_ARGS slicer_arg1 [slicer_arg2 [...]]] [SCRIPT_ARGS script_arg1 [script_arg2 [..]]])</code>:
-** Run unittests with Slicer using <code>--python-code "import slicer.testing\\; slicer.testing.runUnitTest(['${CMAKE_CURRENT_BINARY_DIR}', '${_script_source_dir}'], '${test_name}')"</code>.
+** Useful to run a python test that can not be added as a unittest.
 ** Slicer arguments systematically passed are <code>--testing</code> and <code>--no-splash</code>.
 ** Conveniently call [https://cmake.org/cmake/help/latest/module/ExternalData.html#command:externaldata_add_test ExternalData_add_test] with the appropriate parameters.