RCDB C++ tests automation

Author: DraTeots

.github/workflows/cpp-tests.yml

@@ -0,0 +1,47 @@
+name: C++ tests
+
+on:
+  push:
+  pull_request:
+    branches: [main]
+
+jobs:
+  cpp-sqlite:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install build dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y cmake g++ libsqlite3-dev
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      # The C++ unit tests read a fixture SQLite database. We build it with the
+      # `rcdb` CLI - the single, canonical way to initialize an RCDB database -
+      # so there is no checked-in binary fixture to drift out of sync.
+      - name: Install rcdb (provides the `rcdb db init` test fixture)
+        run: |
+          python -m pip install --upgrade pip
+          pip install --editable $GITHUB_WORKSPACE/python
+
+      - name: Create the C++ test SQLite database
+        run: |
+          rcdb -c "sqlite:////$GITHUB_WORKSPACE/cpp_test.sqlite" db init --add-cpp-tests --confirm
+
+      - name: Configure and build C++ tests (SQLite only)
+        run: |
+          cmake -S $GITHUB_WORKSPACE/cpp -B $GITHUB_WORKSPACE/cpp/build -DWITH_SQLITE=ON -DWITH_MYSQL=OFF
+          cmake --build $GITHUB_WORKSPACE/cpp/build --target test_rcdb_cpp -j
+
+      - name: Run C++ tests
+        env:
+          # 4-slash form: SQLAlchemy (used to seed) and the C++ SqLiteProvider parser
+          # (strips the leading "sqlite:///") both resolve this to the same absolute path.
+          RCDB_TEST_CONNECTION: "sqlite:////${{ github.workspace }}/cpp_test.sqlite"
+        run: $GITHUB_WORKSPACE/cpp/build/test_rcdb_cpp

.github/workflows/python-tests.yml

@@ -1,6 +1,9 @@
 name: Python tests
 
-on: [push]
+on:
+  push:
+  pull_request:
+    branches: [main]
 
 jobs:
   build:

cpp/CMakeLists.txt

@@ -1,5 +1,11 @@
-#(!) this CMake build system IS experimental and is made mostly for using CLion IDE.
-# Scons - is the main RCDB make system, so please use it in order to build rcdb.lib and examples
+# RCDB C++ is a header-only library - nothing here is required to USE it (just #include the headers
+# and link sqlite3 and/or the mysql client). This CMake project builds the unit tests and examples.
+#
+# Build & run the SQLite unit tests:
+#   cmake -S . -B build -DWITH_SQLITE=ON -DWITH_MYSQL=OFF
+#   cmake --build build --target test_rcdb_cpp
+#   RCDB_TEST_CONNECTION="sqlite:///<path-to>.sqlite" ./build/test_rcdb_cpp
+# Create the test database with:  rcdb -c sqlite:///<path-to>.sqlite db init --add-cpp-tests --confirm
 
 cmake_minimum_required(VERSION 3.4)
 project(rcdb_cpp)
@@ -68,17 +74,27 @@ SET(TEST_SOURCE_FILES
         include/RCDB/StringUtils.h
         include/RCDB/ConfigParser.h
 
-        tests/test_Connection.cpp
         tests/test_ConditionType.cpp
-        tests/test_MySqlProvider.cpp
-        tests/test_SqLiteProvider.cpp
 
         tests/catch.hpp
         tests/catch.cpp
         tests/test_ConfigParser.cpp
         include/json/json.hpp
         )
 
+# Provider tests are gated by the corresponding DB backend, so an SQLite-only
+# build does not need MySQL headers (mysql.h) and a MySQL-only build does not need SQLite.
+if(WITH_MYSQL)
+    list(APPEND TEST_SOURCE_FILES tests/test_MySqlProvider.cpp)
+endif()
+
+# The Connection and SqLiteProvider tests both pull in the SQLiteCpp amalgamation,
+# whose out-of-line definitions are not `inline`. Compile them as a single unity
+# translation unit (tests/test_sqlite_unity.cpp) so the definitions appear once.
+if(WITH_SQLITE)
+    list(APPEND TEST_SOURCE_FILES tests/test_sqlite_unity.cpp)
+endif()
+
 add_executable(test_rcdb_cpp ${TEST_SOURCE_FILES})
 add_executable(examples_trigger_params    examples/get_trigger_params.cpp)
 add_executable(examples_fadc_masks        examples/get_fadc_masks.cpp)

