tadashi-aikawa/jumeaux

View on GitHub
mkdocs/ja/addons/did_challenge.md

Summary

Maintainability
Test Coverage
did_challenge [:fontawesome-brands-github:][s1]
===============================

[s1]: https://github.com/tadashi-aikawa/jumeaux/tree/master/jumeaux/addons/did_challenge

次のchallengeに移る前に処理をします。


[:fontawesome-brands-github:][sleep] sleep
--------------------------

[sleep]: https://github.com/tadashi-aikawa/jumeaux/tree/master/jumeaux/addons/did_challenge/sleep.py

指定した時間、待機します。


### Config

#### Definitions

| Key | Type  |            Description             | Example | Default |
| --- | ----- | ---------------------------------- | ------- | ------- |
| min | float | 待機時間 :fontawesome-solid-circle-exclamation: の下限値 | 0.1     |         |
| max | float | 待機時間 :fontawesome-solid-circle-exclamation: の上限値 | 1.0     |         |

!!! info "待機時間について"

    待機時間は`min`から`max`の範囲でランダムに決定されます。
    固定値にしたい場合は`min`と`max`に指定したい値を設定してください。

#### Examples

##### ランダムで0.1~1.0秒待機する

```yaml
  did_challenge:
    - name: sleep
      config:
        min: 0.1
        max: 1.0
```

##### 0.5秒待機する

```yaml
  did_challenge:
    - name: sleep
      config:
        min: 0.5
        max: 0.5
```


[:fontawesome-brands-github:][tag] tag
----------------------

[tag]: https://github.com/tadashi-aikawa/jumeaux/tree/master/jumeaux/addons/did_challenge/tag.py

リクエスト結果ごとにタグを設定します。


### Config

#### Definitions

##### Root

| Key        | Type                      | Description    | Example | Default |
|------------|---------------------------|----------------|---------|---------|
| conditions | [Condition[]](#condition) | タグの値と条件 |         |         |

##### Condition

| Key  | Type | Description                   | Example                           | Default |
|------|------|-------------------------------|-----------------------------------|---------|
| tag  | str  | 付与するタグ :fontawesome-solid-circle-exclamation: | `tag: {{ trial.one.type }}`       |         |
| when | str  | 条件式 :fontawesome-solid-circle-exclamation:       | <pre>"trial.name == 'hoge'"</pre> |         |


!!! info "tagおよびwhenについて"

    [Template表記]に対応しています。
    プロパティは以下を使用できます。

    | key             | Type                 | Description                 |
    |-----------------|----------------------|-----------------------------|
    | trial           | [Trial][trial]       | テスト結果                  |
    | res_one         | [Response][response] | oneのレスポンス情報         |
    | res_other       | [Response][response] | otherのレスポンス情報       |
    | res_one_props   | (dict)               | oneのレスポンスプロパティ   |
    | res_other_props | (dict)               | otherのレスポンスプロパティ |


#### Examples

##### Trialのnameが`json`のとき、`json`というタグを付ける

```yaml
  did_challenge:
    - name: tag
      config:
        conditions:
          - tag: json
            when: "trial.name == 'json'"
```

##### それぞれのレスポンスタイプをタグとして付ける

```yaml
  did_challenge:
    - name: tag
      config:
        conditions:
          - tag: "tag:{{ trial.one.type }}"
          - tag: "tag:{{ trial.other.type }}"
```

##### oneのレスポンスプロパティ`items[0].type` の値をタグにつける

```yaml
  did_challenge:
    - name: tag
      config:
        conditions:
          - tag: "{{ res_one_props.items[0].type }}"
```

[Template表記]: ../../template
[trial]: ../../models/trial
[response]: ../../models/response