Added some tests, and fixed a few things

Author: sp-lyang

README.md

@@ -1,3 +1,4 @@
+[![Build Status](https://travis-ci.org/singleplatform-eng/ansible-role-celery.svg?branch=master)](https://travis-ci.org/singleplatform-eng/ansible-role-celery)
 Ansible-Role-Celery
 =========
 
@@ -15,7 +16,7 @@ Defaults
 celery_env_dir: /etc/celery.d
 celery_log_dir: /var/log/celery
 celery_run_dir: /var/run/celery
-celery_bin: "{{python_virtualenv}}/bin/celery"
+celery_bin: "/usr/local/bin/celery"
 ```
 Required Vars
 ```
@@ -27,9 +28,7 @@ celery_services
 Dependencies
 ------------
 Python
-Python VirtualEnv
-
-This role assumes that the celery binary is installed into the local python virtualenv's bin directory. The default value of celery_bin requires that the ansible variable "{{python_virtualenv}}" be defined.
+Message Broker - the tests in this role use a local instance of redis-server
 
 Example Playbook
 ----------------

defaults/main.yml

@@ -3,4 +3,12 @@ celery_install: True
 celery_env_dir: /etc/celery.d
 celery_log_dir: /var/log/celery
 celery_run_dir: /var/run/celery
-celery_bin: "{{python_virtualenv}}/bin/celery"
+celery_bin: "/usr/local/bin/celery"
+
+celeryd_default_env:
+  CELERYD_LOG_FILE: "/var/log/celery/%n%I.log"
+  CELERYD_PID_FILE: "/var/run/celery/%n.pid"
+  CELERY_APP: "{{celery_app}}"
+  CELERY_BIN: "{{celery_bin}}"
+  CELERYD_LOG_LEVEL: "INFO"
+  CELERYD_NODES: "worker"

tasks/main.yml

@@ -6,4 +6,4 @@
   include_tasks: manage_configs.yml
 
 - name: Manage systemd Service Units
-  include_tasks: manage_service_units.yml
+  include_tasks: manage_units.yml

tasks/manage_configs.yml

@@ -1,5 +1,5 @@
 ---
 - name: Configure Celery EnvironmentFile
   template: src=celery_env.j2 dest="{{celery_env_dir}}/{{item.name}}"
-  notify: "restart celery service"
+  notify: "restart celery services"
   with_items: "{{celery_services}}"

tasks/manage_paths.yml

@@ -3,22 +3,22 @@
   file:
     path: "{{celery_env_dir}}"
     state: directory
-    owner: "{{app_user}}"
-    group: "{{app_user}}"
+    owner: "{{celery_user}}"
+    group: "{{celery_user}}"
     mode: 0755
 
 - name: Ensure Celery Log Dir exists
   file:
     path: "{{celery_log_dir}}"
     state: directory
-    owner: "{{app_user}}"
-    group: "{{app_user}}"
+    owner: "{{celery_user}}"
+    group: "{{celery_user}}"
     mode: 0755
 
 - name: Ensure Celery Run Dir exists
   file:
     path: "{{celery_run_dir}}"
     state: directory
-    owner: "{{app_user}}"
-    group: "{{app_user}}"
+    owner: "{{celery_user}}"
+    group: "{{celery_user}}"
     mode: 0755

tasks/manage_units.yml

@@ -1,5 +1,5 @@
 ---
 - name: Configure Celery systemd service unit
   template: src=celery.service.j2 dest="/etc/systemd/system/{{item.name}}.service"
-  notify: restart celery service
+  notify: restart celery services
   with_items: "{{celery_services}}"

tests/files/redis.conf

@@ -0,0 +1,30 @@
+# # This file is managed by Ansible. Local changes will be overwritten.
+
+daemonize yes
+pidfile /var/run/redis/redis-server.pid
+port 6379
+bind 127.0.0.1
+
+
+timeout 300
+
+loglevel notice
+logfile /var/log/redis/redis-server.log
+
+# To enable logging to the system logger, just set 'syslog-enabled' to yes,
+# and optionally update the other syslog parameters to suit your needs.
+# syslog-enabled no
+# syslog-ident redis
+# syslog-facility local0
+
+databases 16
+
+save 900 1
+save 300 10
+save 60 10000
+
+rdbcompression yes
+dbfilename dump.rdb
+dir /var/lib/redis
+
+# maxclients 128

tests/files/tasks.py

@@ -0,0 +1,7 @@
+from celery import Celery
+
+app = Celery('tasks', broker='redis://localhost:6379')
+
+@app.task
+def add(x, y):
+    return x + y

tests/test.retry

@@ -0,0 +1 @@
+localhost

tests/test.sh

@@ -0,0 +1,75 @@
+#!/bin/bash
+#
+# Ansible role test shim.
+#
+# Usage: [OPTIONS] ./tests/test.sh
+#   - distro: a supported Docker distro version (default = "centos7")
+#   - playbook: a playbook in the tests directory (default = "test.yml")
+#   - cleanup: whether to remove the Docker container (default = true)
+#   - container_id: the --name to set for the container (default = timestamp)
+
+# Exit on any individual command failure.
+set -e
+
+# Pretty colors.
+red='\033[0;31m'
+green='\033[0;32m'
+neutral='\033[0m'
+
+timestamp=$(date +%s)
+
+# Allow environment variables to override defaults.
+distro=${distro:-"ubuntu1804"}
+playbook=${playbook:-"test.yml"}
+cleanup=${cleanup:-"true"}
+container_id=${container_id:-$timestamp}
+
+## Set up vars for Docker setup.
+init="/lib/systemd/systemd"
+opts="--privileged --volume=/sys/fs/cgroup:/sys/fs/cgroup:ro"
+
+# Run the container using the supplied OS.
+printf ${green}"Starting Docker container: geerlingguy/docker-$distro-ansible."${neutral}"\n"
+docker pull geerlingguy/docker-$distro-ansible:latest
+docker run --detach --volume="$PWD":/etc/ansible/roles/role_under_test:rw --name $container_id $opts geerlingguy/docker-$distro-ansible:latest $init
+
+printf "\n"
+
+# Install requirements if `requirements.yml` is present.
+if [ -f "$PWD/tests/requirements.yml" ]; then
+  printf ${green}"Requirements file detected; installing dependencies."${neutral}"\n"
+  docker exec --tty $container_id env TERM=xterm ansible-galaxy install -r /etc/ansible/roles/role_under_test/tests/requirements.yml
+fi
+
+printf "\n"
+
+# Test Ansible syntax.
+printf ${green}"Checking Ansible playbook syntax."${neutral}
+docker exec --tty $container_id env TERM=xterm ansible-playbook /etc/ansible/roles/role_under_test/tests/$playbook --syntax-check
+
+printf "\n"
+
+# Run Ansible playbook.
+printf ${green}"Running command: docker exec $container_id env TERM=xterm ansible-playbook /etc/ansible/roles/role_under_test/tests/$playbook"${neutral}
+docker exec $container_id env TERM=xterm env ANSIBLE_FORCE_COLOR=1 ansible-playbook /etc/ansible/roles/role_under_test/tests/$playbook
+
+# Run Ansible playbook again (idempotence test).
+printf ${green}"Running playbook again: idempotence test"${neutral}
+idempotence=$(mktemp)
+docker exec $container_id ansible-playbook /etc/ansible/roles/role_under_test/tests/$playbook | tee -a $idempotence
+tail $idempotence \
+  | grep -q 'changed=0.*failed=0' \
+  && (printf ${green}'Idempotence test: pass'${neutral}"\n") \
+  || (printf ${red}'Idempotence test: fail'${neutral}"\n" && exit 1)
+
+
+printf ${green}"Testing Start Handlers and Service\n"${neutral}
+docker exec $container_id ansible-playbook /etc/ansible/roles/role_under_test/tests/$playbook -e 'test_handlers=True test_service=True'
+printf ${green}"Handlers and Service test passed\n"${neutra}
+
+
+# Remove the Docker container (if configured).
+if [ "$cleanup" = true ]; then
+  printf "Removing Docker container...\n"
+  docker rm -f $container_id
+fi