[test-suite] Robust warnings for Fortran Test Suite tests that require Ninja.

[naromero77]

Summary

• Add CMake issue number to Fortran Test Suite warning.
• Add CMake issue number in CMake Fortran module.
• Add ninja_required helper function.
• Add ninja_required to SPEC2017 CPU ROMS floating point tests.

[Meinersbur]

CMakeLists.txt

10–11

Assuming that we add ninja_required() to every test that needs it, this warning is unnecessary.

If such a test is included in TEST_SUITE_SUBDRS: Get warning and error
Otherwise: Warning does not apply

cmake/modules/Fortran.cmake

4

Wrap line?

9–19

Thanks for the explanation

[naromero77]

CMakeLists.txt

10–11

Your suggestion is to just get rid of the warning in the top-level CMakeLists.txt completely, since its redundant with ninja_required()?

Can you confirm?

[Meinersbur]

CMakeLists.txt

10–11

Correct

[naromero77]

• Get rid of redudant warning in top-level CMakeLists when Ninja is not used.
• Improve line wrapping.

[Meinersbur]

LGTM

CMakeLists.txt

 cmake_minimum_required(VERSION 3.13.4)
 
 include(CheckSymbolExists)
 
 option(TEST_SUITE_FORTRAN "Enable Fortran test suite" OFF)
 
 project(test-suite C CXX)
 
 if(TEST_SUITE_FORTRAN)
   enable_language(Fortran)
-  if(NOT CMAKE_GENERATOR STREQUAL "Ninja")
-      message(WARNING
-  "Fortran test suite may NOT build with this CMAKE_GENERATOR = ${CMAKE_GENERATOR}.\n"
-  "Recommend using Ninja 1.10 or later by adding -G \"Ninja\" to cmake invocation.")
-  endif()
 endif()
 
 function(append value)
   foreach(variable ${ARGN})
     set(${variable} "${${variable}} ${value}" PARENT_SCOPE)
   endforeach(variable)
 endfunction()
 
 # The test-suite is designed to be built in release mode anyway and

External/SPEC/CFP2017rate/554.roms_r/CMakeLists.txt

 # https://www.spec.org/cpu2017/Docs/benchmarks/554.roms_r.html
 include(../../SpecCPU2017.cmake)
 if (NOT TEST_SUITE_SPEC2017_ROOT)
   return ()
 endif ()
 
+ninja_required()
+
 speccpu2017_benchmark(RATE)
 
 speccpu2017_add_include_dirs(.)
 
 # SPEC benchmark uses customized version of filepp, called specpp.
 # However, these additional filepp flags do not make any impact
 # to the benchmark results. This note serves a a reminder.
 # set(MODULE_SPECPP_DIR "${TEST_SUITE_SPEC2017_ROOT}/bin/modules.specpp")

External/SPEC/SpecCPU2017.cmake

 # SPEC CPU 2017
 # https://www.spec.org/cpu2017/Docs/
 
 include(External)
 include(CopyDir)
 include(Host)
+include(Fortran)
 
 # Search for SPEC CPU 2017 root directory.
 llvm_externals_find(TEST_SUITE_SPEC2017_ROOT "speccpu2017" "SPEC CPU2017")
 if (NOT TEST_SUITE_SPEC2017_ROOT)
   return ()
 endif ()
 
 # Print warnings once only, even if included multiple times.

cmake/modules/Fortran.cmake

+##===- Fortran.cmake ----------------------------------------------------===##
+#
+# Fortran-specific helper functions to build benchmarks and the
+# corresponding .test files
+#
+##===--------------------------------------------------------------------===##
+
+
+# The Ninja generator supports robust scanning for modules that are
+# needed by some Fortran tests. Because Ninja does a full
+# preprocessing pass on Fortran files, it is able to detect module
+# dependencies that are dependent on preprocessing.
+# For example,
+# #ifdef FOO 
+# USE MODULE_A
+# #else
+# USE MODULE_B
+# #endif
+# This is support by Ninja, but not the Unix Makefiles generator.
+# More details here:
+# https://gitlab.kitware.com/cmake/cmake/-/issues/16590"
+
+function(ninja_required)
+  if(NOT CMAKE_GENERATOR STREQUAL "Ninja")
+    message(SEND_ERROR
+      "This test is NOT supported by CMAKE_GENERATOR = ${CMAKE_GENERATOR}.\n"
+      "Please use use Ninja 1.10 or later by adding -G \"Ninja\" to cmake invocation.\n")
+  endif()
+endfunction()