-
Notifications
You must be signed in to change notification settings - Fork 94
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provide support in Ginkgo for Coverage and Sanitizers build.
+ Add a CMake script which simplifies adding new build types to the project + Use this script to provide three new build types: + COVERAGE: relies on gcov and the `--coverage` flag + ASAN: relies on the flag `-fsanitize=address` + TSAN: relies on the flag `-fsanitize=thread` + Add four new steps to the CI system, one for each of the new build types plus valgrind. + Update CI Benchmarking support as it was using the old format. + Add configuration files to simplify using CTest and support CDash. + Document these additions in the Readme.
- Loading branch information
Showing
7 changed files
with
394 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| set(CTEST_PROJECT_NAME "Ginkgo Project") | ||
| set(CTEST_NIGHTLY_START_TIME "01:00:00 UTC") | ||
|
|
||
| set(CTEST_DROP_METHOD "http") | ||
| set(CTEST_DROP_SITE "my.cdash.org") | ||
| set(CTEST_DROP_LOCATION "/submit.php?project=Ginkgo+Project") | ||
| set(CTEST_DROP_SITE_CDASH TRUE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| list(APPEND CTEST_CUSTOM_COVERAGE_EXCLUDE | ||
| # Exclude list set by cmake | ||
| @CUSTOM_COVERAGE_EXCLUDE@ | ||
|
|
||
| # Exclude try_compile sources from coverage results: | ||
| "/CMakeFiles/CMakeTmp/" | ||
|
|
||
| "third_party" | ||
|
|
||
| "test" | ||
|
|
||
| "c\\+\\+" | ||
| ) | ||
|
|
||
| set(CTEST_SOURCE_DIRECTORY "@Ginkgo_SOURCE_DIR@" CACHE STRING "" FORCE) | ||
| set(CTEST_BINARY_DIRECTORY "@Ginkgo_BINARY_DIR@" CACHE STRING "" FORCE) | ||
|
|
||
| set(CTEST_MEMORYCHECK_COMMAND_OPTIONS "--trace-children=yes --leak-check=full") | ||
| set(CTEST_MEMORYCHECK_SUPPRESSIONS_FILE "@Ginkgo_SOURCE_DIR@/dev_tools/valgrind/suppressions.supp") | ||
|
|
||
| set(CTEST_COVERAGE_EXTRA_FLAGS "-p") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| #.rst: | ||
| # Ginkgo CTestScript | ||
| # ------- | ||
| # | ||
| # Runs our tests through CTest, with support for Coverage or memory checking. | ||
| # | ||
| # This script provides a full CTest run whith result submission to Ginkgo's | ||
| # CDash dashboard. The supported runs are: | ||
| # + With or without coverage, requires the gcov tool. | ||
| # + With or without address sanitizers. | ||
| # + With or without thread sanitizers. | ||
| # + With or without valgrind, requires the valgrind tool. | ||
| # | ||
| # Note that only one of these can be ran at once, as the build types | ||
| # conflict. Ginkgo is always configured with CUDA, OpenMP and Reference | ||
| # support. The results are always sent to the dashboard: | ||
| # https://my.cdash.org/index.php?project=Ginkgo+Project | ||
| # | ||
| # Running the script | ||
| # ^^^^^^^^^^^^^^^^^^ | ||
| # | ||
| # To run the script, launch the command `ctest -S cmake/CTestScript.cmake` | ||
| # from the Ginkgo's source directory. The default settings are for the CI | ||
| # system's DEBUG tests run. To configure the script use standard CMake `-D` | ||
| # parameters. For example, the following command runs coverage. | ||
| # | ||
| # `ctest -S cmake/CTestScript.cmake -DCTEST_BUILD_CONFIGURATION=COVERAGE` | ||
| # | ||
| # Instead, this runs the ThreadSanitizer: | ||
| # | ||
| # `ctest -S cmake/CTestScript.cmake -DCTEST_BUILD_CONFIGURATION=TSAN | ||
| # -DCTEST_MEMORYCHECK_TYPE=ThreadSanitizer` | ||
| # | ||
| # Input Variables | ||
| # ^^^^^^^^^^^^^^^^ | ||
| # | ||
| # This script can be configured with the following input variables: | ||
| # | ||
| # ``CTEST_SOURCE_DIRECTORY`` | ||
| # Where the sources are located. By default, the current directory. | ||
| # | ||
| # ``CTEST_BINARY_DIRECTORY`` | ||
| # In which directory should the sources be builts. Default, `./build`. | ||
| # | ||
| # ``CTEST_SITE`` | ||
| # A string to describe the machine this is ran on. Default FineCI. | ||
| # | ||
| # ``CTEST_CMAKE_GENERATOR`` | ||
| # Which generator should be used for the build. Default `Unix Makefiles` | ||
| # | ||
| # ``CTEST_BUILD_CONFIGURATION`` | ||
| # Which configuration should Ginkgo be built with. Default `DEBUG`. | ||
| # The supported values are: COVERAGE, ASAN, TSAN, DEBUG and RELEASE. | ||
| # | ||
| # ``CTEST_TEST_MODEL`` | ||
| # Which CTest test model should be used. Default `Continuous`. | ||
| # The supported values are the same as CTest's, namely: | ||
| # Experimental, Nightly, Continuous. | ||
| # | ||
| # ``CTEST_BUILD_NAME`` | ||
| # The name of the build being ran. Default: `CTEST_BUILD_CONFIGURATION` | ||
| # | ||
| # ``CTEST_MEMORYCHECK_TYPE`` | ||
| # Whether memorycheck should be ran. Default: `None`. Supported values are: | ||
| # Valgrind, ThreadSanitizer, AddressSanitizer and None. | ||
| # | ||
|
|
||
| if (NOT DEFINED CTEST_SOURCE_DIRECTORY) | ||
| set(CTEST_SOURCE_DIRECTORY ".") | ||
| endif() | ||
|
|
||
| if (NOT DEFINED CTEST_BINARY_DIRECTORY) | ||
| set(CTEST_BINARY_DIRECTORY "./build") | ||
| endif() | ||
|
|
||
| if (NOT DEFINED CTEST_SITE) | ||
| set(CTEST_SITE "Linux-FineCI") | ||
| endif() | ||
|
|
||
| if (NOT DEFINED CTEST_CMAKE_GENERATOR) | ||
| set(CTEST_CMAKE_GENERATOR "Unix Makefiles") | ||
| endif() | ||
|
|
||
| # Supported: COVERAGE, ASAN, TSAN, DEBUG and RELEASE | ||
| if (NOT DEFINED CTEST_BUILD_CONFIGURATION) | ||
| set(CTEST_BUILD_CONFIGURATION "DEBUG") | ||
| endif() | ||
|
|
||
| if (NOT DEFINED CTEST_TEST_MODEL) | ||
| set(CTEST_TEST_MODEL "Continuous") | ||
| endif() | ||
|
|
||
| if (NOT DEFINED CTEST_BUILD_NAME) | ||
| set(CTEST_BUILD_NAME "${CTEST_BUILD_CONFIGURATION}") | ||
| endif() | ||
|
|
||
| #Supported: Valgrind, ThreadSanitizer, AddressSanitizer. | ||
| if (NOT DEFINED CTEST_MEMORYCHECK_TYPE) | ||
| set(CTEST_MEMORYCHECK_TYPE "None") | ||
| endif() | ||
|
|
||
| # Find coverage and valgrind tools | ||
| if(CTEST_MEMORYCHECK_TYPE STREQUAL "Valgrind") | ||
| find_program(CTEST_MEMORYCHECK_COMMAND valgrind) | ||
| set(CTEST_BUILD_NAME "Valgrind") | ||
| endif() | ||
|
|
||
| if(CTEST_BUILD_CONFIGURATION STREQUAL "COVERAGE") | ||
| find_program(CTEST_COVERAGE_COMMAND gcov) | ||
| endif() | ||
|
|
||
| include(ProcessorCount) | ||
| ProcessorCount(PROC_COUNT) | ||
| if(NOT PROC_COUNT EQUAL 0) | ||
| if(NOT WIN32) | ||
| set(CTEST_BUILD_FLAGS "-j${PROC_COUNT}") | ||
| endif(NOT WIN32) | ||
| endif() | ||
|
|
||
| ctest_start("${CTEST_TEST_MODEL}") | ||
| ctest_submit(PARTS Start) | ||
|
|
||
| ctest_configure(BUILD "${CTEST_BINARY_DIRECTORY}" OPTIONS "-DGINKGO_BUILD_REFERENCE=ON;-DGINKGO_BUILD_OMP=ON;-DGINKGO_BUILD_CUDA=ON;-DCMAKE_BUILD_TYPE=${CTEST_BUILD_CONFIGURATION}" APPEND) | ||
| ctest_submit(PARTS Configure) | ||
|
|
||
| ctest_read_custom_files( ${CTEST_BINARY_DIRECTORY} ) | ||
|
|
||
| ctest_build(BUILD "${CTEST_BINARY_DIRECTORY}" APPEND) | ||
| ctest_submit(PARTS Build) | ||
|
|
||
| ctest_test(BUILD "${CTEST_BINARY_DIRECTORY}" APPEND) | ||
| ctest_submit(PARTS Test) | ||
|
|
||
| if (CTEST_BUILD_CONFIGURATION STREQUAL "COVERAGE") | ||
| ctest_coverage(BUILD "${CTEST_BINARY_DIRECTORY}" APPEND) | ||
| ctest_submit(PARTS Coverage) | ||
| endif() | ||
|
|
||
| if(NOT CTEST_MEMORYCHECK_TYPE STREQUAL "None") | ||
| ctest_memcheck(BUILD "${CTEST_BINARY_DIRECTORY}" APPEND) | ||
| ctest_submit(PARTS MemCheck) | ||
| endif() | ||
|
|
Oops, something went wrong.