📋

【Day8】リクエストの結果を次のステップで利用してみる / runnチュートリアル

2023/12/08に公開

API

はじめに

一人アドベントカレンダーとしスタートしていました。
本記事は API シナリオテストツールでもある runn のチュートリアルをステップバイステップで理解して貰おう！というのが趣旨です。
25 日間のチュートリアルを経て、 runn を使っての API シナリオテストや、 API と連動させる自動化処理を一人で行えるようになることを目標にしています。
runn is 何？という方は、以下に紹介記事を書いていますのでよろしくお願いします。

チュートリアルを実際に試し、もし躓いた箇所があれば、記事のコメント欄にお知らせいただけると幸いです。

前日の記事は「レスポンスの結果を検証してみる」でした。

リクエストの結果を次のステップで利用してみる

昨日の記事でレスポンス結果の参照及び検証する方法について説明しました。
1 つのエンドポイントに対して呼び出しと検証ができるようになりました。
ここからよりシナリオテストっぽくしていきます。

今までの内容ではステップが 1 つのみでしたが、今回始めて複数ステップになります。

もうそろそろスクロールしないと見えないですねｗ
分割してみていきます。

1 番目のステップです。
ここは前回と変わりません。

今回のメインはこちらです。

詳しく見ていきましょう。

{{}} の部分で変数展開されているのがわかります。
以前の "変数を使ってみる"での説明や今回の 1 番目のステップの様に vars.変数名 ではなく previous.resp.body という参照になっています。
"レスポンスの結果を検証してみる" で説明した current.res.body と近い記述になっています。
違いは current が previous になっているだけです。
previous は 1 つ前のステップを表すものになります。逆に？ current が現在のステップを表すものになります。
これらは runn が自動的に作成する変数となります。

今回のケースでは previous.res.body.articles[0].slug となっており、記事一覧取得のレスポンスで 1 番目の記事（配列は 0 から始まります）の slug にアクセスしています。
slug は JSON のキーの名前ですが、一般的には URL のパスの一部になります。

動きを理解する為に debug 実行させてみましょう。
今回は変数で cout は 1 件のみに絞っています。

% USER=katzumi runn run day08/previous.yml --debug
Run "指定された件数分、記事一覧を取得します" on "次のステップで一つ前のレスポンスを引き継いでみよう".steps[0]
-----START HTTP REQUEST-----
GET /api/articles?count=1&order=daily&username=katzumi HTTP/1.1
Host: zenn.dev
Content-Type: application/json


-----END HTTP REQUEST-----
-----START HTTP RESPONSE-----
HTTP/2.0 200 OK
Alt-Svc: h3=":443"; ma=2592000,h3-29=":443"; ma=2592000
Cache-Control: max-age=0, private, must-revalidate
Content-Type: application/json; charset=utf-8
Date: Sun, 19 Nov 2023 08:32:20 GMT
Etag: W/"03bc53e4ed94561f41ca79dea5359c00"
Referrer-Policy: strict-origin-when-cross-origin
Server: Google Frontend
Vary: Accept-Encoding, Origin
Via: 1.1 google
X-Cloud-Trace-Context: 2bd7a1c4a89563bafcb968a57420ab6d
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Frame-Options: SAMEORIGIN
X-Permitted-Cross-Domain-Policies: none
X-Request-Id: 95248596-93ae-4ba4-a45c-c6c3f4fc2cb9
X-Runtime: 0.014307
X-Xss-Protection: 0

{"articles":[{"id":115084,"post_type":"Article","title":"APIシナリオテストの新ツールrunn","slug":"api-scenario-testing-with-runn","comments_count":0,"liked_count":172,"body_letters_count":10851,"article_type":"tech","emoji":"🧪","is_suspending_private":false,"published_at":"2022-09-20T00:29:27.454+09:00","body_updated_at":"2022-09-20T07:27:45.059+09:00","source_repo_updated_at":"2022-09-20T07:27:45.046+09:00","pinned":false,"path":"/katzumi/articles/api-scenario-testing-with-runn","user":{"id":1578,"username":"katzumi","name":"katzumi","avatar_small_url":"https://res.cloudinary.com/zenn/image/fetch/s--O0GLM2Pk--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/8fb0c88e62.jpeg"},"publication":null}],"next_page":2}
-----END HTTP RESPONSE-----
Run "test" on "次のステップで一つ前のレスポンスを引き継いでみよう".steps[0]

Run "記事の詳細を取得します" on "次のステップで一つ前のレスポンスを引き継いでみよう".steps[1]
-----START HTTP REQUEST-----
GET /api/articles/api-scenario-testing-with-runn HTTP/1.1
Host: zenn.dev
Content-Type: application/json


-----END HTTP REQUEST-----
-----START HTTP RESPONSE-----
HTTP/2.0 200 OK

.. snip ..

-----END HTTP RESPONSE-----
Run "test" on "次のステップで一つ前のレスポンスを引き継いでみよう".steps[1]
.

1 scenario, 0 skipped, 0 failures

1 ステップ目のレスポンスの JSON を整形すると以下の様になっていました。

{
  "articles": [
    {
      "id": 115084,
      "post_type": "Article",
      "title": "APIシナリオテストの新ツールrunn",
      "slug": "api-scenario-testing-with-runn",
      "comments_count": 0,
      "liked_count": 172,
      "body_letters_count": 10851,
      "article_type": "tech",
      "emoji": "🧪",
      "is_suspending_private": false,
      "published_at": "2022-09-20T00:29:27.454+09:00",
      "body_updated_at": "2022-09-20T07:27:45.059+09:00",
      "source_repo_updated_at": "2022-09-20T07:27:45.046+09:00",
      "pinned": false,
      "path": "/katzumi/articles/api-scenario-testing-with-runn",
      "user": {
        "id": 1578,
        "username": "katzumi",
        "name": "katzumi",
        "avatar_small_url": "https://res.cloudinary.com/zenn/image/fetch/s--O0GLM2Pk--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/8fb0c88e62.jpeg"
      },
      "publication": null
    }
  ],
  "next_page": 2
}

こちらの slug が api-scenario-testing-with-runn となっています。
こちらの変数が展開されており 2 件目のステップのデバック出力は以下のようになります。

Run "記事の詳細を取得します" on "次のステップで一つ前のレスポンスを引き継いでみよう".steps[1]
-----START HTTP REQUEST-----
GET /api/articles/api-scenario-testing-with-runn HTTP/1.1
Host: zenn.dev
Content-Type: application/json

上記のようなアクセスになっています。
ステップが分かれると desc で指定した内容がでるのでわかりやすくなります。desc の書き方は "ステップに説明を付けてみる" を参照ください。

こちらの一連のステップで記事一覧から 1 番目の記事の詳細を取得するというシナリオが実現できています。

最後にテストも見てみましょう。
ここでも previous を利用します。
記事の詳細は slug でアクセスしていますが、テストでは id の比較します。

current.res.body.article.id
現在のステップの記事の ID になります。
previous.res.body.articles[0].id
前回のステップ（記事一覧取得）の記事リストの最初の記事の ID（記事詳細取得時の ID）

という意味になります。
こうすることでより厳密なテストになることでしょう。

如何でしたでしょうか？複数のエンドポイントの API を組み合わせてのテストが簡単に行えることを、ご理解いただけたことと考えます！

明日以降ももっと便利に使えるになるチュートリアルをご紹介しますのでお楽しみに。

明日は「ステップに名前を付ける」です。

はじめに

リクエストの結果を次のステップで利用してみる

Discussion