GitHub Actions で C/C++のテストを自動実行できるようにしてみた

2025年9月28日

どもです。

今回は、Google Testを使って実装されている単体テストを、GitHub Actionsで実行される環境を作成してみたので、その内容について書いてみます。

1. テスト対象コード

単体テストを自動実行できるようにするにあたり、まずテスト対象とするコードを決定してみます。
サンプルの関数をテキトーに作成してもよいのですが、今回は以下のリポジトリのあるコードを対象としてみることにしてみました。

Ev3MindStormCar

このコードの中でも、特に以下のフォルダに格納されたコードのいくつかを対象にしてみます。

dev/sdk/Ev3Car/src

※だいぶ昔に、LEGOのMindSTORMを動かすために作成したコードです。自分のコードなので、文句は言われない。

このコードをテストするにあたり、以下のようなフォルダ構成を作成します。

(work_space_root)
├─.github
│  └─workflows
└─dev
    ├─src
    │  ├─CLC
    │  │      CLC_TravelDistance.cpp
    │  │      CLC_TravelSpeed.cpp
    │  │      
    │  ├─include
    │  │      ev3api.h
    │  │      
    │  └─UTIL
    │          util.cpp
    │          util.h
    │          
    └─test
        ├─framework
        │  └─googletest
        └─src
            │  CMakeLists.txt
            │  
            ├─CLC
            │      CMakeLists.txt
            │      UTEST_TravelSpeed_calc_travel_speed.cpp
            │      UTEST_TravelSpeed_init_travel_speed.cpp
            │      
            └─UTIL
                    CMakeLists.txt
                    UTEST_util_init_buff.cpp
                    UTEST_util_limit_int.cpp

この構成の中で、dev/srcの下にテスト対象関数が実装されたソースコードが格納されています。
dev/test/srcの下に、単体テストのコードを配置しています。
このコードは、今回はGoogleTestを使用して実装しています。
単体テストのフレームワークであるGoogleTestは、dev/test/frameworkの下にヘッダファイル、およびライブラリを格納しています。

細かく記載すると長くなるので、本投稿では詳細を割愛します。
また、テストプログラムのビルドにcmakeを使用します。そのために必要なCMakeLists.txtも作成しています。
GoogleTestやcmake、CMakeLists.txt の内容はGitHub Actionsの本質ではないので、内容の説明は省略します。

ただ、/dev/test/srcの下、およびCLCやUTILの各フォルダにおいて、cmakeによるビルドができるようにしておく必要はあります。

2. GitHub Actionsの設定

開発環境、および作業環境の確認ができたので、次はGitHubActionsの設定を行います。
GitHubActionは、.github/workflows内に、拡張子が.ymlとなっているファイルに記述、定義します。
今回は、CMake_UTest.ymlという名前で作成します。

このファイルの内容は、以下の通りです。

name: CMake Unit Test

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build-and-test:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3

    - name: Install dependencies
      run: sudo apt-get update && sudo apt-get install -y cmake g++ make

    - name: Configure
      run: cmake -S dev/test/src -B dev/test/src/build

    - name: Build
      run: cmake --build dev/test/src/build

    - name: Run tests (build root)
      run: cd dev/test/src/build && ctest --output-on-failure

    - name: Run tests (UTIL)
      working-directory: dev/test/src/build/UTIL
      run: ./UTEST_util --gtest_output=xml:utest_util_results.xml

    - name: Run tests (CLC)
      working-directory: dev/test/src/build/CLC
      run: ./UTEST_TravelSpeed --gtest_output=xml:utest_util_results.xml