windmill/ansible-role-borgbackup
Code Issues Proposed changes

Initial commit

Browse Source 
First commit for borgbackup ansible role.

Change-Id: I6b07d5c89d0aba62d361dbe103969ce14d1047b7
Signed-off-by: Paul Belanger <pabelanger@redhat.com>
This commit is contained in:
Paul Belanger 2019-01-28 11:14:13 -05:00
parent 134eab33d1
commit ecb92f2dfe
30 changed files with 884 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.gitignore vendored Normal file
View File

@ -0,0 +1,5 @@
.tox/
AUTHORS
ChangeLog
doc/build/
*.pyc

61
.zuul.yaml Normal file
View File

@ -0,0 +1,61 @@
---
- job:
name: ansible-role-borgbackup-base
parent: unittests
pre-run: tests/playbooks/pre.yaml
run: tests/playbooks/run.yaml
post-run:
- tests/playbooks/post.yaml
- tests/collect-logs.yaml
roles:
- zuul: openstack/ansible-role-borgbackup
# Testing for borgbackup_install_method: pip
- job:
name: ansible-role-borgbackup
parent: ansible-role-borgbackup-base
- job:
name: ansible-role-borgbackup-fedora-latest
parent: ansible-role-borgbackup
nodeset: fedora-latest
- job:
name: ansible-role-borgbackup-ubuntu-bionic
parent: ansible-role-borgbackup
nodeset: ubuntu-bionic
# Testing for borgbackup_install_method: git
- job:
name: ansible-role-borgbackup-src
parent: ansible-role-borgbackup-base
vars:
borgbackup_install_method: git
- job:
name: ansible-role-borgbackup-src-fedora-latest
parent: ansible-role-borgbackup-src
nodeset: fedora-latest
- job:
name: ansible-role-borgbackup-src-ubuntu-bionic
parent: ansible-role-borgbackup-src
nodeset: ubuntu-bionic
- project:
check:
jobs:
- ansible-role-borgbackup-fedora-latest
- ansible-role-borgbackup-ubuntu-bionic
- ansible-role-borgbackup-src-fedora-latest
- ansible-role-borgbackup-src-ubuntu-bionic
- tox-linters
- windmill-tox-molecule
gate:
jobs:
- ansible-role-borgbackup-fedora-latest
- ansible-role-borgbackup-ubuntu-bionic
- ansible-role-borgbackup-src-fedora-latest
- ansible-role-borgbackup-src-ubuntu-bionic
- tox-linters
- windmill-tox-molecule

202
LICENSE Normal file
View File

@ -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.

45
README.rst Normal file
View File

@ -0,0 +1,45 @@
=======================
ansible-role-borgbackup
=======================
Ansible role to manage borgbackup
* License: Apache License, Version 2.0
* Documentation: https://ansible-role-borgbackup.readthedocs.org
* Source: https://git.openstack.org/cgit/openstack/ansible-role-borgbackup
* Bugs: https://bugs.launchpad.net/ansible-role-borgbackup
Description
-----------
BorgBackup (short: Borg) is a deduplicating backup program. Optionally, it
supports compression and authenticated encryption.
Requirements
------------
* pip3 to be installed if using borgbackup_install_method: (git|pip)
See `bindep.txt` for role dependencies.
Packages
~~~~~~~~
Package repository index files should be up to date before using this role, we
do not manage them.
Role Variables
--------------
Dependencies
------------
Example Playbook
----------------
.. code-block:: yaml
- name: Install borgbackup
hosts: foo
roles:
- ansible-role-borgbackup

5
bindep.txt Normal file
View File

@ -0,0 +1,5 @@
# This is a cross-platform list tracking distribution packages needed by tests;
# see http://docs.openstack.org/infra/bindep/ for additional information.
docker.io [test platform:dpkg]
docker [test platform:fedora]

41
defaults/main.yaml Normal file
View File

@ -0,0 +1,41 @@
# 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.
---
# tasks/main.yaml
borgbackup_task_manager:
- pre
- install
- config
# tasks/config.yaml
borgbackup_user_name: borgbackup
borgbackup_user_group: borgbackup
borgbackup_user_home: /var/lib/borgbackup
borgbackup_user_home_mode: 0755
# borgbackup_user_shell:
# tasks/install.yaml
borgbackup_git_dest: "{{ ansible_user_dir }}/src/github.com/borgbackup/borg"
borgbackup_git_uri: https://github.com/borgbackup/borg
borgbackup_git_version: master
# borgbackup_git_update
borgbackup_install_method: pip
borgbackup_pip_name: borgbackup
# borgbackup_pip_executable:
# borgbackup_pip_extra_args:
# borgbackup_pip_version:
# borgbackup_pip_virtualenv_python:
# borgbackup_pip_virtualenv:

