Refactor role

Author: medanthelinium

.aar-doc.yml

@@ -0,0 +1,98 @@
+---
+output_file: README.md
+output_mode: replace
+output_template: |
+  <!-- BEGIN_ANSIBLE_DOCS -->
+  # {{ role }}
+
+  {{ metadata.galaxy_info.description }}
+
+  ## Supported Operating Systems
+
+  - Debian 12
+  - Ubuntu 24.04, 22.04
+  - FreeBSD [Proserver](https://infrastructure.punkt.de/de/produkte/proserver.html)
+
+  ## Role Arguments
+
+  {% for entrypoint in argument_specs.keys() %}
+
+  {% if "description" in argument_specs[entrypoint] %}
+  {%- if argument_specs[entrypoint].description is string -%}
+  {{ argument_specs[entrypoint].description }}
+  {% else %}
+  {%- for line in argument_specs[entrypoint].description -%}
+  {{ line }}
+
+  {% endfor -%}
+  {% endif -%}
+  {% endif -%}
+
+  {% if entrypoint_options[entrypoint] | length > 1 -%}
+  {% for path, options in entrypoint_options[entrypoint][1:] -%}
+  #### Options for `{{ path | reject('eq', 'main') | join(".") }}`
+
+  |Option|Description|Type|Required|Default|
+  |---|---|---|---|---|
+  {%- for name, details in options.items() %}
+  | `{{ name }}` | {{ details.display_description }} | {{ details.display_type }} | {{ details.display_required }} | {{ details.display_default }} |
+  {%- endfor %}
+
+  {% endfor -%}
+
+  {% endif -%}
+
+  {% if entrypoint in entrypoint_choices -%}
+  {% for path, choices in entrypoint_choices[entrypoint] -%}
+  #### Choices for {{ path | join(" > ") }}
+
+  |Choice|
+  |---|
+  {%- for item in choices %}
+  | {{ item }} |
+  {%- endfor %}
+
+  {% endfor -%}
+  {% endif -%}
+  {% else -%}
+
+  This entrypoint has no options.
+
+  {% endfor -%}
+
+  ## Dependencies
+
+  {%- if ("dependencies" in metadata) and (metadata.dependencies | length > 0) %}
+  {%- for dependency in metadata.dependencies %}
+  {%- if dependency.src %}
+  - [{{ dependency.role }}]({{ dependency.src }})
+  {%- else %}
+  - {{ dependency.role }}
+  {%- endif %}
+    {%- if dependency.when %}
+    - **Condition**: `{{ dependency.when }}`
+    {%- endif %}
+  {%- endfor %}
+  {%- else %}
+  None.
+  {%- endif %}
+
+  ## Installation
+  Add this role to the requirements.yml of your playbook as follows:
+  ```yaml
+  roles:
+    - name: {{ role }}
+      src: https://github.com/punktDe/ansible-wireguard
+  ```
+
+  Afterwards, install the role by running `ansible-galaxy install -r requirements.yml`
+
+  ## Example Playbook
+
+  ```yaml
+  - hosts: all
+    roles:
+      - name: wireguard
+  ```
+
+  <!-- END_ANSIBLE_DOCS -->

.ansible-lint

@@ -0,0 +1,14 @@
+---
+skip_list:
+  - meta-no-info
+  - var-naming[no-role-prefix]
+  - name[template]
+
+warn_list:
+  - no-handler
+  - package-latest
+  - risky-shell-pipe
+  - unnamed-task
+
+exclude_paths:
+  - .ansible/

.editorconfig

@@ -0,0 +1,14 @@
+# EditorConfig: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# 2 space indentation for YAML
+[{*.yml,*.yaml}]
+indent_style = space
+indent_size = 2

.envrc

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+if [ -n "$DIRENV_DIFF" ]; then
+  # Do not `set -e` unless we're being run from direnv
+  set -e
+fi
+
+if [ ! -f venv-ansible-wireguard/bin/activate ]; then
+	echo "Creating a virtual Python environment"
+	uv -q venv --allow-existing --seed venv-ansible-wireguard
+fi
+
+echo "Activating the Python virtual environment"
+. venv-ansible-wireguard/bin/activate
+
+echo "Installing Python requirements"
+uv -q pip install -r requirements.txt
+
+export GITHUB_ACTIONS=maybe
+export ANSIBLE_HASH_BEHAVIOUR=merge

.github/workflows/test.yml

@@ -0,0 +1,61 @@
+---
+name: Test
+run-name: Run molecule tests on the role
+on:
+  push:
+  workflow_dispatch:
+
+env:
+  ANSIBLE_ROLES_PATH: roles
+  ANSIBLE_HASH_BEHAVIOUR: merge
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install dependencies
+        run: |
+          uv -q venv --allow-existing --seed .venv
+          . .venv/bin/activate
+          uv -q pip install -r requirements.txt
+
+      - name: Run ansible-lint
+        run: |
+          . .venv/bin/activate
+          ansible-lint
+
+  molecule:
+    strategy:
+      matrix:
+        os: [ubuntu-2204, ubuntu-2404, debian-12]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install dependencies.
+        run: |
+          uv -q venv --allow-existing --seed .venv
+          . .venv/bin/activate
+          uv -q pip install -r requirements.txt
+          ansible-galaxy install -r requirements.yml
+
+      - name: Run molecule
+        run: |
+          . .venv/bin/activate
+          molecule test -p ${{ matrix.os }}

.gitignore

@@ -0,0 +1,16 @@
+.DS_Store
+*.pyc
+__pycache__
+.idea
+.vscode
+/*.retry
+/.fact_cache
+/venv/
+debug.log
+id_ed25519*
+/venv*/
+.collections
+roles
+.roles
+.venv
+.ansible

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+---
+repos:
+  - repo: https://github.com/ansible/ansible-lint.git
+    rev: v25.1.3
+    hooks:
+      - id: ansible-lint
+        files: \.(yaml|yml)$

.yamllint

@@ -0,0 +1,15 @@
+---
+extends: default
+
+rules:
+  line-length: disable
+  truthy:
+    allowed-values: ['true', 'false', 'yes', 'no']
+  comments:
+    min-spaces-from-content: 1
+  braces:
+    min-spaces-inside: 0
+    max-spaces-inside: 1
+
+ignore: |
+  .cache

defaults/main.yaml

@@ -1,2 +1,3 @@
+---
 wireguard:
   wg_quick: {}

meta/main.yml

@@ -0,0 +1,9 @@
+---
+galaxy_info:
+  author: "punkt.de"
+  license: "MIT"
+  role_name: wireguard
+  description: "Wireguard role for Linux"
+  namespace: "punktde"
+  min_ansible_version: "2.15"
+  platforms: []