asserts_specification.md

type	layout	title
docs	single	Specifications | Assert Jobs Specification

Assert Jobs Specification

{{% data_sites rename_docs %}}

Asserts can be used to compare two "things". These "things" may be the result of two jobs or the result against one job against a baseline. (Indeed, it could be the comparison of two baselines but that wouldn't really get folks anywhere).

Currently the following comparisons are supported:

switch assertion.Relation {
case "==", "eq":
  if assertion.Key == assertion.Value {
    return assertPass()
  } else {
    return assertFail(assertion.Key, assertion.Value)
  }
case "!=", "ne":
  if assertion.Key != assertion.Value {
    return assertPass()
  } else {
    return assertFail(assertion.Key, assertion.Value)
  }
case ">", "gt":
  k, v, err := bulkConvert(assertion.Key, assertion.Value)
  if err != nil {
    return convFail()
  }
  if k > v {
    return assertPass()
  } else {
    return assertFail(assertion.Key, assertion.Value)
  }
case ">=", "ge":
  k, v, err := bulkConvert(assertion.Key, assertion.Value)
  if err != nil {
    return convFail()
  }
  if k >= v {
    return assertPass()
  } else {
    return assertFail(assertion.Key, assertion.Value)
  }
case "<", "lt":
  k, v, err := bulkConvert(assertion.Key, assertion.Value)
  if err != nil {
    return convFail()
  }
  if k < v {
    return assertPass()
  } else {
    return assertFail(assertion.Key, assertion.Value)
  }
case "<=", "le":
  k, v, err := bulkConvert(assertion.Key, assertion.Value)
  if err != nil {
    return convFail()
  }
  if k <= v {
    return assertPass()
  } else {
    return assertFail(assertion.Key, assertion.Value)
  }
}

Only number-like types may be compared using the gt, ge, lt, le notation.

Currently, the only way to call an assert value of equals for an array is to declare it as a string as such:

- name: assertBytesMemoryArray
  job:
    assert:
      key: $queryBytesMemoryArray
      relation: eq
      val: "[hello,marmots,how,are,you]"

N.B. -- yaml can be a bit testing. If you use the symbols notation make sure to put double quotes around the following:

• "!="
• ">="
• ">"

All Specifications