dev test recipe

レシピのテスト

インストール

最新リリースからコンパイル済みのバイナリをダウンロードしてください. Windowsをお使いの方は、tbx-xx.x.xxx-win.zipのようなzipファイルをダウンロードしてください. その後、アーカイブを解凍し、デスクトップフォルダに tbx.exe を配置します. watermint toolboxは、システムで許可されていれば、システム内のどのパスからでも実行できます. しかし、説明書のサンプルでは、デスクトップフォルダを使用しています. デスクトップフォルダ以外にバイナリを配置した場合は、パスを読み替えてください.

利用方法

このドキュメントは”デスクトップ”フォルダを例として使用します.

実行

Windows:

cd $HOME\Desktop
.\tbx.exe dev test recipe 

macOS, Linux:

$HOME/Desktop/tbx dev test recipe

macOS Catalina 10.15以上の場合: macOSは開発者情報を検証します. 現在、tbxはそれに対応していません. 実行時の最初に表示されるダイアログではキャンセルします. 続いて、”システム環境設定”のセキュリティーとプライバシーから一般タブを選択します. 次のようなメッセージが表示されています:

“tbx”は開発元を確認できないため、使用がブロックされました。

“このまま開く”というボタンがあります. リスクを確認の上、開いてください. ２回目の実行ではダイアログに”開く”ボタンがありますので、これを選択します

オプション:

-all: 全てのレシピをテストします. Default: false
-no-timeout: レシピのテスト時にタイムアウトしません. Default: false
-single: テストするレシピ名
-verbose: テスト結果の詳細出力. Default: false

共通のオプション:

-auth-database: 認証データベースへのカスタムパス (デフォルト: $HOME/.toolbox/secrets/secrets.db)
-auto-open: 成果物フォルダまたはURLを自動で開く. Default: false
-bandwidth-kb: コンテンツをアップロードまたはダウンロードする際の帯域幅制限(Kバイト毎秒). 0の場合、制限を行わない. Default: 0
-budget-memory: メモリの割り当て目標 (メモリ使用量を減らすために幾つかの機能が制限されます). Options: low, normal. Default: normal
-budget-storage: ストレージの利用目標 (ストレージ利用を減らすためログ、機能を限定します). Options: low, normal, unlimited. Default: normal
-concurrency: 指定した並列度で並列処理を行います. Default: プロセッサー数
-debug: デバッグモードを有効にする. Default: false
-experiment: 実験的機能を有効化する
-extra: 追加パラメータファイルのパス
-lang: 表示言語. Options: auto, en, ja. Default: auto
-output: 出力書式 (none/text/markdown/json). Options: text, markdown, json, none. Default: text
-output-filter: 出力フィルタ・クエリ（jq構文）。レポートの出力はjq構文を使ってフィルタリングされる。このオプションは、レポートがJSONとして出力される場合にのみ適用される。
-proxy: HTTP/HTTPS プロクシ (hostname:port). プロキシの設定を省略したい場合はDIRECTを指定してください
-quiet: エラー以外のメッセージを抑制し、出力をJSONLフォーマットに変更します. Default: false
-retain-job-data: ジョブデータ保持ポリシー. Options: default, on_error, none. Default: default
-secure: トークンをファイルに保存しません. Default: false
-skip-logging: ローカルストレージへのログ保存をスキップ. Default: false
-verbose: 現在の操作を詳細に表示します.. Default: false
-workspace: ワークスペースへのパス

実行結果

作成されたレポートファイルのパスはコマンド実行時の最後に表示されます. もしコマンドライン出力を失ってしまった場合には次のパスを確認してください. [job-id]は実行の日時となります. このなかの最新のjob-idを各委任してください.

OS	パスのパターン	例
Windows	`%HOMEPATH%\.toolbox\jobs\[job-id]\reports`	C:\Users\bob.toolbox\jobs\20190909-115959.597\reports
macOS	`$HOME/.toolbox/jobs/[job-id]/reports`	/Users/bob/.toolbox/jobs/20190909-115959.597/reports
Linux	`$HOME/.toolbox/jobs/[job-id]/reports`	/home/bob/.toolbox/jobs/20190909-115959.597/reports

レポート: result

レシピテスト結果このコマンドはレポートを3種類の書式で出力します. result.csv, result.json, ならびに result.xlsx.

列	説明
path	レシピへのパス
name	レシピの名称
skip	テストがスキップされた場合はTrue
timeout_enabled	タイムアウトモードが有効な場合はTrue
use_mock	モックモードを有効にしている場合はTrue
timeout	テストタイムアウトの場合はTrue
duration	テスト時間(ミリ秒)
no_error	エラーを受信しなかった場合はTrue
error	エラー

-budget-memory lowオプションを指定した場合、レポートはJSON形式のみで生成されます

レポートが大きなものとなる場合、.xlsxフォーマットのファイルは次のようにいくつかに分割されて出力されます; result_0000.xlsx, result_0001.xlsx, result_0002.xlsx, …

watermint toolbox - The multi-purpose utility command-line tool for web services