Improved testing procedure and documentation

Co-authored-by: jlhcrawford <54402133+jlhcrawford@users.noreply.github.com>

Author: 2 people

CMakeLists.txt

@@ -19,16 +19,44 @@ if (NOT (CMAKE_SIZEOF_VOID_P EQUAL 8))
   message(FATAL_ERROR "HElib requires a 64-bit architecture.")
 endif ()
 
-# Define standard installation directories (GNU)
-include(GNUInstallDirs)
-
 # Use -std=c++14 as default.
 set(CMAKE_CXX_STANDARD 14)
 # Disable C++ extensions
 set(CMAKE_CXX_EXTENSIONS OFF)
 # Require full C++ standard
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
+################################################################################
+#                                                                              #
+#                             FOLDER DEFINITIONS                               #
+#                                                                              #
+################################################################################
+
+# Define standard installation directories (GNU)
+include(GNUInstallDirs)
+
+# Location of the cmake extra files
+set(HELIB_CMAKE_EXTRA_DIR "${PROJECT_SOURCE_DIR}/cmake")
+# Prefix of the header files (directory to be added to the include list)
+set(HELIB_INCLUDE_DIR "${PROJECT_SOURCE_DIR}/include")
+# Location of helib header files
+set(HELIB_HEADER_DIR "${HELIB_INCLUDE_DIR}/helib")
+# Location of the source files
+set(HELIB_SOURCE_DIR "${PROJECT_SOURCE_DIR}/src")
+# Location of the google tests
+set(HELIB_TESTS_DIR "${PROJECT_SOURCE_DIR}/tests")
+# Location of the directory containing the test binary (runTests).
+# Keeping this location relative as it will be changed if PACKAGE_BUILD=ON.
+set(HELIB_TEST_BIN_DIR "bin")
+
+# Setting compiler output directories
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY
+    ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR})
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY
+    ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR})
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY
+    ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR})
+
 # GMP minimal version to be used if not PACKAGE_BUILD
 set(GMP_MINIMAL_VERSION "6.0.0")
 # NTL minimal version to be used if NOT PACKAGE_BUILD
@@ -60,7 +88,7 @@ set_property(CACHE
              STRINGS "Debug" "RelWithDebInfo" "Release" "MinSizeRel")
 
 # Path containing FindGMP.cmake and FindNTL.cmake
-list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
+list(APPEND CMAKE_MODULE_PATH "${HELIB_CMAKE_EXTRA_DIR}")
 
 option(BUILD_SHARED "Build as shared library" OFF)
 
@@ -224,16 +252,6 @@ else (PACKAGE_BUILD)
   # Checks that at least version NTL_MINIMAL_VERSION is available
   find_package(NTL "${NTL_MINIMAL_VERSION}" REQUIRED)
 
-  # Setting compiler output directories
-  set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY
-      ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR})
-  set(CMAKE_LIBRARY_OUTPUT_DIRECTORY
-      ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR})
-  set(CMAKE_RUNTIME_OUTPUT_DIRECTORY
-      ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR})
-  set(CMAKE_RUNTIME_OUTPUT_DIRECTORY
-      ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR})
-
   # Thread enabling checks
   # Checking if NTL is built with NTL_THREADS=on
   set(ntl_config_file "${NTL_INCLUDE_PATHS}/NTL/config.h")
@@ -295,13 +313,24 @@ if (PACKAGE_BUILD)
                -DFETCH_GMP=${FETCH_GMP}
                -DENABLE_TEST=${ENABLE_TEST}
                -DHELIB_DEBUG=${HELIB_DEBUG}
+               -DHELIB_CMAKE_EXTRA_DIR=${HELIB_CMAKE_EXTRA_DIR}
+               -DHELIB_INCLUDE_DIR=${HELIB_INCLUDE_DIR}
+               -DHELIB_HEADER_DIR=${HELIB_HEADER_DIR}
+               -DHELIB_SOURCE_DIR=${HELIB_SOURCE_DIR}
+               -DHELIB_TESTS_DIR=${HELIB_TESTS_DIR}
     BUILD_ALWAYS ON)
 