7
doc/requirements.txt Normal file
View File

@ -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

73
doc/source/conf.py Executable file
View File

@ -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'ansible-role-borgbackup'
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}

1
doc/source/index.rst Normal file
View File

@ -0,0 +1 @@
.. include:: ../../README.rst

30
meta/main.yml Normal file
View File

@ -0,0 +1,30 @@
# 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.
---
galaxy_info:
author: Paul Belanger
description: BorgBackup is a deduplicating backup program.
company: Red Hat, Inc.
license: Apache
min_ansible_version: 2.4
platforms:
- name: Fedora
versions:
- 29
- name: Ubuntu
versions:
- 18.04
categories:
- system
dependencies: []

9
molecule/default/Dockerfile.j2 Normal file
View File

@ -0,0 +1,9 @@
# Molecule managed
{% if item.registry is defined %}
FROM {{ item.registry.url }}/{{ item.image }}
{% else %}
FROM {{ item.image }}
{% endif %}
RUN apt-get update && apt-get install -y python sudo bash ca-certificates python-pip python3-pip && apt-get clean;

29
molecule/default/molecule.yml Normal file
View File

@ -0,0 +1,29 @@
---
dependency:
name: galaxy
driver:
name: docker
lint:
name: yamllint
platforms:
- name: ubuntu-bionic
image: ubuntu:bionic
provisioner:
name: ansible
config_options:
ssh_connection:
pipelining: true
lint:
name: ansible-lint
log: true
playbooks:
converge: ../../tests/playbooks/run.yaml
scenario:
name: default
verifier:
name: testinfra
directory: ../tests
options:
verbose: true
lint:
name: flake8

41
molecule/tests/test_role.py Normal file
View File

@ -0,0 +1,41 @@
# 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.
def test_backup_user(host):
user = host.user('borgbackup')
assert user.exists
assert user.name == 'borgbackup'
assert user.group == 'borgbackup'
assert user.home == '/var/lib/borgbackup'
f = host.file('/var/lib/borgbackup')
assert f.exists
assert f.is_directory
assert f.user == 'borgbackup'
assert f.group == 'borgbackup'
assert f.mode == 0o755
def test_repos_directory(host):
f = host.file('/var/lib/borgbackup/repos')
assert f.exists
assert f.is_directory
assert f.user == 'borgbackup'
assert f.group == 'borgbackup'
assert f.mode == 0o755
def test_borgbackup_version(host):
host.check_output('borg --version')

1
requirements.txt Normal file
View File

@ -0,0 +1 @@
ansible>=2.4.0

23
tasks/config.yaml Normal file
View File

@ -0,0 +1,23 @@
# 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: Create required directories
become: true
file:
group: "{{ borgbackup_user_group }}"
owner: "{{ borgbackup_user_name }}"
path: "{{ item }}"
state: directory
with_items:
- "{{ borgbackup_user_home }}/repos"

35
tasks/install.yaml Normal file
View File

@ -0,0 +1,35 @@
# 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: Define borgbackup_build_depends
set_fact:
borgbackup_build_depends: "{{ __borgbackup_build_depends | list }}"
when: borgbackup_build_depends is not defined
- name: Ensure build dependencies are present
become: true
package:
name: "{{ borgbackup_build_depends }}"
state: present
when: borgbackup_install_method == 'git' or borgbackup_install_method == 'pip'
- name: Define borgbackup_pip_executable if needed
set_fact:
borgbackup_pip_executable: pip3
when:
- borgbackup_install_method == 'git' or borgbackup_install_method == 'pip'
- borgbackup_pip_virtualenv_python is not defined
- borgbackup_pip_executable is not defined
- include: "install/{{ borgbackup_install_method }}.yaml"

26
tasks/install/git.yaml Normal file
View File

@ -0,0 +1,26 @@
# 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: Git clone borgbackup
git:
dest: "{{ borgbackup_git_dest }}"
repo: "{{ borgbackup_git_uri }}"
update: "{{ borgbackup_git_update|default(omit) }}"
version: "{{ borgbackup_git_version }}"
- name: Set borgbackup_pip_name to local git repo
set_fact:
borgbackup_pip_name: "file://{{ borgbackup_git_dest }}"
- include: pip.yaml

23
tasks/install/pip.yaml Normal file
View File

