Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F62044549
AkantuTestsMacros.cmake
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Subscribers
None
File Metadata
Details
File Info
Storage
Attached
Created
Fri, May 10, 13:46
Size
14 KB
Mime Type
text/html
Expires
Sun, May 12, 13:46 (1 d, 23 h)
Engine
blob
Format
Raw Data
Handle
17541914
Attached To
rAKA akantu
AkantuTestsMacros.cmake
View Options
#===============================================================================
# @file AkantuTestsMacros.cmake
#
# @author Nicolas Richart <nicolas.richart@epfl.ch>
#
# @date creation: Fri Sep 03 2010
# @date last modification: Fri Jan 22 2016
#
# @brief macros for tests
#
# @section LICENSE
#
# Copyright (©) 2010-2012, 2014, 2015 EPFL (Ecole Polytechnique Fédérale de
# Lausanne) Laboratory (LSMS - Laboratoire de Simulation en Mécanique des
# Solides)
#
# Akantu is free software: you can redistribute it and/or modify it under the
# terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option) any
# later version.
#
# Akantu is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Akantu. If not, see <http://www.gnu.org/licenses/>.
#
#===============================================================================
#[=======================================================================[.rst:
#AkantuTestsMacros
#-----------------
#
#This modules provides the functions to helper to declare tests and folders
#containing tests in akantu
#
#.. command:: add_test_tree
#
# add_test_tree(<test_direcotry>)
#
# ``<test_directory>`` is the entry direcroty of the full structure of
# subfolders containing tests
#
#.. command:: add_akantu_test
#
# add_akantu_test(<dir> <desc>)
#
# This function add a subdirectory ``<dir>`` of tests that will be conditionnaly
# activable and will be visible only if the parent folder as been activated An
# option ``AKANTU_BUILD_TEST_<dir>`` will appear in ccmake with the description
# ``<desc>``. The compilation of all tests can be forced with the option
# ``AKANTU_BUILD_ALL_TESTS``
#
#.. command:: register_test
#
# register_test(<test_name>
# SOURCES <sources>...
# PACKAGE <akantu_packages>...
# SCRIPT <scirpt>
# [FILES_TO_COPY <filenames>...]
# [DEPENDS <targets>...]
# [DIRECTORIES_TO_CREATE <directories>...]
# [COMPILE_OPTIONS <flags>...]
# [EXTRA_FILES <filnames>...]
# [UNSABLE]
# [PARALLEL]
# )
#
# This function defines a test ``<test_name>_run`` this test could be of
# different nature depending on the context. If Just sources are provided the
# test consist of running the executable generated. If a file ``<test_name>.sh``
# is present the test will execute the script. And if a ``<test_name>.verified``
# exists the output of the test will be compared to this reference file
#
# The options are:
#
# ``SOURCES <sources>...``
# The list of source files to compile to generate the executable of the test
#
# ``PACKAGE <akantu_packages>...``
# The list of package to which this test belongs. The test will be activable
# only of all the packages listed are activated
#
# ``SCRIPT <script>``
# The script to execute instead of the executable
#
# ``FILES_TO_COPY <filenames>...``
# List of files to copy from the source directory to the build directory
#
# ``DEPENDS <targets>...``
# List of targets the test depends on, for example if a mesh as to be generated
#
# ``DIRECTORIES_TO_CREATE <directories>...``
# Obsolete. This specifies a list of directories that have to be created in
# the build folder
#
# ``COMPILE_OPTIONS <flags>...``
# List of extra compilations options to pass to the compiler
#
# ``EXTRA_FILES <filnames>...``
# Files to consider when generating a package_source
#
# ``UNSABLE``
# If this option is specified the test can be unacitivated by the glocal option
# ``AKANTU_BUILD_UNSTABLE_TESTS``, this is mainly intendeed to remove test
# under developement from the continious integration
#
# ``PARALLEL``
# This specifies that this test should be run in parallel. It will generate a
# series of test for different number of processors. This automaticaly adds a
# dependency to the package ``AKANTU_PARALLEL``
#
#]=======================================================================]
set
(
AKANTU_DRIVER_SCRIPT
${
AKANTU_CMAKE_DIR
}
/akantu_test_driver.sh
)
# ==============================================================================
macro
(
add_test_tree
dir
)
if
(
AKANTU_TESTS
)
enable_testing
()
include
(
CTest
)
mark_as_advanced
(
BUILD_TESTING
)
set
(
_akantu_current_parent_test
${
dir
}
CACHE
INTERNAL
"Current test folder"
FORCE
)
set
(
_akantu_
${
dir
}
_tests_count
0
CACHE
INTERNAL
""
FORCE
)
string
(
TOUPPER
${
dir
}
_u_dir
)
set
(
AKANTU_BUILD_
${
_u_dir
}
ON
CACHE
INTERNAL
"${desc}"
FORCE
)
package_get_all_test_folders
(
_test_dirs
)
foreach
(
_dir
${
_test_dirs
}
)
add_subdirectory
(
${
_dir
}
)
endforeach
()
endif
()
endmacro
()
# ==============================================================================
function
(
add_akantu_test
dir
desc
)
if
(
NOT
EXISTS
${
CMAKE_CURRENT_SOURCE_DIR
}
/
${
dir
}
)
return
()
endif
()
set
(
_my_parent_dir
${
_akantu_current_parent_test
}
)
# initialize variables
set
(
_akantu_current_parent_test
${
dir
}
CACHE
INTERNAL
"Current test folder"
FORCE
)
set
(
_akantu_
${
dir
}
_tests_count
0
CACHE
INTERNAL
""
FORCE
)
# set the option for this directory
string
(
TOUPPER
${
dir
}
_u_dir
)
option
(
AKANTU_BUILD_
${
_u_dir
}
"${desc}"
)
mark_as_advanced
(
AKANTU_BUILD_
${
_u_dir
}
)
# add the sub-directory
add_subdirectory
(
${
dir
}
)
# if no test can be activated make the option disappear
set
(
_force_deactivate_count
FALSE
)
if
(
${
_akantu_${dir
}
_tests_count}
EQUAL
0
)
set
(
_force_deactivate_count
TRUE
)
endif
()
# if parent off make the option disappear
set
(
_force_deactivate_parent
FALSE
)
string
(
TOUPPER
${
_my_parent_dir
}
_u_parent_dir
)
if
(
NOT
AKANTU_BUILD_
${
_u_parent_dir
}
)
set
(
_force_deactivate_parent
TRUE
)
endif
()
if
(
_force_deactivate_parent
OR
_force_deactivate_count
OR
AKANTU_BUILD_ALL_TESTS
)
if
(
NOT
DEFINED
_AKANTU_BUILD_
${
_u_dir
}
_SAVE
)
set
(
_AKANTU_BUILD_
${
_u_dir
}
_SAVE
${
AKANTU_BUILD_${_u_dir
}
}
CACHE
INTERNAL
""
FORCE
)
endif
()
unset
(
AKANTU_BUILD_
${
_u_dir
}
CACHE
)
if
(
AKANTU_BUILD_ALL_TESTS
AND
NOT
_force_deactivate_count
)
set
(
AKANTU_BUILD_
${
_u_dir
}
ON
CACHE
INTERNAL
"${desc}"
FORCE
)
else
()
set
(
AKANTU_BUILD_
${
_u_dir
}
OFF
CACHE
INTERNAL
"${desc}"
FORCE
)
endif
()
else
()
if
(
DEFINED
_AKANTU_BUILD_
${
_u_dir
}
_SAVE
)
unset
(
AKANTU_BUILD_
${
_u_dir
}
CACHE
)
set
(
AKANTU_BUILD_
${
_u_dir
}
${
_AKANTU_BUILD_${_u_dir
}
_SAVE}
CACHE
BOOL
"${desc}"
)
unset
(
_AKANTU_BUILD_
${
_u_dir
}
_SAVE
CACHE
)
endif
()
endif
()
# adding up to the parent count
math
(
EXPR
_tmp_parent_count
"${_akantu_${dir}_tests_count} + ${_akantu_${_my_parent_dir}_tests_count}"
)
set
(
_akantu_
${
_my_parent_dir
}
_tests_count
${
_tmp_parent_count
}
CACHE
INTERNAL
""
FORCE
)
# restoring the parent current dir
set
(
_akantu_current_parent_test
${
_my_parent_dir
}
CACHE
INTERNAL
"Current test folder"
FORCE
)
endfunction
()
# ==============================================================================
function
(
register_test
test_name
)
set
(
multi_variables
SOURCES
FILES_TO_COPY
DEPENDS
DIRECTORIES_TO_CREATE
COMPILE_OPTIONS
EXTRA_FILES
PACKAGE
)
cmake_parse_arguments
(
_register_test
"UNSTABLE;PARALLEL"
"POSTPROCESS;SCRIPT;PARALLEL_LEVEL"
"${multi_variables}"
${
ARGN
}
)
if
(
NOT
_register_test_PACKAGE
)
message
(
FATAL_ERROR
"No reference package was defined for the test"
" ${test_name} in folder ${CMAKE_CURRENT_SOURCE_DIR}"
)
endif
()
set
(
_test_act
TRUE
)
# Activate the test anly if all packages associated to the test are activated
foreach
(
_package
${
_register_test_PACKAGE
}
)
package_is_activated
(
${
_package
}
_act
)
if
(
NOT
_act
)
set
(
_test_act
FALSE
)
endif
()
endforeach
()
# check if the test is marked unstable and if the unstable test should be run
if
(
_register_test_UNSTABLE
AND
NOT
AKANTU_BUILD_UNSTABLE_TESTS
)
set
(
_test_act
FALSE
)
endif
()
# check that the sources are files that need to be compiled
if
(
_register_test_SOURCES}
OR
_register_test_UNPARSED_ARGUMENTS
)
set
(
_need_to_compile
TRUE
)
else
()
set
(
_need_to_compile
FALSE
)
endif
()
set
(
_compile_source
)
foreach
(
_file
${
_register_test_SOURCES
}
${
_register_test_UNPARSED_ARGUMENTS
}
)
if
(
_file
MATCHES
"\\.cc$"
OR
_file
MATCHES
"\\.hh$"
)
list
(
APPEND
_compile_source
${
_file
}
)
endif
()
endforeach
()
# todo this should be checked for the build package_sources since the file will not be listed.
if
(
_test_act
)
math
(
EXPR
_tmp_parent_count
"${_akantu_${_akantu_current_parent_test}_tests_count} + 1"
)
set
(
_akantu_
${
_akantu_current_parent_test
}
_tests_count
${
_tmp_parent_count
}
CACHE
INTERNAL
""
FORCE
)
string
(
TOUPPER
${
_akantu_current_parent_test
}
_u_parent
)
if
(
AKANTU_BUILD_
${
_u_parent
}
OR
AKANTU_BUILD_ALL_TESTS
)
if
(
_compile_source
)
# get the include directories for sources in activated directories
package_get_all_include_directories
(
AKANTU_LIBRARY_INCLUDE_DIRS
)
# get the external packages compilation and linking informations
package_get_all_external_informations
(
AKANTU_EXTERNAL_INCLUDE_DIR
AKANTU_EXTERNAL_LIBRARIES
)
# set the proper includes to build most of the tests
include_directories
(
${
PROJECT_BINARY_DIR
}
/src
${
AKANTU_LIBRARY_INCLUDE_DIRS
}
${
AKANTU_EXTERNAL_INCLUDE_DIR
}
)
# Register the executable to compile
add_executable
(
${
test_name
}
${
_compile_source
}
)
set_property
(
TARGET
${
test_name
}
APPEND
PROPERTY
INCLUDE_DIRECTORIES
${
AKANTU_LIBRARY_INCLUDE_DIRS
}
${
AKANTU_EXTERNAL_INCLUDE_DIR
}
)
target_link_libraries
(
${
test_name
}
akantu
)
if
(
_register_test_DEPENDS
)
add_dependencies
(
${
test_name
}
${
_register_test_DEPENDS
}
)
endif
()
# add the extra compilation options
if
(
_register_test_COMPILE_OPTIONS
)
set_target_properties
(
${
test_name
}
PROPERTIES
COMPILE_DEFINITIONS
"${_register_test_COMPILE_OPTIONS}"
)
endif
()
if
(
AKANTU_EXTRA_CXX_FLAGS
)
set_target_properties
(
${
test_name
}
PROPERTIES
COMPILE_FLAGS
"${AKANTU_EXTRA_CXX_FLAGS}"
)
endif
()
else
()
if
(
_register_test_UNPARSED_ARGUMENTS
AND
NOT
_register_test_SCRIPT
)
set
(
_register_test_SCRIPT
${
_register_test_UNPARSED_ARGUMENTS
}
)
endif
()
endif
()
# copy the needed files to the build folder
if
(
_register_test_FILES_TO_COPY
)
foreach
(
_file
${
_register_test_FILES_TO_COPY
}
)
file
(
COPY
"${_file}"
DESTINATION
.
)
endforeach
()
endif
()
# create the needed folders in the build folder
if
(
_register_test_DIRECTORIES_TO_CREATE
)
foreach
(
_dir
${
_register_test_DIRECTORIES_TO_CREATE
}
)
if
(
IS_ABSOLUTE
${
dir
}
)
file
(
MAKE_DIRECTORY
"${_dir}"
)
else
()
file
(
MAKE_DIRECTORY
"${CMAKE_CURRENT_BINARY_DIR}/${_dir}"
)
endif
()
endforeach
()
endif
()
# register the test for ctest
set
(
_arguments
-n
"${test_name}"
)
if
(
_register_test_SCRIPT
)
file
(
COPY
${
_register_test_SCRIPT
}
FILE_PERMISSIONS
OWNER_READ
OWNER_WRITE
OWNER_EXECUTE
GROUP_READ
GROUP_EXECUTE
WORLD_READ
WORLD_EXECUTE
DESTINATION
.
)
list
(
APPEND
_arguments
-e
"${_register_test_SCRIPT}"
)
elseif
(
EXISTS
"${CMAKE_CURRENT_SOURCE_DIR}/${test_name}.sh"
)
file
(
COPY
${
test_name
}
.sh
DESTINATION
.
)
list
(
APPEND
_arguments
-e
"${test_name}.sh"
)
else
()
list
(
APPEND
_arguments
-e
"${test_name}"
)
endif
()
list
(
APPEND
_arguments
-E
"${PROJECT_BINARY_DIR}/akantu_test_environement.sh"
)
if
(
_register_test_PARALLEL
)
list
(
APPEND
_arguments
-p
"${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG}"
)
if
(
_register_test_PARALLEL_LEVEL
)
set
(
_procs
"${_register_test_PARALLEL_LEVEL}"
)
elseif
(
CMAKE_VERSION
VERSION_GREATER
"3.0"
)
include
(
ProcessorCount
)
ProcessorCount
(
N
)
while
(
N
GREATER
1
)
set
(
_procs
"${N} ${_procs}"
)
math
(
EXPR
N
"${N} / 2"
)
endwhile
()
endif
()
if
(
NOT
_procs
)
set
(
_procs
2
)
endif
()
list
(
APPEND
_arguments
-N
"${_procs}"
)
endif
()
if
(
_register_test_POSTPROCESS
)
list
(
APPEND
_arguments
-s
"${_register_test_POSTPROCESS}"
)
endif
()
list
(
APPEND
_arguments
-w
"${CMAKE_CURRENT_BINARY_DIR}"
)
if
(
EXISTS
"${CMAKE_CURRENT_SOURCE_DIR}/${test_name}.verified"
)
list
(
APPEND
_arguments
-r
"${CMAKE_CURRENT_SOURCE_DIR}/${test_name}.verified"
)
endif
()
string
(
REPLACE
";"
" "
_command
"${_arguments}"
)
# register them test
add_test
(
NAME
${
test_name
}
_run
COMMAND
${
AKANTU_DRIVER_SCRIPT
}
${
_arguments
}
)
# add the executable as a dependency of the run
set_tests_properties
(
${
test_name
}
_run
PROPERTIES
DEPENDS
${
test_name
}
)
endif
()
endif
()
set
(
_test_all_files
)
# add the source files in the list of all files
foreach
(
_file
${
_register_test_SOURCES
}
${
_register_test_UNPARSED_ARGUMENTS
}
${
_register_test_EXTRA_FILES
}
${
_register_test_SOURCES
}
${
_register_test_SCRIPT
}
${
_register_test_POSTPROCESS
}
${
_register_test_FILES_TO_COPY
}
)
if
(
EXISTS
${
CMAKE_CURRENT_SOURCE_DIR
}
/
${
_file
}
)
list
(
APPEND
_test_all_files
"${_file}"
)
else
()
message
(
"The file \"
${
_file
}
\"
registred
by
the
test
\"${test_name}\"
does
not
exists
")
endif()
endforeach()
# add the different dependencies files (meshes, local libraries, ...)
foreach(_dep ${_register_test_DEPENDS})
get_target_list_of_associated_files(${_dep} _dep_ressources)
if(_dep_ressources)
list(APPEND _test_all_files "
${
_dep_ressources
}
")
endif()
endforeach()
# add estra files to the list of files referenced by a given test
if(EXISTS "
${
CMAKE_CURRENT_SOURCE_DIR
}
/
${
test_name
}
.sh
")
list(APPEND _test_all_files "
${
test_name
}
.sh
")
endif()
if(EXISTS "
${
CMAKE_CURRENT_SOURCE_DIR
}
/
${
test_name
}
.verified
")
list(APPEND _test_all_files "
${
test_name
}
.verified
")
endif()
if(_register_test_SCRIPT)
list(APPEND _test_all_files "
${
_register_test_SCRIPT
}
")
endif()
# clean the list of all files for this test and add them in the total list
foreach(_file ${_test_all_files})
get_filename_component(_full ${_file} ABSOLUTE)
file(RELATIVE_PATH __file ${PROJECT_SOURCE_DIR} ${_full})
list(APPEND _tmp "
${
__file
}
"
)
endforeach
()
foreach
(
_pkg
${
_register_test_PACKAGE
}
)
package_get_name
(
${
_pkg
}
_pkg_name
)
_package_add_to_variable
(
TESTS_FILES
${
_pkg_name
}
${
_tmp
}
)
endforeach
()
endfunction
()
Event Timeline
Log In to Comment