From a0bb3417417d2e74e3b197f433c82fd3f56dd0c5 Mon Sep 17 00:00:00 2001 From: Brad Cowie Date: Mon, 23 Oct 2023 16:45:58 +1300 Subject: [PATCH] Release role. --- .github/dependabot.yml | 7 ++ .github/workflows/lint.yml | 32 ++++++ .github/workflows/test.yml | 41 +++++++ LICENSE | 202 +++++++++++++++++++++++++++++++++ README.md | 93 +++++++++++++++ meta/argument_specs.yml | 53 +++++++++ meta/main.yml | 24 ++++ molecule/default/Dockerfile.j2 | 20 ++++ molecule/default/converge.yml | 9 ++ molecule/default/molecule.yml | 19 ++++ test-requirements.txt | 6 + 11 files changed, 506 insertions(+) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/lint.yml create mode 100644 .github/workflows/test.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 meta/argument_specs.yml create mode 100644 meta/main.yml create mode 100644 molecule/default/Dockerfile.j2 create mode 100644 molecule/default/converge.yml create mode 100644 molecule/default/molecule.yml create mode 100644 test-requirements.txt diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..64284b9 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,7 @@ +--- +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "monthly" diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..c07813f --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,32 @@ +--- +name: Lint + +on: + pull_request: + branches: + - main + +jobs: + ansible-lint: + name: Ansible Lint + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Lint ansible + uses: wandansible/action-ansible-lint@v1 + + jinja2-lint: + name: Jinja2 Lint + runs-on: ubuntu-latest + env: + J2LINT_FILES_REGEX: '^templates/.+$' + steps: + - name: Checkout repo + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Lint jinja2 files + uses: wandansible/action-j2lint@v1 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..617cd15 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,41 @@ +--- +name: Tests + +on: + pull_request: + branches: + - main + +jobs: + generate-matrix: + name: Generate matrix + runs-on: ubuntu-latest + outputs: + matrix: ${{ steps.generate-matrix.outputs.matrix }} + steps: + - name: Generate matrix + id: generate-matrix + uses: wandnz/action-supported-distro-releases@v1 + + molecule: + name: Molecule + runs-on: ubuntu-latest + needs: generate-matrix + strategy: + matrix: + target: ${{ fromJson(needs.generate-matrix.outputs.matrix) }} + exclude: + - target: debian:buster + steps: + - name: Checkout repo + uses: actions/checkout@v4 + - name: Setup python + uses: actions/setup-python@v4 + with: + python-version: '3.x' + - name: Install test dependencies + run: pip3 install -r test-requirements.txt + - name: Run molecule + run: molecule test + env: + MOLECULE_DOCKER_IMAGE: ${{ matrix.target }} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cc08bc1 --- /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 2022 The University of Waikato, Hamilton, New Zealand. + + 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.md b/README.md new file mode 100644 index 0000000..89f77a5 --- /dev/null +++ b/README.md @@ -0,0 +1,93 @@ +Ansible role: sanity\_check +========================== + +Perform sanity checks against the host environment where the +ansible playbook is being run and abandon if any issues are found. + +Checks include: + + * Ansible version + * Required python modules are installed + * Ansible playbook directory is checked out from the right git branch + and there are no local changes in the git working tree. + +Role Variables +-------------- + +``` +ENTRY POINT: main - Perform sanity checks before running playbooks + + Perform sanity checks against the host environment where the + ansible playbook is being run and abandon if any issues are + found. Checks include: ansible version, required python + modules are installed, ansible playbook directory is checked + out from the right git branch and there are no local changes + in the git working tree. + +OPTIONS (= is mandatory): + +- sanity_check_ansible_playbook_dir + Path to ansible playbook directory + default: '{{ ansible_config_file | dirname }}' + type: str + +- sanity_check_git_branch + Name of the git branch that ansible playbooks should be run + from + default: main + type: str + +- sanity_check_git_repo + If true, run git repo sanity checks against ansible playbook + directory + default: true + type: bool + +- sanity_check_minimum_ansible_version + Minimum ansible version required to run the playbooks + default: 2.12.0 + type: str + +- sanity_check_python_modules + Python modules required to run the playbooks + default: [{apt_package: python3-passlib, name: passlib}, {apt_package: python3-jmespath, name: jmespath}, + {apt_package: python3-netaddr, name: netaddr}] + elements: dict + type: list + + OPTIONS: + + = apt_package + Apt package which provides the python module + type: str + + = name + Python module name + type: str +``` + +Installation +------------ + +This role can either be installed manually with the ansible-galaxy CLI tool: + + ansible-galaxy install git+https://github.com/wandansible/sanity_check,main,wandansible.sanity_check + +Or, by adding the following to `requirements.yml`: + + - name: wandansible.sanity_check + src: https://github.com/wandansible/sanity_check + +Roles listed in `requirements.yml` can be installed with the following ansible-galaxy command: + + ansible-galaxy install -r requirements.yml + +Example Playbook +---------------- + + - hosts: all + roles: + - role: wandansible.sanity_check + gather_facts: false + run_once: true + become: false diff --git a/meta/argument_specs.yml b/meta/argument_specs.yml new file mode 100644 index 0000000..2886e04 --- /dev/null +++ b/meta/argument_specs.yml @@ -0,0 +1,53 @@ +--- +argument_specs: + main: + short_description: Perform sanity checks before running playbooks + description: | + Perform sanity checks against the host environment where + the ansible playbook is being run and abandon if any issues are found. + Checks include: + ansible version, required python modules are installed, + ansible playbook directory is checked out from the right git branch + and there are no local changes in the git working tree. + options: + sanity_check_minimum_ansible_version: + description: Minimum ansible version required to run the playbooks + type: str + default: 2.12.0 + + sanity_check_python_modules: + description: Python modules required to run the playbooks + type: list + elements: dict + options: + name: + description: Python module name + type: str + required: true + apt_package: + description: Apt package which provides the python module + type: str + required: true + default: + - name: passlib + apt_package: python3-passlib + - name: jmespath + apt_package: python3-jmespath + - name: netaddr + apt_package: python3-netaddr + + sanity_check_git_repo: + description: >- + If true, run git repo sanity checks against ansible playbook directory + type: bool + default: true + + sanity_check_ansible_playbook_dir: + description: Path to ansible playbook directory + type: str + default: "{{ ansible_config_file | dirname }}" + + sanity_check_git_branch: + description: Name of the git branch that ansible playbooks should be run from + type: str + default: main diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..9f421b2 --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,24 @@ +--- +galaxy_info: + namespace: wandansible + role_name: sanity_check + author: WAND Network Research Group + description: Perform sanity checks before running playbooks + + license: Apache-2.0 + + min_ansible_version: "2.10" + + platforms: + - name: Debian + versions: + - bullseye + - bookworm + - name: Ubuntu + versions: + - focal + - jammy + + galaxy_tags: [] + +dependencies: [] diff --git a/molecule/default/Dockerfile.j2 b/molecule/default/Dockerfile.j2 new file mode 100644 index 0000000..6d84a42 --- /dev/null +++ b/molecule/default/Dockerfile.j2 @@ -0,0 +1,20 @@ +{% if item.registry is defined and '/' not in item.image %} +FROM {{ item.registry.url }}/{{ item.image }} +{% else %} +FROM {{ item.image }} +{% endif %} + +{% if item.env is defined %} +{% for var, value in item.env.items() %} +{% if value %} +ENV {{ var }} {{ value }} +{% endif %} +{% endfor %} +{% endif %} + +RUN export DEBIAN_FRONTEND=noninteractive \ + && apt-get update \ + && apt-get install -y python3 sudo bash ca-certificates iproute2 python3-apt aptitude systemd gnupg \ + && apt-get clean + +CMD ["/lib/systemd/systemd"] diff --git a/molecule/default/converge.yml b/molecule/default/converge.yml new file mode 100644 index 0000000..2ecd574 --- /dev/null +++ b/molecule/default/converge.yml @@ -0,0 +1,9 @@ +--- +- name: Converge + hosts: all + tasks: + - name: "Include wandansible.sanity_check" + ansible.builtin.include_role: + name: "wandansible.sanity_check" + vars: + sanity_check_ansible_playbook_dir: "{{ lookup('ansible.builtin.env', 'GITHUB_WORKSPACE') }}" diff --git a/molecule/default/molecule.yml b/molecule/default/molecule.yml new file mode 100644 index 0000000..d96c253 --- /dev/null +++ b/molecule/default/molecule.yml @@ -0,0 +1,19 @@ +--- +dependency: + name: galaxy +driver: + name: docker +platforms: + - name: instance + image: ${MOLECULE_DOCKER_IMAGE:-ubuntu:latest} + pre_build_image: false + override_command: false + privileged: true + volumes: + - /sys/fs/cgroup:/sys/fs/cgroup:rw + cgroupns_mode: host +provisioner: + name: ansible + log: true +verifier: + name: ansible diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..5b92c1c --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,6 @@ +ansible +jmespath +passlib +netaddr +molecule +molecule-plugins[docker]