Google tests and Updated Github Actions

.github/workflows/build_and_gtest.yml

@@ -0,0 +1,42 @@
+name: Build and Test
+
+on:
+  push:
+    branches:
+      - main
+      - gtest
+  pull_request:
+    branches:
+      - main
+      - gtest
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Update Libraries
+      run: sudo apt-get update
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get install -y cmake g++ libgtest-dev libarmadillo-dev libopenblas-dev libsuperlu-dev libeigen3-dev
+        # Build and install Google Test (if not pre-installed)
+        cd /usr/src/googletest && sudo cmake . && sudo make && sudo make install
+
+    - name: Create build directory
+      run: mkdir build
+
+    - name: Run CMake
+      run: cmake -S . -B build
+
+    - name: Build library
+      run: cmake --build build
+
+    - name: Run tests
+      run: |
+        cd build
+        make run_tests

CMakeLists.txt

@@ -10,9 +10,9 @@ message(STATUS "Detected CXX Compiler ID: ${CMAKE_CXX_COMPILER_ID}")
 # Compiler-specific CXX_FLAGS and linker flags
 if (CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
     set(CMAKE_CXX_FLAGS "-O3 -Xclang -fopenmp -DARMA_DONT_USE_WRAPPER -DARMA_USE_SUPERLU")
-    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -L/usr/local/Cellar/libomp/19.1.6/lib -lomp")
+    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -L/usr/local/opt/libomp/lib -lomp")
     message(STATUS "Using AppleClang-specific flags.")
-    include_directories("/usr/local/Cellar/libomp/19.1.6/include")
+    include_directories("/usr/local/opt/libomp/include")
 else()
     set(CMAKE_CXX_FLAGS "-O3 -fopenmp -DARMA_DONT_USE_WRAPPER -DARMA_USE_SUPERLU")
     set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS}")
@@ -74,8 +74,8 @@ else()
 endif()
 
 find_package(Eigen3 3.3.7 REQUIRED)
