Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/AnsibleCheck/ansiblecheck

One Stop Solution For Checking Your Ansible Roles and Playbooks
https://github.com/AnsibleCheck/ansiblecheck

ansible ansible-playbooks ansible-roles continuous-integration docker testing

Last synced: about 2 months ago
JSON representation

One Stop Solution For Checking Your Ansible Roles and Playbooks

Host: GitHub
URL: https://github.com/AnsibleCheck/ansiblecheck
Owner: AnsibleCheck
License: mit
Created: 2016-11-04T17:12:33.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2020-03-13T13:43:19.000Z (over 4 years ago)
Last Synced: 2024-07-29T10:31:09.129Z (about 2 months ago)
Topics: ansible, ansible-playbooks, ansible-roles, continuous-integration, docker, testing
Language: Dockerfile
Homepage:
Size: 88.9 KB
Stars: 55
Watchers: 6
Forks: 6
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-list-ansible - ansiblecheck

README

AnsibleCheck
=============

[![Build Status](https://travis-ci.org/AnsibleCheck/ansiblecheck.svg?branch=master)](https://travis-ci.org/AnsibleCheck/ansiblecheck) [![GitHub issues](https://img.shields.io/github/issues/ansiblecheck/ansiblecheck.svg)](https://github.com/AnsibleCheck/ansiblecheck) [![Docker Automated build](https://img.shields.io/docker/automated/ansiblecheck/ansiblecheck.svg?maxAge=2592000)](https://hub.docker.com/r/ansiblecheck/ansiblecheck/) [![Docker Pulls](https://img.shields.io/docker/pulls/ansiblecheck/ansiblecheck.svg)](https://hub.docker.com/r/ansiblecheck/ansiblecheck/) [![Join the chat at https://gitter.im/AnsibleCheck/ansiblecheck](https://badges.gitter.im/AnsibleCheck/ansiblecheck.svg)](https://gitter.im/AnsibleCheck/ansiblecheck?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

A One Stop Solution For Checking Your Ansible Roles and Playbooks.

### Docker Images

* [```ubuntu-16.04```, ```ubuntu-xenial``` (*ubuntu-xenial/Dockerfile*)](https://github.com/AnsibleCheck/ansiblecheck/blob/master/core/Ubuntu/xenial/Dockerfile)
* [```ubuntu-18.04```, ```ubuntu-bionic``` (*ubuntu-bionic/Dockerfile*)](https://github.com/AnsibleCheck/ansiblecheck/blob/master/core/Ubuntu/bionic/Dockerfile)
* [```debian-10```, ```debian-buster``` (*debian-buster/Dockerfile*)](https://github.com/AnsibleCheck/ansiblecheck/blob/master/core/Debian/buster/Dockerfile)
* [```debian-9```, ```debian-stretch``` (*debian-stretch/Dockerfile*)](https://github.com/AnsibleCheck/ansiblecheck/blob/master/core/Debian/stretch/Dockerfile)
* [```debian-8```, ```debian-jessie``` (*debian-jessie/Dockerfile*)](https://github.com/AnsibleCheck/ansiblecheck/blob/master/core/Debian/jessie/Dockerfile)
* [```centos-7```, ```el-7``` (*el-7/Dockerfile*)](https://github.com/AnsibleCheck/ansiblecheck/blob/master/core/EL/7/Dockerfile)
* [```centos-6```, ```el-6``` (*el-6/Dockerfile*)](https://github.com/AnsibleCheck/ansiblecheck/blob/master/core/EL/6/Dockerfile)
* [```fedora-24``` (*fedora-24/Dockerfile*)](https://github.com/AnsibleCheck/ansiblecheck/blob/master/core/Fedora/24/Dockerfile)
* [```archlinux-latest``` (*archlinux-latest/Dockerfile*)](https://github.com/AnsibleCheck/ansiblecheck/blob/master/core/ArchLinux/latest/Dockerfile)
* [```oraclelinux-7```, ```oraclelinux-7.3``` (*oraclelinux-7.3/Dockerfile*)](https://github.com/AnsibleCheck/ansiblecheck/blob/master/core/OracleLinux/7.3/Dockerfile)
* [```oraclelinux-6```, ```oraclelinux-6.8``` (*oraclelinux-6.8/Dockerfile*)](https://github.com/AnsibleCheck/ansiblecheck/blob/master/core/OracleLinux/6.8/Dockerfile)
* [```opensuse-42.2``` ```opensuse-leap``` (*opensuse-42.2/Dockerfile*)](https://github.com/AnsibleCheck/ansiblecheck/blob/master/core/opensuse/42.2/Dockerfile)

### General Principles

AnsibleCheck utilizes Docker to deploy test boxes with Ansible built into the
images. By then loading your generated roles into these docker instances
you can check to insure compliance with the platforms that you claim your
role supports.

In this project we utilize the same naming conventions that are offered in
an Ansible galaxy project as well as more standard conventions by secondary tags.

Differing platforms have differing initialization scripts. None of these images
are intended for production use. They are entirely built for the purpose of
testing Ansible roles and playbooks.

If this is intended for automated testing, then travis builds are highly preferable
because they allow you to demonstrate on your galaxy role that it can actually
support the operating systems you claim to support.

### How To Use

#### Travis-CI

To get started with travis-ci take a look at the examples in the docs. At the
end of this section will be a complete list of supported environment combinations
to generate valid travis builds of your roles.
However ```distribution``` and ```distribution_version``` will be primarily
matching the full list of Operating systems by ansible galaxy that is at the
very bottom of this document.

Basically build your role and depending on how you would like to test your [role](docs/examples/simple) or [playbook](docs/examples/simple-playbook),
either simply or with multiple tests or with [extra variables](docs/examples/with-variables)
to assess whether your role/playbook runs as expected under all conditions.

#### Manually

1. [Install Docker](https://docs.docker.com/engine/installation/)
2. Pull the desired image/images from Docker Hub. These images are tags that
are in all lower case.

```shell
docker pull ansiblecheck/ansiblecheck:ubuntu-xenial
```

3. Run a container from the image and mount the role/playbook into the image.
Check run_opts and init for the travis build

```shell
docker run --detach --volume="${PWD}":/etc/ansible/roles/role_under_test:ro \
--privileged \
--volume=/sys/fs/cgroup:/sys/fs/cgroup:ro ansiblecheck/ansiblecheck:ubuntu-xenial \
/usr/lib/systemd/systemd
```

4. Finally Utilize Ansible Inside of the Container Space To See That The Role
functions correctly.

```shell
docker exec --tty "${container_id}" env TERM=xterm ansible-playbook \
/etc/ansible/roles/role_under_test/tests/test.yml --syntax-check
```

```shell
docker exec "$(cat ${container_id})" ansible-playbook \
/etc/ansible/roles/role_under_test/tests/test.yml
```

### AnsibleCheck Configurations

You can comment out an environment with # on each line of the list item.

```yaml
- distribution: Ubuntu
distribution_version: bionic
init: /lib/systemd/systemd
run_opts: "--privileged --volume=/sys/fs/cgroup:/sys/fs/cgroup:ro"
- distribution: Ubuntu
distribution_version: xenial
init: /lib/systemd/systemd
run_opts: "--privileged --volume=/sys/fs/cgroup:/sys/fs/cgroup:ro"
- distribution: EL
distribution_version: "7"
init: /usr/lib/systemd/systemd
run_opts: "--privileged --volume=/sys/fs/cgroup:/sys/fs/cgroup:ro"
- distribution: EL
distribution_version: "6"
init: /sbin/init
run_opts: ""
- distribution: Debian
distribution_version: buster
init: /lib/systemd/systemd
run_opts: "--privileged --volume=/sys/fs/cgroup:/sys/fs/cgroup:ro"
- distribution: Debian
distribution_version: stretch
init: /lib/systemd/systemd
run_opts: "--privileged --volume=/sys/fs/cgroup:/sys/fs/cgroup:ro"
- distribution: Debian
distribution_version: jessie
init: /lib/systemd/systemd
run_opts: "--privileged --volume=/sys/fs/cgroup:/sys/fs/cgroup:ro"
- distribution: Fedora
distribution_version: "24"
init: /usr/lib/systemd/systemd
run_opts: "--privileged --volume=/sys/fs/cgroup:/sys/fs/cgroup:ro"
```

### Ansible Galaxy Configurations

```yaml
platforms:
- name: OpenBSD
versions:
- all
- 5.6
- 5.7
- 5.8
- 5.9
- 6.0
- name: Fedora
versions:
- all
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- name: DellOS
versions:
- all
- 10
- 6
- 9
- name: MacOSX
versions:
- all
- 10.10
- 10.11
- 10.12
- 10.7
- 10.8
- 10.9
- name: Junos
versions:
- all
- any
- name: GenericBSD
versions:
- all
- any
- name: Void Linux
versions:
- all
- any
- name: GenericLinux
versions:
- all
- any
- name: NXOS
versions:
- all
- any
- name: IOS
versions:
- all
- any
- name: Amazon
versions:
- all
- 2013.03
- 2013.09
- 2016.03
- name: ArchLinux
versions:
- all
- any
- name: FreeBSD
versions:
- all
- 10.0
- 10.1
- 10.2
- 10.3
- 8.0
- 8.1
- 8.2
- 8.3
- 8.4
- 9.0
- 9.1
- 9.1
- 9.2
- 9.3
- name: Ubuntu
versions:
- all
- lucid
- maverick
- natty
- oneiric
- precise
- quantal
- raring
- saucy
- trusty
- utopic
- vivid
- wily
- xenial
- bionic
- name: Debian
versions:
- jessie
- buster
- stretch
- name: EL
versions:
- all
- 5
- 6
- 7
- name: Windows
versions:
- all
- 2012R2
- name: SmartOS
versions:
- all
- any
- name: opensuse
versions:
- all
- 12.1
- 12.2
- 12.3
- 13.1
- 13.2
- name: SLES
versions:
- all
- 10SP3
- 10SP4
- 11
- 11SP1
- 11SP2
- 11SP3
- 11SP4
- 12
- 12SP1
- name: GenericUNIX
versions:
- all
- any
- name: Solaris
versions:
- all
- 10
- 11.0
- 11.1
- 11.2
- 11.3
- name: eos
versions:
- all
- Any
```

#### Projects Using AnsibleCheck

Submit a pull request to add your project to the list.

* [carlosbuenosvinos.ansistrano-deploy](https://galaxy.ansible.com/carlosbuenosvinos/ansistrano-deploy/)
* [ChristopherDavenport.universal-java](https://galaxy.ansible.com/ChristopherDavenport/universal-java/)
* [ChristopherDavenport.universal-oracle-client](https://galaxy.ansible.com/ChristopherDavenport/universal-oracle-client/)
* [ChristopherDavenport.icu](https://galaxy.ansible.com/ChristopherDavenport/icu/)
* [ChristopherDavenport.gnu-cobol](https://galaxy.ansible.com/ChristopherDavenport/gnu-cobol/)
* [eNiXHosting](https://galaxy.ansible.com/eNiXHosting/)

#### Attribution

A significant piece of the base work came from groundwork laid out
by [geerlingguy](https://github.com/geerlingguy) for testing his own roles
internally. Now hopefully we can all work towards building better roles where
we are certain of the functionality they provide on multiple systems