assert Module

May 8, 2026 ยท View on GitHub

Assert conditions; task fails if conditions are not met.

Parameters

ParameterDescriptionTypeRequiredDefault
thatAssertion conditions, supports template syntaxarray or stringYes-
success_msgMessage to stdout when assertion is truestringNoTrue
fail_msgMessage to stderr when assertion is falsestringNoFalse
msgSame as fail_msg, lower priority than fail_msgstringNoFalse

Examples

1. Single condition (string)

- name: assert single condition
  assert:
    that: eq 1 1
  • stdout: "True"
  • stderr: ""

2. Multiple conditions (array)

- name: assert multi-condition
  assert:
    that:
      - eq 1 1
      - eq 1 2
  • stdout: "False"
  • stderr: "False"

3. Custom success message

- name: assert is succeed
  assert:
    that: eq 1 1
    success_msg: "It's succeed"
  • stdout: "It's succeed"
  • stderr: ""

4. Custom failure message

- name: assert is failed
  assert:
    that: eq 1 2
    fail_msg: "It's failed"
    msg: "It's failed!"
  • stdout: "False"
  • stderr: "It's failed"