【Day19】外部コマンドを実行してみる / runnチュートリアル
はじめに
一人アドベントカレンダーとしスタートして絶賛掲載中です。
本記事は API シナリオテストツールでもある runn のチュートリアルをステップバイステップで理解して貰おう！というのが趣旨です。
25 日間のチュートリアルを経て、 runn を使っての API シナリオテストや、 API と連動させる自動化処理を一人で行えるようになることを目標にしています。
runn is 何？という方は、以下に紹介記事を書いていますのでよろしくお願いします。
チュートリアルを実際に試し、もし躓いた箇所があれば、記事のコメント欄にお知らせいただけると幸いです。
前日の記事は「OpenAPIの仕様書通りか？テストする」でした。
外部コマンドを実行してみる
昨日の記事 で OpenAPI 仕様書によるリクエストとレスポンスの検証ができるようになりました。
今回は更に OpenAPI 仕様書を利用した場合の便利な機能を紹介したいきます。
前回の runbook からステップ 1 つ追加しました。
単体テストではカバレッジが計測できますが、API テストではアプリケーションのステップ単位でのカバレッジを計測することが通常出来ません。
今回のお題の外部コマンドを実行して API 仕様書のカバー範囲を確認する方法は以下の通りになります。
外部コマンドを実行するには Exec Runner を利用します。
Exec Runner は組み込みの Runner で設定不要で利用できます。
command セクションで実行するコマンドを指定します。
コマンドの実行結果はそれぞれ以下のように参照できます。
- exit_code
終了コード。 - stdout
標準出力。 - stderr
標準エラー出力。
dump でコマンドの結果を出力しています。
Dump runner の使い方は "Hello world!" と "レスポンスをdumpして外部JSON化する" で紹介しています。
Exec Runner を使う際の注意点として、実行時のオプションの追加が必要な点です。
$ runn run --scopes run:exec day19/exec-coverage.yml
Spec Coverage
-----------------------------------------------------
Total 10.5%
Swagger Petstore - OpenAPI 3.0:1.0.17 10.5%
.
1 scenario, 0 skipped, 0 failures
--scopes run:exec オプションになります。
実行結果としてカバレッジが出力されます。
サンプルで Exec Runner を利用していますが、もちろん直接以下のように実行してもカバレッジ表示ができます。
$ runn coverage day19/open-api-coverage.yml
普段は run コマンドを実行していますが、coverage コマンドに変えるだけです。
API のテスト漏れがないか？偶には API のシナリオテストでのカバレッジを見てみると良いかと考えます。
明日は「DB に結果を格納する」です。
Discussion