cpp/SConstruct

@@ -0,0 +1,17 @@
+// Unity translation unit for the SQLite-backed tests.
+//
+// The vendored SQLiteCpp amalgamation (include/RCDB/SQLiteCpp.h) defines its
+// member functions out-of-line WITHOUT `inline`, so it is only safe to pull
+// into a single translation unit per binary - exactly how every cpp/examples
+// program (each a single .cpp) uses it. The test binary is the only consumer
+// that links several object files, so test_Connection.cpp and
+// test_SqLiteProvider.cpp - both of which transitively include SQLiteCpp.h -
+// would otherwise produce duplicate-symbol link errors.
+//
+// Compiling them together here makes SQLiteCpp.h's include guard collapse the
+// definitions to one copy. The two source files keep their own TEST_CASEs and
+// remain editable/standalone for IDEs; CMake compiles this unity file instead
+// of the two individually (see cpp/CMakeLists.txt, WITH_SQLITE branch).
+
+#include "test_SqLiteProvider.cpp"
+#include "test_Connection.cpp"

cpp/examples/SConscript

@@ -68,9 +68,7 @@ In order for your code to build ensure flags/configuration:
 
 ​* Code ```#define RCDB_MYSQL```
 * Compiler arguments ```-DRCDB_MYSQL```
-* Scons ```env.Append(CPPDEFINES=['RCDB_MYSQL', 'RCDB_SQLITE'])```
-* CMAKE ```add_definitions(-DRCDB_MYSQL)```
-* SMBS ```AddRcdb()``` in SConscript
+* CMake ```-DWITH_MYSQL=ON``` (which does ```add_definitions(-DRCDB_MYSQL)```)
 
 
 ### Dependencies
@@ -123,15 +121,29 @@ rapidjson::Document ToJsonDocument();  /// For JSon document
 rcdb::ValueTypes GetValueType();       /// Returns the type enum
 ```
 
-## Examples
+## Building the tests and examples (CMake)
 
-Examples are located in [$RCDB_HOME/cpp/examples](https://github.com/JeffersonLab/rcdb/tree/main/cpp/examples) folder. To build them use `with-examples=true` scons flag:
+The C++ tests and examples are built with CMake. SQLite-only is the default; add
+`-DWITH_MYSQL=ON` to also build the MySQL provider (needs `libmysqlclient-dev`).
 
 ```bash
 cd $RCDB_HOME/cpp
-scons with-examples=true #...
+cmake -S . -B build -DWITH_SQLITE=ON -DWITH_MYSQL=OFF
+cmake --build build --target test_rcdb_cpp        # unit tests
+cmake --build build                               # everything, incl. examples
 ```
 
+The unit tests need a SQLite database with test data. Create one with the `rcdb` CLI
+and point `RCDB_TEST_CONNECTION` at it:
+
+```bash
+rcdb -c sqlite:///cpp_test.sqlite db init --add-cpp-tests --confirm
+RCDB_TEST_CONNECTION="sqlite:///cpp_test.sqlite" ./build/test_rcdb_cpp
+```
+
+Examples are located in the [$RCDB_HOME/cpp/examples](https://github.com/JeffersonLab/rcdb/tree/main/cpp/examples) folder
+and are built as the `examples_*` targets by the `cmake --build build` command above.
+
 After examples are built they are located in `$RCDB_HOME/cpp/bin` directory named as `exmpl_<...>`
 
 <br>

cpp/tests/SConscript

@@ -54,6 +54,6 @@ rcdb -c sqlite:///test.sqlite db init --drop-all
 The command to upgrade DB structure from previous RCDB versions:
 
 ```bash
-rcdb -c sqlite:///test.sqlite db upgrade
+rcdb -c sqlite:///test.sqlite db update
 ```