Skip to content

Commit

Permalink
Fixing grammar in the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
maglub committed Mar 18, 2021
1 parent 107c16d commit bc6c346
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 17 deletions.
34 changes: 18 additions & 16 deletions molecule/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,9 @@ This directory is the home of the test playbooks:

# Molecule

The default tested version is postgresql 9.6, 10, 11, 12, and 13 on Ubuntu 20.04. We are currently _not_ linting anything.
The default tested version is postgresql 9.6, 10, 11, 12, and 13 on Ubuntu 20.04. Linting is disabled for the tests.

```
lint: |
set -e
# yamllint .
# ansible-lint
```

You can override this with setting the environment variable MOLECULE_DISTRO to one of:
The default distribution is ubuntu2004. You can override th with setting the environment variable MOLECULE_DISTRO to one of:

* centos7
* centos8
Expand All @@ -27,12 +20,6 @@ You can override this with setting the environment variable MOLECULE_DISTRO to o
* ubuntu1804
* ubuntu2004

The images we use are extended with systemd by Jeff Geerling. Before we start the tests, `molecule` runs the `prepare.yml` playbook to:

* Create a user called `ansbile`, with the default group membership of either `wheel` (CentOS, Fedora), or `sudo` (Debian, ubuntu)
* Install a couple of packages that Jeff Geerling did not install in his container images, that we need in order to test the role properly


Manual execution of the molecule tests with the distro of your liking. Examples:

```
Expand All @@ -41,6 +28,13 @@ MOLECULE_DISTRO=debian10 molecule converge
MOLECULE_DISTRO=ubuntu2004 molecule converge
```

The images we use are extended with systemd by Jeff Geerling. See https://hub.docker.com/u/geerlingguy/

Prior to the testing, molecule runs the prepare.yml playbook to:

* Create a user called `ansible`, with the default group membership of either `wheel` (CentOS, Fedora), or `sudo` (Debian, ubuntu)
* Install a couple of packages that Jeff Geerling did not install in his container images, that are needed in order to test the role properly

The main file ./molecule/default/molecule.yml sets up versions to test from 9.6 to 13.

# Tests
Expand Down Expand Up @@ -74,12 +68,19 @@ pip install molecule molecule-docker

# Examples

Examples:
To run molecule tests locally, you can run the following commands:

```
#--- to just create the default containers (ubuntu2004), and run prepare.yml
molecule create
#--- to run the tests and keep the containers
molecule converge
#--- full life cycle of tests
molecule test
#--- to clean up (i.e after converge, if you would like to change to a different distribution)
molecule destroy
#--- with specific distro release
Expand All @@ -88,6 +89,7 @@ MOLECULE_DISTRO=ubuntu2004 molecule converge
MOLECULE_DISTRO=ubuntu2004 molecule test
MOLECULE_DISTRO=ubuntu2004 molecule destroy
```

# References

* https://github.com/search?q=user%3Ageerlingguy+docker-.*-ansible
2 changes: 1 addition & 1 deletion tests/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Introduction

For more docu about molecule testing, see ../molecule/README.md
For more documentation about molecule testing, see ../molecule/README.md

This directory is the home of the test playbooks:

Expand Down

0 comments on commit bc6c346

Please sign in to comment.