<TBBAS-2530> Add CI script installing prebuilt openDAQ, building module, running tests, and uploading reports

Author: Aliaksandr Adziareika

.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: Build and Test example module
+
+on:
+  pull_request:
+    branches:
+      - main
+      - jira/*
+
+jobs:
+    build-and-test:
+      runs-on: ubuntu-latest
+      steps:
+        - name: Checkout repo
+          uses: actions/checkout@v4
+
+        - name: Install dependencies
+          run: |
+            sudo apt-get update && sudo apt-get install -y git wget cmake ninja-build mono-complete g++ libgmock-dev
+            wget -v https://docs.opendaq.com/download/SDK/opendaq-3.20.4-ubuntu22.04-x86_64.deb -O /tmp/opendaq.deb
+            sudo dpkg -i /tmp/opendaq.deb || sudo apt-get install -f -y
+
+        - name: Configure CMake 
+          run: cmake -B build/output -S . -G Ninja -DOPENDAQ_ENABLE_TESTS=ON -DCMAKE_BUILD_TYPE=Release
+
+        - name: Build
+          run: cmake --build build/output --target all
+
+        - name: Run tests with GTest report
+          run: |
+            mkdir -p build/reports
+            export GTEST_OUTPUT=xml:$(pwd)/build/reports/gtest-report.xml
+            ctest --test-dir build/output --output-on-failure -V
+
+        - name: Upload test report artifact
+          if: always()
+          uses: actions/upload-artifact@v4
+          with:
+            name: gtest-report
+            path: build/reports/gtest-report.xml

CMakeLists.txt

@@ -30,6 +30,11 @@ if(OPENDAQ_DEVICE_EXAMPLE_ENABLE_SERVER_APP)
 	set(OPENDAQ_ENABLE_NATIVE_STREAMING ON CACHE BOOL "" FORCE)
 endif()
 
+if (OPENDAQ_ENABLE_TESTS)
+    message(STATUS "Unit tests are ENABLED")
+    enable_testing()
+endif()
+
 add_subdirectory(external)
 add_subdirectory(example_module)
 

example_module/src/CMakeLists.txt

@@ -37,6 +37,7 @@ if (MSVC)
     target_compile_options(${LIB_NAME} PRIVATE /bigobj)
 endif()
 
+find_package(openDAQ 3.20.4 REQUIRED)
 target_link_libraries(${LIB_NAME} PUBLIC daq::opendaq
 )
 

example_module/tests/CMakeLists.txt

@@ -8,10 +8,37 @@ set(TEST_SOURCES test_example_module.cpp
 add_executable(${TEST_APP} ${TEST_SOURCES}
 )
 
-target_link_libraries(${TEST_APP} PRIVATE daq::test_utils
+find_package(openDAQ 3.20.4 REQUIRED)
+target_link_libraries(${TEST_APP} PRIVATE daq::opendaq
                                           ${SDK_TARGET_NAMESPACE}::${MODULE_NAME}
 )
 
+find_package(GTest QUIET)
+if (NOT GTest_FOUND)
+    message(STATUS "GTest not found, fetching googletest with gmock...")
+
+    include(FetchContent)
+    FetchContent_Declare(
+        googletest
+        URL https://github.com/google/googletest/archive/refs/tags/v1.14.0.zip
+    )
+    set(INSTALL_GTEST OFF CACHE BOOL "" FORCE)
+    FetchContent_MakeAvailable(googletest)
+else()
+    message(STATUS "GTest found, setting up googletest with gtest, gmock...")
+endif()
+
+# Link module + gtest/gmock
+target_link_libraries(${TEST_APP} 
+    PRIVATE
+        GTest::gtest
+        GTest::gtest_main
+        GTest::gmock
+        GTest::gmock_main
+)
+include(GoogleTest)
+gtest_discover_tests(${TEST_APP})
+
 add_test(NAME ${TEST_APP}
          COMMAND $<TARGET_FILE_NAME:${TEST_APP}>
          WORKING_DIRECTORY bin

example_module/tests/test_app.cpp

@@ -1,20 +1,10 @@
-#include <testutils/testutils.h>
-#include <testutils/bb_memcheck_listener.h>
+#include <gtest/gtest.h>
 #include <coreobjects/util.h>
-#include <opendaq/module_manager_init.h>
-#include <coretypes/stringobject_factory.h>
-
 
 int main(int argc, char** args)
 {
-    daq::daqInitializeCoreObjectsTesting();
-    daqInitModuleManagerLibrary();
-
     testing::InitGoogleTest(&argc, args);
 
-    testing::TestEventListeners& listeners = testing::UnitTest::GetInstance()->listeners();
-    listeners.Append(new DaqMemCheckListener());
-
     auto res = RUN_ALL_TESTS();
 
     return  res;

example_module/tests/test_example_module.cpp

@@ -5,7 +5,7 @@
 #include <example_module/version.h>
 #include <gmock/gmock.h>
 #include <opendaq/opendaq.h>
-#include <testutils/testutils.h>
+// #include <testutils/testutils.h>
 
 #include <chrono>
 #include <thread>

external/CMakeLists.txt

@@ -5,6 +5,4 @@ if (${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})
     message(FATAL_ERROR "In-source build is not supported!")
 endif()
 
-include(FetchContent)
-
 add_subdirectory(openDAQ)

external/openDAQ/CMakeLists.txt

@@ -1,12 +1,3 @@
 set(OPENDAQ_ENABLE_TESTS false)
 
-FetchContent_Declare(
-    openDAQ
-    GIT_REPOSITORY https://github.com/openDAQ/openDAQ.git
-    GIT_TAG v3.20.1
-    GIT_PROGRESS   ON
-	SYSTEM
-    FIND_PACKAGE_ARGS 3.20.1 GLOBAL
-)
-
-FetchContent_MakeAvailable(openDAQ)
+find_package(openDAQ 3.20.4 REQUIRED)