【Day16】JSONファイルにパラメータ埋め込みをしてみる / runnチュートリアル
はじめに
一人アドベントカレンダーとしスタートして絶賛掲載中です。
本記事は API シナリオテストツールでもある runn のチュートリアルをステップバイステップで理解して貰おう！というのが趣旨です。
25 日間のチュートリアルを経て、 runn を使っての API シナリオテストや、 API と連動させる自動化処理を一人で行えるようになることを目標にしています。
runn is 何？という方は、以下に紹介記事を書いていますのでよろしくお願いします。
チュートリアルを実際に試し、もし躓いた箇所があれば、記事のコメント欄にお知らせいただけると幸いです。
前日の記事は「リクエストJSONを外部ファイル化する」でした。
JSONファイルにパラメータ埋め込みをしてみる
昨日の記事 でリクエスト内容を外部ファイル（JSON）化できるようになりました。
今回は、1 つの JSON ファイルで柔軟にデータパターンを増やせる方法について紹介していきます。
前回のシナリオの内容は大きく挙動を変えずに include を組み合わせたシナリオにしています。
- json-template.yml
メインシナリオファイルです。 - post-scrap.yml
前回のスクラップ記事を登録するシナリオを分割しています。 - scrap.json.template
今回の肝となるファイルです。
変更があるステップを見ていきます。
スクラップ記事の登録処理が include に書き直されています。
前回は vars セクションで json ファイルを読み込むようになっていましたが、include 時の vars でも json 展開ができるようになっています。
こちらの記述方法は "includeしたシナリオの変数を書き換えよう" を参照ください。
あと新しい要素として組み込み関数 faker.UUID() を呼び出しています。
こちらでダミーの UUID を発行できます。
runn には他にも便利な組み込み関数が幾つかあるのでオフィシャルのドキュメント（Additional built-in functions）を参照ください。
次の 2,3 ステップ目は前回とほぼ同じなので割愛して、post-scrap.yml を見ていきます。
単純に前回の 1 ステップ目をそのまま切り出した感じになあります。
次にメインの scrap.json.template を見ていきます。
中身は JSON のファイルですが、パラメータの埋め込みがされています。
{{.vars.title_suffix }}
こちらの記述方法は Go Template になります。
Go Template として認識させるには .json.template という拡張子にする必要があります。
Template 自体の記法については詳しくは説明しませんが、こちらの記述で title_suffix 変数が展開されます。
include 元でダミーの UUID が指定されているものが出力されることになります。
どういう値が展開されているかは debug オプションを有効にして実行してみてください。
% SESSION="miserarenaiyo" runn run day16/json-template.yml --verbose
=== JSONテンプレートを利用してデータの柔軟性を高めましょう (day16/json-template.yml) ... ok
--- スクラップ記事を登録します (postScrap) ... ok
=== JSONリクエストを送信するシナリオ (day16/post-scrap.yml) ... ok
--- スクラップ記事を登録します (postScrap) ... ok
--- スクラップ記事をアーカイブします (archiveScrap) ... ok
--- スクラップ記事を削除します (deleteScrap) ... ok
1 scenario, 0 skipped, 0 failures
SESSION に何を指定させるか？は "リクエストJSONを外部ファイル化する > 前準備" を参照ください。
Go Template を使うと、一部値が違うデータを用意したりすることが出来るので大変便利です。
明日は「レスポンスを dump して外部 JSON 化する」です。
Discussion
こちらの記事の内容ではUUIDのパラメータが正しくリクエストが出来ていない問題がありました。
修正版の内容をzenn bookの方にアップしましたのでこちらを参照ください