etrobocon2021

KatLabが開発するETロボコン2021 (アドバンストクラス) のリポジトリです。
Cブロック大会 (九州北・九州南・沖縄) で、競技部門2位、モデル部門1位、総合優勝になりました！

開発環境

ETロボコン公式シミュレータ
C++
GoogleTest
Git/GitHub/GitHub Actions

環境構築の詳細は、wikiを見てください。

ビルド方法

L コースの場合

etrobo ディレクトリで以下のコマンドを実行する

 $ make app=etrobocon2021 sim up

etrobo/workspace/etrobocon2021 ディレクトリでビルドをしたい場合は、上記コマンドのmakeを./make.shに置き換えて実行する

$ ./make.sh app=etrobocon2021 sim up

R コースの場合

etrobo ディレクトリで以下のコマンドを実行する

 $ make right app=etrobocon2021 sim up

etrobo/workspace/etrobocon2021 ディレクトリでビルドをしたい場合は、上記コマンドのmakeを./make.shに置き換えて実行する

$ ./make.sh right app=etrobocon2021 sim up

テストの実行

~/etrobo/workspace/etrobocon2021にあるgtest_all.shファイルを実行することで、 Google Test を実行できます。

$ cd ~/etrobo/workspace/etrobocon2021
$ ./gtest_all.sh

!! エラーが発生した場合

cmakeをインストールしていない場合

以下のようなエラーが発生した際は、cmakeをインストールしなければいけません。
```
./test/gtest/gtest_build.sh: 9: ./test/gtest/gtest_build.sh: cmake: not found
```
Windows の場合は、 sudo apt install cmakeを実行してcmakeをインストールした後、もう一度gtest_all.shファイルを実行してください。

macOS の場合は、Homebrewをインストールし、brew install cmakeを実行してcmakeをインストールした後、もう一度gtest_all.shファイルを実行してください。

テストコードでデバッガ(GDB)を使う

デバッガが使えると何がうれしい？

セグフォの発生個所をコード上に表示してくれる
セグフォ発生時の変数の値を確認することが出来る
任意の行で処理を一時停止し、変数の値等を確認することが出来る（ブレークポイント）
e.t.c.

前提条件：Remote - WSLを使用している

デバッガを使うための下準備

デバッガのインストール

sudo apt install gdb

拡張機能のインストール

以下の拡張機能をインストールしてください。

GoogleTestを実行する

./gtest_all.sh

デバッグターゲットの設定を行う

Ctrl + Shift + P キーを同時に押して CMake: Set Debug Target を入力し Enter を押し、[Unspecified] Unspecified (Let CMake guess [以下略])を選択してください。

デバッガを実行する

VS Code の一番左の列、上から4つめの虫と再生マークアイコンをクリックする。
F5キーを押してデバッグのを行う(ブレークポイントを設定していない場合、ただ単にテストを行って終了します) ソースコードやテストコードが変更された場合は、自動でビルドも行います。

途中で処理を止めて変数等を確認したい場合（ブレークポイントの設定）

確認したいソースコードを開く
途中で処理を止めたい行の行番号にカーソルを合わせ、クリックする
行番号の左に赤い●が表示されたら設定完了（複数設定可能）
F5キーを押してデバッグの開始
画面左に変数等のデバッグ情報が表示されます
再度F5キーを押すとブレークポイントに到達するまでプログラムが実行されますその他にも便利な機能があるので、気になる人は調べたら色々じってみてください。

テストコード以外が原因と考えられるエラーが発生した場合

以下の作業のいずれか又はすべてを行った後、再度デバッガを実行してください

./gtest_all.sh を実行する
buildディレクトリを削除した後、./gtest_all.shを実行する
VS Code を再起動する

Authors

KatLabメンバー, 宮崎大学片山徹郎研究室

KatLab-MiyazakiUniv / etrobocon2021

readme