Defining Tests

Overview

Tests can be defined in the runway config file to test your modules in any way you desire before deploying. They are run by using the runway test command. Tests are run in the order they are defined.

Example:

tests:
  - name: example-test
    type: script
    args:
      commands:
        - echo "Success!"

Test Failures

The default behavior if a tests fails is to continue running the rest of the tests and return a non-zero exit code at the end. This behavior can modified to allow testing to continue by adding required: true to the test definition. This will terminate execution if test fails and no further tests will be run.

Example

tests:
  - name: hello-world
    type: script
    required: true
    args:
      commands:
        - echo "Hello World!"  && exit 1

Built-in Test Types

cfn-lint

Source: https://github.com/aws-cloudformation/cfn-python-lint

Validate CloudFormation yaml/json templates against the CloudFormation spec and additional checks. Includes checking valid values for resource properties and best practices.

In order to use this test, there must be a .cfnlintrc file in the same directory as the Runway config file.

Example:

tests:
  - name: cfn-lint-example
    type: cfn-lint

script

Executes a list of provided commands. Each command is run in its own subprocess.

Commands are passed into the test using the commands argument.

Example:

tests:
  - name: hello-world
    type: script
    args:
      commands:
        - echo "Hello World!"

yamllint

Source: https://github.com/adrienverge/yamllint

A linter for YAML files. yamllint does not only check for syntax validity, but for weirdnesses like key repetition and cosmetic problems such as lines length, trailing spaces, indentation, etc.

A .yamllint file can be placed at in the same directory as the Runway config file to customize the linter or, the Runway provided template will be used.

Example:

tests:
  - name: yamllint-example
    type: yamllint