22.27.114. salt.states.test

22.27.114.1. Test States

Provide test case states that enable easy testing of things to do with
state calls, e.g. running, calling, logging, output filtering etc.
always-passes:
  test.succeed_without_changes:
    - name: foo

always-fails:
  test.fail_without_changes:
    - name: foo

always-changes-and-succeeds:
  test.succeed_with_changes:
    - name: foo

always-changes-and-fails:
  test.fail_with_changes:
    - name: foo

my-custom-combo:
  test.configurable_test_state:
    - name: foo
    - changes: True
    - result: False
    - comment: bar.baz
salt.states.test.configurable_test_state(name, changes=True, result=True, comment='')

A configurable test state which determines its output based on the inputs.

New in version 2014.7.0.

name:
A unique string.
changes:
Do we return anything in the changes field? Accepts True, False, and 'Random' Default is True
result:
Do we return successfully or not? Accepts True, False, and 'Random' Default is True
comment:
String to fill the comment field with. Default is ''
salt.states.test.fail_with_changes(name)

Returns failure and changes is not empty.

New in version 2014.7.0.

name:
A unique string.
salt.states.test.fail_without_changes(name)

Returns failure.

New in version 2014.7.0.

name:
A unique string.
salt.states.test.mod_watch(name, sfun=None, **kwargs)

' Call this function via a watch statement

New in version 2014.7.0.

Any parameters in the state return dictionary can be customized by adding the keywords result, comment, and changes.

this_state_will_return_changes:
  test.succeed_with_changes

this_state_will_NOT_return_changes:
  test.succeed_without_changes

this_state_is_watching_another_state:
  test.succeed_without_changes:
    - comment: 'This is a custom comment'
    - watch:
      - test: this_state_will_return_changes
      - test: this_state_will_NOT_return_changes

this_state_is_also_watching_another_state:
  test.succeed_without_changes:
    - watch:
      - test: this_state_will_NOT_return_changes
salt.states.test.succeed_with_changes(name)

Returns successful and changes is not empty

New in version 2014.7.0.

name:
A unique string.
salt.states.test.succeed_without_changes(name)

Returns successful.

New in version 2014.7.0.

name
A unique string.

Docs for previous releases are available on salt.rtfd.org.

Latest Salt release: 2014.1.13

Try the shiny new release candidate of Salt, v2014.7.0rc6! More info here.

Table Of Contents

Previous topic

22.27.113. salt.states.sysctl

Next topic

22.27.115. salt.states.timezone

SaltStack News

Upcoming SaltStack events, webinars and local meet ups and user groups.