GitHub Actions と Google Test を使って Arduino のライブラリに動的テストを導入する

MyLibrary
│
├─ .github
│  └─ workflows
│     └─ UnitTest.yml
├─ src
│  ├─ Algorithm
│  │  └─ Math.hpp
│  └─ MyLibrary.hpp
│
├─ test
│  └─ UnitTest
│     ├─ Thirdparty
│     │  └─ googletest    <-- サブモジュールとして追加
│     ├─ Algorithm
│     │  ├─ CMakeLists.txt
│     │  └─ Math.cpp      <-- テスト用ソースファイル
│     └─ CMakeLists.txt
│
├─ .gitignore
│
└─ library.properties

# run in MyLibrary/
git submodule add https://github.com/google/googletest.git test/UnitTest/Thirdparty/googletest

#pragma once

namespace Math
{
    inline int Factorial(int n)
    {
        if (n <= 0)
            return 1;
        else
            return n * Factorial(n - 1);
    }
}

#pragma once

#include <MyLibrary/Algorithm/Math.hpp>

test/UnitTest/Build/

name=MyLibrary
version=1.0.0
author=HogeHoge
maintainer=HogeHoge
sentence=HogeHoge
paragraph=HogeHoge
category=Other
url=http://example.com/
architectures=*

cmake_minimum_required(VERSION 3.14)
project(UnitTest)

if (MSVC)
    add_compile_options(/std:c++14)   # C++14
    add_compile_options(/permissive-) # C++標準に準拠
    add_compile_options(/wd4819)      # エンコーディングの違いによるエラーを無効化
endif()


# GoogleTest 設定
set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/Thirdparty/googletest)
include(GoogleTest)
enable_testing()

# 子ディレクトリの CMakeLists で使えるよう、インクルードディレクトリ(src)のパスをキャッシュに保存
get_filename_component(ABSOLUTE_LIBRARY_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../src" ABSOLUTE)
set(LIBRARY_DIR ${ABSOLUTE_LIBRARY_DIR} CACHE STRING "include path")

# 子ディレクトリを登録
add_subdirectory(./Algorithm)

cmake_minimum_required(VERSION 3.14)

# 実行ファイルを追加
add_executable(AlgorithmTest
    Math.cpp
)

# インクルードディレクトリを設定
target_include_directories(AlgorithmTest PUBLIC ${LIBRARY_DIR})

# Google Test とリンク
target_link_libraries(AlgorithmTest gtest_main)

# テストケースを追加
gtest_discover_tests(AlgorithmTest)

#include <gtest/gtest.h>
#include <MyLibrary/Algorithm/Math.hpp>

TEST(Factorial, HandlesPositiveInput)
{
    EXPECT_EQ(Factorial(1),   1);
    EXPECT_EQ(Factorial(2),   2);
    EXPECT_EQ(Factorial(3),   6);
    EXPECT_EQ(Factorial(4),  24);
    EXPECT_EQ(Factorial(5), 120);
}

add_executable(AlgorithmTest
    Math.cpp
    HogeHoge.cpp
    HugaHuga.cpp
    ...
)

cmake -S . -B Build
cmake --build Build
cd Build
ctest --output-on-failure
cd -

winget install -e --id Kitware.CMake

-- Building for: Visual Studio <略>
-- Selecting Windows SDK version <略> to target Windows <略>
-- The C compiler identification is MSVC <略>

-------- 略 --------

    Start 1: Factorial.HandlesPositiveInput
1/1 Test #1: Factorial.HandlesPositiveInput ...   Passed    0.02 sec

100% tests passed, 0 tests failed out of 1

Total Test time (real) =   0.12 sec

name: Unit Tests

on:
  push:
    paths-ignore:
      - "**.md"
  pull_request:
    paths-ignore:
      - "**.md"

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  unit-test:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Clone submodules
        run: git submodule update --init --recursive

      - name: Build
        working-directory: test/UnitTest
        run: cmake -S . -B Build && cmake --build Build

      - name: Run tests
        working-directory: test/UnitTest/Build
        run: ctest --output-on-failure