[WIP] Migrate examples to standalone tests

Author: LecrisUT

cmake/FortunoTestHelpers.cmake

@@ -0,0 +1,64 @@
+# This file is part of Fortuno.
+# Licensed under the BSD-2-Clause Plus Patent license.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+
+function(Fortuno_add_test test)
+  #[===[.md
+  # Fortuno_add_test
+
+  Internal helper for adding functional tests testing whole CMake projects.
+
+  ## Synopsis
+  ```cmake
+  Template_add_test(<name>
+    [TEST_NAME <test_name>]
+    [TARGET <target>]
+  )
+  ```
+
+  ## Options
+
+  `<name>`
+  : Path to the CMake project to be executed relative to `${CMAKE_CURRENT_SOURCE_DIR}`
+
+  `TEST_NAME` [Default: `<name>`]
+  : Name for the test to be used as the ctest name
+  ]===]
+
+  set(ARGS_Options)
+  set(ARGS_OneValue
+    TEST_NAME
+  )
+  set(ARGS_MultiValue)
+  cmake_parse_arguments(PARSE_ARGV 1 ARGS "${ARGS_Options}" "${ARGS_OneValue}" "${ARGS_MultiValue}")
+
+  # Check required/optional arguments
+  if (ARGC LESS 1)
+    message(FATAL_ERROR "Missing test name")
+  endif ()
+  if (NOT DEFINED ARGS_TEST_NAME)
+    set(ARGS_TEST_NAME ${test})
+  endif ()
+
+  set(configure_args
+    -DCMAKE_Fortran_COMPILER=${CMAKE_Fortran_COMPILER}
+  )
+  if (Fortuno_IS_TOP_LEVEL)
+    list(APPEND configure_args
+      # Generated Config file point to binary targets until it is installed
+      -DTemplate_ROOT=${Fortuno_BINARY_DIR}
+      -DFETCHCONTENT_SOURCE_DIR_FORTUNO=${Template_SOURCE_DIR}
+    )
+  endif ()
+
+  add_test(NAME ${ARGS_TEST_NAME}
+    COMMAND ${CMAKE_CTEST_COMMAND} --build-and-test ${CMAKE_CURRENT_SOURCE_DIR}/${test}
+    ${CMAKE_CURRENT_BINARY_DIR}/${test}
+    # Use the same build environment as the current runner
+    --build-generator "${CMAKE_GENERATOR}"
+    --build-options ${configure_args}
+    --test-command ${CMAKE_CTEST_COMMAND}
+      --test-dir ${CMAKE_CURRENT_BINARY_DIR}/${test}
+      --output-on-failure
+  )
+endfunction()

config.cmake

