
はじめに
Hurl の API テストを GitHub Actions で動かしてみようと思った.Hurl の CI/CD Integration というドキュメントを参考に簡易的な仕組みで試してみた👌
環境
- Hurl 8.0.1
👾 bin/integration.sh
Hurl のドキュメントでは bin/integration.sh というスクリプトを使って API テスト対象のアプリケーションを起動するようになっていた.今回はサンプルとして httpbin を使う.
またコンテナが起動する前に API テストが実行されないように待機するロジックも必要になる.よく dockerize や wait-for-it を使ったりするけど,Hurl のドキュメントでは Hurl の --retry オプションを使うようになっていて,へぇ〜💡と思った.
#!/bin/sh set -eu wait_for_url () { echo "Testing $1..." printf 'GET %s\nHTTP 200' "$1" | hurl --retry "$2" > /dev/null return 0 } echo 'Starting container' docker run --name httpbin --rm --detach --publish 8080:8080 mccutchen/go-httpbin:2.22.1 wait_for_url 'http://localhost:8080/status/200' 60
👾 tests/main.hurl
Hurl の API テストは適当に3つの項目を準備した✅️
- ステータスコード
200が返ること - 指定したクエリパラメータがレスポンスに含まれること
- 指定した
User-Agentが正しくリクエストされていること
GET http://localhost:8080/status/200 HTTP 200 GET http://localhost:8080/get [Query] hello: world HTTP 200 [Asserts] jsonpath "$.args.hello[0]" == "world" GET http://localhost:8080/headers User-Agent: hurl-on-github-actions HTTP 200 [Asserts] jsonpath "$.headers['User-Agent'][0]" == "hurl-on-github-actions"
👾 .github/workflows/ci.yml
最後に GitHub Actions ワークフローを準備する.Hurl のインストールはドキュメントと同じく curl で取得するようにしていて,あとは bin/integration.sh と hurl --test tests/*.hurl を実行すれば OK❗️
name: CI on: push: branches: - main pull_request: jobs: test: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Install Hurl run: | curl --location --remote-name https://github.com/Orange-OpenSource/hurl/releases/download/8.0.1/hurl_8.0.1_amd64.deb sudo dpkg -i hurl_8.0.1_amd64.deb - name: Start API run: bin/integration.sh - name: Run Hurl tests run: hurl --test tests/*.hurl
動作確認
期待通りに Hurl の API テストを GitHub Actions で動かせた👌
Run hurl --test tests/*.hurl Success tests/main.hurl (3 request(s) in 2 ms) -------------------------------------------------------------------------------- Executed files: 1 Executed requests: 3 (1500.0/s) Succeeded files: 1 (100.0%) Failed files: 0 (0.0%) Duration: 2 ms (0h:0m:0s:2ms)

👾 .github/workflows/ci.yml(HTML レポート付き)
hurl --test コマンドはテストレポートを出力するオプションもある.
- HTML Report:
--report-html - JSON Report:
--report-json - JUnit Report:
--report-junit - TAP Report:
--report-tap
GitHub Actions で HTML レポートをアーティファクトに登録する場合は以下のように GitHub Actions ワークフローを拡張すれば OK❗️
name: CI on: push: branches: - main pull_request: jobs: test: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Install Hurl run: | curl --location --remote-name https://github.com/Orange-OpenSource/hurl/releases/download/8.0.1/hurl_8.0.1_amd64.deb sudo dpkg -i hurl_8.0.1_amd64.deb - name: Start API run: bin/integration.sh - name: Run Hurl tests run: hurl --test --report-html tests/report tests/*.hurl - name: Upload HTML report if: always() uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: hurl-report path: tests/report/
動作確認(HTML レポート付き)
HTML レポートは複数ファイルで構成されるため ZIP 経由でダウンロードする必要があるけど,期待通りに Hurl の HTML レポートを確認できた.
$ tree .
.
├── index.html
└── store
├── 37bcfe3c-7091-4535-928e-69c16ef4bf3f-run.html
├── 37bcfe3c-7091-4535-928e-69c16ef4bf3f-source.html
└── 37bcfe3c-7091-4535-928e-69c16ef4bf3f-timeline.html
2 directories, 4 files

まとめ
Hurl の API テストを GitHub Actions で動かしてみた.Hurl を使う機会が増えてるからもっとブログにまとめていくぞ〜💪
関連記事
kakakakakku.hatenablog.com kakakakakku.hatenablog.com kakakakakku.hatenablog.com