Merge pull request geerlingguy#287 from geerlingguy/202-collections

Issue geerlingguy#202: New Collections chapter content.

Author: geerlingguy

.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 .vagrant/
 vagrant_ansible_inventory_default
+__pycache__
 *.cache
 *.retry
 test.sh

.travis.yml

@@ -6,6 +6,8 @@ branches:
     - master
 
 env:
+  - shell_script: collection.sh
+
   # Run each test playbook in a separate environment.
   - playbook: deployments.yml
     distro: ubuntu1804
@@ -74,6 +76,9 @@ env:
   - playbook: solr.yml
     distro: ubuntu1604
 
+  - playbook: test-plugin.yml
+    distro: centos7
+
 script:
   # Use test shim and run playbook if playbook is provided.
   - |

README.md

@@ -41,44 +41,49 @@ Here is an outline of all the examples contained in this repository, by chapter:
 
 ### Chapter 7
 
-  - [`dynamic-inventory`](dynamic-inventory/): Two example dynamic inventory scripts (one in PHP, one in Python) for use with Ansible.
+  - [`test-plugin`](test-plugin/): A simple test plugin that verifies a given value is representative of the color blue.
+  - [`collection`](collection/): An example local collection to demonstrate the basic structure of content collections.
 
 ### Chapter 8
 
+  - [`dynamic-inventory`](dynamic-inventory/): Two example dynamic inventory scripts (one in PHP, one in Python) for use with Ansible.
+
+### Chapter 9
+
   - [`lamp-infrastructure`](lamp-infrastructure/): A multi-server LAMP-based web application infrastructure focused on high-availability and performance for a LAMP-stack app.
   - [`elk`](elk/): A two-server example of the Elasticsearch-Logstash-Kibana stack, which uses one server to store and visualize logs centrally, and another server to send logs via Filebeat.
 
-### Chapter 9
+### Chapter 10
 
   - [`deployments`](deployments/): A playbook that deploys a Ruby on Rails application into an environment that runs Passenger and Nginx to handle web requests.
   - [`deployments-balancer`](deployments-balancer/): A playbook that handles zero-downtime deployments to webservers running behind an HAProxy load balancer.
   - [`deployments-rolling`](deployments-rolling/): A playbook that demonstrates rolling deployments to multiple servers for a Node.js app.
 
-### Chapter 10
+### Chapter 11
 
   - N/A
 
-### Chapter 11
+### Chapter 12
 
   - [`jenkins`](jenkins/): A playbook that installs and configures Jenkins for CI/CD.
 
-### Chapter 12
+### Chapter 13
 
   - [`molecule`](molecule/): A Molecule example used for testing and developing an Ansible playbook, or for testing in a Continuous Integration (CI) environment.
   - [`ci.yml` GitHub Actions workflow](.github/workflows/ci.yml): A GitHub Actions workflow which runs the `molecule` example in a CI environment.
 
-### Chapter 13
+### Chapter 14
 
   - [`https-self-signed`](https-self-signed/): A playbook that generates self-signed certificates.
   - [`https-letsencrypt`](https-letsencrypt/): A playbook that demonstrates automated certificate management with Let's Encrypt and Ansible.
   - [`https-nginx-proxy`](https-nginx-proxy/): A playbook that demonstrates proxying HTTPS traffic through Nginx to HTTP backends.
 
-### Chapter 14
+### Chapter 15
 
   - [`docker`](docker/): Very simple playbook demonstrating Ansible's ability to manage Docker container images.
   - [`docker-hubot`](docker-hubot/): Slightly more involved example of Ansible's ability to manage and run Docker container images.
 
-### Chapter 15
+### Chapter 16
 
   - [`kubernetes`](kubernetes/): A playbook that builds a three-node Kubernetes cluster.
 

collection/README.md

@@ -0,0 +1,3 @@
+# Ansible Local Collection Example
+
+TODO.

collection/collections/ansible_collections/local/colors/galaxy.yml

@@ -0,0 +1,7 @@
+---
+namespace: local
+name: colors
+version: 1.0.0
+readme: README.md
+authors:
+- your name <[email protected]>

collection/collections/ansible_collections/local/colors/plugins/test/blue.py

@@ -0,0 +1,23 @@
+# Ansible custom 'blue' test plugin definition.
+
+def is_blue(string):
+    ''' Return True if a valid CSS value of 'blue'. '''
+    blue_values = [
+        'blue',
+        '#0000ff',
+        '#00f',
+        'rgb(0,0,255)',
+        'rgb(0%,0%,100%)',
+    ]
+    if string in blue_values:
+        return True
+    else:
+        return False
+
+class TestModule(object):
+    ''' Return dict of custom jinja tests. '''
+
+    def tests(self):
+        return {
+            'blue': is_blue
+        }

collection/main.yml

@@ -0,0 +1,14 @@
+---
+- hosts: all
+
+  vars:
+    my_color_choice: blue
+
+  tasks:
+    - name: "Verify {{ my_color_choice }} is a form of blue."
+      assert:
+        that: my_color_choice is local.colors.blue
+
+    - name: "Verify yellow is not a form of blue."
+      assert:
+        that: "'yellow' is not local.colors.blue"

test-plugin/main.yml

@@ -0,0 +1,10 @@
+---
+- hosts: all
+
+  vars:
+    my_color_choice: blue
+
+  tasks:
+    - name: "Verify {{ my_color_choice }} is a form of blue."
+      assert:
+        that: my_color_choice is blue

test-plugin/test_plugins/blue.py

@@ -0,0 +1,23 @@
+# Ansible custom 'blue' test plugin definition.
+
+def is_blue(string):
+    ''' Return True if a valid CSS value of 'blue'. '''
+    blue_values = [
+        'blue',
+        '#0000ff',
+        '#00f',
+        'rgb(0,0,255)',
+        'rgb(0%,0%,100%)',
+    ]
+    if string in blue_values:
+        return True
+    else:
+        return False
+
+class TestModule(object):
+    ''' Return dict of custom jinja tests. '''
+
+    def tests(self):
+        return {
+            'blue': is_blue
+        }

tests/collection.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+#
+# Collection playbook tests.
+set -e
+
+# Make sure pip3 is available.
+sudo apt-get update
+sudo apt-get install -y python3-pip python3-setuptools
+pip3 install --upgrade setuptools pip
+
+# Install dependencies.
+sudo pip3 install ansible
+
+cd collection
+
+# Run Ansible playbook.
+ansible-playbook -c local -i 'localhost,' main.yml