add: GoogleTest環境の構築

Author: takuchi17

.gitignore

@@ -0,0 +1,2 @@
+# ディレクトリ
+build

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 のフェッチとビルド
+# Windows環境では動かないかも
+include(FetchContent)
+FetchContent_Declare(
+  googletest
+  URL https://github.com/google/googletest/archive/refs/tags/v1.16.0.zip
+)
+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)

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,53 @@ build:
 start:
 	cd $(MAKEFILE_PATH)../ && make start
 
+## テスト関連 ##
+# テストのビルドディレクトリが存在しない場合は作成する
+test-build:
+	@mkdir -p $(MAKEFILE_PATH)build
+	cd $(MAKEFILE_PATH)build && cmake .. && make
+
+# テストを実行する
+test-exec: 
+	@if [ ! -f $(MAKEFILE_PATH)build/etrobocon2025_test ]; then \
+		echo "テスト実行ファイルが見つかりません。まずビルドを実行してください。"; \
+		echo " $$ make test-build"; \
+		exit 1; \
+	fi
+	cd $(MAKEFILE_PATH)build && ./etrobocon2025_test
+
+# テストをビルドして実行する
+test: smart-clean test-build test-exec
+
+# build ディレクトリを完全に削除する
+clean:
+	@if [ -d $(MAKEFILE_PATH)build ]; then \
+		rm -rf $(MAKEFILE_PATH)build; \
+		echo "'build/' ディレクトリを削除しました。"; \
+	else \
+		echo "'build/' ディレクトリは既に存在しません。"; \
+	fi
+
+# 実行環境が変更されている場合にのみ 'build' を削除する
+smart-clean:
+	@if [ -d $(MAKEFILE_PATH)build ]; then \
+		if [ -f "$(MAKEFILE_PATH)build/Makefile" ]; then \
+			CMAKE_SOURCE_DIR=`grep -E "^CMAKE_SOURCE_DIR[[:space:]]*=" $(MAKEFILE_PATH)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)build; \
+			else \
+				echo "[LOG] 実行環境は変更されていません。"; \
+			fi; \
+		fi; \
+	else \
+		echo "'build/' ディレクトリは既に存在しません。"; \
+	fi
+
 ## 開発関連 ##
 # ファイルにclang-formatを適用する
 format:

README.md

@@ -2,13 +2,20 @@
 
 宮崎大学片山徹郎研究室チーム KatLab が作成する[ET ロボコン 2025](https://www.etrobo.jp/)アドバンストクラスの走行システムプログラムです。
 
+## 構成
+### ./modules
+ソースファイルを格納
+### ./tests
+テストソースを格納
+
 ## プロジェクトのビルド
 ### 実機の場合
 ```etrobocon2025```で以下を実行
 ```shell
 make build
 ```
 ### 実機以外の場合
+etrobo環境でビルドが出来ないため，現状 (20250502) ではこの方法を考えています
 ```etrobocon2025```で以下を順に実行
 1. (まだの場合は)bookworm環境のイメージを以下のコマンドで作成
 ```shell
@@ -21,4 +28,16 @@ docker run -it --rm -v $(pwd):/RasPike-ART/sdk/workspace/etrobocon2025 myimage:a
 3. プロジェクトのビルド
 ```shell
 make build
+```
+
+## テスト
+```etrobocon2025```で以下を実行
+```shell
+make test
+```
+もしくは，```etrobocon2025```で以下を実行
+```shell
+make smart-clean
+make test-build
+make test-exec
 ```

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

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();
+}

tests/helpers/OStreamCapture.h

@@ -0,0 +1,42 @@
+/**
+ * @file   OStreamCapture.h
+ * @brief  C++ストリームをキャプチャするためのヘルパークラスの宣言
+ * @author takuchi17
+ */
+
+#ifndef O_STREAM_CAPTURE_H
+#define O_STREAM_CAPTURE_H
+
+#include <iostream>
+#include <sstream>
+#include <streambuf>
+#include <string>
+
+using namespace std;
+
+class OStreamCapture {
+ private:
+  ostream& targetStream;   // キャプチャ対象の出力ストリーム (例: std::cout)
+  stringstream buffer;     // 出力を一時的に保存するバッファ
+  streambuf* originalBuf;  // 元のストリームバッファ
+
+ public:
+  /**
+   * @brief コンストラクタ: ストリームキャプチャの開始 (バッファの差し替え)
+   * @param _targetStream キャプチャしたい std::ostream (例: std::cout)
+   */
+  OStreamCapture(ostream& _targetStream);
+
+  /**
+   * @brief デストラクタ: キャプチャ終了とストリームバッファの復元
+   */
+  ~OStreamCapture();
+
+  /**
+   * @brief キャプチャされた出力内容を取得
+   * @return 出力された文字列
+   */
+  string getOutput() const;
+};
+
+#endif  // O_STREAM_CAPTURE_H