CATとGitHubを連携してみた
テスト管理ツールCATのサポート担当の坂本です。
gitリポジトリ連携プラグイン（※1）を利用してCATの課題(※2)とgitのコミットログを連携できるようになりました。ステータスの変動時や、ソースの変更内容を確認する際に便利な機能になります。
本記事ではCATとGitHub(※3)でgitのリポジトリ連携についてご案内いたします。
※1 CATのプラグイン機能はダウンロード版限定の機能になります。
※2 障害票（バグ票）やプロジェクトで実施すべきタスクをここでは「課題」とします。
※3 GitHubはGitHub社が提供するサービスです。
CATとgitを連携する効果は以下の二点です。
- 課題を起点として、関連するテストケース、コミットを一気通貫で把握できる
- 課題の修正完了時に変更差分を課題参照画面から確認できる
[CATの課題参照画面]
CATプロジェクトと、gitのリポジトリは一対一で対応するようになっています。連携されたgitのリポジトリ上でCATの課題IDを記載してコミットすると、CATが自動的にgitのコミットとCATの課題を関連付けします。
[前提条件]
gitのサーバとしてGitHubを利用し、プロトコルにsshを利用します。
※gitのプラグインはgitプロトコルとsshプロトコルに対応しています。
[手順]
秘密鍵、公開鍵の作成
サーバ上で秘密鍵、公開鍵を作成します。
$ssh-keygen -t rsa
[GitHub側の設定]
GitHubにssh公開鍵を登録します。
[CAT側の設定]
①プラグインインストール
gitプラグインをディレクトリに配置します。
配置先：${CAT_HOME}/catmodule/ROOT/WEB-INF/lib/
②CATを再起動します。
$systemctl stop cat
$systemctl start cat
③メニューアイコン（歯車）から[システム管理]を選択し、[プラグイン管理]をクリックしてプラグインをインストールします。
④プロジェクトのトップ画面から「プロジェクト設定」を選択し、「Gitリポジトリ連携設定」をクリックして
リポジトリ連携設定を表示し、SSH接続情報（※）と秘密鍵を登録します。（※今回はsshで接続設定をします。）
※SSHを利用する際の注意点
CATでSSHを利用する際は以下の通り登録をしてください。
ssh://xxxx@xxxxxxxx.xxx/ xxxxxx/xxxxxx.git
CATの課題とgitのコミットを関連付けします
gitでコミットをする
gitをコミットをします。
$git add sample.txt
$git commit -m "テスト ERRW-3”
※コミットログに課題のID（今回の場合は ERRW-3）を記載することでCATの課題とgitを関連付けすることができます。課題はCATの課題一覧から確認できます。
$git push origin master
CATでコミットを確認する
サンプルで起票した課題の参照画面を開き、ページ下部活動のタブのgitをクリックするとコミットが確認できます。
※ファイル名をクリックするとの更新差分が確認できます。
リポジトリを連携すると修正の内容を課題から確認できます。修正内容や修正の抜け漏れの防止をすることができます。是非一度おためしください！
