diff --git a/.forgejo/workflows/molecule.yml b/.forgejo/workflows/molecule.yml new file mode 100644 index 0000000..59dc096 --- /dev/null +++ b/.forgejo/workflows/molecule.yml @@ -0,0 +1,18 @@ +--- +on: [push] +jobs: + lint: + runs-on: docker + container: + image: code.waks.be/nishiki/molecule:docker + steps: + - uses: actions/checkout@v3 + - run: ansible-lint . + - run: yamllint . + molecule: + runs-on: docker + container: + image: code.waks.be/nishiki/molecule:docker + steps: + - uses: actions/checkout@v3 + - run: molecule test diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1331d18 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.kitchen/* +*.pyc diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..2f9af0a --- /dev/null +++ b/.yamllint @@ -0,0 +1,12 @@ +--- +extends: default + +ignore: | + .kitchen* + vendor/ + .forgejo/ + +rules: + line-length: + max: 120 + level: warning diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..016b6d1 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,8 @@ +# CHANGELOG + +This project adheres to [Semantic Versioning](http://semver.org/). +Which is based on [Keep A Changelog](http://keepachangelog.com/) + +## [Unreleased] + +- first version diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0b9a699 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 2024 Adrien Waksberg + + 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..200efa0 --- /dev/null +++ b/README.md @@ -0,0 +1,92 @@ +# Ansible role: Forgejo runner + +[![Version](https://img.shields.io/badge/latest_version-0.0.0-green.svg)](https://code.waks.be/nishiki/ansible-role-forgejo_runner/releases) +[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://code.waks.be/nishiki/ansible-role-forgejo_runner/src/branch/main/LICENSE) +[![Build](https://code.waks.be/nishiki/ansible-role-forgejo_runner/actions/workflows/molecule.yml/badge.svg?branch=main)](https://code.waks.be/nishiki/ansible-role-forgejo_runner/actions?workflow=molecule.yml) + +Install and configure Forgejo runner + +## Requirements + +- Ansible >= 2.10 +- Debian + - Bookworm + +## Role variables + +| Name | Type | Required | Default | Comment | +| ------------------------------ | ---- | -------- | ----------------------------------------------------------------------- | -------------------------- | +| forgejo_runner_version | str | no | 3.4.1 | version to install | +| forgejo_runner_binary_checksum | str | no | sha256:5cf1d28e6d2d6168b10f2e7fac5425fe6789491834c047b5f7bb21ab84b9eaf5 | checksum for verify binary | +| forgejo_runner_arch | str | no | amd64 | architecture of binary | +| forgejo_runner_name | str | no | inventory_hostname | runner name in forgejo | +| forgejo_runner_instance_url | str | yes | | forgejo instance url | +| forgejo_runner_instance_token | str | yes | | forgejo token to register | +| forgejo_runner_config | dict | no | | | + +### forgejo_runner_config + +All options are in [the documentation](https://forgejo.codeberg.page/docs/latest/admin/actions/#configuration) + +Default value: + +```yaml +log: + level: info +runner: + file: .runner + capacity: 1 + timeout: 30m + insecure: false +container: + force_pull: true +``` + +## How to use + +```yaml +- hosts: server + roles: + - forgejo_runner + vars: + forgejo_runner_version: 3.4.1 + forgejo_runner_binary_checksum: sha256:5cf1d28e6d2d6168b10f2e7fac5425fe6789491834c047b5f7bb21ab84b9eaf5 + forgejo_runner_arch: amd64 + forgejo_runner_name: mysuperserver + forgejo_runner_instance_url: https://git.example.com/ + forgejo_runner_instance_token: SECRET_TOKEN + forgejo_runner_config: + log: + level: debug + runner: + capacity: 3 + container: + force_pull: false +``` + +## Development + +### Test with molecule and docker + +- install [docker](https://docs.docker.com/engine/installation/) +- install `python3` and `python3-pip` +- install molecule and dependencies `pip3 install molecule molecule-docker docker ansible-lint pytest-testinfra yamllint` +- run `molecule test` + +## License + +``` +Copyright (c) 2024 Adrien Waksberg + +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/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..ac4d89e --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,17 @@ +--- +forgejo_runner_version: 3.4.1 +forgejo_runner_binary_checksum: sha256:5cf1d28e6d2d6168b10f2e7fac5425fe6789491834c047b5f7bb21ab84b9eaf5 +forgejo_runner_arch: amd64 +forgejo_runner_name: "{{ inventory_hostname }}" +forgejo_runner_config: {} +forgejo_runner_default_config: + log: + level: info + runner: + file: /opt/forgejo-runner/.runner + capacity: 1 + timeout: 30m + insecure: false + container: + force_pull: true +forgejo_runner_full_config: "{{ forgejo_runner_default_config | combine(forgejo_runner_config) }}" diff --git a/handlers/main.yml b/handlers/main.yml new file mode 100644 index 0000000..bc92175 --- /dev/null +++ b/handlers/main.yml @@ -0,0 +1,5 @@ +--- +- name: Restart forgejo-runner + ansible.builtin.service: + name: forgejo-runner + state: restarted diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..1128e9e --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,21 @@ +--- +galaxy_info: + role_name: forgejo_runner + namespace: nishiki + author: Adrien Waksberg + company: Adrien Waksberg + description: Install and configure forgejo_runner + license: Apache2 + min_ansible_version: "2.10" + + platforms: + - name: Debian + versions: + - bookworm + + galaxy_tags: + - ci + - forgejo + - git + +dependencies: [] diff --git a/molecule/default/converge.yml b/molecule/default/converge.yml new file mode 100644 index 0000000..8c65e4f --- /dev/null +++ b/molecule/default/converge.yml @@ -0,0 +1,25 @@ +--- +- name: Converge + hosts: all + roles: + - ansible-role-forgejo_runner + vars: + forgejo_runner_instance_token: secret + forgejo_runner_instance_url: https://git.example.com/ + + pre_tasks: + - name: Update apt cache + ansible.builtin.apt: + update_cache: true + + - name: Create forgejo-runner home + ansible.builtin.file: + path: /opt/forgejo-runner + mode: "0755" + state: directory + + - name: Create .runner file + ansible.builtin.file: + path: /opt/forgejo-runner/.runner + mode: "0644" + state: touch diff --git a/molecule/default/molecule.yml b/molecule/default/molecule.yml new file mode 100644 index 0000000..abd7df7 --- /dev/null +++ b/molecule/default/molecule.yml @@ -0,0 +1,28 @@ +--- +driver: + name: docker +platforms: + - name: debian12 + image: code.waks.be/nishiki/molecule:debian12 + privileged: true + volumes: + - /sys/fs/cgroup:/sys/fs/cgroup:rw + cgroupns_mode: host + command: /bin/systemd + capabilities: + - SYS_ADMIN +verifier: + name: testinfra +scenario: + test_sequence: + - dependency + - cleanup + - destroy + - syntax + - create + - prepare + - converge + - side_effect + - verify + - cleanup + - destroy diff --git a/molecule/default/tests/test_default.py b/molecule/default/tests/test_default.py new file mode 100644 index 0000000..a5fc89c --- /dev/null +++ b/molecule/default/tests/test_default.py @@ -0,0 +1,34 @@ +import testinfra.utils.ansible_runner + +def test_package(host): + package = host.package('docker.io') + assert package.is_installed + +def test_user(host): + user = host.user('forgejo-runner') + assert user.exists + assert user.group == 'forgejo-runner' + assert 'docker' in user.groups + assert user.home == '/opt/forgejo-runner' + assert user.shell == '/bin/nologin' + +def test_binary_file(host): + path = host.file('/usr/local/bin/forgejo-runner') + assert path.exists + assert path.is_file + assert path.user == 'root' + assert path.group == 'root' + assert path.mode == 0o755 + +def test_config_file(host): + path = host.file('/etc/forgejo-runner.yml') + assert path.exists + assert path.is_file + assert path.user == 'root' + assert path.group == 'root' + assert path.mode == 0o644 + assert path.contains('level: info') + +def test_service(host): + service = host.service('forgejo-runner') + assert service.is_enabled diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..45036bd --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,77 @@ +--- +- name: install dependency + ansible.builtin.package: + name: + - docker.io + tags: forgejo-runner + +- name: Create group + ansible.builtin.group: + name: forgejo-runner + tags: forgejo-runner + +- name: Create user + ansible.builtin.user: + name: forgejo-runner + group: forgejo-runner + groups: docker + shell: /bin/nologin + home: /opt/forgejo-runner + tags: forgejo-runner + +- name: Download binary + ansible.builtin.get_url: + url: >- + https://code.forgejo.org/forgejo/runner/releases/download/v{{ forgejo_runner_version + }}/forgejo-runner-{{ forgejo_runner_version + }}-linux-{{ forgejo_runner_arch }} + dest: /usr/local/bin/forgejo-runner + owner: root + group: root + mode: "0755" + checksum: "{{ forgejo_runner_binary_checksum }}" + tags: forgejo-runner + +- name: Copy config + ansible.builtin.copy: + content: "{{ forgejo_runner_full_config | to_nice_yaml }}" + dest: /etc/forgejo-runner.yml + owner: root + group: root + mode: "0644" + notify: Restart forgejo-runner + tags: forgejo-runner + +- name: Check if register file exists + ansible.builtin.stat: + path: /opt/forgejo-runner/.runner + register: st + tags: forgejo-runner + +- name: Register the runner + ansible.builtin.command: >- + forgejo-runner register --no-interactive + --token {{ forgejo_runner_instance_token }} --name {{ forgejo_runner_name }} + --instance {{ forgejo_runner_instance_url }} --config /etc/forgejo-runner.yml + become: true + become_user: forgejo-runner + when: not st.stat.exists # noqa no-changed-when + tags: forgejo-runner + +- name: Copy systemd unit + ansible.builtin.template: + src: forgejo-runner.service.j2 + dest: /lib/systemd/system/forgejo-runner.service + owner: root + group: root + mode: "0644" + notify: Restart forgejo-runner + tags: forgejo-runner + +- name: Enable and start service + ansible.builtin.service: + name: forgejo-runner + state: started + enabled: true + daemon_reload: true + tags: forgejo-runner diff --git a/templates/forgejo-runner.service.j2 b/templates/forgejo-runner.service.j2 new file mode 100644 index 0000000..c476a83 --- /dev/null +++ b/templates/forgejo-runner.service.j2 @@ -0,0 +1,14 @@ +# {{ ansible_managed }} + +[Unit] +Description=Forgejo runner daemon +After=network.target + +[Service] +Type=simple +WorkingDirectory=/opt/forgejo-runner +User=forgejo-runner +ExecStart=/usr/local/bin/forgejo-runner daemon -c /etc/forgejo-runner.yml + +[Install] +WantedBy=multi-user.target