はじめに
前回,前々回とテストについて書いてきました。前回の最後では,Makefileを使ってテスト用のコマンドを作ることができました。
ところで,このmake
というコマンド,どこかで見覚えがないでしょうか…
…はい,実はこのブログを構築している静的サイトジェネレータのコマンドhugo
に似ています。Hugoについては,こちらの記事を読んでいただけると嬉しいです。
それでですね,上の記事で説明したように,このサイトはGithub Actionsを使うことで,自動的にビルドされています。この仕組みによって,毎回わざわざhugo
コマンドを手元で打ってビルドする必要がなくなったのでした。
では,同じことがC言語プログラムのテストについてもできるのではないでしょうか?
…えー,できます!
準備
Github Actionsをテスト用の環境として使いたいので,まずはこれまで作ってきたディレクトリをGithub に push しましょう。前回までの成果物はこんな感じでした。
$> tree
.
├── Makefile
├── README.md
├── include
│ └── my_abs.h
├── src
│ └── my_abs.c
└── tests
└── test.c
このディレクトリをGithubにpushします。以下のような感じになりました。
YAMLファイル
Github Actions を使うためには,どういうイベントが起きたら,どういうジョブをするかといったルールを記述するファイルが必要になります。このファイルはYAMLという形式で記述されている必要があります。
というわけで,YAMLファイルが必要になるのですが,便利なことに,基本的な形が整えられたファイルをGithub上でゲットすることができます。やった〜。
まずは,Actionsタブをクリックします。
すると,ページが遷移して,Suggested for this repositoryに,C/C++ with Make という設定が確認できます。
Configureというタブをクリックします。
おー!これが欲しかったのよ〜。
Start commit というタブをクリックして,このYAMLファイルをプロジェクトに追加しましょう。
そして,ローカルに変更を反映するために,git pull
コマンドを打っておきましょう。リポジトリは以下のような構成になりました。
c-cpp.yml
の編集
現在のc-cpp.yml
ファイルには,configure
というよくわからないフィールドが含まれているので,思い切って今回これは消しちゃうことにします。問題が起きたら,もう一度戻って考えることにしましょう。
また,make
にも現在のMakefileに記述されていないルールを使っているものがあるので,これらは削除して,代わりにmake test
を追加します。jobの名前に関しては,今回走らせたい処理はビルドではなく,テストなので,ここも書き換えることにします。最終的に以下のようなYAMLファイルになりました。
name: C/C++ CI
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: test
run: make test
では,main
ブランチにpushしてみましょう。Githubのページを覗いてみましょう。
なんか,赤い丸みたいなのが出てきてますね。
次に,Actionsタブをクリックしてみます。
あ,なんか色々増えてますね!testというところをクリックしてみると…
すごい!ちゃんと,テストが実行されたログが残っています!テストが自動で走る仕組みができました!
おわりに
ということで,Github Actionsを使ったテストの自動化についての記事でした。solareenloさんのこちらの記事を読むと,valgrind を使ったメモリリークのチェックなども,Github Actionsで自動化することができるようです!
今回の記事では,自動テストのメリットについては触れることができませんでした。私の今の考えでは,自動テストが真価を発揮するのは複数人で開発する時なのではないかと考えています。ここで,継続的インテグレーション/デプロイメントという概念が登場することになります。ここらへんについても勉強して,近いうちに記事にできたらいいなと思います!今回も最後まで読んでいただきありがとうございました!
今回作ったリポジトリは,こちらです。