-find_library(OpenBLAS_LIBRARIES NAMES openblas blas PATHS "/usr/lib/x86_64-linux-gnu" REQUIRED)
-find_library(LAPACK_LIBRARY lapack REQUIRED PATHS "/usr/lib" "/usr/lib/x86_64-linux-gnu" "/usr/local/lib" "/usr/local/Cellar/")
+find_library(OpenBLAS_LIBRARIES NAMES openblas blas PATHS "/usr/lib/x86_64-linux-gnu" "/usr/local/opt/" REQUIRED)
+find_library(LAPACK_LIBRARY lapack REQUIRED PATHS "/usr/lib" "/usr/lib/x86_64-linux-gnu" "/usr/local/lib" "/usr/local/opt/")
 
 # Required libraries and link settings
 set(LINK_LIBS ${ARMADILLO_LIBRARIES}

src/cpp/utils.cpp

@@ -15,6 +15,7 @@
  * 
  */
 
+
 /* 
  * @file utils.cpp
  * @brief Helpers for sparse operations and MATLAB analogs

tests/cpp/CMakeLists.txt

@@ -1,15 +1,28 @@
-# tests_C++ Configuration
+# Include directories for the source code
 include_directories("${CMAKE_SOURCE_DIR}/src/cpp")
 
+# FetchContent module to download and configure Google Test
+include(FetchContent)
+
+# Download and install Google Test
+FetchContent_Declare(
+  googletest
+  URL https://github.com/google/googletest/archive/refs/heads/main.zip
+)
+
+# Set up the fetched content
+FetchContent_MakeAvailable(googletest)
+
 # Find all test*.cpp files
 file(GLOB TEST_SOURCES test*.cpp)
 
 set(TEST_EXECUTABLES "")
 
+# Create test executables and link with Google Test
 foreach(TEST_SOURCE ${TEST_SOURCES})
     get_filename_component(TEST_NAME ${TEST_SOURCE} NAME_WE)
     add_executable(${TEST_NAME} ${TEST_SOURCE})
-    target_link_libraries(${TEST_NAME} PUBLIC mole_C++ ${LINK_LIBS})
+    target_link_libraries(${TEST_NAME} PUBLIC mole_C++ gtest gtest_main ${LINK_LIBS})
     list(APPEND TEST_EXECUTABLES ${TEST_NAME})
 endforeach()
 

tests/cpp/test1.cpp

@@ -1,32 +1,26 @@
-/**
- * Nullity test of Divergence operator
- */
-
 #include "mole.h"
-#include <iostream>
+#include <gtest/gtest.h>
 
 void run_nullity_test(int k, Real tol) {
-  int m = 2 * k + 1;
-  Real dx = 1;
+    int m = 2 * k + 1;
+    Real dx = 1;
 
-  Divergence D(k, m, dx);
-  vec field(m + 1, fill::ones);
+    Divergence D(k, m, dx);
+    vec field(m + 1, fill::ones);
 
-  vec sol = D * field;
+    vec sol = D * field;
 
-  if (norm(sol) > tol) {
-    cout << "\033[1;31mTest FAILED!\033[0m\n";
-    exit(1);
-  }
+    EXPECT_NEAR(norm(sol), 0, tol);
 }
 
-int main() {
-  Real tol = 1e-10;
-
-  for (int k : {2, 4, 6})
-    run_nullity_test(k, tol);
-
-  cout << "\033[1;32mTest PASSED!\033[0m\n";
+TEST(DivergenceTests, Nullity) {
+    Real tol = 1e-10;
+    for (int k : {2, 4, 6}) {
+        run_nullity_test(k, tol);
+    }
+}
 
-  return 0;
+int main(int argc, char **argv) {
+    ::testing::InitGoogleTest(&argc, argv);
+    return RUN_ALL_TESTS();
 }

tests/cpp/test2.cpp

@@ -1,33 +1,21 @@
-/**
- * Nullity test of Gradient operator
- */
-
 #include "mole.h"
-#include <iostream>
+#include <gtest/gtest.h>
 
 void run_nullity_test(int k, Real tol) {
-  int m = 2 * k + 1;
-  Real dx = 1;
+    int m = 2 * k + 1;
+    Real dx = 1;
 
-  Gradient G(k, m, dx);
-  vec field(m + 2, fill::ones);
+    Gradient G(k, m, dx);
+    vec field(m + 2, fill::ones);
 
-  vec sol = G * field;
+    vec sol = G * field;
 
-  if (norm(sol) > tol) {
-    cout << "\033[1;31mTest FAILED!\033[0m\n";
-    cout << norm(sol);
-    exit(1);
-  }
+    ASSERT_LT(norm(sol), tol) << "Gradient Nullity Test failed for k = " << k;
 }
 
-int main() {
-  Real tol = 1e-10;
-
-  for (int k : {2, 4, 6, 8})
-    run_nullity_test(k, tol);
-
-  cout << "\033[1;32mTest PASSED!\033[0m\n";
-
-  return 0;
+TEST(GradientTests, Nullity) {
+    Real tol = 1e-10;
+    for (int k : {2, 4, 6, 8}) {
+        run_nullity_test(k, tol);
+    }
 }

tests/cpp/test3.cpp

@@ -1,32 +1,21 @@
-/**
- * Nullity test of Laplacian operator
- */
-
 #include "mole.h"
-#include <iostream>
+#include <gtest/gtest.h>
 
 void run_nullity_test(int k, Real tol) {
-  int m = 2 * k + 1;
-  Real dx = 1;
+    int m = 2 * k + 1;
+    Real dx = 1;
 
-  Laplacian L(k, m, dx);
-  vec field(m + 2, fill::ones);
+    Laplacian L(k, m, dx);
+    vec field(m + 2, fill::ones);
 
-  vec sol = L * field;
+    vec sol = L * field;
 
-  if (norm(sol) > tol) {
-    cout << "\033[1;31mTest FAILED!\033[0m\n";
-    exit(1);
-  }
+    ASSERT_LT(norm(sol), tol) << "Laplacian Nullity Test failed for k = " << k;
 }
 
-int main() {
-  Real tol = 1e-10;
-
-  for (int k : {2, 4, 6})
-    run_nullity_test(k, tol);
-
-  cout << "\033[1;32mTest PASSED!\033[0m\n";
-
-  return 0;
+TEST(LaplacianTests, Nullity) {
+    Real tol = 1e-10;
+    for (int k : {2, 4, 6}) {
+        run_nullity_test(k, tol);
+    }
 }

tests/cpp/test4.cpp

@@ -1,47 +1,35 @@
-/**
- * Energy test
- */
-
 #include "mole.h"
+#include <gtest/gtest.h>
 #include <algorithm>
-#include <iostream>
-
-int main() {
 
-  int k = 4;
-  Real a = -5;
-  Real b = 5;
-  int m = 500;
-  vec grid = linspace(a, b, m);
-  Real dx = grid(1) - grid(0);
-  Real tol = 1e-10;
+TEST(EnergyTests, EigenvalueTest) {
+    int k = 4;
+    Real a = -5;
+    Real b = 5;
+    int m = 500;
+    vec grid = linspace(a, b, m);
+    Real dx = grid(1) - grid(0);
+    Real tol = 1e-10;
 
-  Laplacian L(k, m - 2, dx);
+    Laplacian L(k, m - 2, dx);
 
-  std::transform(grid.begin(), grid.end(), grid.begin(),
-                 [](Real x) { return x * x; });
+    std::transform(grid.begin(), grid.end(), grid.begin(),
+                   [](Real x) { return x * x; });
 
-  sp_mat V(m, m);
-  V.diag(0) = grid;
+    sp_mat V(m, m);
+    V.diag(0) = grid;
 
-  sp_mat H = -0.5 * (sp_mat)L + V;
+    sp_mat H = -0.5 * (sp_mat)L + V;
 
-  cx_vec eigval;
-  eig_gen(eigval, (mat)H);
+    cx_vec eigval;
+    eig_gen(eigval, (mat)H);
 
-  eigval = sort(eigval);
+    eigval = sort(eigval);
 
-  vec expected{1, 3, 5, 7, 9};
+    vec expected{1, 3, 5, 7, 9};
 
-  bool failed = false;
-  for (int i = 0; i < expected.size(); ++i)
-    if (std::norm(real(eigval(i) / eigval(0)) - expected(i)) > tol) {
-      cout << "\033[1;31mTest FAILED!\033[0m\n";
-      failed = true;
+    for (int i = 0; i < expected.size(); ++i) {
+        ASSERT_LT(std::norm(real(eigval(i) / eigval(0)) - expected(i)), tol)
+            << "Energy Test failed for eigenvalue index " << i;
     }
-
-  if (!failed)
-    cout << "\033[1;32mTest PASSED!\033[0m\n";
-
-  return 0;
 }