BAT CLI リファレンス

BAT コマンドラインインターフェースでは、テストをローカルで実行し、継続的に API テストを行うために監視をスケジュールできます。CLI-xAPI を使用してクラウドでテストをスケジュールできます。 BAT CLI は Anypoint Platform と統合されています。

このリファレンスでは、bat コマンドで使用できる構文と主要なオプションについて説明します。bat コマンドを使用して、テストのデバッグと実行、テストをスケジュールするためのログイン情報の取得、テストのスケジュール、テストスケジュールのリスト、追加操作の実行ができます。

bat コマンド

bat コマンドにより、API 機能監視コマンドラインインターフェースが提供されます。

構文

bat [<file> …​ | <option> …​]

bat [login --username=<value> [--profile=<value>] --host=<value>]

次のオプションにより、パスワードを要求する双方向コマンドが表示されます。

password for user [username]: <password>

必要に応じて、login コマンドにオプション --password=<password> を含めることもできます。

各項目は次のとおりです。

  • file はパスおよびファイル名への相対パスです。file には次の基本名のいずれかと次の拡張子のいずれかが必要です。

    • 基本ファイル名: main、bat

    • 拡張子: .yaml または .yml

      引数を付けずに bat を実行すると、BAT は現在のディレクトリで YAML を読み取り、指定されたテストを実行します。 環境用に、config フォルダを作成して config で別の設定ファイルを追加できます。

test-project
├── bat.yaml
├── tests
└── config
    ├── default
    ├── devx
    ├── qax
    ├── stgx
    └── prod

コマンドラインオプション

  • bat ~/path/to/folder/
    目的のフォルダを実行します。BAT は bat.yaml ファイルと main.dwl ファイルを検索して実行します。

  • bat ./folder/file.dwl
    目的のファイルを実行します。プロジェクトのルートは現在のフォルダです。 プロジェクトのルートはインポートを解決し、ライブラリおよびファイルを読み込むために使用されます。

    • --config=<name>

      設定ファイルを (config フォルダから) 選択し、結果をグローバル変数として登録します。

    • --version

      インストールされた BAT のバージョン番号およびラッパーを標準出力に出力します。最新バージョンがインストールされていない場合、そのバージョンがダウンロードされます。

    • --bat-version=1.0.51

      指定されたバージョンを使用して BAT を実行します。

    • --update

      最新の BAT CLI をインストールします。

    • --validate

      ファイルまたはフォルダを検証します。また、--config と連携して特定の設定の検証も行います。

    • get_token

      ログイン情報ファイルで Anypoint Platform にアクセスするためのトークンを返します。プロファイルを生成するには最初に bat login を実行する必要があります。

    • worker register

      マシン名を使用して投稿を生成し、ダミーの対象を作成します。

    • target ls list

      プロファイルの組織からすべての対象の情報をリストします。

    • schedule create [--cron="<expression>"]

      Cron 式を使用し、テストおよびすべてのファイルが含まれる zip を生成して、スケジューラを作成します。デフォルトでは、Cron 式が入力されないと、テストは 15 分ごとに実行するようにスケジュールされます。

    • schedule disable <scheduleID> 指定された ID で特定されるスケジュールを無効にします。このコマンドを実行した後で bat schedule ls を実行すると、その値が表示されます。

    • schedule enable <scheduleID>

      指定された ID で特定されるスケジュールを有効にします。このコマンドは、bat schedule disable <scheduleID> コマンドで無効にしたスケジュールを有効にする場合のみ使用します。

    • schedule endpoint <arbitrary-URL> [--cron="<cron>"] [--name=<suiteName>] [--target=<targetId>] [--new-relic-license-key=<newRelicLicenseKey>] [--slack-webhook=<slackWebHook>] [--sumo-endpoint=<sumoEndpoint>] [--pager-duty-routing-key=<pagerDutyRoutingKey>] [--custom-report-url=<customReportUrl>] [--custom-report-headers=<header1,header2,…​,headerN>] [--custom-report-transformation=<pathToDwlFile>][--init-folder]

      任意の URL を使用する監視を Exchange で作成します (例: http://example.com)。必要に応じて、コマンドを追加して別のパラメータで bat.yaml を生成できます。

      • [--cron="<cron>"] デフォルトでは、テストは 15 分ごとに実行するようにスケジュールされます。Cron 式を使用して変更できます。

      • [--name="<suiteName>"] スイートの名前を設定します。

      • [--target="<targetId>"] 監視の特定の対象を設定します。

      • [--new-relic-license-key="<newRelicLicenseKey>"] New Relic レポートを bat.yaml に追加します。

      • [--slack-webhook="<slackWebHook>"] Slack レポートを bat.yaml に追加します。

      • [--sumo-endpoint="<sumoEndpoint>"] Sumo レポートを bat.yaml に追加します。

      • [--pager-duty-routing-key="<pagerDutyRoutingKey>"] PagerDuty レポートを bat.yaml に追加します。

      • [--custom-report-url="<customReportUrl>"] [--custom-report-headers="<header1,header2,…​,headerN>"] | [--custom-report-transformation="<pathToDwlFile>"] カスタムレポートを bat.yaml ファイルに追加し、必要に応じて変換ファイルを追加できます。

      • [--init-folder] 生成された exchange.json、bat.yaml、main.dml を現在のディレクトリに保存します。

    • schedule ls | list

      プロファイルの組織からすべてのスケジューラ情報をリストします。

    • schedule rm | remove <scheduleId>

      その ID を基準にスケジュールを削除します。

    • --username=<value>

      値は Anypoint Platform ユーザ名です。

    • --password=<value>

      値は Anypoint Platform ユーザ名のパスワードです。

    • --profile=<value>

      プロファイルは次のとおりです。

      • Anypoint Platform の場所にアクセスし、BAT セッション間でログイン情報を保持するためのプロファイルの名前。このオプションを使用すれば、セッション間で再ログインする必要がなくなります。省略可能。

      • エンドポイントをスケジュールするためのプロファイルの名前であり、使用した BAT ログインプロファイルとは異なる場合があります。デフォルトでは、BAT はスケジュール用のログインプロファイルを使用します。省略可能。

    • --init-folder

      現在のディレクトリで監視を作成することで生成されたファイル、exchange.json および main.dwl を保存します。省略可能。

    • --init

      基本的なプロジェクトフォルダをセットアップする bat init コマンドと同じです。このフォルダには以下のファイルが含まれます。

bat.yaml
tests/
tests/HelloWorld.dwl
config/
config/default.dwl
config/prod.dwl
config/dev.dwl

BAT コマンドの例

  • bat.yaml ファイルから複数のテストファイルを実行します。

    bat bat.yaml

  • 単一のファイルを実行します。

    bat ./test/myFile.dwl

  • インストールされたバージョンを判断します。

    bat --version

    最新バージョンでない場合の出力例:

    Updating Version: You have an older BAT version.
    The new version will be downloaded in /Users/<username>/.bat/bat-cli-1.0.51
    Downloading version 1.0.51. Please wait`.......................
    BAT Wrapper: 1.0.53
    BAT Version: 1.0.51

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub