FindMatlab: Extend matlab_add_unit_test to run arbitrary test code
Allow a custom matlab set of commands to be run as the test instead of
just `runtests('matlab_file_name')`.
This commit is contained in:
Bill Hoffman
Brad King
parent
ea69e03afa
commit
4ebb4ae6cf
|
|
@ -635,7 +635,7 @@ function(matlab_get_version_from_matlab_run matlab_binary_program matlab_list_ve
|
|||
set(devnull INPUT_FILE NUL)
|
||||
endif()
|
||||
|
||||
# timeout set to 30 seconds, in case it does not start
|
||||
# timeout set to 120 seconds, in case it does not start
|
||||
# note as said before OUTPUT_VARIABLE cannot be used in a platform
|
||||
# independent manner however, not setting it would flush the output of Matlab
|
||||
# in the current console (unix variant)
|
||||
|
|
@ -644,11 +644,18 @@ function(matlab_get_version_from_matlab_run matlab_binary_program matlab_list_ve
|
|||
OUTPUT_VARIABLE _matlab_version_from_cmd_dummy
|
||||
RESULT_VARIABLE _matlab_result_version_call
|
||||
ERROR_VARIABLE _matlab_result_version_call_error
|
||||
TIMEOUT 30
|
||||
TIMEOUT 120
|
||||
WORKING_DIRECTORY "${_matlab_temporary_folder}"
|
||||
${devnull}
|
||||
)
|
||||
|
||||
if("${_matlab_result_version_call}" MATCHES "timeout")
|
||||
if(MATLAB_FIND_DEBUG)
|
||||
message(WARNING "[MATLAB] Unable to determine the version of Matlab."
|
||||
" Matlab call timed out after 120 seconds.")
|
||||
endif()
|
||||
return()
|
||||
endif()
|
||||
|
||||
if(${_matlab_result_version_call})
|
||||
if(MATLAB_FIND_DEBUG)
|
||||
|
|
@ -698,7 +705,6 @@ function(matlab_get_version_from_matlab_run matlab_binary_program matlab_list_ve
|
|||
|
||||
endfunction()
|
||||
|
||||
|
||||
#.rst:
|
||||
# .. command:: matlab_add_unit_test
|
||||
#
|
||||
|
|
@ -720,6 +726,7 @@ endfunction()
|
|||
# matlab_add_unit_test(
|
||||
# NAME <name>
|
||||
# UNITTEST_FILE matlab_file_containing_unittest.m
|
||||
# [CUSTOM_MATLAB_COMMAND matlab_command_to_run_as_test]
|
||||
# [UNITTEST_PRECOMMAND matlab_command_to_run]
|
||||
# [TIMEOUT timeout]
|
||||
# [ADDITIONAL_PATH path1 [path2 ...]]
|
||||
|
|
@ -735,6 +742,11 @@ endfunction()
|
|||
# ``UNITTEST_FILE``
|
||||
# the matlab unittest file. Its path will be automatically
|
||||
# added to the Matlab path.
|
||||
# ``CUSTOM_MATLAB_COMMAND``
|
||||
# Matlab script command to run as the test.
|
||||
# IIf this is not set, then the following is run:
|
||||
# "runtests('matlab_file_name'), exit(max([ans(1,:).Failed]))
|
||||
# matlab_file_name comes from UNITTEST_FILE without the .m.
|
||||
# ``UNITTEST_PRECOMMAND``
|
||||
# Matlab script command to be ran before the file
|
||||
# containing the test (eg. GPU device initialisation based on CMake
|
||||
|
|
@ -748,12 +760,18 @@ endfunction()
|
|||
# ``MATLAB_ADDITIONAL_STARTUP_OPTIONS``
|
||||
# a list of additional option in order
|
||||
# to run Matlab from the command line.
|
||||
# -nosplash -nodesktop -nodisplay are always added.
|
||||
# ``TEST_ARGS``
|
||||
# Additional options provided to the add_test command. These
|
||||
# options are added to the default options (eg. "CONFIGURATIONS Release")
|
||||
# ``NO_UNITTEST_FRAMEWORK``
|
||||
# when set, indicates that the test should not
|
||||
# use the unittest framework of Matlab (available for versions >= R2013a).
|
||||
# ``WORKING_DIRECTORY``
|
||||
# This will be the working directory for the test. If specified it will
|
||||
# also be the output directory used for the log file of the test run.
|
||||
# If not specifed the temporary directory ${CMAKE_BINARY_DIR}/Matlab will
|
||||
# be used as the working directory and the log location.
|
||||
#
|
||||
function(matlab_add_unit_test)
|
||||
|
||||
|
|
@ -762,11 +780,12 @@ function(matlab_add_unit_test)
|
|||
endif()
|
||||
|
||||
set(options NO_UNITTEST_FRAMEWORK)
|
||||
set(oneValueArgs NAME UNITTEST_PRECOMMAND UNITTEST_FILE TIMEOUT)
|
||||
set(oneValueArgs NAME UNITTEST_FILE TIMEOUT WORKING_DIRECTORY
|
||||
UNITTEST_PRECOMMAND CUSTOM_TEST_COMMAND)
|
||||
set(multiValueArgs ADDITIONAL_PATH MATLAB_ADDITIONAL_STARTUP_OPTIONS TEST_ARGS)
|
||||
|
||||
set(prefix _matlab_unittest_prefix)
|
||||
cmake_parse_arguments(${prefix} "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
|
||||
cmake_parse_arguments(PARSE_ARGV 0 ${prefix} "${options}" "${oneValueArgs}" "${multiValueArgs}" )
|
||||
|
||||
if(NOT ${prefix}_NAME)
|
||||
message(FATAL_ERROR "[MATLAB] The Matlab test name cannot be empty")
|
||||
|
|
@ -774,15 +793,17 @@ function(matlab_add_unit_test)
|
|||
|
||||
add_test(NAME ${${prefix}_NAME}
|
||||
COMMAND ${CMAKE_COMMAND}
|
||||
-Dtest_name=${${prefix}_NAME}
|
||||
-Dadditional_paths=${${prefix}_ADDITIONAL_PATH}
|
||||
-Dtest_timeout=${${prefix}_TIMEOUT}
|
||||
-Doutput_directory=${_matlab_temporary_folder}
|
||||
-DMatlab_PROGRAM=${Matlab_MAIN_PROGRAM}
|
||||
-Dno_unittest_framework=${${prefix}_NO_UNITTEST_FRAMEWORK}
|
||||
-DMatlab_ADDITIONNAL_STARTUP_OPTIONS=${${prefix}_MATLAB_ADDITIONAL_STARTUP_OPTIONS}
|
||||
-Dunittest_file_to_run=${${prefix}_UNITTEST_FILE}
|
||||
-Dcmd_to_run_before_test=${${prefix}_UNITTEST_PRECOMMAND}
|
||||
"-Dtest_name=${${prefix}_NAME}"
|
||||
"-Dadditional_paths=${${prefix}_ADDITIONAL_PATH}"
|
||||
"-Dtest_timeout=${${prefix}_TIMEOUT}"
|
||||
"-Doutput_directory=${_matlab_temporary_folder}"
|
||||
"-Dworking_directory=${${prefix}_WORKING_DIRECTORY}"
|
||||
"-DMatlab_PROGRAM=${Matlab_MAIN_PROGRAM}"
|
||||
"-Dno_unittest_framework=${${prefix}_NO_UNITTEST_FRAMEWORK}"
|
||||
"-DMatlab_ADDITIONNAL_STARTUP_OPTIONS=${${prefix}_MATLAB_ADDITIONAL_STARTUP_OPTIONS}"
|
||||
"-Dunittest_file_to_run=${${prefix}_UNITTEST_FILE}"
|
||||
"-Dcustom_Matlab_test_command=${${prefix}_CUSTOM_TEST_COMMAND}"
|
||||
"-Dcmd_to_run_before_test=${${prefix}_UNITTEST_PRECOMMAND}"
|
||||
-P ${_FindMatlab_SELF_DIR}/MatlabTestsRedirect.cmake
|
||||
${${prefix}_TEST_ARGS}
|
||||
${${prefix}_UNPARSED_ARGUMENTS}
|
||||
|
|
@ -1034,7 +1055,7 @@ function(_Matlab_get_version_from_root matlab_root matlab_known_version matlab_f
|
|||
if(${list_of_all_versions_length} GREATER 0)
|
||||
list(GET matlab_list_of_all_versions 0 _matlab_version_tmp)
|
||||
else()
|
||||
set(_matlab_version_tmp "")
|
||||
set(_matlab_version_tmp "unknown")
|
||||
endif()
|
||||
|
||||
# set the version into the cache
|
||||
|
|
|
|||
|
|
@ -23,11 +23,12 @@
|
|||
# -DMatlab_PROGRAM=matlab_exe_location
|
||||
# -DMatlab_ADDITIONNAL_STARTUP_OPTIONS=""
|
||||
# -Dtest_name=name_of_the_test
|
||||
# -Dcustom_Matlab_test_command=""
|
||||
# -Dcmd_to_run_before_test=""
|
||||
# -Dunittest_file_to_run
|
||||
# -P FindMatlab_TestsRedirect.cmake
|
||||
|
||||
set(Matlab_UNIT_TESTS_CMD -nosplash -nojvm -nodesktop -nodisplay ${Matlab_ADDITIONNAL_STARTUP_OPTIONS})
|
||||
set(Matlab_UNIT_TESTS_CMD -nosplash -nodesktop -nodisplay ${Matlab_ADDITIONNAL_STARTUP_OPTIONS})
|
||||
if(WIN32)
|
||||
set(Matlab_UNIT_TESTS_CMD ${Matlab_UNIT_TESTS_CMD} -wait)
|
||||
endif()
|
||||
|
|
@ -36,6 +37,13 @@ if(NOT test_timeout)
|
|||
set(test_timeout 180)
|
||||
endif()
|
||||
|
||||
# If timeout is -1, then do not put a timeout on the execute_process
|
||||
if(test_timeout EQUAL -1)
|
||||
set(test_timeout "")
|
||||
else()
|
||||
set(test_timeout TIMEOUT ${test_timeout})
|
||||
endif()
|
||||
|
||||
if(NOT cmd_to_run_before_test)
|
||||
set(cmd_to_run_before_test)
|
||||
endif()
|
||||
|
|
@ -50,16 +58,30 @@ foreach(s IN LISTS additional_paths)
|
|||
endif()
|
||||
endforeach()
|
||||
|
||||
if(custom_Matlab_test_command)
|
||||
set(unittest_to_run "${custom_Matlab_test_command}")
|
||||
else()
|
||||
set(unittest_to_run "runtests('${unittest_file_to_run_name}'), exit(max([ans(1,:).Failed]))")
|
||||
endif()
|
||||
|
||||
|
||||
if(no_unittest_framework)
|
||||
set(unittest_to_run "try, ${unittest_file_to_run_name}, catch err, disp('An exception has been thrown during the execution'), disp(err), disp(err.stack), exit(1), end, exit(0)")
|
||||
endif()
|
||||
|
||||
set(Matlab_SCRIPT_TO_RUN
|
||||
"addpath(${concat_string}), path, ${cmd_to_run_before_test}, ${unittest_to_run}"
|
||||
"addpath(${concat_string}); ${cmd_to_run_before_test}; ${unittest_to_run}"
|
||||
)
|
||||
# if the working directory is not specified then default
|
||||
# to the output_directory because the log file will go there
|
||||
# if the working_directory is specified it will override the
|
||||
# output_directory
|
||||
if(NOT working_directory)
|
||||
set(working_directory "${output_directory}")
|
||||
endif()
|
||||
|
||||
set(Matlab_LOG_FILE "${output_directory}/${test_name}.log")
|
||||
string(REPLACE "/" "_" log_file_name "${test_name}.log")
|
||||
set(Matlab_LOG_FILE "${working_directory}/${log_file_name}")
|
||||
|
||||
set(devnull)
|
||||
if(UNIX)
|
||||
|
|
@ -69,11 +91,14 @@ elseif(WIN32)
|
|||
endif()
|
||||
|
||||
execute_process(
|
||||
COMMAND "${Matlab_PROGRAM}" ${Matlab_UNIT_TESTS_CMD} -logfile "${test_name}.log" -r "${Matlab_SCRIPT_TO_RUN}"
|
||||
# Do not use a full path to log file. Depend on the fact that the log file
|
||||
# is always going to go in the working_directory. This is because matlab
|
||||
# on unix is a shell script that does not handle spaces in the logfile path.
|
||||
COMMAND "${Matlab_PROGRAM}" ${Matlab_UNIT_TESTS_CMD} -logfile "${log_file_name}" -r "${Matlab_SCRIPT_TO_RUN}"
|
||||
RESULT_VARIABLE res
|
||||
TIMEOUT ${test_timeout}
|
||||
${test_timeout}
|
||||
OUTPUT_QUIET # we do not want the output twice
|
||||
WORKING_DIRECTORY "${output_directory}"
|
||||
WORKING_DIRECTORY "${working_directory}"
|
||||
${devnull}
|
||||
)
|
||||
|
||||
|
|
@ -87,5 +112,5 @@ message("Matlab test ${name_of_the_test} output:\n${matlab_log_content}") # if w
|
|||
|
||||
|
||||
if(NOT (res EQUAL 0))
|
||||
message( FATAL_ERROR "[MATLAB] TEST FAILED" )
|
||||
message( FATAL_ERROR "[MATLAB] TEST FAILED Matlab returned ${res}" )
|
||||
endif()
|
||||
|
|
|
|||
Loading…
Reference in New Issue