diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1515753 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +AUTHORS +ChangeLog +doc/build/ +# Production inventory +inventory/production +# Roles installed from galaxy +playbooks/roles/openstack.* +.tox/ diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..2ceb272 --- /dev/null +++ b/.yamllint @@ -0,0 +1,13 @@ +extends: default + +ignore: | + .tox + +rules: + braces: + max-spaces-inside: 1 + level: error + brackets: + max-spaces-inside: 1 + level: error + line-length: disable diff --git a/.zuul.d/jobs.yaml b/.zuul.d/jobs.yaml new file mode 100644 index 0000000..654a7e5 --- /dev/null +++ b/.zuul.d/jobs.yaml @@ -0,0 +1,33 @@ +--- +- job: + name: windmill-backup-base + pre-run: tests/playbooks/pre.yaml + run: tests/playbooks/run.yaml + post-run: tests/playbooks/post.yaml + required-projects: + - openstack/ansible-role-borgbackup + - openstack/ansible-role-borgmatic + - openstack/ansible-role-ssh + timeout: 3600 + +# Testing for install_method: pip +- job: + name: windmill-backup + parent: windmill-backup-base + vars: + windmill_backup_extra_vars_file: tests/extra-vars/pip.yaml + +- job: + name: windmill-backup-centos-7 + parent: windmill-backup + nodeset: centos-7 + +- job: + name: windmill-backup-fedora-latest + parent: windmill-backup + nodeset: fedora-latest + +- job: + name: windmill-backup-ubuntu-bionic + parent: windmill-backup + nodeset: ubuntu-bionic diff --git a/.zuul.d/project-templates.yaml b/.zuul.d/project-templates.yaml new file mode 100644 index 0000000..4cbcae9 --- /dev/null +++ b/.zuul.d/project-templates.yaml @@ -0,0 +1,20 @@ +--- +- project-template: + name: windmill-backup-jobs-fedora-latest + check: + jobs: + - windmill-backup-fedora-latest + gate: + queue: windmill + jobs: + - windmill-backup-fedora-latest + +- project-template: + name: windmill-backup-jobs-bionic + check: + jobs: + - windmill-backup-ubuntu-bionic + gate: + queue: windmill + jobs: + - windmill-backup-ubuntu-bionic diff --git a/.zuul.d/projects.yaml b/.zuul.d/projects.yaml new file mode 100644 index 0000000..e5e0e1e --- /dev/null +++ b/.zuul.d/projects.yaml @@ -0,0 +1,6 @@ +--- +- project: + templates: + - ansible-role-jobs + - windmill-backup-jobs-fedora-latest + - windmill-backup-jobs-bionic diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..6e3288e --- /dev/null +++ b/README.rst @@ -0,0 +1,18 @@ +=============== +windmill-backup +=============== + +An Ansible deployment to validate ansible roles for Continuous Integration + +* License: Apache License, Version 2.0 +* Documentation: https://windmill-backup.readthedocs.org +* Source: https://git.openstack.org/cgit/openstack/windmill-backup +* Bugs: https://bugs.launchpad.net/windmill-backup + +Description +----------- + +Windmill is a collection of Ansible playbooks and roles used to deploy +Continuous Integration (CI) tools. It serves to be a functional test environment +for our Ansible CI roles primarily, however it also provides an example +deployment for users. diff --git a/bindep.txt b/bindep.txt new file mode 100644 index 0000000..084f943 --- /dev/null +++ b/bindep.txt @@ -0,0 +1,14 @@ +# This is a cross-platform list tracking distribution packages needed by tests; +# see http://docs.openstack.org/infra/bindep/ for additional information. + +dbus +libffi-devel [platform:rpm] +libffi-dev [platform:dpkg] +libselinux-python [platform:rpm] +libssl-dev [platform:dpkg] +openssl-devel [platform:rpm] +python2-dnf [platform:fedora] +python3-devel [platform:rpm] +python3-dev [platform:dpkg] +python-devel [platform:rpm] +python-dev [platform:dpkg] diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..1f3277f --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,7 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. + +# this is required for the docs build jobs +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +doc8>=0.6.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100755 index 0000000..4f74602 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,73 @@ +# -*- coding: utf-8 -*- +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import os +import sys + +sys.path.insert(0, os.path.abspath('../..')) +# -- General configuration ---------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + 'sphinx.ext.autodoc', +] + +# autodoc generation is a bit aggressive and a nuisance when doing heavy +# text edit cycles. +# execute "export SPHINX_DEBUG=1" in your terminal to disable + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'windmill' +copyright = u'2013, OpenStack Foundation' + +# If true, '()' will be appended to :func: etc. cross-reference text. +add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +add_module_names = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# -- Options for HTML output -------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +# html_theme_path = ["."] +# html_theme = '_theme' +# html_static_path = ['static'] + +# Output file base name for HTML help builder. +htmlhelp_basename = '%sdoc' % project + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass +# [howto/manual]). +latex_documents = [ + ('index', + '%s.tex' % project, + u'%s Documentation' % project, + u'OpenStack Foundation', 'manual'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +# intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..a6210d3 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1 @@ +.. include:: ../../README.rst diff --git a/inventory/testing/group_vars/all.yaml b/inventory/testing/group_vars/all.yaml new file mode 100644 index 0000000..2857a97 --- /dev/null +++ b/inventory/testing/group_vars/all.yaml @@ -0,0 +1,20 @@ +# Copyright 2016 Red Hat, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +--- +borgbackup_pip_virtualenv_python: python3 +borgbackup_pip_virtualenv: /opt/venv/borgbackup +borgbackup_user_shell: /bin/bash + +borgmatic_pip_virtualenv_python: python3 +borgmatic_pip_virtualenv: /opt/venv/borgmatic diff --git a/inventory/testing/hosts b/inventory/testing/hosts new file mode 100644 index 0000000..ba2b585 --- /dev/null +++ b/inventory/testing/hosts @@ -0,0 +1,9 @@ +bastion ansible_connection=local + +[disabled] + +[borg-client] +client01 ansible_host=127.0.2.1 + +[borg-server] +borg01 ansible_host=127.0.1.1 diff --git a/playbooks/bastion.yaml b/playbooks/bastion.yaml new file mode 100644 index 0000000..6c8a516 --- /dev/null +++ b/playbooks/bastion.yaml @@ -0,0 +1,33 @@ +# Copyright 2016 Red Hat, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +--- +- name: Bootstrap bastion node + hosts: bastion + + pre_tasks: + - name: Create SSH keys (if missing) + command: ssh-keygen -t rsa -f ~/.ssh/id_rsa -N "" + args: + creates: ~/.ssh/id_rsa + + - name: Ensure SSH public key is authorized + authorized_key: + user: "{{ lookup('env', 'USER') }}" + key: "{{ lookup('file', lookup('env','HOME') + '/.ssh/id_rsa.pub') }}" + + - name: Ensure remote SSH host keys are known + known_hosts: + name: "{{ hostvars[item].ansible_host }}" + key: "{{ lookup('pipe', 'ssh-keyscan -t rsa {{ hostvars[item].ansible_host }}') }}" + with_inventory_hostnames: all:!bastion diff --git a/playbooks/borg-client.yaml b/playbooks/borg-client.yaml new file mode 100644 index 0000000..2d7b6e9 --- /dev/null +++ b/playbooks/borg-client.yaml @@ -0,0 +1,73 @@ +# Copyright 2019 Red Hat, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +--- +- name: Install borg-client + hosts: borg-client:!disabled + + tasks: + - name: Setup openstack.borgbackup role + include_role: + name: openstack.borgbackup + vars: + borgbackup_task_manager: + - pre + - install + + - name: Setup openstack.borgmatic role + include_role: + name: openstack.borgmatic + + - name: Generage borgbackup SSH keys + become: true + become_user: borgbackup + command: ssh-keygen -b 4096 -t rsa -f ~/.ssh/id_rsa -q -N "" + args: + creates: ~/.ssh/id_rsa + + - name: Add borg-server SSH host keys to known_hosts + become: true + become_user: borgbackup + known_hosts: + hash_host: true + key: "{{ hostvars[item].ansible_host }} ssh-ed25519 {{ hostvars[item].ansible_facts['ssh_host_key_ed25519_public'] }}" + name: "{{ hostvars[item].ansible_host }}" + with_inventory_hostnames: + - borg-server:!disabled + + - name: Read SSH public key + become: true + become_user: borgbackup + slurp: + src: ~/.ssh/id_rsa.pub + register: borg_id_rsa_pub + + - name: Setup openstack.ssh role + become: true + become_user: "borg_{{ inventory_hostname_short }}" + include_role: + name: openstack.ssh + apply: + delegate_to: "{{ item }}" + vars: + ssh_task_manager: + - config + ssh_authorized_keys_content: "restrict,command=\"cd ~/repos;{{ borgbackup_pip_virtualenv }}/bin/borg serve --restrict-to-path ~/repos\" {{ borg_id_rsa_pub.content | b64decode | trim }}" + ssh_key_private_content: false + ssh_key_public_content: false + ssh_known_hosts_content: false + ssh_user_home: "/opt/backups/borg_{{ inventory_hostname_short }}" + ssh_user_name: "borg_{{ inventory_hostname_short }}" + ssh_user_group: borgbackup + with_inventory_hostnames: + - borg-server:!disabled diff --git a/playbooks/borg-server.yaml b/playbooks/borg-server.yaml new file mode 100644 index 0000000..fa755e5 --- /dev/null +++ b/playbooks/borg-server.yaml @@ -0,0 +1,42 @@ +# Copyright 2019 Red Hat, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +--- +- name: Install borg-server + hosts: borg-server:!disabled + + tasks: + - name: Setup openstack.borgbackup role + include_role: + name: openstack.borgbackup + + - name: Ensure /opt/backups exists + become: true + file: + path: /opt/backups + state: directory + mode: 0755 + + - name: Setup openstack.borgbackup role + include_role: + name: openstack.borgbackup + vars: + borgbackup_task_manager: + - pre + - config + borgbackup_user_name: "borg_{{ borg_clients }}" + borgbackup_user_home: "/opt/backups/borg_{{ borg_clients }}" + with_inventory_hostnames: + - borg-client:!disabled + loop_control: + loop_var: borg_clients diff --git a/playbooks/site.yaml b/playbooks/site.yaml new file mode 100644 index 0000000..eb5d1db --- /dev/null +++ b/playbooks/site.yaml @@ -0,0 +1,16 @@ +# Copyright 2019 Red Hat, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +--- +- import_playbook: borg-server.yaml +- import_playbook: borg-client.yaml diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..bd9afca --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +ansible>=2.4.0 +netaddr diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..ed855ea --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,6 @@ +hacking<0.11,>=0.10 +ansible-lint +ara +bashate +sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 +yamllint diff --git a/tests/ansible.cfg b/tests/ansible.cfg new file mode 100644 index 0000000..6b40916 --- /dev/null +++ b/tests/ansible.cfg @@ -0,0 +1,9 @@ +[defaults] +callback_whitelist = profile_tasks, timer +fact_caching = jsonfile +fact_caching_connection = ~/.cache/ansible/facts + +[ssh_connection] +# NOTE(pabelanger): Enable pipelining to deal with becomes issues: +# http://docs.ansible.com/ansible/become.html#becoming-an-unprivileged-user +pipelining = True diff --git a/tests/playbooks/group_vars/all.yaml b/tests/playbooks/group_vars/all.yaml new file mode 100644 index 0000000..b0b8bd0 --- /dev/null +++ b/tests/playbooks/group_vars/all.yaml @@ -0,0 +1,2 @@ +--- +windmill_backup_src_dir: "{{ zuul.projects['git.openstack.org/openstack/windmill-backup'].src_dir }}" diff --git a/tests/playbooks/post.yaml b/tests/playbooks/post.yaml new file mode 100644 index 0000000..71eed48 --- /dev/null +++ b/tests/playbooks/post.yaml @@ -0,0 +1,26 @@ +--- +- hosts: all + tasks: + - name: Collect tox logs + synchronize: + dest: "{{ zuul.executor.log_root }}/tox" + mode: pull + src: "{{ windmill_backup_src_dir }}/.tox/venv/log/" + verify_host: true + + - name: Ensure ara-report directory exists + file: + path: "{{ zuul_output_dir }}/logs/logs/ara-report" + state: directory + + - name: Copy ARA database to ara-report directory + shell: "cp ~/.ara/ansible.sqlite {{ zuul_output_dir }}/logs/logs/ara-report" + + # TODO: Migrate to fetch-zuul-logs when + # https://review.openstack.org/#/c/583346/ is merged. + - name: Collect log output + synchronize: + dest: "{{ zuul.executor.log_root }}/" + mode: pull + src: "{{ zuul_output_dir }}/logs/" + verify_host: true diff --git a/tests/playbooks/pre.yaml b/tests/playbooks/pre.yaml new file mode 100644 index 0000000..d7ec44a --- /dev/null +++ b/tests/playbooks/pre.yaml @@ -0,0 +1,39 @@ +--- +- hosts: all + tasks: + - name: Disable extra wheels mirror + become: true + lineinfile: + dest: /etc/pip.conf + regexp: ^extra-index-url + state: absent + + - name: Remove exclude from dnf.conf + become: true + lineinfile: + dest: /etc/dnf/dnf.conf + regexp: ^exclude + state: absent + when: ansible_os_family == 'RedHat' + + - name: Bootstrap bindep environment + args: + chdir: "{{ windmill_backup_src_dir }}" + command: tox -ebindep + + - name: Bootstrap tox environment + args: + chdir: "{{ windmill_backup_src_dir }}" + command: tox -evenv --notest + + - name: Install ansible configuration file + copy: + dest: "{{ ansible_user_dir }}/.ansible.cfg" + remote_src: true + src: "{{ ansible_user_dir }}/{{ windmill_backup_src_dir }}/tests/ansible.cfg" + + - name: Install ansible roles via galaxy + args: + chdir: "{{ windmill_backup_src_dir }}" + executable: /bin/bash + shell: source .tox/venv/bin/activate; ./tools/install_roles.sh diff --git a/tests/playbooks/run.yaml b/tests/playbooks/run.yaml new file mode 100644 index 0000000..dfc86d4 --- /dev/null +++ b/tests/playbooks/run.yaml @@ -0,0 +1,12 @@ +--- +- hosts: all + tasks: + - name: Bootstrap bastion node using ansible + args: + chdir: "{{ windmill_backup_src_dir }}" + shell: tox -evenv -- ansible-playbook -i inventory/testing/hosts playbooks/bastion.yaml + + - name: Run ansible-playbook for site.yaml + args: + chdir: "{{ windmill_backup_src_dir }}" + shell: "tox -evenv -- ansible-playbook -v -f1 -i inventory/testing/hosts playbooks/site.yaml" diff --git a/tools/install_bindep.sh b/tools/install_bindep.sh new file mode 100755 index 0000000..d6883c7 --- /dev/null +++ b/tools/install_bindep.sh @@ -0,0 +1,26 @@ +#!/bin/bash -ex +# Copyright 2016 Red Hat, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +PACKAGES=$(bindep -b -f bindep.txt test || true) +if [ -z "$PACKAGES" ]; then + exit +fi + +if apt-get -v > /dev/null 2>&1 ; then + sudo apt-get update + sudo apt-get --assume-yes install $PACKAGES +else + sudo dnf install -y $PACKAGES +fi diff --git a/tools/install_roles.sh b/tools/install_roles.sh new file mode 100755 index 0000000..a5cb1b0 --- /dev/null +++ b/tools/install_roles.sh @@ -0,0 +1,24 @@ +#!/bin/bash -ex +# Copyright 2015 Red Hat, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +TOOLSDIR=$(dirname $0) + +# NOTE(pabelanger): Check if we are running in the gate, if so use cached repos +# to avoid hitting the network. +if [ -f /etc/ci/mirror_info.sh ]; then + sed -e "s|https://|file://${HOME}/src/|g" -i $TOOLSDIR/requirements.yaml +fi + +ansible-galaxy install -v -r $TOOLSDIR/requirements.yaml -p playbooks/roles $@ diff --git a/tools/requirements.yaml b/tools/requirements.yaml new file mode 100644 index 0000000..9b2f4e5 --- /dev/null +++ b/tools/requirements.yaml @@ -0,0 +1,9 @@ +--- +- name: openstack.borgbackup + src: git+https://git.openstack.org/openstack/ansible-role-borgbackup + +- name: openstack.borgmatic + src: git+https://git.openstack.org/openstack/ansible-role-borgmatic + +- name: openstack.ssh + src: git+https://git.openstack.org/openstack/ansible-role-ssh diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..1afd1a6 --- /dev/null +++ b/tox.ini @@ -0,0 +1,56 @@ +[tox] +minversion = 1.4.2 +envlist = docs,linters +skipsdist = True + +[testenv] +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + +[testenv:bindep] +basepython = python3 +# Do not install any requirements. We want this to be fast and work even if +# system dependencies are missing, since it's used to tell you what system +# dependencies are missing! This also means that bindep must be installed +# separately, outside of the requirements files. +deps = bindep +commands = + {toxinidir}/tools/install_bindep.sh + +[testenv:docs] +basepython = python3 +deps = -r{toxinidir}/doc/requirements.txt +whitelist_externals = + bash +commands= + bash -c "rm -rf doc/build" + doc8 doc + sphinx-build -b html doc/source doc/build/html + +[testenv:linters] +basepython = python3 +whitelist_externals = bash +commands = + yamllint -s . + flake8 + bash -c "ansible-lint -x 204 playbooks/*.yaml" + +[testenv:venv] +basepython = python3 +commands = {posargs} +passenv = + HOME + SSH_AUTH_SOCK + TERM + USER +setenv = + ANSIBLE_CALLBACK_PLUGINS = {envsitepackagesdir}/ara/plugins/callbacks + PYTHONUNBUFFERED = 1 + +[flake8] +# E123, E125 skipped as they are invalid PEP-8. + +show-source = True +ignore = E123,E125 +builtins = _ +exclude=.venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build