-  if (ENABLE_TEST)
-    add_test(NAME helib_check
-             COMMAND ${CMAKE_MAKE_PROGRAM} test
-             WORKING_DIRECTORY "${DEPENDENCIES_FOLDER}/Build/helib_external")
-  endif (ENABLE_TEST)
+    if (ENABLE_TEST)
+      # Tests for PACKAGE_BUILD are located in
+      # ${DEPENDENCIES_FOLDER}/Build/helib_external/${HELIB_TEST_BIN_DIR}.
+      # Update its location and add the tests to cmake to avoid re-creating
+      # their targets (as they are already built by ExternalProject_Add)
+      set(HELIB_TEST_BIN_DIR
+          "${DEPENDENCIES_FOLDER}/Build/helib_external/${HELIB_TEST_BIN_DIR}")
+      set(ONLY_ADD_TEST ON)
+      add_subdirectory("${HELIB_TESTS_DIR}" tests)
+      unset(ONLY_ADD_TEST)
+    endif (ENABLE_TEST)
 
   # To install copy the whole PACKAGE_DIR directory to the defined prefix
   install(

INSTALL.md

@@ -80,10 +80,10 @@ make -j16
 4. (optional) If step 2 was performed with `-DENABLE_TEST=ON`, HElib tests can 
 be run as follows:
 ```
-ctest -R helib_check
+ctest
 ```
 Detailed HElib-specific test logs can be found in 
-`dependencies/Build/helib_external/Testing/Temporary/LastTest.log`.
+`Testing/Temporary/LastTest.log`.
 
 5. (optional) Run the install step, to copy the folder `helib_pack` to
 `${CMAKE_INSTALL_PREFIX}` (in this example `/home/alice/helib_install`):

TESTS.md

@@ -5,15 +5,19 @@
    downloaded and the correct targets will be defined for cmake.
 2. To compile them, `make` as normal from a build directory.
 3. The entire set of tests can be run with:
-    - `./bin/runTests`.  The parameters `noPrint`, `dry` and `verbose` can be
-       specified as before, but they will apply to all tests which are run.
+    - `./bin/runTests` or `./dependencies/Build/helib_external/bin/runTests` if
+      `PACKAGE_BUILD=ON`.  The parameters `noPrint`, `dry` and `verbose` can be
+      specified as before, but they will apply to all tests which are run.
     - `ctest`.  In this case the output will be significantly less verbose and
-       therefore less helpful in the case of a failure.  The parameter
-       `--output-on-failure` will display the output of each test that happened
-       to fail.  It's possible to run tests in parallel by using
-       `-j<number of concurrent tests>`
+      therefore less helpful in the case of a failure.  The parameter
+      `--output-on-failure` can be added to display the output of each test that
+      happened to fail.  It is also possible to run tests in parallel by using
+      `-j<number of concurrent tests>`.  Detailed output of the tests (as if run
+      directly with `runTests`) can be found in
+      `Testing/Temporary/LastTest.log`.
     - `make test`, which will run the tests through `ctest`.  In this case no
-      arguments can be passed.
+      arguments can be passed.  Detailed output of the tests (as if run directly
+      with `runTests`) can be found in `Testing/Temporary/LastTest.log`.
 
 ## Running a subset of the tests
 
@@ -23,7 +27,7 @@ tests, for example, one simply runs
 ```
 ./bin/runTests --gtest_filter='*PolyEval*'
 ```
-To list all the tests, use `./bin/runTests --gtest_list_tests`. More details
+To list all the tests, use `./bin/runTests --gtest_list_tests`.  More details
 on this filtering can be found in Google's documentation [here][1].
 
 It is also possible to run a specific test using `ctest` by adding the argument
@@ -32,8 +36,8 @@ simply runs
 ```
 ctest -R "PolyEval"
 ```
-More details on this filtering can be found in `ctest` documentation
-`ctest --help`.
+To list all the tests, use `ctest -N`.  More details on this filtering can be
+found in the `ctest` documentation `ctest --help`.
 
 ## Changing parameters
 

dependencies/gmp/CMakeLists.txt

@@ -61,13 +61,7 @@ ExternalProject_Add(
     # LOG_TEST ON
 )
 
-if (ENABLE_TEST)
-  set(test_path "${DEPENDENCIES_FOLDER}/Source/gmp_fetched")
-  add_test(NAME gmp_check
-           COMMAND ${CMAKE_MAKE_PROGRAM} check
-           WORKING_DIRECTORY ${test_path})
-  unset(test_path)
-endif (ENABLE_TEST)
+# No tests will be performed for GMP
 
 # Removed due to rpath delay
 # add_dependencies(gmp_external gmp_fetched)

dependencies/ntl/CMakeLists.txt

@@ -100,13 +100,7 @@ ExternalProject_Add(
     # LOG_TEST ON
 )
 
-if (ENABLE_TEST)
-  set(test_path "${DEPENDENCIES_FOLDER}/Source/ntl_fetched/src")
-  add_test(NAME ntl_check
-           COMMAND ${CMAKE_MAKE_PROGRAM} check
-           WORKING_DIRECTORY ${test_path})
-  unset(test_path)
-endif (ENABLE_TEST)
+# No tests will be performed for NTL
 
 # Removing static library libntl.a.
 set(ntl_static_lib

src/CMakeLists.txt

@@ -16,12 +16,8 @@ project(helib
         VERSION 1.1.0
         LANGUAGES CXX)
 
-# Location of the header files
-set(PROJECT_INCLUDE_DIR "${PROJECT_SOURCE_DIR}/../include")
-# Location of the google tests
-set(PROJECT_TESTS_DIR "${PROJECT_SOURCE_DIR}/../tests")
-# Location of helib headers
-set(HELIB_HEADER_DIR "${PROJECT_INCLUDE_DIR}/helib")
+# Globals HELIB_CMAKE_EXTRA_DIR, HELIB_INCLUDE_DIR, HELIB_HEADER_DIR,
+# HELIB_SOURCE_DIR and HELIB_TESTS_DIR are previously set and forwarded here.
 
 # We assume enable threads is passed correctly (already checked)
 if (HELIB_REQUIRES_PTHREADS)
@@ -30,6 +26,16 @@ endif (HELIB_REQUIRES_PTHREADS)
 
 include(GNUInstallDirs)
 
+if (PACKAGE_BUILD)
+  # Setting compiler output directories if not inherited from above (if PACKAGE_BUILD=ON)
+  set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY
+      ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR})
+  set(CMAKE_LIBRARY_OUTPUT_DIRECTORY
+      ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR})
+  set(CMAKE_RUNTIME_OUTPUT_DIRECTORY
+      ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR})
+endif (PACKAGE_BUILD)
+
 # Setting up cmake install directories
 if (WIN32 AND NOT CYGWIN)
   set(CMAKE_INSTALL_CMAKEDIR "CMake")
