spec2scenarigo

概要／Overview

本CLIは、OpenAPIからScenarigoのテストシナリオを生成するためのツールです。

インストール／Install

$ go install github.com/o-ga09/[email protected]

使い方／Usage

• csv-file：OpenAPI Specのパラメータを指定したくない場合に、パラメーターを別途指定するcsvファイル
  • ヘッダなし
  • カラムの順序は、テスト対象パス（文字列）、HTTPメソッド（文字列）
  • テスト対象パスに、パスパラメーターやクエリパラメーターを含む

/v1/health/xxxxx?companyname=xxxxxx&company=yyyyyyy,GET,
/v1/company/000000/project/1729712947901?user=xxxxxx,GET
/v1/user/000000?company=xxxxxx,GET

• dry-run：シナリオファイルの生成なしに、デバッグ可能にする
• host：APIサーバのURL(OpenAPI Specに複数指定されている場合に、一番最初の要素のURLが使用される仕様のため)
  • 現在のバージョンでは、x-api-keyのみ認証を通過できます
  • export API_KEY=xxxを設定する必要があります。
• output-file：シナリオのファイル名を指定可能
• test-case： 200、404、400、500といったHTTPステータス毎にテストシナリオを生成できる。

Usage:
  spec2scenarigo [input file] [flags]

Flags:
  -c, --csv-file string      add test pattern parameter
  -d, --dry-run              dry run mode. not generate scenario file
  -h, --help                 Help message
  -s, --host string          API EndPoint
  -o, --output-file string   output file name
  -t, --test-case string     determine use test case
  -v, --version              version for go-spec-to-scenarigo

特徴／Features

• テスト対象のAPIのレスポンスを使用して、シナリオを生成する
• パスパラメーターや、クエリパラメーターにOpenAPIの記述を使用したくない場合にcsvで別途指定できる
• --dry-runオプションを指定すると、シナリオファイルの生成なしにOpenAPI Specから値が取得できているかを確認できる

注意事項／Caution

• 本ツールは、開発中のため、バグが含まれている可能性があります。また、テストも全て書かれていないので品質については保証いたしかねます。

今後の予定／Updates

• テストを書く
• APIをリクエストする認証に対応する（basic認証、Bearer認証、awssigv4）
• リクエストボディ（文字列）をcsvで指定できるようにする