@ -0,0 +1,23 @@
# 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 borgbackup using pip
become: true
pip:
executable: "{{ borgbackup_pip_executable|default(omit) }}"
extra_args: "{{ borgbackup_pip_extra_args|default(omit) }}"
name: "{{ borgbackup_pip_name }}"
version: "{{ borgbackup_pip_version|default(omit) }}"
virtualenv_python: "{{ borgbackup_pip_virtualenv_python|default(omit) }}"
virtualenv: "{{ borgbackup_pip_virtualenv|default(omit) }}"

21
tasks/main.yaml Normal file
View File

@ -0,0 +1,21 @@
# 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: Include OS-specific variables
include_vars: "{{ ansible_os_family }}.yaml"
- include: "{{ borgbackup_task }}.yaml"
with_items: "{{ borgbackup_task_manager }}"
loop_control:
loop_var: borgbackup_task

33
tasks/pre.yaml Normal file
View File

@ -0,0 +1,33 @@
# 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: Create group account
become: true
group:
name: "{{ borgbackup_user_group }}"
- name: Create user account
become: true
user:
createhome: true
group: "{{ borgbackup_user_group }}"
home: "{{ borgbackup_user_home }}"
name: "{{ borgbackup_user_name }}"
shell: "{{ borgbackup_user_shell|default(omit) }}"
- name: Set permissions on home directory
become: true
file:
path: "{{ borgbackup_user_home }}"
mode: "{{ borgbackup_user_home_mode }}"

3
test-requirements.txt Normal file
View File

@ -0,0 +1,3 @@
ara
docker
molecule

19
tests/collect-logs.yaml Normal file
View File

@ -0,0 +1,19 @@
- hosts: all
tasks:
- name: Collect testinfra reports
synchronize:
dest: "{{ zuul_output_dir }}/logs"
src: "{{ item }}"
verify_host: true
delegate_to: "{{ inventory_hostname }}"
with_items:
- "{{ ansible_user_dir }}/{{ zuul.project.src_dir }}/junit.xml"
# 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

1
tests/inventory Normal file
View File

@ -0,0 +1 @@
localhost

8
tests/playbooks/post.yaml Normal file
View File

@ -0,0 +1,8 @@
- hosts: all
tasks:
- name: Run testinfra validation
include_role:
name: tox
vars:
tox_envlist: testinfra
tox_install_siblings: false

8
tests/playbooks/pre.yaml Normal file
View File

@ -0,0 +1,8 @@
- hosts: all
tasks:
- name: Disable extra wheels mirror
become: yes
lineinfile:
dest: /etc/pip.conf
regexp: ^extra-index-url
state: absent

34
tests/playbooks/run.yaml Normal file
View File

@ -0,0 +1,34 @@
# 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.
---
- hosts: all
vars:
rolename: ansible-role-borgbackup
roles:
- "{{ rolename }}"
post_tasks:
- name: Register borgbackup_git_dest_stat
stat:
path: /home/zuul/src/github.com/borgbackup/borg
register: borgbackup_git_dest_stat
when: borgbackup_install_method == 'git'
- name: Assert borgbackup_git_dest tests.
assert:
that:
- borgbackup_git_dest_stat.stat.exists
- borgbackup_git_dest_stat.stat.isdir
when: borgbackup_install_method == 'git'

21
tools/test-setup.sh Executable file
View File

@ -0,0 +1,21 @@
#!/bin/bash -ex
# Copyright 2018 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.
if ! [ $(getent group docker) ]; then
sudo groupadd docker
fi
sudo gpasswd -a ${USER} docker
sudo service docker restart

43
tox.ini Normal file
View File

@ -0,0 +1,43 @@
[tox]
minversion = 1.4.2
envlist = docs,linters
skipsdist = True
[testenv]
deps = -r{toxinidir}/requirements.txt
-r{toxinidir}/test-requirements.txt
[testenv:docs]
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:testinfra]
commands =
pytest --junit-xml junit.xml --sudo --verbose molecule/tests
[testenv:venv]
commands = {posargs}
[flake8]
# E123, E125 skipped as they are invalid PEP-8.
show-source = True
ignore = E123,E125
builtins = _
exclude=.venv,.git,.tox,dist,doc,*egg,build
[testenv:linters]
commands =
molecule lint
[testenv:molecule]
sitepackages = True
setenv =
ANSIBLE_CALLBACK_PLUGINS = {envsitepackagesdir}/ara/plugins/callbacks
commands =
molecule test

18
vars/Debian.yaml Normal file
View File

@ -0,0 +1,18 @@
# 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.
---
__borgbackup_build_depends:
- cython3
- libacl1-dev
- libssl-dev

18
vars/RedHat.yaml Normal file
View File

@ -0,0 +1,18 @@
# 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.
---
__borgbackup_build_depends:
- libacl-devel
- openssl-devel
- python3-Cython