Configuration¶
設定ファイル(デフォルトconfig.yml
)について説明します。
Definitions¶
Config¶
Key | Type | Description | Example | Default |
---|---|---|---|---|
one | AccessPoint | 比較元のアクセス先情報 | ||
other | AccessPoint | 比較先のアクセス先情報 | ||
output | OutputSummary | 出力に関する設定 | ||
threads | (int) | 実行スレッド数 | 2 | 1 |
processes | (int) | 実行プロセス数 | 2 | 1 |
max_retries | (int) | 接続エラー時の最大リトライ数 | 0 | 3 |
title | (string) | タイトル | Test | No title |
description | (string) | 説明 | Running for test | |
tags | (string[]) | タグ | - test |
|
notifiers | (dict[Notifier]) | 通知設定 | ||
judge_response_header | (bool) | レスポンスヘッダも判定に加えるかどうか | true |
false |
ignore_response_header_keys | (string[]) | レスポンスヘッダの比較で無視するkeyのリスト | ["Date", "Server"] |
["Content-Length", "Date"] |
addons | Addons | 利用するアドオンの設定 |
threads
実際に使用するスレッド数は指定した数の2倍になります。 (one
とother
へは2スレッドで同時にリクエストするため)
threadsとprocessesを指定した場合
threads
とprocesses
の両方を指定した場合、スレッド数は1になります。
notifiers
アドオンなどで通知が必要な場合、notifiersのキーを指定します。
OutputSummary¶
Key | Type | Description | Example | Default |
---|---|---|---|---|
response_dir | string | レスポンスを格納するディレクトリのパス | test/responses | |
encoding | (string) | 出力するレポートのエンコーディング | euc-jp | utf8 |
Examples¶
リクエストが空だと通知するconfigの例¶
title: Test
Description: Running for test
one:
name: One
host: https://raw.githubusercontent.com/tadashi-aikawa/jumeaux-toolbox/master/vagrant/ignore/one
other:
name: Other
host: https://raw.githubusercontent.com/tadashi-aikawa/jumeaux-toolbox/master/vagrant/ignore/other
notifiers:
test-notifier:
type: slack
version: 2
output:
response_dir: responses
addons:
log2reqs:
name: plain
reqs2reqs:
- name: empty_guard
config:
notifies:
- notifier: test-notifier
message: "{{ title }} notify!"