Skip to content

An ansible-native testing framework for collections, playbooks, and roles with configurable workflows for testing any system or service

License

Notifications You must be signed in to change notification settings

ansible/molecule

About Ansible Molecule

PyPI Package Documentation Status image Python Black Code Style Ansible Code of Conduct Discussions Repository License

Molecule is an Ansible testing framework designed for developing and testing Ansible collections, playbooks, and roles.

Molecule leverages standard Ansible features including inventory, playbooks, and collections to provide flexible testing workflows. Test scenarios can target any system or service reachable from Ansible, from containers and virtual machines to cloud infrastructure, hyperscaler services, APIs, databases, and network devices. Molecule can also validate inventory configurations and dynamic inventory sources.

Molecule encourages an approach that results in consistently developed Ansible content that is well-written, easily understood and maintained.

Molecule supports only the latest two major versions of Ansible (N/N-1).

Once installed, the command line can be called using any of the methods below:

molecule ...
python3 -m molecule ...  # python module calling method

Documentation

Read the documentation and more at https://ansible.readthedocs.io/projects/molecule/.

Get Involved

See the Talk to us section of the documentation to ask questions, find help, and join the conversation.

For complete details, see the Ansible communication guide.

If you want to get moving fast and make a quick patch:

$ git clone https://github.com/ansible-community/molecule && cd molecule
$ python3 -m venv .venv && source .venv/bin/activate
$ python3 -m pip install -U setuptools pip tox

And you're ready to make your changes!

Authors

Molecule project was created by Retr0h and it is now community-maintained as part of the Ansible by Red Hat project.

License

The MIT License.

The logo is licensed under the Creative Commons NoDerivatives 4.0 License.

If you have some other use in mind, contact us.