mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
c69810bf04
* Add test which allows to query whether an action is available. * Add documentation. * Fix FreeBSD / macOS compatibility. * Rename an_action -> a_module. * Forgot one place.
28 lines
941 B
ReStructuredText
28 lines
941 B
ReStructuredText
.. _ansible_collections.community.general.docsite.test_guide:
|
|
|
|
community.general Test (Plugin) Guide
|
|
=====================================
|
|
|
|
The :ref:`community.general collection <plugins_in_community.general>` offers currently one test plugin.
|
|
|
|
.. contents:: Topics
|
|
|
|
Feature Tests
|
|
-------------
|
|
|
|
The ``a_module`` test allows to check whether a given string refers to an existing module or action plugin. This can be useful in roles, which can use this to ensure that required modules are present ahead of time.
|
|
|
|
.. code-block:: yaml+jinja
|
|
|
|
- name: Make sure that community.aws.route53 is available
|
|
assert:
|
|
that:
|
|
- >
|
|
'community.aws.route53' is community.general.a_module
|
|
|
|
- name: Make sure that community.general.does_not_exist is not a module or action plugin
|
|
assert:
|
|
that:
|
|
- "'community.general.does_not_exist' is not community.general.a_module"
|
|
|
|
.. versionadded:: 4.0.0
|