improved build and CI (#601)

Erich (build):
- adjusted install interface paths to use CMAKE_INSTALL_INCLUDEDIR
- added platform-agnostic RPATH handling via helper function setup_quest_rpath
- set RPATH origin for dynamic linking
- passed QuEST version info to CMake

Tyson (CI):
- run compiled examples to test for link-time errors
- temporarily disabled LCOV reporting to PRs

---------

Co-authored-by: Tyson Jones <[email protected]>

Author: eessmann

.github/workflows/audit.yml

@@ -188,3 +188,8 @@ jobs:
           coverage-files: ./${{ env.tracefile }}
           minimum-coverage: ${{ env.min_coverage }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
+
+        # temporarily DISABLING above reporting of LCOV results in
+        # PR since they're not yet representative and will only
+        # confuse incoming unitaryHACK contributors
+        if: false

.github/workflows/compile.yml

@@ -7,7 +7,9 @@
 # compilers (like libomp, CUDA, ROCm). Compilation
 # includes the v4 unit and integration tests, the
 # deprecated v3 tests (when possible), and all the
-# example programs. No compiled execs are run however.
+# example programs. One example executable is then
+# run (both C and C++ versions) to ensure the build
+# was successful and does not cause link-time errors.
 # Note that ARM compilation is not yet tested here,
 # but in fact Linux ARM is used by a paid test runner.
 #
@@ -144,6 +146,8 @@ jobs:
       cuda_arch: 70
       hip_arch: gfx801
       rocm_path: /opt/rocm/bin
+      example_dir: build/examples/isolated
+      example_fn_pref: reporting_quregs
 
     # perform the job
     steps:
@@ -232,3 +236,16 @@ jobs:
       # force 'Release' build (needed by MSVC to enable optimisations)
       - name: Compile
         run: cmake --build ${{ env.build_dir }} --config Release --parallel
+
+      # attempt to run the compiled executable, testing for link-time errors,
+      # logging stdout and stderr to file (to verify the executable actually ran)
+      - name: Run (Windows)
+        if: ${{ matrix.os == 'windows-latest' }}
+        run: |
+          ./${{ env.example_dir }}/Release/${{ env.example_fn_pref }}_c.exe
+          ./${{ env.example_dir }}/Release/${{ env.example_fn_pref }}_cpp.exe
+      - name: Run (non-Windows)
+        if: ${{ matrix.os != 'windows-latest' }}
+        run: |
+          ./${{ env.example_dir }}/${{ env.example_fn_pref }}_c
+          ./${{ env.example_dir }}/${{ env.example_fn_pref }}_cpp

CMakeLists.txt

@@ -250,11 +250,15 @@ add_library(QuEST::QuEST ALIAS QuEST)
 
 # Set include directories
 target_include_directories(QuEST
-  PUBLIC
-  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/quest/include>
-  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
-  $<INSTALL_INTERFACE:../quest/include>
-  $<INSTALL_INTERFACE:..>
+        PUBLIC
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/quest/include>
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+        $<INSTALL_INTERFACE:${ORG_INSTALL_PATH}>
+)
+set_target_properties(QuEST PROPERTIES
+        VERSION     ${PROJECT_VERSION}
+        SOVERSION   ${PROJECT_VERSION_MAJOR}
 )
 
 # Add required C and C++ standards
@@ -436,15 +440,34 @@ install(TARGETS min_example
   RUNTIME
   DESTINATION ${CMAKE_INSTALL_BINDIR}
 )
-set_target_properties(min_example
-  PROPERTIES 
-    INSTALL_RPATH "${CMAKE_INSTALL_FULL_LIBDIR}"
-)
 
 if (BUILD_EXAMPLES)
   add_subdirectory(examples)
 endif()
 
+## RATH
+set(BUILD_RPATH_USE_ORIGIN ON)
+if(APPLE)
+  set(_RPATH_ORIGIN "@loader_path")
+else()
+  set(_RPATH_ORIGIN "$ORIGIN")
+endif()
+
+set(_INSTALL_RPATH  "${_RPATH_ORIGIN}/../${CMAKE_INSTALL_LIBDIR}")
+set(_BUILD_RPATH    "${_RPATH_ORIGIN};$<TARGET_FILE_DIR:QuEST>")
+
+# A tiny helper function so you can call it for every target
+function(setup_quest_rpath tgt)
+  set_target_properties(${tgt} PROPERTIES
+          BUILD_RPATH   "${_BUILD_RPATH}"
+          INSTALL_RPATH "${_INSTALL_RPATH}"
+          # keeps RPATH from being stripped when installing
+          INSTALL_RPATH_USE_LINK_PATH TRUE
+  )
+endfunction()
+
+setup_quest_rpath(QuEST)
+setup_quest_rpath(min_example)
 ## User Source
 
 if (USER_SOURCE AND NOT OUTPUT_EXE)
@@ -459,9 +482,10 @@ if (USER_SOURCE AND OUTPUT_EXE)
   add_executable(${OUTPUT_EXE} ${USER_SOURCE})
   target_link_libraries(${OUTPUT_EXE} PUBLIC QuEST)
   install(TARGETS ${OUTPUT_EXE} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
-  set_target_properties(${OUTPUT_EXE} PROPERTIES INSTALL_RPATH "${CMAKE_INSTALL_FULL_LIBDIR}")
+  setup_quest_rpath(${OUTPUT_EXE})
 endif()
 
+
 ## Tests
 
 if (ENABLE_TESTING)