Skip to content

final

Jumeauxの処理が完了する直前処理を行う事ができます。

summary

結果の概要をテキスト形式で出力します。
出力された項目の定義はreportを参考にしてください。

Config

Definitions

Root
Key Type Description Example Default
sysout (bool) ファイルではなく標準出力を使うか true false

sysout

  • trueでない場合はファイルが作成されます
  • ファイルはconfigのresponse_dirで指定されたディレクトリの中にsummary.txtという名前で作成されます

Examples

結果の概要ファイルを出力する
  final:
    - name: summary
結果の概要を標準出力に出力する
  final:
    - name: summary
      config:
        sysout: true

json

結果のレポートをjson形式で出力します。
出力されたjsonの定義はreportを参照してください。

Config

Definitions

Root
Key Type Description Example Default
sysout (bool) ファイルではなく標準出力を使うか true false
indent (int) インデント 2 -

sysout

  • trueでない場合はファイルが作成されます
  • ファイルはconfigのresponse_dirで指定されたディレクトリの中にreport.jsonという名前で作成されます

indent

未指定だと1行で出力されます。

Examples

結果のレポートをjsonファイルで出力する
  final:
    - name: json
結果のレポートをインデントサイズ4で標準出力に出力する
  final:
    - name: json
      config:
        sysout: true
        indent: 4

miroir

Miroir参照用にデータをAWSに登録します。

Config

Definitions

Root
Key Type Description Example Default
table string 転送先DynamoDBのテーブル名 miroir
bucket string 転送先S3のBucket名 mamansoft-miroir
prefix (string) 転送先S3のkey prefix test
cache_max_age (int) S3に転送したレスポンスのキャッシュ生存期間(秒) 3600 0
with_zip (bool) ReportとレスポンスをzipしたファイルをS3に転送するか false true
assumed_role_arn (string) Assumed roleで認証を行う場合はarnを指定する TODO:
checklist (string) 今はまだ使用していません
local_stack LocalStack LocalStackを使用する場合に設定する
when (When[]) Miroirへ転送する条件
when
Name Description
not_empty 結果が空ではないとき
has_different 結果にdifferentが存在するとき
  • 全ての条件を満たす場合のみ転送します
  • 未指定の場合は必ず転送します
LocalStack
Key Type Description Example Default
use bool LocalStackを使用するか true
endpoint (string) LocalStackのエンドポイント http://localstack http://localhost

Examples

キャッシュ1時間で保存する
  final:
    - name: miroir
      config:
        table: miroir
        bucket: mamansoft-miroir
        cache_max_age: 3600
キャッシュなしでprefixを指定して保存する

Bucketのtest/配下にデータが保存されます。

  final:
    - name: miroir
      config:
        table: miroir
        bucket: mamansoft-miroir
        prefix: test
LocalStackを使ってキャッシュ2分で保存する
  final:
    - name: miroir
      config:
        table: miroir
        bucket: mamansoft-miroir
        cache_max_age: 120
        local_stack:
          use: true
結果が空でないときだけ保存する
  final:
    - name: miroir
      config:
        table: miroir
        bucket: mamansoft-miroir
        when:
          - not_empty

slack

Danger

本アドオンは非推奨です。代わりにnotifyを使用してください。

実行結果をSlackに転送します。

Prerequirements

Slackの場合

環境変数 SLACK_INCOMING_WEBHOOKS_URLIncoming webhookのURIを設定して下さい

Config

Definitions

Root
Key Type Description Example Default
conditions Condition[] 送信条件と送信内容
Condition
Key Type Description Example Default
payload Payload Slack送信に関する情報
Payload
Key Type Description Example Default
message_format string 本文
channel string 送信先channel #hoge
username string 投稿ユーザ名 Jumeaux man jumeaux
icon_emoji (string) アイコン(絵文字表記) :smile:
icon_url (string) アイコン(URL) http://hoge/image.jpg

message_formatについて

Template表記に対応しています。
プロパティはReportで定義されたものを使用できます。

Examples

#jumeaux channelに終了時通知する
  final:
    - name: slack
      config:
        conditions:
          - payload:
              message_format: Finish Jumeaux!!
              channel: "#jumeaux"
              icon_emoji: ":innocent:"
メッセージフォーマットを利用して通知する
  final:
    - name: slack
      config:
        conditions:
          - payload:
              message_format: "Version {{ version }}, Title: {{ title }}, -- {{ summary.status.different }} diffs"
              channel: "#jumeaux"

通知本文は Version 0.24.1, Title: DEMO, -- 2 diffs のようになります。

notify

実行結果を通知します。

Prerequirements

Slackの場合

環境変数 SLACK_INCOMING_WEBHOOKS_URLIncoming webhookのURIを設定して下さい

Config

Definitions

root
Key Type Description Example Default
notifies (Notify[]) 通知設定
Notify
Key Type Description Example Default
notifier string 使用する通知設定の名前 jumeaux
message string 送信するメッセージ
{{ title }}が完了しました

notifierについて

通知設定の例は config/examples を参考にしてください。定義は notifier の通りです。

messageについて

Template表記に対応しています。
プロパティはReportで定義されたものを使用できます。

Examples

通知設定jumeauxを使って終了時通知する
  final:
    - name: notify
      config:
        notifies:
          - notifier: jumeaux
            message: "{{ title }} is Finish!! There are {{ summary.status.different }} diffs.."

notifier: jumeauxについて

Jumeauxのconfigに以下のような設定が必要です。

notifiers:
  jumeaux:
    type: slack
    channel: "#jumeaux"
    username: jumeaux
    icon_emoji: "jumeaux"

csv

レポートのtrialsをCSVファイル形式で追加出力します。

Config

Definitions

Key Type Description Example Default
column_names string[] 出力する要素名のリスト [seq, name, status]
output_path string 出力するCSVファイルのパス result.csv
with_header (bool) ヘッダ行を出力するか true false
column_names

以下の要素が有効です。

Name Description
seq シーケンス
name 名称
path パス
headers ヘッダ(JSON文字列)
queries クエリ(JSON文字列)
request_time リクエスト日時
status ステータス
one.url oneのリクエストURL
one.status oneのステータスコード
one.byte oneのレスポンスサイズ
one.response_sec oneのレスポンスタイム(秒)
one.content_type oneのコンテントタイプ
one.encoding oneのレスポンスエンコーディング
other.url otherのリクエストURL
other.status otherのステータスコード
other.byte otherのレスポンスサイズ
other.response_sec otherのレスポンスタイム(秒)
other.content_type otherのコンテントタイプ
other.encoding otherのレスポンスエンコーディング

Examples

seq name status の要素を出力する
  final:
    - name: csv
      config:
        column_names:
          - seq
          - name
          - status
        output_path: result.csv
seq name status, one.response_sec, other.response_sec の要素をヘッダ付きで出力する
  final:
    - name: csv
      config:
        with_header: true
        column_names:
          - seq
          - name
          - status
          - one.response_sec
          - other.response_sec
        output_path: result.csv

viewer

結果をGUIで確認するためのHTMLを出力します。

出力されるindex.htmlは同じディレクトリに以下のエントリがいる前提で動作します。

  • oneディレクトリ
  • otherディレクトリ
  • report.json

report.jsonを作成するにはfinal/jsonアドオンを指定してください。

Config

Definitions

Config設定はありません。

Examples

結果をGUIで確認するためのviewerを同梱する
  final:
    - name: json  # report.jsonが必要なため
    - name: viewer