Add generic base and base-test jobs/playbooks

Start with a stripped-down fork of the base job from project-config,
omitting any OpenStack-specific roles and variables. Also include a
duplicate base-test job intended for testing out potential changes
to the base job.

Extend the linters env for tox to check the included playbooks with
ansible-lint, and add Sphinx integration for autodocumenting the new
playbooks.

Change-Id: I575be518c3e549a51c0c94deb295061dcf8be0b5

doc/source/conf.py

@@ -22,6 +22,7 @@ import sys
 extensions = [
     'sphinx.ext.autodoc',
     #'sphinx.ext.intersphinx',
+    'zuul_sphinx',
 ]
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy

doc/source/index.rst

@@ -4,6 +4,8 @@
 .. toctree::
    :maxdepth: 2
 
+   jobs
+
 Indices and tables
 ==================
 

doc/source/jobs.rst

@@ -0,0 +1,5 @@
+Jobs
+=====
+
+.. zuul:autojobs::
+

playbooks/base-test/post-ssh.yaml

@@ -0,0 +1,3 @@
+- hosts: all
+  roles:
+    - remove-build-sshkey

playbooks/base-test/pre.yaml

@@ -0,0 +1,4 @@
+- hosts: all
+  roles:
+    - add-build-sshkey
+    - prepare-workspace

playbooks/base/post-ssh.yaml

@@ -0,0 +1,3 @@
+- hosts: all
+  roles:
+    - remove-build-sshkey

playbooks/base/pre.yaml

@@ -0,0 +1,4 @@
+- hosts: all
+  roles:
+    - add-build-sshkey
+    - prepare-workspace

tox.ini

@@ -22,8 +22,34 @@ commands = bindep test
 commands = python setup.py build_sphinx
 
 [testenv:linters]
+basepython = python3
+whitelist_externals = bash
+setenv =
+   ANSIBLE_LIBRARY= {envdir}/src/zuul/zuul/ansible/library
+passenv =
+  # NOTE(pabelanger): if you'd like to run tox -elinters locally, you'll need
+  # to export ANSIBLE_ROLES_PATH pointing to the currect repos.
+  # see infra-zuul-jobs-linters job for more information.
+  ANSIBLE_ROLES_PATH
+# Add dependencies here since other jobs use python2 and zuul requires
+# python3.
+deps =
+  # Zuul is required to supply the zuul ansible modules for ansible-lint
+  -egit+https://git.openstack.org/openstack-infra/zuul@feature/zuulv3#egg=zuul
+  ansible<2.4.0
+  ansible-lint
+  hacking>=0.10,<0.11
+  bashate>=0.2
 commands =
   flake8 {posargs}
+  # Ansible lint
+  # [ANSIBLE0012] Commands should not change things if nothing needs doing
+  bash -c "find playbooks -type f -regex '.*.ya?ml' -print0 | \
+    xargs -t -n1 -0 ansible-lint -xANSIBLE0012"
+  # Ansible Syntax Check
+  bash -c "find playbooks -type f -regex '.*.ya?ml' -exec \
+    ansible-playbook --syntax-check -i {toxinidir}/tests/inventory \
+    \{\} + > /dev/null"
 
 [testenv:venv]
 commands = {posargs}

zuul.yaml

@@ -0,0 +1,28 @@
+- job:
+    name: base
+    parent: null
+    description: |
+      The recommended base job.
+
+      All jobs ultimately inherit from this.  It runs a pre-playbook
+      which copies all of the job's prepared git repos on to all of
+      the nodes in the nodeset.
+
+      It also sets a default timeout value (which may be overidden).
+    pre-run: playbooks/base/pre.yaml
+    post-run: playbooks/base/post-ssh.yaml
+    roles:
+      - zuul: openstack-infra/zuul-jobs
+    timeout: 1800
+
+- job:
+    name: base-test
+    parent: null
+    description: |
+      A job to test changes to the base job without disturbing the
+      main job in production.  Not for general use.
+    pre-run: playbooks/base-test/pre.yaml
+    post-run: playbooks/base-test/post-ssh.yaml
+    roles:
+      - zuul: openstack-infra/zuul-jobs
+    timeout: 1800