Merge pull request #2 from KatLab-MiyazakiUniv/ticket-KL25-7

takahashitom · web-flow · commit cbde8c881508 · 2025-05-07T00:04:29.000+09:00
#KL25-7 GoogleTest環境とCI環境の構築
diff --git a/.github/workflows/build-check.yaml b/.github/workflows/build-check.yaml
@@ -0,0 +1,27 @@
+name: Build Check
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        
+      # イメージのビルドは時間がかかるため，事前にビルドしたものをpullしてくる 
+      # https://hub.docker.com/r/chihayataku/kat_etrobo2025
+      - name: Pull Docker image
+        run: |
+          docker pull chihayataku/kat_etrobo2025:arm64
+
+      - name: Run build in container
+        run: |
+          docker run --rm -v $(pwd):/RasPike-ART/sdk/workspace/etrobocon2025 chihayataku/kat_etrobo2025:arm64 \
+          bash -c "cd /RasPike-ART/sdk/workspace/etrobocon2025 && make build"
diff --git a/.github/workflows/format-check.yaml b/.github/workflows/format-check.yaml
@@ -0,0 +1,19 @@
+name: Format Check
+
+on: [push, pull_request]
+
+jobs:
+  format-check:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install clang-format
+        run: sudo apt-get update && sudo apt-get install -y clang-format
+
+      - name: Run clang-format check
+        run: |
+          find ./ ./tests ./modules -type f \( -name "*.cpp" -o -name "*.h" \) \
+          | xargs clang-format --dry-run --Werror
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -0,0 +1,28 @@
+name: Run Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # - name: Set up Docker Buildx
+      #   uses: docker/setup-buildx-action@v2
+
+      # - name: Build Docker image
+      #   run: docker buildx build --platform linux/arm64 --load -t myimage:arm64 .
+
+      # - name: Run tests in container
+      #   run: |
+      #     docker run --rm -v $(pwd):/RasPike-ART/sdk/workspace/etrobocon2025 myimage:arm64 \
+      #     bash -c "cd /RasPike-ART/sdk/workspace/etrobocon2025 && make test"
+
+      # 今のところはコンテナを使わずに直接実行する．
+      # もしコンテナによるテスト実施が可能であれば，
+      # これをコメントアウトして，以上を有効化する．
+      - name: Run tests
+        run: |
+          make test   
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+# ディレクトリ
+bin
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -0,0 +1,64 @@
+# GoogleTest用のCMakeLists.txt
+cmake_minimum_required(VERSION 3.14)
+project(etrobocon2025)
+
+# C++標準とカバレッジ用フラグ
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+# デバッグビルド用のフラグ
+set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -g")
+
+# カバレッジレポート作成のオプション
+option(ENABLE_COVERAGE "Enable test coverage reporting" ON)
+if(ENABLE_COVERAGE)
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fprofile-arcs -ftest-coverage")
+endif()
+
+# GoogleTest のフェッチとビルド
+include(FetchContent)
+FetchContent_Declare(
+  googletest
+  URL https://github.com/google/googletest/archive/refs/tags/v1.16.0.zip
+)
+set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+FetchContent_MakeAvailable(googletest)
+
+# プロジェクトのソースディレクトリ構造の定義 (適宜登録)
+set(PROJECT_MODULE_DIR ${PROJECT_SOURCE_DIR}/modules)
+set(PROJECT_TEST_DIR ${PROJECT_SOURCE_DIR}/tests)
+
+# 必要なインクルードディレクトリの設定 (適宜登録)
+set(INCLUDE_DIRS
+  ${PROJECT_MODULE_DIR}
+  ${PROJECT_TEST_DIR}/helpers
+)
+
+# ソースファイルの登録 (適宜登録)
+file(GLOB_RECURSE PROJECT_SOURCES
+  "${PROJECT_MODULE_DIR}/*.cpp"
+  "${PROJECT_TEST_DIR}/helpers/*.cpp"
+)
+
+# プロジェクトのライブラリターゲットを作成
+add_library(${PROJECT_NAME}_impl STATIC ${PROJECT_SOURCES})
+target_include_directories(${PROJECT_NAME}_impl PUBLIC ${INCLUDE_DIRS})
+
+# テスト設定
+enable_testing()
+
+# tests ディレクトリ内の *Test.cpp をすべてテストソースとして登録
+file(GLOB TEST_SOURCES "${PROJECT_TEST_DIR}/*Test.cpp")
+
+# テスト実行可能ファイルの作成
+add_executable(${PROJECT_NAME}_test ${TEST_SOURCES})
+target_link_libraries(${PROJECT_NAME}_test
+  PRIVATE
+    ${PROJECT_NAME}_impl
+    gtest_main
+)
+
+# テストの登録
+include(GoogleTest)
+gtest_discover_tests(${PROJECT_NAME}_test)
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,23 @@
+# 実機と同じ環境( bookworm AArch64)を構築するためのDockerfile
+FROM debian:bookworm
+
+# 必要なパッケージをインストール
+RUN apt-get update && apt-get install -y \
+  build-essential \
+  ruby \
+  git \
+  cmake \
+  sudo \
+  && gem install shell \
+  && apt-get clean && rm -rf /var/lib/apt/lists/*
+
+# ビルド時に日本語が含まれていたらエラーになるので，C.UTF-8を指定
+ENV LANG=C.UTF-8 
+
+# RasPike-ART を clone
+# libraspike-artは，RasPike-ART内で運営がリンクで紐づけていたため，直接cloneする必要がある
+RUN git clone https://github.com/ETrobocon/RasPike-ART.git /RasPike-ART \
+  && git clone https://github.com/ETrobocon/libraspike-art.git /RasPike-ART/libraspike-art
+
+# 作業ディレクトリを/RasPike-ART/sdk/workspace/etrobocon2025に設定
+WORKDIR /RasPike-ART/sdk/workspace/etrobocon2025
diff --git a/Makefile b/Makefile
@@ -12,6 +12,16 @@ help:
 	@echo " $$ make format"
 	@echo フォーマットチェックをする
 	@echo " $$ make format-check"
+	@echo テストをビルドする
+	@echo " $$ make test-build"
+	@echo テストを実行する
+	@echo " $$ make test-exec"
+	@echo テスト用の'build'ディレクトリを削除する
+	@echo " $$ make clean"
+	@echo 環境が変わっている場合のみ build ディレクトリを削除する
+	@echo " $$ make smart-clean"
+	@echo 必要があればbuildディレクトリを削除し, テストをビルドして実行する
+	@echo " $$ make test"
 
 ## 実行関連 ##
 build:
@@ -21,6 +31,57 @@ build:
 start:
 	cd $(MAKEFILE_PATH)../ && make start
 
+## テスト関連 ##
+# テストのビルドディレクトリが存在しない場合は作成する
+test-build:
+	@mkdir -p $(MAKEFILE_PATH)bin/build
+	cd $(MAKEFILE_PATH)bin/build && cmake ../.. && make
+
+# テストを実行する
+test-exec: 
+	@if [ ! -f $(MAKEFILE_PATH)bin/build/etrobocon2025_test ]; then \
+		echo "テスト実行ファイルが見つかりません。まずビルドを実行してください。"; \
+		echo " $$ make test-build"; \
+		exit 1; \
+	fi
+	cd $(MAKEFILE_PATH)bin/build && ./etrobocon2025_test
+
+# テストをビルドして実行する
+test: smart-clean test-build test-exec
+
+# build ディレクトリを完全に削除する
+clean:
+	@if [ -d $(MAKEFILE_PATH)bin/build ]; then \
+		rm -rf $(MAKEFILE_PATH)bin/build; \
+		echo "'build/' ディレクトリを削除しました。"; \
+	else \
+		echo "'build/' ディレクトリは既に存在しません。"; \
+	fi
+
+# 実行環境が変更されている場合にのみ 'build' を削除する
+smart-clean:
+	@if [ -d $(MAKEFILE_PATH)bin/build ]; then \
+		if [ -f "$(MAKEFILE_PATH)bin/build/Makefile" ]; then \
+			CMAKE_SOURCE_DIR=`grep -E "^CMAKE_SOURCE_DIR[[:space:]]*=" $(MAKEFILE_PATH)bin/build/Makefile | cut -d= -f2 | xargs`; \
+			CMAKE_SOURCE_DIR_REAL=`readlink -f "$$CMAKE_SOURCE_DIR"`; \
+			CURRENT_DIR_REAL=`readlink -f "$$(pwd)"`; \
+			echo "[DEBUG] CMAKE_SOURCE_DIR: '$$CMAKE_SOURCE_DIR_REAL'"; \
+			echo "[DEBUG] CURRENT_DIR    : '$$CURRENT_DIR_REAL'"; \
+			if [ "$$CMAKE_SOURCE_DIR_REAL" != "$$CURRENT_DIR_REAL" ]; then \
+				echo "[LOG] 実行環境の変更が検出されたため 'build' を削除します。"; \
+				rm -rf $(MAKEFILE_PATH)bin/build; \
+			else \
+				echo "[LOG] 実行環境は変更されていません。"; \
+			fi; \
+		else \
+			echo "[LOG] 'build/Makefile' が存在しません。"; \
+			echo "[LOG] 'buildディレクトリを完全削除します。"; \
+			make clean; \
+		fi; \
+	else \
+		echo "'build' ディレクトリは既に存在しません。"; \
+	fi
+
 ## 開発関連 ##
 # ファイルにclang-formatを適用する
 format:
diff --git a/README.md b/README.md
@@ -1,3 +1,64 @@
 # etrobocon2025
 
 宮崎大学片山徹郎研究室チーム KatLab が作成する[ET ロボコン 2025](https://www.etrobo.jp/)アドバンストクラスの走行システムプログラムです。
+
+## 構成
+### ./modules
+ソースファイルを格納
+### ./tests
+テストソースを格納
+
+## プロジェクトのビルド
+### 実機の場合
+```etrobocon2025```で以下を実行
+```shell
+make build
+```
+### 実機以外の場合
+etrobo環境でビルドが出来ないため，現状 (20250502) ではこの方法を考えています．
+etrobo環境でのビルドが出来ることにきづいた?できるようになった?ので，etrobo環境でのビルドの仕方も追記します( 20250505 )．
+#### etrobo環境( 速いため，こちらを推奨 )
+```~/etrobo/raspike-athrill-v850e2m/sdk/workspace/etrobocon2025```で以下を実行
+```shell
+make build
+```
+
+
+#### Docker仮想環境
+```etrobocon2025```で以下を順に実行
+1. (まだの場合は)bookworm環境のイメージを以下のコマンドで作成
+```shell
+docker buildx build --platform linux/arm64 -t kat_etrobo2025:arm64 .
+```
+2. コンテナ作成と起動
+```shell
+docker run -it --rm -v $(pwd):/RasPike-ART/sdk/workspace/etrobocon2025 kat_etrobo2025:arm64 bash
+```
+もし，ファイル保存などの権限問題に引っかかったら，以下のコマンドでUIDとGIDを確認し，
+```shell
+id -u
+```
+```shell
+id -g
+```
+その番号でそれぞれ，以下のコマンドのUIDとGIDを置き換えて実行してみてください
+```shell
+docker run -it --rm --user UID:GID -v $(pwd):/RasPike-ART/sdk/workspace/etrobocon2025 kat_etrobo2025:arm64 bash
+```
+
+3. プロジェクトのビルド
+```shell
+make build
+```
+
+## テスト
+```etrobocon2025```で以下を実行
+```shell
+make test
+```
+もしくは，```etrobocon2025```で以下を実行
+```shell
+make smart-clean
+make test-build
+make test-exec
+```
diff --git a/tests/EtRobocon2025Test.cpp b/tests/EtRobocon2025Test.cpp
@@ -0,0 +1,27 @@
+/**
+ * @file   EtRobocon2025Test.cpp
+ * @brief  EtRobocon2025クラスのテスト
+ * @author takuchi17
+ */
+
+#include <gtest/gtest.h>
+#include "EtRobocon2025.h"
+#include "helpers/OStreamCapture.h"
+
+using namespace std;
+
+namespace etrobocon2025_test {
+  // start関数が最終的に標準出力に"Hello KATLAB"を出力することを確認するテスト
+  TEST(EtRobocon2025Test, Start)
+  {
+    string expected = "Hello KATLAB\n";
+
+    // 標準出力をキャプチャ
+    OStreamCapture capture(cout);
+
+    // start関数を実行
+    EtRobocon2025::start();
+
+    EXPECT_EQ(expected, capture.getOutput());
+  }
+}  // namespace etrobocon2025_test
diff --git a/tests/helpers/OStreamCapture.cpp b/tests/helpers/OStreamCapture.cpp
@@ -0,0 +1,23 @@
+/**
+ * @file   OStreamCapture.cpp
+ * @brief  C++ストリームをキャプチャするためのヘルパークラスの実装
+ * @author takuchi17
+ */
+
+#include "OStreamCapture.h"
+
+OStreamCapture::OStreamCapture(ostream& _targetStream)
+  : targetStream(_targetStream), originalBuf(_targetStream.rdbuf())
+{
+  targetStream.rdbuf(buffer.rdbuf());
+}
+
+OStreamCapture::~OStreamCapture()
+{
+  targetStream.rdbuf(originalBuf);
+}
+
+string OStreamCapture::getOutput() const
+{
+  return buffer.str();
+}
diff --git a/tests/helpers/OStreamCapture.h b/tests/helpers/OStreamCapture.h
