From bbb9c911b5734167df38fe0700bac630694a0fdc Mon Sep 17 00:00:00 2001
From: Thomas Madlener <thomas.madlener@desy.de>
Date: Thu, 11 Jan 2024 17:23:52 +0100
Subject: [PATCH] Make sure that LCIO installations are cleanly consumable with
 builtin SIO (#184)

* Add a small downstream project for testing

* Build downstream project in CI

* Update CMake config template to work with new sio packaging

* Bump minimum required SIO version to v00-01
---
 .github/workflows/key4hep.yml                 |  7 ++++++
 .github/workflows/linux.yml                   |  7 ++++++
 CMakeLists.txt                                |  4 ++--
 cmake/LCIOConfig.cmake.in                     |  7 +-----
 .../CMakeLists.txt                            | 15 +++++++++++++
 .../lcio_test_program.cpp                     | 22 +++++++++++++++++++
 6 files changed, 54 insertions(+), 8 deletions(-)
 create mode 100644 tests/downstream-project-cmake-test/CMakeLists.txt
 create mode 100644 tests/downstream-project-cmake-test/lcio_test_program.cpp

diff --git a/.github/workflows/key4hep.yml b/.github/workflows/key4hep.yml
index 9db920284..1b74f57da 100644
--- a/.github/workflows/key4hep.yml
+++ b/.github/workflows/key4hep.yml
@@ -28,3 +28,10 @@ jobs:
           make -k
           make install
           ctest --output-on-failure
+          echo "::group::Test downstream build"
+          cd -
+          export CMAKE_PREFIX_PATH=$PWD/install:$CMAKE_PREFIX_PATH
+          cd tests/downstream-project-cmake-test
+          mkdir build && cd build
+          cmake .. -DCMAKE_CXX_STANDARD=17
+          make -k
diff --git a/.github/workflows/linux.yml b/.github/workflows/linux.yml
index f93a904a3..084e222cb 100644
--- a/.github/workflows/linux.yml
+++ b/.github/workflows/linux.yml
@@ -30,3 +30,10 @@ jobs:
           make -k
           make install
           ctest --output-on-failure
+          echo "::group::Test downstream build"
+          cd -
+          export CMAKE_PREFIX_PATH=$PWD/install:$CMAKE_PREFIX_PATH
+          cd tests/downstream-project-cmake-test
+          mkdir build && cd build
+          cmake .. -DCMAKE_CXX_STANDARD=17
+          make -k
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 4f2a3231e..d44a9424d 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -161,8 +161,8 @@ eval $*
 
 ENDIF()
 
-# Deal with SIO
-FIND_PACKAGE( SIO QUIET )
+# Deal with SIO (we need at least 0.1 since there are no targets before)
+FIND_PACKAGE( SIO 0.1 QUIET )
 
 IF( NOT SIO_FOUND )
   MESSAGE( STATUS "SIO not found on your system. Using builtin sio" )
diff --git a/cmake/LCIOConfig.cmake.in b/cmake/LCIOConfig.cmake.in
index e1b545636..ef304a1d6 100644
--- a/cmake/LCIOConfig.cmake.in
+++ b/cmake/LCIOConfig.cmake.in
@@ -68,12 +68,7 @@ CHECK_PACKAGE_LIBS( LCIO lcio @CHECK_PACKAGE_SIO_LIBRARY@ )
 
 
 include(CMakeFindDependencyMacro)
-if("@CHECK_PACKAGE_SIO_LIBRARY@" STREQUAL "") 
-  find_dependency(SIO REQUIRED)
-else()
-  find_dependency(ZLIB REQUIRED)
-  include("${CMAKE_CURRENT_LIST_DIR}/SIOTargets.cmake")
-endif()
+find_dependency(SIO @SIO_VERSION@)
 
 # Include the targets file to create the imported targets that a client can link
 # to or execute
diff --git a/tests/downstream-project-cmake-test/CMakeLists.txt b/tests/downstream-project-cmake-test/CMakeLists.txt
new file mode 100644
index 000000000..77f70f5c2
--- /dev/null
+++ b/tests/downstream-project-cmake-test/CMakeLists.txt
@@ -0,0 +1,15 @@
+cmake_minimum_required(VERSION 3.14)
+
+project(DownstreamProjectUsingLCIO)
+
+find_package(LCIO REQUIRED)
+
+# Make sure that the LCIO version is set and usableas a version
+if (${LCIO_VERSION} VERSION_GREATER "0.0.0")
+  message(STATUS "Found LCIO version " ${LCIO_VERSION})
+else()
+  message(FATAL_ERROR "Cannot determine LCIO_VERSION")
+endif()
+
+add_executable(lcio_test_program lcio_test_program.cpp)
+target_link_libraries(lcio_test_program PRIVATE LCIO::lcio)
diff --git a/tests/downstream-project-cmake-test/lcio_test_program.cpp b/tests/downstream-project-cmake-test/lcio_test_program.cpp
new file mode 100644
index 000000000..a53be69fa
--- /dev/null
+++ b/tests/downstream-project-cmake-test/lcio_test_program.cpp
@@ -0,0 +1,22 @@
+#include "EVENT/LCEvent.h"
+#include "IMPL/LCCollectionVec.h"
+#include "IMPL/LCEventImpl.h"
+#include "IMPL/MCParticleImpl.h"
+#include "MT/LCWriter.h"
+
+int main() {
+  auto mcp = new IMPL::MCParticleImpl();
+  mcp->setPDG(11);
+
+  auto coll = new IMPL::LCCollectionVec(EVENT::LCIO::MCPARTICLE);
+  coll->addElement(mcp);
+
+  auto event = new IMPL::LCEventImpl();
+  event->addCollection(coll, "mcps");
+
+  auto writer = MT::LCWriter();
+  writer.open("test.slcio");
+  writer.writeEvent(event);
+
+  return 0;
+}