@@ -49,7 +55,7 @@ configure_file(version.in.cpp
 if (ENABLE_TEST)
   # Download and unpack googletest at configure time
   message(STATUS "Setting up googletest framework")
-  configure_file("${PROJECT_SOURCE_DIR}/../cmake/gtest.cmake"
+  configure_file("${HELIB_CMAKE_EXTRA_DIR}/gtest.cmake"
                  "${CMAKE_CURRENT_BINARY_DIR}/googletest-download/CMakeLists.txt")
   execute_process(
       COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" .
@@ -247,7 +253,7 @@ target_include_directories(
     PUBLIC # NOTE: The includes must be kept in this order to avoid cmake
            # looking for HElib in /usr/local/include
            # Headers used from source/build location:
-           "$<BUILD_INTERFACE:${PROJECT_INCLUDE_DIR}>"
+           "$<BUILD_INTERFACE:${HELIB_INCLUDE_DIR}>"
            # Adding CMAKE_CURRENT_BINARY_DIR to include files to access the
            # auto-generated version.h file.
            "$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>"
@@ -301,7 +307,10 @@ if (BUILD_SHARED)
 endif (BUILD_SHARED)
 
 if (ENABLE_TEST)
-  add_subdirectory("${PROJECT_TESTS_DIR}" tests)
+  # Add tests target (so they will be built) and all tests to cmake.
+  set(ONLY_ADD_TEST OFF)
+  add_subdirectory("${HELIB_TESTS_DIR}" tests)
+  unset(ONLY_ADD_TEST)
 endif (ENABLE_TEST)
 
 # Installing helib
@@ -332,7 +341,7 @@ write_basic_package_version_file(
 
 # Generating the basic helibConfig.cmake file
 configure_package_config_file(
-    ${PROJECT_SOURCE_DIR}/../cmake/helibConfig.cmake.in
+    ${HELIB_CMAKE_EXTRA_DIR}/helibConfig.cmake.in
     ${CMAKE_CURRENT_BINARY_DIR}/helibConfig.cmake
     INSTALL_DESTINATION ${CMAKE_INSTALL_CMAKEDIR})