Link Search Menu Expand Document
Fetch

Assert

Some examples show how to assert the response.

Table of contents

  1. Assert
    1. Table of contents
    2. assert basic key-values
    3. assert header
    4. assert cookie
    5. assert error
    6. assert json
    7. assert html
    8. assert xml
    9. assert yaml or toml
    10. assert redirect

assert basic key-values

request:
  method: get
  url: 'http://httpbin.org/get'
  header:
    hello: world
assert:
  status: ok
  status_in:
    - ok
  status_not_in:
    - not found
  statusCode: 200
  statusCode_in:
    - 400
    - 500
  statusCode_not_in:
    - 200
    - 400
  statusCode_lt: 100
  statusCode_lte: 100
  statusCode_gt: 500
  statusCode_gte: 500
  contentLength: 18
  contentLength_lt: 1
  contentLength_lte: 1
  contentLength_gt: 180
  contentLength_gte: 180
  contentType: abc
  contentType_in:
    - application/json
  contentType_not_in:
    - application/json
  body: HTTPBIN is awesome
  body_contains: Hello
  body_not_contains: Hello
  body_icontains: hello
  body_startswith: A
  body_endswith: a
  body_not_startswith: '{'
  body_not_endswith: '}'
  body_matches: ".ello"
  body_not_matches: ".ello"
  latency_lt: 0
  latency_lte: 0
  latency_gt: 100
  latency_gte: 100
  proto: "HTTP/2.0"
  protoMajor: 2
  protoMinor: 0

note: the *contains support a single string or a list of strings, if the value is a list, it’s AND relationship.

assert:
  # body should both contains Hello and world
  body_contains:
    - Hello
    - world
  # body should not contains Hello and world
  body_not_contains:
    - Hello
    - world
  body_icontains:
    - hello
    - world

note: the *matches support a single regex or a list of regexs, if the value is a list, it’s AND relationship.

assert:
  # body should both matches .ello and .orld
  body_matches:
    - .ello
    - .orld
  # body should not matches .ello and .orld
  body_not_matches:
    - .ello
    - .orld

assert header

title: http method get headers
description: http method get headers
request:
  method: get
  url: 'http://httpbin.org/response-headers?freeform=hello'
assert:
  status: ok
  statusCode: 200
  contentType: application/json
  header:
    server: gunicorn/19.9.0
    freeform: hello
  header_exists:
    - "server"
    - "freeform"
  header_value_contains:
    server: gunicorn
  header_value_matches:
    x-request-id: "^[a-z0-9]{32}$"

title: cookie assert
description: cookie assert
request:
  method: get
  url: 'http://httpbin.org/cookies/set?name1=value1&name2=value2'
  disable_redirect: true
assert:
  statusCode: 302
  contentType: text/html
  cookie:
    - name: name1
      value: value1
      path: /
    - name: name2
      value: value3
      path: /
  cookie_exists:
    - name1
    - name3

assert error

the fail error contains specific text

title: http method get
description: http method get
request:
  method: get
  url: 'http://not.exists.local:8113/ping/'
config:
  timeout: 1
assert:
  error_contains: context deadline exceeded

note: the error_contains support a single string or a list of strings, if the value is a list, it’s AND relationship.

assert:
  # error should both contains Hello and world
  error_contains:
    - Hello
    - world

assert json

title: json assert
description: json assert
request:
  method: post
  url: 'http://httpbin.org/post'
  body: |
    {
        "hello": "world",
        "array": [1, 2, 3, 4]
    }
  header:
    Content-Type: application/json
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 180
  contentType: application/json
  json:
    - path: headers.Host
      value: httpbin.org
    - path: headers."Accept-Encoding"
      value: gzip
    - path: 'json.array[0]'
      value: 1
    - path: json.hello
      value: world
    - path: '*.hello'
      value:
        - world
    - path: length(json.array)
      value: 4
    - path: json.abcdefg
      value: 1

assert html

title: html assert
description: html assert
request:
  method: get
  url: 'http://httpbin.org/html'
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 180
  contentType: text/html
  html:
    - path: /html/body/h1
      value: Herman Melville - Moby-Dick
    - path: /slideshow/@author
      value: Overview

assert xml

title: xml assert
description: xml assert
request:
  method: get
  url: 'http://httpbin.org/xml'
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 180
  contentType: application/xml
  xml:
    - path: '/slideshow/slide[2]/title'
      value: Overview
    - path: /slideshow/@author
      value: Overview

assert yaml or toml

use jmespath

title: yaml assert
description: yaml assert
request:
  method: get
  url: 'http://0.0.0.0:8080/someYAML'
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 1
  contentType: application/x-yaml
  yaml:
    - path: message
      value: hey
    - path: foo.bar
      value: hello2

title: toml assert
description: toml assert
request:
  method: get
  url: 'http://0.0.0.0:8080/someTOML'
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 1
  contentType: application/toml
  toml:
    - path: message
      value: hey
    - path: foo.bar
      value: hello2

assert redirect

title: http redirect
description: http redirect
request:
  method: get
  url: 'http://www.httpbin.org/get'
assert:
  has_redirect: false
  redirectCount_lt: 10
  redirectCount_lte: 10
  redirectCount_gt: 0
  redirectCount_gte: 0