Newer
Older
#
# AddTest
# -------
#
# Creates application test runs. Order of arguments can be arbitrary.
#
# AddTest(
# NAME <name of the the test>
# PATH <working directory> # relative to SourceDir/Tests/Data
# EXECUTABLE <executable target> # optional, defaults to ogs
# WRAPPER <time|memcheck|callgrind> # optional, defaults to time
# TESTER <diff|memcheck> # optional
# DATA <list of all required data files, white-space separated, have to be in PATH>
# )
#
# Conditional arguments:
#
# diff-tester
# - DIFF_DATA <list of files to diff>
# # the given file is compared to a file with the same name from Tests/Data
# numdiff-tester
# - DIFF_DATA <list of files to numdiff>
# # the given file is compared to a file with the same name from Tests/Data
# vtkdiff-tester
# - DIFF_DATA <vtk file> <data array a name> <data array b name>
# # the given data arrays in the vtk file are compared
#
# parse arguments
set(options NONE)
set(oneValueArgs EXECUTABLE PATH NAME WRAPPER TESTER ABSTOL RELTOL)
set(multiValueArgs EXECUTABLE_ARGS DATA DIFF_DATA WRAPPER_ARGS)
cmake_parse_arguments(AddTest "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
set(AddTest_SOURCE_PATH "${Data_SOURCE_DIR}/${AddTest_PATH}")
set(AddTest_BINARY_PATH "${Data_BINARY_DIR}/${AddTest_PATH}")
file(MAKE_DIRECTORY ${AddTest_BINARY_PATH})
file(TO_NATIVE_PATH "${AddTest_BINARY_PATH}" AddTest_BINARY_PATH_NATIVE)
# set defaults
if(NOT AddTest_EXECUTABLE)
set(AddTest_EXECUTABLE ogs)
endif()
if (NOT AddTest_ABSTOL)
set (AddTest_ABSTOL 1e-16)
endif()
if (NOT AddTest_RELTOL)
set (AddTest_RELTOL 1e-16)
endif()
# message("AddTest_ABSTOL ${AddTest_ABSTOL}")
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
if("${AddTest_EXECUTABLE}" STREQUAL "ogs")
set(AddTest_EXECUTABLE_ARGS -o ${AddTest_BINARY_PATH_NATIVE} ${AddTest_EXECUTABLE_ARGS})
endif()
if(NOT AddTest_WRAPPER)
set(AddTest_WRAPPER time)
endif()
# --- Implement wrappers ---
# check requirements, disable if not met
if(AddTest_WRAPPER STREQUAL "time" AND NOT TIME_TOOL_PATH)
return()
endif()
if(AddTest_WRAPPER STREQUAL "memcheck" AND NOT VALGRIND_TOOL_PATH)
return()
endif()
if(AddTest_WRAPPER STREQUAL "callgrind" AND NOT VALGRIND_TOOL_PATH)
return()
endif()
if(AddTest_WRAPPER STREQUAL "mpirun" AND NOT MPIRUN_TOOL_PATH)
return()
endif()
if(AddTest_WRAPPER STREQUAL "time")
set(WRAPPER_COMMAND time)
elseif(AddTest_WRAPPER STREQUAL "memcheck" AND VALGRIND_TOOL_PATH)
set(WRAPPER_COMMAND "${VALGRIND_TOOL_PATH} --tool=memcheck --log-file=${AddTest_SOURCE_PATH}/${AddTest_NAME}_memcheck.log -v --leak-check=full --show-reachable=yes --track-origins=yes --malloc-fill=0xff --free-fill=0xff")
set(tester memcheck)
elseif(AddTest_WRAPPER STREQUAL "callgrind" AND VALGRIND_TOOL_PATH)
set(WRAPPER_COMMAND "${VALGRIND_TOOL_PATH} --tool=callgrind --branch-sim=yes --cache-sim=yes --dump-instr=yes --collect-jumps=yes")
unset(tester)
elseif(AddTest_WRAPPER STREQUAL "mpirun")
set(WRAPPER_COMMAND ${MPIRUN_TOOL_PATH})
endif()
# --- Implement testers ---
# check requirements, disable if not met
if(AddTest_TESTER STREQUAL "diff" AND NOT DIFF_TOOL_PATH)
return()
endif()
if(AddTest_TESTER STREQUAL "numdiff" AND NOT NUMDIFF_TOOL_PATH)
return()
endif()
if(AddTest_TESTER STREQUAL "vtkdiff" AND NOT TARGET vtkdiff)
return()
endif()
if(AddTest_TESTER STREQUAL "memcheck" AND NOT GREP_TOOL_PATH)
return()
endif()
if((AddTest_TESTER STREQUAL "diff" OR AddTest_TESTER STREQUAL "numdiff" OR AddTest_TESTER STREQUAL "vtkdiff") AND NOT AddTest_DIFF_DATA)
message(FATAL_ERROR "AddTest(): ${AddTest_NAME} - no DIFF_DATA given!")
endif()
if(AddTest_TESTER STREQUAL "diff")
set(SELECTED_DIFF_TOOL_PATH ${DIFF_TOOL_PATH})
set(TESTER_ARGS "-sbB")
elseif(AddTest_TESTER STREQUAL "numdiff")
set(SELECTED_DIFF_TOOL_PATH ${NUMDIFF_TOOL_PATH})
set(TESTER_ARGS "--statistics --absolute-tolerance=${AddTest_ABSTOL} --relative-tolerance=${AddTest_RELTOL}")
elseif(AddTest_TESTER STREQUAL "vtkdiff")
set(SELECTED_DIFF_TOOL_PATH $<TARGET_FILE:vtkdiff>)
set(TESTER_ARGS "--abs ${AddTest_ABSTOL} --rel ${AddTest_RELTOL}")
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
endif()
if(AddTest_TESTER STREQUAL "diff" OR AddTest_TESTER STREQUAL "numdiff")
foreach(FILE ${AddTest_DIFF_DATA})
get_filename_component(FILE_EXPECTED ${FILE} NAME)
set(TESTER_COMMAND ${TESTER_COMMAND} "${SELECTED_DIFF_TOOL_PATH} \
${TESTER_ARGS} ${AddTest_SOURCE_PATH}/${FILE_EXPECTED} \
${AddTest_BINARY_PATH}/${FILE}")
endforeach()
string(REPLACE ";" " && " TESTER_COMMAND "${TESTER_COMMAND}")
elseif(AddTest_TESTER STREQUAL "vtkdiff")
list(LENGTH AddTest_DIFF_DATA DiffDataLength)
if (NOT ${DiffDataLength} EQUAL 3)
message(FATAL_ERROR "For vtkdiff tester 3 diff data arguments are required.")
endif()
list(GET AddTest_DIFF_DATA 0 VTK_FILE)
list(GET AddTest_DIFF_DATA 1 NAME_A)
list(GET AddTest_DIFF_DATA 2 NAME_B)
set(TESTER_COMMAND ${TESTER_COMMAND} "${SELECTED_DIFF_TOOL_PATH} \
${AddTest_BINARY_PATH}/${VTK_FILE} \
-a ${NAME_A} -b ${NAME_B} \
${TESTER_ARGS}")
string(REPLACE ";" " && " TESTER_COMMAND "${TESTER_COMMAND}")
elseif(tester STREQUAL "memcheck")
set(TESTER_COMMAND "! ${GREP_TOOL_PATH} definitely ${AddTest_SOURCE_PATH}/${AddTest_NAME}_memcheck.log")
endif()
## -----------
if(TARGET ${AddTest_EXECUTABLE})
set(AddTest_EXECUTABLE_PARSED $<TARGET_FILE:${AddTest_EXECUTABLE}>)
else()
set(AddTest_EXECUTABLE_PARSED ${AddTest_EXECUTABLE})
endif()
set(FILES_TO_DELETE "")
foreach(ITEM ${AddTest_DIFF_DATA})
if(ITEM MATCHES "^.*\.(vtu|vtk)$")
list(APPEND FILES_TO_DELETE "${ITEM}")
endif()
endforeach()
# Run the wrapper
NAME "${AddTest_EXECUTABLE}-${AddTest_NAME}-${AddTest_WRAPPER}"
COMMAND ${CMAKE_COMMAND}
-DEXECUTABLE=${AddTest_EXECUTABLE_PARSED}
"-DEXECUTABLE_ARGS=${AddTest_EXECUTABLE_ARGS}"
-Dcase_path=${AddTest_SOURCE_PATH}
-DBINARY_PATH=${AddTest_BINARY_PATH}
-DWRAPPER_COMMAND=${WRAPPER_COMMAND}
"-DWRAPPER_ARGS=${AddTest_WRAPPER_ARGS}"
"-DFILES_TO_DELETE=${FILES_TO_DELETE}"
-P ${PROJECT_SOURCE_DIR}/scripts/cmake/test/AddTestWrapper.cmake
)
if(NOT AddTest_TESTER OR OGS_COVERAGE)
return()
endif()
# Run the tester
add_test(
NAME "${AddTest_EXECUTABLE}-${AddTest_NAME}-${AddTest_WRAPPER}-${AddTest_TESTER}"
COMMAND ${CMAKE_COMMAND}
-Dcase_path=${AddTest_SOURCE_PATH}
-DTESTER_COMMAND=${TESTER_COMMAND}
-P ${PROJECT_SOURCE_DIR}/scripts/cmake/test/AddTestTester.cmake
)
set_tests_properties(${AddTest_EXECUTABLE}-${AddTest_NAME}-${AddTest_WRAPPER}-${AddTest_TESTER}
PROPERTIES DEPENDS ${AddTest_EXECUTABLE}-${AddTest_NAME}-${AddTest_WRAPPER})