feat: add unit tests in ci (#201)

Author: maxday

.clang-tidy

@@ -4,6 +4,7 @@ Checks:
 -modernize-use-trailing-return-type,-bugprone-easily-swappable-parameters,-readability-identifier-length'
 WarningsAsErrors: '*'
 HeaderFilterRegex: 'include/aws/.*\.h$'
+ExcludeHeaderFilter: 'build/_deps/gtest-src.*'
 FormatStyle: 'none'
 CheckOptions:
   - key:             modernize-pass-by-value.ValuesOnly

.github/workflows/workflow.yml

@@ -12,39 +12,24 @@ env:
 
 jobs:
   build:
-    # The CMake configure and build commands are platform agnostic and should work equally
-    # well on Windows or Mac.  You can convert this to a matrix build if you need
-    # cross-platform coverage.
-    # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        arch: [ubuntu-latest, ubuntu-24.04-arm]
+    runs-on: ${{ matrix.arch }}
 
     steps:
     - uses: actions/checkout@v3
-    
     - name: Install Dependencies
       run: sudo apt-get update && sudo apt-get install -y clang-tidy libcurl4-openssl-dev
 
     - name: Configure CMake
-      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
-      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
-      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCMAKE_CXX_CLANG_TIDY=clang-tidy
+      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCMAKE_CXX_CLANG_TIDY=clang-tidy -DENABLE_TESTS=ON
 
     - name: Build It
-      # Build your program with the given configuration
       run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
 
-  build-on-arm-too:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - uses: uraimo/run-on-arch-action@v2
-      with:
-        arch: aarch64
-        distro: ubuntu20.04
-        run: |
-          apt-get update && apt-get install -y cmake g++ clang-tidy libcurl4-openssl-dev
-          cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCMAKE_CXX_CLANG_TIDY=clang-tidy
-          cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+    - name: Test It
+      run: cd build && make && ctest
 
   build-demo:
     runs-on: ubuntu-latest
@@ -68,15 +53,11 @@ jobs:
         cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=~/lambda-install
         make
         make aws-lambda-package-demo
-  
-  
+
   format:
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v3
 
     - name: Check Formatting
       run: ./ci/codebuild/format-check.sh
-
-

README.md

@@ -39,6 +39,23 @@ $ cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=~/lambda-install
 $ make && make install
 ```
 
+### Running Unit Tests Locally
+
+To run the unit tests locally, follow these steps to build:
+
+```bash
+$ cd aws-lambda-cpp
+$ mkdir build
+$ cd build
+$ cmake .. -DCMAKE_BUILD_TYPE=Debug -DENABLE_TESTS=ON
+$ make
+```
+
+Run unit tests:
+```bash
+$ ctest
+```
+
 To consume this library in a project that is also using CMake, you would do:
 
 ```cmake

tests/CMakeLists.txt

@@ -1,17 +1,50 @@
+cmake_minimum_required(VERSION 3.11)
 project(aws-lambda-runtime-tests LANGUAGES CXX)
 
-find_package(AWSSDK COMPONENTS lambda iam)
+if(DEFINED ENV{GITHUB_ACTIONS})
+    # Fetch Google Test for unit tests
+    include(FetchContent)
+    FetchContent_Declare(gtest
+        URL https://github.com/google/googletest/archive/v1.12.0.tar.gz
+        DOWNLOAD_EXTRACT_TIMESTAMP TRUE
+    )
+    # Configure build of googletest
+    set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+    set(BUILD_GMOCK OFF CACHE BOOL "" FORCE)
+    set(INSTALL_GTEST OFF)
+    FetchContent_MakeAvailable(gtest)
 
-add_executable(${PROJECT_NAME}
-    main.cpp
-    runtime_tests.cpp
-    version_tests.cpp
-    gtest/gtest-all.cc)
+    add_executable(unit_tests
+        unit/no_op_test.cpp)
+    target_link_libraries(unit_tests PRIVATE gtest_main aws-lambda-runtime)
 
-target_link_libraries(${PROJECT_NAME} PRIVATE ${AWSSDK_LINK_LIBRARIES} aws-lambda-runtime)
+    # Register unit tests
+    include(GoogleTest)
+    gtest_discover_tests(unit_tests
+        PROPERTIES
+        LABELS "unit"
+        DISCOVERY_TIMEOUT 10)
+else()
+    message(STATUS "Unit tests skipped: Not in GitHub Actions environment")
+endif()
 
-include(GoogleTest)
-gtest_discover_tests(${PROJECT_NAME} EXTRA_ARGS "--aws_prefix=${TEST_RESOURCE_PREFIX}") # requires CMake 3.10 or later
 
-add_subdirectory(resources)
+find_package(AWSSDK COMPONENTS lambda iam QUIET)
+
+if(AWSSDK_FOUND)
+    add_executable(${PROJECT_NAME}
+        integration/main.cpp
+        integration/runtime_tests.cpp
+        integration/version_tests.cpp
+        gtest/gtest-all.cc)
+
+    target_link_libraries(${PROJECT_NAME} PRIVATE ${AWSSDK_LINK_LIBRARIES} aws-lambda-runtime)
+
+    include(GoogleTest)
+    gtest_discover_tests(${PROJECT_NAME} EXTRA_ARGS "--aws_prefix=${TEST_RESOURCE_PREFIX}")
+
+    add_subdirectory(resources)
+else()
+    message(STATUS "Integration tests skipped: AWS SDK not found or not in GitHub Actions environment")
+endif()
 

tests/main.cpp renamed to tests/integration/main.cpp

@@ -1,6 +1,6 @@
 #include <aws/core/Aws.h>
 #include <aws/core/utils/logging/ConsoleLogSystem.h>
-#include "gtest/gtest.h"
+#include "../gtest/gtest.h"
 
 std::function<std::shared_ptr<Aws::Utils::Logging::LogSystemInterface>()> get_console_logger_factory()
 {

tests/runtime_tests.cpp renamed to tests/integration/runtime_tests.cpp

@@ -13,7 +13,7 @@
 #include <aws/lambda/model/CreateFunctionRequest.h>
 #include <aws/lambda/model/InvokeRequest.h>
 #include <aws/core/utils/base64/Base64.h>
-#include "gtest/gtest.h"
+#include "../gtest/gtest.h"
 #include <aws/lambda/model/LogType.h>
 #include <cstdio>
 #include <iostream>

tests/version_tests.cpp renamed to tests/integration/version_tests.cpp

@@ -1,5 +1,5 @@
 #include <aws/lambda-runtime/version.h>
-#include "gtest/gtest.h"
+#include "../gtest/gtest.h"
 
 using namespace aws::lambda_runtime;
 

tests/unit/no_op_test.cpp

@@ -0,0 +1,6 @@
+#include <gtest/gtest.h>
+
+TEST(noop, dummy_test)
+{
+    ASSERT_EQ(0, 0);
+}