Built-in tests

Handler

class ansibleci.tests.handler.Handler(runner)

Test to check if all notified handlers (i.e. notify:) are available.

The task notify: parameters will be looked up in all tasks/* files, while the handler name: parameters will be looked up in all handlers/* files.

Readme

class ansibleci.tests.readme.Readme(runner)

Test to check if all roles have a Readme file in place.

If the README_CHECK_DEFAULTS config flag is set to True, then it will also check if the role’s default variables (i.e. defaults/*) are mentioned in the role’s Readme file.

The name of the Readme file is controled with the README_FILENAME config variable.

Tag

class ansibleci.tests.tag.Tag(runner)

Test to check if all tasks are tagged properly with the tags: parameter.

If the TAG_ROLE_NAME config flag is set to True, the test will also make sure that all tasks are tagged with the role’s name.