Add unit tests and run them in the CI

Author: guitargeek

.github/workflows/clang-tidy-review.yml

@@ -30,13 +30,22 @@ jobs:
 
       - name: install lit
         run: pip install lit
-        
+
       - name: Run clang-tidy
         uses: ZedThree/clang-tidy-review@v0.21.0
         id: review
         with:
           build_dir: build
-          apt_packages: cmake,libxml2,libxml2-dev,libtinfo-dev,zlib1g-dev,libzstd-dev,wget,libvdt-dev
+          apt_packages:
+            - cmake
+            - libgtest-dev
+            - libtinfo-dev
+            - libvdt-dev
+            - libxml2
+            - libxml2-dev
+            - libzstd-dev
+            - wget
+            - zlib1g-dev
           split_workflow: true
           config_file: .clang-tidy
           cmake_command: >

.github/workflows/cvmfs-ci.yml

@@ -76,6 +76,7 @@ jobs:
                 -DCMAKE_INSTALL_PREFIX=../install \
                 -DCMAKE_BUILD_TYPE=RelWithDebInfo \
                 -DINSTALL_PYTHON=FALSE \
+                -DBUILD_TESTS=TRUE \
                 ..;
           make install -j$(nproc);
           cd ..;
@@ -103,8 +104,21 @@ jobs:
             root --version
             combine --help
 
+      - name: Run Tests
+        if: ${{ env.CMSSW_VERSION == '' }}
+        env:
+          LCG_RELEASE: ${{ matrix.LCG_RELEASE }}
+          LCG_ARCH: ${{ matrix.LCG_ARCH }}
+        run: >-
+          source /cvmfs/sft.cern.ch/lcg/views/${LCG_RELEASE}/${LCG_ARCH}/setup.sh;
+          source virtualenv/bin/activate;
+          cd build;
+          ctest --output-on-failure -j$(nproc) .;
+
       - uses: ./.github/actions/run-in-cvmfs
         name: Counting datacard
+        # Only run this test in CMSSW mode, because otherwise we already run this in the unit tests
+        if: ${{ env.CMSSW_VERSION != '' }}
         with:
           script: |
             text2workspace.py  data/tutorials/multiDim/toy-hgg-125.txt -m 125 -P HiggsAnalysis.CombinedLimit.PhysicsModel:floatingXSHiggs --PO modes=ggH,qqH

CMakeLists.txt

@@ -5,6 +5,7 @@ project(HiggsAnalysisCombinedLimit VERSION 0.0.1)
 option( MODIFY_ROOTMAP "Modify generated Rootmap to take out classes already bundled in StatAnalysis" FALSE )
 option( INSTALL_PYTHON "Install the Python library and scripts" TRUE )
 option( USE_VDT "Use VDT (fast and vectorisable mathematical functions)" TRUE )
+option( BUILD_TESTS "Build tests" FALSE )
 
 # Can build with CMake after e.g. setting up StatAnalysis release like this:
 # export ATLAS_LOCAL_ROOT_BASE=/cvmfs/atlas.cern.ch/repo/ATLASLocalRootBase
@@ -132,3 +133,11 @@ if(INSTALL_PYTHON)
   INSTALL(FILES ${empty_init_py} DESTINATION ${Python_SITELIB_IN_PREFIX}/HiggsAnalysis)
   INSTALL(FILES ${empty_init_py} DESTINATION ${Python_SITELIB_IN_PREFIX}/HiggsAnalysis/CombinedLimit)
 endif()
+
+
+if(BUILD_TESTS)
+  find_package(GTest 1.10 REQUIRED)
+
+  enable_testing()
+  add_subdirectory(test)
+endif()

test/CMakeLists.txt

@@ -0,0 +1,28 @@
+# Set the location of text2workspace.py, assuming installation to a virtual
+# environment inside the source directory.
+set(t2w ${CMAKE_SOURCE_DIR}/virtualenv/bin/text2workspace.py)
+
+# Counting datacard - text2workspace
+ROOT_ADD_TEST(counting_datacard-t2w
+    COMMAND ${t2w} toy-hgg-125.txt -m 125 -P HiggsAnalysis.CombinedLimit.PhysicsModel:floatingXSHiggs --PO modes=ggH,qqH
+    COPY_TO_BUILDDIR ${CMAKE_SOURCE_DIR}/data/tutorials/multiDim/toy-hgg-125.txt
+    FIXTURES_SETUP counting_datacard
+    # Append the build directory to the library Path to we can use Combine classes
+    ENVIRONMENT LD_LIBRARY_PATH=${CMAKE_BINARY_DIR}:$ENV{LD_LIBRARY_PATH}
+)
+
+# Counting datacard - combine
+ROOT_ADD_TEST(counting_datacard
+    COMMAND combine -M MultiDimFit toy-hgg-125.root  --setParameterRanges r=-1,1
+    FIXTURES_REQUIRED counting_datacard # requires corresponding text2workspace run
+    # We compare the output to reference files to validate the best-fit parameter values
+    WORKING_DIR ${CMAKE_CURRENT_BINARY_DIR}
+    CHECKOUT
+    OUTPUT counting_datacard.out
+    OUTREF ${CMAKE_CURRENT_SOURCE_DIR}/references/counting_datacard.out
+    # For this test, we are not interested in the standard error, but you could
+    # compare this too:
+    # CHECKERR
+    # ERROR counting_datacard.err
+    # ERRREF ${CMAKE_CURRENT_SOURCE_DIR}/references/counting_datacard.err
+)

test/references/counting_datacard.out

@@ -0,0 +1,11 @@
+ <<< Combine >>> 
+ <<< v10.2.1 >>>
+>>> Random number generator seed is 123456
+>>> Method used is MultiDimFit
+Warning: Did not find a parameter with name r
+Doing initial fit: 
+
+ --- MultiDimFit ---
+best fit parameter values: 
+   r_ggH :    +0.882
+   r_qqH :    +4.683