@@ -15,7 +15,12 @@ option(FORTUNO_WITH_COARRAY "Fortuno: whether library with coarray interface sho
 
 option(FORTUNO_WITH_TESTS "Fortuno: whether to build test suite" ${PROJECT_IS_TOP_LEVEL})
 
-option(FORTUNO_WITH_EXAMPLES "Fortuno: whether to build example apps" ${PROJECT_IS_TOP_LEVEL})
+if (FORTUNO_WITH_EXAMPLES)
+  message(WARNING
+      "FORTUNO_WITH_EXAMPLES is deprecated and has no effect. "
+      "This is now part of the tests"
+  )
+endif ()
 
 option(FORTUNO_INSTALL "Fortuno: Install project" ${PROJECT_IS_TOP_LEVEL})
 

example/coarray/CMakeLists.txt

@@ -2,33 +2,37 @@
 # Licensed under the BSD-2-Clause Plus Patent license.
 # SPDX-License-Identifier: BSD-2-Clause-Patent
 
-list(APPEND CMAKE_MESSAGE_CONTEXT Coarray)
-
-add_library(fortuno_example_coarray_mylib)
-set_target_properties(
-  fortuno_example_coarray_mylib PROPERTIES
-  OUTPUT_NAME mylib
+project(coarray-example
+  LANGUAGES Fortran
 )
+
+find_package(Fortuno CONFIG REQUIRED)
+
+# TODO: decouple this from config.cmake setup
+include(../../config.cmake)
+
+add_library(mylib)
 target_sources(
-  fortuno_example_coarray_mylib PRIVATE
+  mylib PRIVATE
   mylib.f90
 )
-target_compile_options(fortuno_example_coarray_mylib PRIVATE ${FORTUNO_FFLAGS_COARRAY})
-target_link_options(fortuno_example_coarray_mylib PRIVATE ${FORTUNO_LDFLAGS_COARRAY})
+target_compile_options(mylib PRIVATE ${FORTUNO_FFLAGS_COARRAY})
+target_link_options(mylib PRIVATE ${FORTUNO_LDFLAGS_COARRAY})
 
-add_executable(fortuno_example_coarray_testapp)
-set_target_properties(
-  fortuno_example_coarray_testapp PROPERTIES
-  OUTPUT_NAME testapp
-)
+add_executable(testapp)
 target_sources(
-  fortuno_example_coarray_testapp PRIVATE
+  testapp PRIVATE
   test_simple.f90
   testapp.f90
 )
 target_link_libraries(
-  fortuno_example_coarray_testapp PRIVATE
-  fortuno_example_coarray_mylib Fortuno::fortuno_coarray
+  testapp PRIVATE
+  mylib Fortuno::fortuno_coarray
+)
+target_compile_options(testapp PRIVATE ${FORTUNO_FFLAGS_COARRAY})
+target_link_options(testapp PRIVATE ${FORTUNO_LDFLAGS_COARRAY})
+
+enable_testing()
+add_test(NAME fortuno_test
+    COMMAND testapp
 )
-target_compile_options(fortuno_example_coarray_testapp PRIVATE ${FORTUNO_FFLAGS_COARRAY})
-target_link_options(fortuno_example_coarray_testapp PRIVATE ${FORTUNO_LDFLAGS_COARRAY})

test/CMakeLists.txt

@@ -4,4 +4,7 @@
 
 list(APPEND CMAKE_MESSAGE_CONTEXT Test)
 
+include(FortunoTestHelpers)
+
 add_subdirectory(unit)
+add_subdirectory(example)

example/CMakeLists.txt renamed to test/example/CMakeLists.txt

@@ -2,34 +2,32 @@
 # Licensed under the BSD-2-Clause Plus Patent license.
 # SPDX-License-Identifier: BSD-2-Clause-Patent
 
-list(APPEND CMAKE_MESSAGE_CONTEXT Example)
-
 if (FORTUNO_WITH_SERIAL)
-  add_subdirectory(serial)
+  Fortuno_add_test(serial)
   if (FORTUNO_WITH_FPP)
-    add_subdirectory(serial-fpp)
+    Fortuno_add_test(serial-fpp)
   endif ()
   if (FYPP)
-    add_subdirectory(serial-fypp)
+    Fortuno_add_test(serial-fypp)
   endif ()
 endif ()
 
 if (FORTUNO_WITH_MPI)
-  add_subdirectory(mpi)
+  Fortuno_add_test(mpi)
   if (FORTUNO_WITH_FPP)
-    add_subdirectory(mpi-fpp)
+    Fortuno_add_test(mpi-fpp)
   endif ()
   if (FYPP)
-    add_subdirectory(mpi-fypp)
+    Fortuno_add_test(mpi-fypp)
   endif ()
 endif ()
 
 if (FORTUNO_WITH_COARRAY)
-  add_subdirectory(coarray)
+  Fortuno_add_test(coarray)
   if (FORTUNO_WITH_FPP)
-    add_subdirectory(coarray-fpp)
+    Fortuno_add_test(coarray-fpp)
   endif ()
   if (FYPP)
-    add_subdirectory(coarray-fypp)
+    Fortuno_add_test(coarray-fypp)
   endif ()
 endif ()

test/example/coarray

@@ -0,0 +1 @@
+../../example/coarray

test/example/coarray-fpp

@@ -0,0 +1 @@
+../../example/coarray-fpp

test/example/coarray-fypp

@@ -0,0 +1 @@
+../../example/coarray-fypp

test/example/mpi

@@ -0,0 +1 @@
+../../example/mpi

test/example/mpi-fpp

@@ -0,0 +1 @@
+../../example/mpi-fpp