ハンズオン その1 では、GitHubからソースコードを取得し、ビルド、デプロイまでをパイプラインを使って構築しました。
ハンズオン その2では、GitHubとの連携及びテストタスクを導入します。
続けて、トリガーをセットし、GitHubへのpushをトリガとしてパイプラインが自動的に動作することを確認します。
[トポロジー]画面を開いている方は、[パイプライン実行]の下の PL というアイコンの横のリンクをクリックします。
※ もしページを閉じてしまっている場合、最初から操作する場合は以下の手順となります。
- OpenShiftのWebコンソールを表示
- 左上のメニューにて[管理者]から[Developer]に切り替え
- [トポロジー]画面をクリックすると、画面に表示された丸の中をクリックすると右側にメニューが出てきます。
- そのメニュー中央辺りの[パイプライン実行]の下の PL というアイコンの横のリンクをクリックします。
パイプラインが表示されます。 右上の[アクション]をクリックし、[トリガーの追加] をクリックします。
トリガーの追加 画面が開きますので、[Gitプロバイダータイプ]に github-push を選択し、[追加]ボタンをクリックしてください。
他の項目はデフォルト値のままで構いません。
パイプラインにトリガーが追加されました。
このトリガーは、GitHub WebHookからのHTTPリクエストを受けパイプラインを実行します。そのために、GitHub WebHookに設定が必要です。
そのために、[トリガーテンプレート]の下のURLをクリップボードにコピーします。
GitHubとトリガーURLとの関係は以下の通りです。続けて、クリップボードにコピーしたURLをGitHubに登録します。
GitHubの自分のリポジトリーへ戻り、[Settings] -> [Webhooks] -> [Add webhook]を選択します。
先ほどクリップボードにコピーしたトリガーURLを[Payload URL]に貼り付けてください。[Control type]は[application/json]を選択してください。
入力後、[Add webhook]を選択します。
以下の図の様に緑のチェックマークが付いたら設定成功です。
すぐにチェックマークが表示されないので、ページを再読み込みしてください。
これでwebhookの設定は完了です。後はソースコードの修正で自動的にアプリケーションがデプロイされます。
GitHub上のソースコードを修正し、それが自動でOpenShiftへ反映されることを試していきます。
GitHubの自分のリポジトリ画面から[SampleApp/Pages/Index.cshtml]ファイルを選択します。
ペンのアイコンをクリックして編集モードにします。
ここでは、GitHubのGUIから編集を行いますが、ローカルにcloneして編集したファイルをcommit、pushしてもOKです。
変更点をクイックに確認するために、ここでは10行目に以下の1行を挿入します。
<p>トリガー動作テスト</p>
変更したら[Commit changes]をクリックしてください。自分所有のリポジトリーなので、そのまま反映されます。
OpenShiftのWebコンソールへ戻り、左側の[トポロジー]を確認すると、再度パイプラインが実行されていることが分かります。
パイプライン実行が完了したらアプリケーションを表示してください。（既に表示されている場合はリロードしてください）
アプリケーション内に先程追加した文言 (トリガー動作テスト) が追加されていることが確認できました。
これで、トリガーを用いて、OpenShift PipelineとGitHubを連携することができました。
これにより、GitHubへのpushを皮切りとしてアプリデプロイまで自動的に実施される、CI/CDの基本設定が完了しました。
続けて、作成したパイプラインにテストタスクを導入し、テストの失敗/成功時のパイプラインの動作を確認していきます。
テストタスクを追加します。
このハンズオンで利用しているアプリケーションは .Net で構築されています。
.Net アプリケーションはSampleAppに、テストコードはSampleApp.Testsに記載しています。
注) .Netのテストコードの書き方については、Microsoftの以下のサイトを参照ください。 https://docs.microsoft.com/ja-jp/dotnet/core/testing/unit-testing-with-dotnet-test
.Netは、現在はWindows/Mac/Linuxと様々な環境でdotnetというコマンドを使って様々な処理を行うことができます。
テストは、dotnet testとタイプすることにより、実行可能です。今回はこのコマンドを使ってテストタスクを作成します。
GitHubの自分のリポジトリーを開き、GitHubの自分のリポジトリ画面からtasks/dotnet-test.ymlファイルを選択し、[Raw]をクリックします。
ブラウザ上に表示されているテキストをすべてクリップボードにコピーします。
OpenShiftの画面に戻ります。左上のメニューにて、[Developer]から[管理者]に切り替えます。
[タスク]をクリックし画面左上の[作成]をクリックし、[タスク]をクリックします。
クリップボードにコピーしたテキストを、画面に貼り付けて[作成]をクリックします。
これでテストタスクが作成されました。次はこのテストタスクをパイプラインに組み込みます。
では、テストタスクをパイプラインに追加します。
左上のメニューにて、[管理者]から[Developer]に切り替えます。
[パイプライン]を選択し、画面中央の PL アイコンの隣のリンクをクリックします。
画面右上の[アクション]から[パイプラインの編集]をクリックします。
このテストタスクは、[fetch-repository (git-clone))]タスクによってワークスペースに置かれたソースコードを使ってアプリケーションのテストを実行します。
[build (s2i-dotnet)]はコンテナイメージの生成まで実施してしまいますので、その間に配置します。
タスク上の(build)にマウスカーソルを当てると、[+]が左右と下に表示されます。左側の[+]をクリックします。
dotnet-testを選択します。
続けて、追加した(dotnet-test)をクリックします。
dotnet-testタスクのパラメータ設定が表示されます。以下の通り設定します。
| パラメータ | 値 |
|---|---|
| VERSION | $(params.VERSION) |
| PATH_CONTEXT | $(params.PATH_CONTEXT) |
ワークスペースは workspace を選択し、[保存]をクリックします。
[dotnet-test]タスクに赤い[!]が表示が表示されていないことを確認し、[保存]をクリックします。
以上で、テストタスクをパイプラインへ追加することができました。
では、変更したパイプラインの動作を確認します。 画面右上の[アクション]から[最終実行の開始]をクリックします。
テストが失敗したはずです。
実は、このテストはわざと失敗するようにしています。
テストが失敗したことで、パイプライン後続のビルドやデプロイ処理が行われていないことを確認できました。
失敗した[dotnet-test]タスクをクリックすると、その失敗内容をログを通じて確認することができます。
ログの最下段を見ると1件Failedとなっています。
原因を探るためにログを上にスクロールし中盤あたりに移動すると、
Assert.Contains() Failure, Not found: Successと記載があります。
このテストでは、「Success」という文字列がWebサイトに含まれていることを期待したが、含まれていなかったことを示唆しています。
もし上記文字列をログ内に見つけられない方は、ブラウザの内部キーワード検索を利用いただき、「Assert.Contains() Failure」を検索ください。
それでは、ソースコードに「Success」を含むように修正を行い、テストが通るようにします。
GitHubの自分のリポジトリ画面に移動し、SampleApp/Pages/Index.cshtmlファイルを選択します。
ペンのアイコンをクリックして編集モードにします。
ここでは、GitHubのGUIから編集を行いますが、ローカルにcloneして編集したファイルをcommit、pushしてもOKです。
変更点をクイックに確認するために、ここでは11行目に以下の1行を挿入します。
<p>Test Success!</p>
変更したら[Commit changes]をクリックしてください。自分所有のリポジトリーなので、そのまま反映されます。
OpenShiftのWebコンソールへ戻り、左側の[トポロジー]を確認すると、再度パイプラインが実行されていることが分かります。
「2.4 パイプラインの動作確認(テスト失敗)」では手動でテストを実行しましたが、今回はソースコードを変更したことによりGitHubとトリガが連動しパイプラインでテストが自動実行されています。
2,3分程度で[dotnet-test]が完了し[build]に移行しているはずです。
実行中のパイプライン実行の右にある[ログの表示]リンクをクリックすることで、パイプライン実行結果ログを確認することができます。
「パイプライン実行>パイプライン実行 の詳細」ページには複数タブがあります。
[詳細]タブが選択されている場合は、[ログ]タブを選択してください。
前回は1件Failedとなっていましたが、今回は1件Passed、つまりテスト成功となっています。
これにより後続のタスクが継続実行されていることを確認できました。
もうしばらく待つと、deployまで終了し画面中心辺りに(成功)という小さなラベルが表示されていることを確認できます。
また、deployのログを見るとsuccessfully rolled outとありますので、デプロイも成功したことを確認できました。
では、アプリケーションを表示してみてください。（既に表示されている場合はリロードしてください）
アプリケーション内に先程追加した文言 (Test Sucess!) が追加されていることが確認できました。
これで、パイプラインにテストタスクを追加し、CIにテストを追加することができました。