[skip ci] fix drone-matrix template

Co-authored-by: Robert Kaussow <xoxys@rknet.org>
Co-committed-by: Robert Kaussow <xoxys@rknet.org>

.drone.jsonnet

@@ -8,14 +8,36 @@ local PipelineLinting = {
   steps: [
     {
       name: 'ansible-later',
-      image: 'xoxys/ansible-later',
+      image: 'thegeeklab/ansible-later',
       commands: [
         'ansible-later',
       ],
     },
+    {
+      name: 'python-format',
+      image: 'python:3.11',
+      environment: {
+        PY_COLORS: 1,
+      },
+      commands: [
+        'pip install -qq yapf',
+        '[ -z "$(find . -type f -name *.py)" ] || (yapf -rd ./)',
+      ],
+    },
+    {
+      name: 'python-flake8',
+      image: 'python:3.11',
+      environment: {
+        PY_COLORS: 1,
+      },
+      commands: [
+        'pip install -qq flake8',
+        'flake8',
+      ],
+    },
   ],
   trigger: {
-    ref: ['refs/heads/master', 'refs/tags/**', 'refs/pull/**'],
+    ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
   },
 };
 
@@ -36,14 +58,12 @@ local PipelineDeployment(scenario='centos7') = {
   steps: [
     {
       name: 'ansible-molecule',
-      image: 'xoxys/molecule:3',
+      image: 'thegeeklab/molecule:4',
       environment: {
-        DO_API_KEY: { from_secret: 'do_api_key' },
+        HCLOUD_TOKEN: { from_secret: 'hcloud_token' },
-        MOLECULE_CUSTOM_MODULES_REPO: 'https://gitea.rknet.org/ansible/custom_modules',
-        MOLECULE_CUSTOM_FILTERS_REPO: 'https://gitea.rknet.org/ansible/custom_filters',
       },
       commands: [
-        'molecule test -s' + scenario,
+        'molecule test -s ' + scenario,
       ],
     },
   ],
@@ -51,7 +71,7 @@ local PipelineDeployment(scenario='centos7') = {
     'linting',
   ],
   trigger: {
-    ref: ['refs/heads/master', 'refs/tags/**'],
+    ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
   },
 };
 
@@ -65,7 +85,7 @@ local PipelineDocumentation = {
   steps: [
     {
       name: 'generate',
-      image: 'xoxys/ansible-doctor',
+      image: 'thegeeklab/ansible-doctor',
       environment: {
         ANSIBLE_DOCTOR_LOG_LEVEL: 'INFO',
         ANSIBLE_DOCTOR_FORCE_OVERWRITE: true,
@@ -87,31 +107,16 @@ local PipelineDocumentation = {
         target_branch: 'docs',
       },
       when: {
-        ref: ['refs/heads/master'],
+        ref: ['refs/heads/main'],
-      },
-    },
-    {
-      name: 'trigger',
-      image: 'plugins/downstream',
-      settings: {
-        server: 'https://drone.rknet.org',
-        token: { from_secret: 'drone_token' },
-        fork: true,
-        repositories: [
-          'ansible/ansible-galaxy',
-        ],
-      },
-      when: {
-        ref: ['refs/heads/master'],
       },
     },
   ],
   trigger: {
-    ref: ['refs/heads/master', 'refs/tags/**', 'refs/pull/**'],
+    ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
   },
   depends_on: [
     'testing-centos7',
-    'testing-centos8',
+    'testing-rocky8',
   ],
 };
 
@@ -128,11 +133,11 @@ local PipelineNotification = {
   steps: [
     {
       name: 'matrix',
-      image: 'plugins/matrix',
+      image: 'thegeeklab/drone-matrix',
       settings: {
         homeserver: { from_secret: 'matrix_homeserver' },
         roomid: { from_secret: 'matrix_roomid' },
-        template: 'Status: **{{ build.status }}**<br/> Build: [{{ repo.Owner }}/{{ repo.Name }}]({{ build.link }}) ({{ build.branch }}) by {{ build.author }}<br/> Message: {{ build.message }}',
+        template: 'Status: **{{ .Build.Status }}**<br/> Build: [{{ .Repo.Owner }}/{{ .Repo.Name }}]({{ .Build.Link }}){{ if .Build.Branch }} ({{ .Build.Branch }}){{ end }} by {{ .Commit.Author }}<br/> Message: {{ .Commit.Message.Title }}',
         username: { from_secret: 'matrix_username' },
         password: { from_secret: 'matrix_password' },
       },
@@ -143,14 +148,14 @@ local PipelineNotification = {
   ],
   trigger: {
     status: ['success', 'failure'],
-    ref: ['refs/heads/master', 'refs/tags/**'],
+    ref: ['refs/heads/main', 'refs/tags/**'],
   },
 };
 
 [
   PipelineLinting,
   PipelineDeployment(scenario='centos7'),
-  PipelineDeployment(scenario='centos8'),
+  PipelineDeployment(scenario='rocky8'),
   PipelineDocumentation,
   PipelineNotification,
 ]

.drone.yml

@@ -7,14 +7,30 @@ platform:
   arch: amd64
 
 steps:
-- name: ansible-later
+  - name: ansible-later
-  image: xoxys/ansible-later
+    image: thegeeklab/ansible-later
     commands:
       - ansible-later
 
+  - name: python-format
+    image: python:3.11
+    commands:
+      - pip install -qq yapf
+      - "[ -z \"$(find . -type f -name *.py)\" ] || (yapf -rd ./)"
+    environment:
+      PY_COLORS: 1
+
+  - name: python-flake8
+    image: python:3.11
+    commands:
+      - pip install -qq flake8
+      - flake8
+    environment:
+      PY_COLORS: 1
+
 trigger:
   ref:
-  - refs/heads/master
+    - refs/heads/main
     - refs/tags/**
     - refs/pull/**
 
@@ -34,23 +50,55 @@ workspace:
   path: ${DRONE_REPO_NAME}
 
 steps:
-- name: ansible-molecule
+  - name: ansible-molecule
-  image: xoxys/molecule:3
+    image: thegeeklab/molecule:4
     commands:
-  - molecule test -scentos7
+      - molecule test -s centos7
     environment:
-    DO_API_KEY:
+      HCLOUD_TOKEN:
-      from_secret: do_api_key
+        from_secret: hcloud_token
-    MOLECULE_CUSTOM_FILTERS_REPO: https://gitea.rknet.org/ansible/custom_filters
-    MOLECULE_CUSTOM_MODULES_REPO: https://gitea.rknet.org/ansible/custom_modules
 
 trigger:
   ref:
-  - refs/heads/master
+    - refs/heads/main
     - refs/tags/**
+    - refs/pull/**
 
 depends_on:
-- linting
+  - linting
+
+---
+kind: pipeline
+name: testing-rocky8
+
+platform:
+  os: linux
+  arch: amd64
+
+concurrency:
+  limit: 1
+
+workspace:
+  base: /drone/src
+  path: ${DRONE_REPO_NAME}
+
+steps:
+  - name: ansible-molecule
+    image: thegeeklab/molecule:4
+    commands:
+      - molecule test -s rocky8
+    environment:
+      HCLOUD_TOKEN:
+        from_secret: hcloud_token
+
+trigger:
+  ref:
+    - refs/heads/main
+    - refs/tags/**
+    - refs/pull/**
+
+depends_on:
+  - linting
 
 ---
 kind: pipeline
@@ -61,8 +109,8 @@ platform:
   arch: amd64
 
 steps:
-- name: generate
+  - name: generate
-  image: xoxys/ansible-doctor
+    image: thegeeklab/ansible-doctor
     environment:
       ANSIBLE_DOCTOR_EXCLUDE_FILES: molecule/
       ANSIBLE_DOCTOR_FORCE_OVERWRITE: true
@@ -71,7 +119,7 @@ steps:
       ANSIBLE_DOCTOR_ROLE_NAME: ${DRONE_REPO_NAME#*.}
       ANSIBLE_DOCTOR_TEMPLATE: hugo-book
 
-- name: publish
+  - name: publish
     image: plugins/gh-pages
     settings:
       netrc_machine: gitea.rknet.org
@@ -84,29 +132,17 @@ steps:
         from_secret: gitea_username
     when:
       ref:
-    - refs/heads/master
+        - refs/heads/main
-
-- name: trigger
-  image: plugins/downstream
-  settings:
-    fork: true
-    repositories:
-    - ansible/ansible-galaxy
-    server: https://drone.rknet.org
-    token:
-      from_secret: drone_token
-  when:
-    ref:
-    - refs/heads/master
 
 trigger:
   ref:
-  - refs/heads/master
+    - refs/heads/main
     - refs/tags/**
     - refs/pull/**
 
 depends_on:
-- testing-centos7
+  - testing-centos7
+  - testing-rocky8
 
 ---
 kind: pipeline
@@ -120,8 +156,8 @@ clone:
   disable: true
 
 steps:
-- name: matrix
+  - name: matrix
-  image: plugins/matrix
+    image: thegeeklab/drone-matrix
     settings:
       homeserver:
         from_secret: matrix_homeserver
@@ -129,23 +165,23 @@ steps:
         from_secret: matrix_password
       roomid:
         from_secret: matrix_roomid
-    template: "Status: **{{ build.status }}**<br/> Build: [{{ repo.Owner }}/{{ repo.Name }}]({{ build.link }}) ({{ build.branch }}) by {{ build.author }}<br/> Message: {{ build.message }}"
+      template: "Status: **{{ .Build.Status }}**<br/> Build: [{{ .Repo.Owner }}/{{ .Repo.Name }}]({{ .Build.Link }}){{ if .Build.Branch }} ({{ .Build.Branch }}){{ end }} by {{ .Commit.Author }}<br/> Message: {{ .Commit.Message.Title }}"
       username:
         from_secret: matrix_username
 
 trigger:
   ref:
-  - refs/heads/master
+    - refs/heads/main
     - refs/tags/**
   status:
     - success
     - failure
 
 depends_on:
-- documentation
+  - documentation
 
 ---
 kind: signature
-hmac: c3eb21e904a1ceed464b6d86c674b7c0b6569ba1787b20cc716269ba7baf01b8
+hmac: 6048ef83a64bc78c4f6c2cb20f3a5fabe27eef22e1195f8288c8376372dd9c0a
 
 ...

.flake8

@@ -1,5 +0,0 @@
-[flake8]
-ignore = D101, D102, D103, D105, D107, E402, W503
-max-line-length = 99
-inline-quotes = double
-exclude = .git,.tox,__pycache__,build,dist,tests,*.pyc,*.egg-info,.cache,.eggs,env*

.gitignore

@@ -9,3 +9,5 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+# ---> Docs
+/_docs

.later.yml

@@ -3,9 +3,10 @@ ansible:
   custom_modules:
     - iptables_raw
     - openssl_pkcs12
-    - proxmox_kvm2
+    - proxmox_kvm
     - ucr
-    - yum_versionlock
+    - corenetworks_dns
+    - corenetworks_token
 
 rules:
   exclude_files:

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Robert Kaussow <mail@geeklabor.de>
+Copyright (c) 2022 Robert Kaussow <mail@thegeeklab.de>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -10,7 +10,3 @@ You can find the full documentation at [https://galaxy.geekdocs.de](https://gala
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-## Maintainers and Contributors
-
-[Robert Kaussow](https://gitea.rknet.org/xoxys)

defaults/main.yml

@@ -1,19 +1,31 @@
 ---
+# @var certbot_version:description: Set a fix version of the certbot package to install.
+# @var certbot_version: $ "_unset_"
+
+# @var certbot_packages_extra:description: Extra packages to install with pip (e.g. DNS plugins).
 certbot_packages_extra: []
 
+certbot_virtualenv_command: /usr/bin/python3 -m venv
+certbot_virtualenv: /opt/python3/certbot
+
 certbot_user: root
-certbot_initial_run_enabled: False
 
 certbot_work_dir: /var/lib/letsencrypt
 certbot_config_dir: /etc/letsencrypt
 certbot_log_dir: /var/log/letsencrypt
 
+certbot_max_log_backups: 30
+
 certbot_preferred_challenges: dns
 certbot_server: https://acme-v02.api.letsencrypt.org/directory
 certbot_email: mail@example.com
 certbot_rsa_key_size: 4096
-certbot_domains:
+certbot_domain_groups:
+  - name: example
+    domains:
+      - "*.example.com"
       - example.com
+    init: False
 
 # @var certbot_credentials:description: >
 # Specify key value parairs for your credentials (e.g. plugin credentials).
@@ -22,18 +34,18 @@ certbot_domains:
 # @end
 certbot_credentials: []
 
+# @var certbot_bin:description: Location of the certbot binary. Default is to `~/.local/.bin/certbot`.
 certbot_command_arguments:
   - "certonly"
-  - "-n -d {{ certbot_domains | join(',') }}"
 
-# @var certbot_scheduler_enabled:description: Enable scheduling via cron.
+# @var certbot_cron_enabled:description: Enable scheduling via cron.
-certbot_scheduler_enabled: True
+certbot_cron_enabled: True
 
-certbot_cron_minute: 30
+# @var certbot_cron_file:description: >
-certbot_cron_hour: 3
+# Use a file under /etc/cron.d but this will only work if `certbot_user` has write permissions for this location.
-
-# @var certbot_cron_file:description: Use a file under /etc/cron.d but this will only work if `certbot_user`
-# has write permissions for this location.
 # @end
 # @var certbot_cron_file: $ "_unset_"
 # @var certbot_cron_file:example: certbot-letsencrypt
+
+certbot_cron_minute: "30"
+certbot_cron_hour: "3"

meta/main.yml

@@ -1,18 +1,20 @@
-# Standards: 0.1
+# Standards: 0.2
 ---
 galaxy_info:
-# @meta author:value: [Robert Kaussow](https://gitea.rknet.org/xoxys)
+  # @meta author:value: [Robert Kaussow](https://gitea.rknet.org/xoxys)
-  author: Robert Kaussow <mail@geeklabor.de>
+  author: Robert Kaussow <mail@thegeeklab.de>
-# @meta description: >
+  namespace: xoxys
-# [![Source Code](https://img.shields.io/badge/gitea-source%20code-blue?logo=gitea&logoColor=white)](https://gitea.rknet.org/ansible/xoxys.certbot)
+  role_name: certbot
-# [![Build Status](https://img.shields.io/drone/build/ansible/xoxys.certbot?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.certbot)
+  # @meta description: >
-# [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+  # [![Source Code](https://img.shields.io/badge/gitea-source%20code-blue?logo=gitea&logoColor=white)](https://gitea.rknet.org/ansible/xoxys.certbot)
-#
+  # [![Build Status](https://img.shields.io/drone/build/ansible/xoxys.certbot?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.certbot)
-# Setup [certbot](https://certbot.eff.org/) Let's Encrypt client.
+  # [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitea.rknet.org/ansible/xoxys.certbot/src/branch/main/LICENSE)
-# @end
+  #
+  # Setup [certbot](https://certbot.eff.org/) Let's Encrypt client.
+  # @end
   description: Setup certbot Let's Encrypt client
   license: MIT
-  min_ansible_version: 2.8
+  min_ansible_version: 2.10
   platforms:
     - name: EL
       versions:
@@ -22,3 +24,5 @@ galaxy_info:
     - letsencrypt
     - certbot
 dependencies: []
+collections:
+  - community.general

molecule/centos7/converge.yml

@@ -2,8 +2,9 @@
 - name: Converge
   hosts: all
   vars:
-    certbot_packages_extra:
+    python3_packages_extra:
-      - epel-release
+      - centos-release-scl
 
   roles:
+    - role: xoxys.python3
     - role: xoxys.certbot

molecule/centos7/create.yml

@@ -5,36 +5,39 @@
   gather_facts: false
   no_log: "{{ molecule_no_log }}"
   vars:
-    ssh_user: root
     ssh_port: 22
-
+    ssh_user: root
-    keypair_name: molecule_key
+    ssh_path: "{{ lookup('env', 'MOLECULE_EPHEMERAL_DIRECTORY') }}/ssh_key"
-    keypair_path: "{{ lookup('env', 'MOLECULE_EPHEMERAL_DIRECTORY') }}/ssh_key"
   tasks:
-    - name: Create local keypair
+    - name: Create SSH key
       user:
         name: "{{ lookup('env', 'USER') }}"
         generate_ssh_key: true
-        ssh_key_file: "{{ keypair_path }}"
+        ssh_key_file: "{{ ssh_path }}"
-      register: local_keypair
+        force: true
+      register: generated_ssh_key
 
-    - name: Create remote keypair
+    - name: Register the SSH key name
-      digital_ocean_sshkey:
+      set_fact:
-        name: "{{ keypair_name }}"
+        ssh_key_name: "molecule-generated-{{ 12345 | random | to_uuid }}"
-        ssh_pub_key: "{{ local_keypair.ssh_public_key }}"
+
+    - name: Register SSH key for test instance(s)
+      hcloud_ssh_key:
+        name: "{{ ssh_key_name }}"
+        public_key: "{{ generated_ssh_key.ssh_public_key }}"
         state: present
-      register: remote_keypair
 
     - name: Create molecule instance(s)
-      digital_ocean_droplet:
+      hcloud_server:
         name: "{{ item.name }}"
-        unique_name: true
+        server_type: "{{ item.server_type }}"
-        region: "{{ item.region_id }}"
+        ssh_keys:
-        image: "{{ item.image_id }}"
+          - "{{ ssh_key_name }}"
-        size: "{{ item.size_id }}"
+        image: "{{ item.image }}"
-        ssh_keys: "{{ remote_keypair.data.ssh_key.id }}"
+        location: "{{ item.location | default(omit) }}"
-        wait: true
+        datacenter: "{{ item.datacenter | default(omit) }}"
-        wait_timeout: 300
+        user_data: "{{ item.user_data | default(omit) }}"
+        api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
         state: present
       register: server
       loop: "{{ molecule_yml.platforms }}"
@@ -44,25 +47,49 @@
     - name: Wait for instance(s) creation to complete
       async_status:
         jid: "{{ item.ansible_job_id }}"
-      register: digitalocean_jobs
+      register: hetzner_jobs
-      until: digitalocean_jobs.finished
+      until: hetzner_jobs.finished
       retries: 300
       loop: "{{ server.results }}"
 
+    - name: Create volume(s)
+      hcloud_volume:
+        name: "{{ item.name }}"
+        server: "{{ item.name }}"
+        location: "{{ item.location | default(omit) }}"
+        size: "{{ item.volume_size | default(10) }}"
+        api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
+        state: "present"
+      loop: "{{ molecule_yml.platforms }}"
+      when: item.volume | default(False) | bool
+      register: volumes
+      async: 7200
+      poll: 0
+
+    - name: Wait for volume(s) creation to complete
+      async_status:
+        jid: "{{ item.ansible_job_id }}"
+      register: hetzner_volumes
+      until: hetzner_volumes.finished
+      retries: 300
+      when: volumes.changed
+      loop: "{{ volumes.results }}"
+
     # Mandatory configuration for Molecule to function.
 
     - name: Populate instance config dict
       set_fact:
-        instance_conf_dict: {
+        instance_conf_dict:
-          'instance': "{{ item.data.droplet.name }}",
+          {
-          'address': "{{ item.data.ip_address }}",
+            "instance": "{{ item.hcloud_server.name }}",
-          'user': "{{ ssh_user }}",
+            "ssh_key_name": "{{ ssh_key_name }}",
-          'port': "{{ ssh_port }}",
+            "address": "{{ item.hcloud_server.ipv4_address }}",
-          'identity_file': "{{ keypair_path }}",
+            "user": "{{ ssh_user }}",
-          'droplet_id': "{{ item.data.droplet.id }}",
+            "port": "{{ ssh_port }}",
-          'ssh_key_id': "{{ remote_keypair.data.ssh_key.id }}",
+            "identity_file": "{{ ssh_path }}",
+            "volume": "{{ item.item.item.volume | default(False) | bool }}",
           }
-      loop: "{{ digitalocean_jobs.results }}"
+      loop: "{{ hetzner_jobs.results }}"
       register: instance_config_dict
       when: server.changed | bool
 
@@ -73,7 +100,10 @@
 
     - name: Dump instance config
       copy:
-        content: "{{ instance_conf | to_json | from_json | molecule_to_yaml | molecule_header }}"
+        content: |
+          # Molecule managed
+
+          {{ instance_conf | to_nice_yaml(indent=2) }}
         dest: "{{ molecule_instance_config }}"
       when: server.changed | bool
 
@@ -83,5 +113,8 @@
         host: "{{ item.address }}"
         search_regex: SSH
         delay: 10
-        timeout: 320
+      loop: "{{ lookup('file', molecule_instance_config) | from_yaml }}"
-      loop: "{{ lookup('file', molecule_instance_config) | molecule_from_yaml }}"
+
+    - name: Wait for VM to settle down
+      pause:
+        seconds: 30

molecule/centos7/destroy.yml

@@ -5,41 +5,62 @@
   gather_facts: false
   no_log: "{{ molecule_no_log }}"
   tasks:
-    - block:
+    - name: Check existing instance config file
-        - name: Populate instance config
+      stat:
+        path: "{{ molecule_instance_config }}"
+      register: cfg
+
+    - name: Populate the instance config
       set_fact:
-            instance_conf: "{{ lookup('file', molecule_instance_config) | molecule_from_yaml }}"
+        instance_conf: "{{ (lookup('file', molecule_instance_config) | from_yaml) if cfg.stat.exists else [] }}"
-            skip_instances: false
-      rescue:
-        - name: Populate instance config when file missing
-          set_fact:
-            instance_conf: {}
-            skip_instances: true
 
     - name: Destroy molecule instance(s)
-      digital_ocean_droplet:
+      hcloud_server:
         name: "{{ item.instance }}"
-        id: "{{ item.droplet_id }}"
+        api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
         state: absent
       register: server
-      loop: "{{ instance_conf | flatten(levels=1) }}"
+      loop: "{{ instance_conf }}"
-      when: not skip_instances
       async: 7200
       poll: 0
 
     - name: Wait for instance(s) deletion to complete
       async_status:
         jid: "{{ item.ansible_job_id }}"
-      register: digitalocean_jobs
+      register: hetzner_jobs
-      until: digitalocean_jobs.finished
+      until: hetzner_jobs.finished
       retries: 300
       loop: "{{ server.results }}"
 
-    - name: Delete remote keypair
+    - pause:
-      digital_ocean_sshkey:
+        seconds: 5
-        fingerprint: "{{ item.ssh_key_id }}"
+
+    - name: Destroy volume(s)
+      hcloud_volume:
+        name: "{{ item.instance }}"
+        server: "{{ item.instance }}"
+        api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
+        state: "absent"
+      register: volumes
+      loop: "{{ instance_conf }}"
+      when: item.volume | default(False) | bool
+      async: 7200
+      poll: 0
+
+    - name: Wait for volume(s) deletion to complete
+      async_status:
+        jid: "{{ item.ansible_job_id }}"
+      register: hetzner_volumes
+      until: hetzner_volumes.finished
+      retries: 300
+      when: volumes.changed
+      loop: "{{ volumes.results }}"
+
+    - name: Remove registered SSH key
+      hcloud_ssh_key:
+        name: "{{ instance_conf[0].ssh_key_name }}"
         state: absent
-      loop: "{{ instance_conf | flatten(levels=1) }}"
+      when: (instance_conf | default([])) | length > 0
 
     # Mandatory configuration for Molecule to function.
 
@@ -49,6 +70,9 @@
 
     - name: Dump instance config
       copy:
-        content: "{{ instance_conf | molecule_to_yaml | molecule_header }}"
+        content: |
+          # Molecule managed
+
+          {{ instance_conf | to_nice_yaml(indent=2) }}
         dest: "{{ molecule_instance_config }}"
       when: server.changed | bool

molecule/centos7/molecule.yml

@@ -1,19 +1,24 @@
 ---
 dependency:
   name: galaxy
+  options:
+    role-file: molecule/requirements.yml
+    requirements-file: molecule/requirements.yml
+  env:
+    ANSIBLE_GALAXY_DISPLAY_PROGRESS: "false"
 driver:
   name: delegated
 platforms:
   - name: centos7-certbot
-    region_id: fra1
+    image: centos-7
-    image_id: centos-7-x64
+    server_type: cx11
-    size_id: s-1vcpu-1gb
 lint: |
-  flake8
+  /usr/local/bin/flake8
 provisioner:
   name: ansible
   env:
     ANSIBLE_FILTER_PLUGINS: ${ANSIBLE_FILTER_PLUGINS:-./plugins/filter}
     ANSIBLE_LIBRARY: ${ANSIBLE_LIBRARY:-./library}
+  log: False
 verifier:
   name: testinfra

molecule/centos7/prepare.yml

@@ -3,7 +3,13 @@
   hosts: all
   gather_facts: false
   tasks:
-    - name: Install python for Ansible
+    - name: Bootstrap python for Ansible
-      raw: test -e /usr/bin/python || (apt -y update && apt install -y python-minimal)
+      raw: |
+        command -v python3 python || (
+        (test -e /usr/bin/dnf && sudo dnf install -y python3) ||
+        (test -e /usr/bin/apt && (apt -y update && apt install -y python-minimal)) ||
+        (test -e /usr/bin/yum && sudo yum -y -qq install python3) ||
+        echo "Warning: Python not boostrapped due to unknown platform."
+        )
       become: true
       changed_when: false

molecule/centos7/tests/test_default.py

@@ -2,13 +2,17 @@ import os
 
 import testinfra.utils.ansible_runner
 
-import warnings
-warnings.filterwarnings("ignore", category=DeprecationWarning)
-
 testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
-    os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all')
+    os.environ["MOLECULE_INVENTORY_FILE"]
+).get_hosts("all")
 
 
 def test_certbot_is_installed(host):
-    certbot = host.package("certbot")
+    pkg = host.pip_package.get_packages(pip_path="/opt/python3/certbot/bin/pip")
-    assert certbot.is_installed
+    assert "certbot" in pkg
+
+
+def test_certbot_run(host):
+    cmd = host.run("/usr/local/bin/certbot --help")
+    assert "Certbot can obtain and install HTTPS/TLS/SSL certificates." in cmd.stdout
+    assert cmd.succeeded

molecule/centos8/create.yml

@@ -1,87 +0,0 @@
----
-- name: Create
-  hosts: localhost
-  connection: local
-  gather_facts: false
-  no_log: "{{ molecule_no_log }}"
-  vars:
-    ssh_user: root
-    ssh_port: 22
-
-    keypair_name: molecule_key
-    keypair_path: "{{ lookup('env', 'MOLECULE_EPHEMERAL_DIRECTORY') }}/ssh_key"
-  tasks:
-    - name: Create local keypair
-      user:
-        name: "{{ lookup('env', 'USER') }}"
-        generate_ssh_key: true
-        ssh_key_file: "{{ keypair_path }}"
-      register: local_keypair
-
-    - name: Create remote keypair
-      digital_ocean_sshkey:
-        name: "{{ keypair_name }}"
-        ssh_pub_key: "{{ local_keypair.ssh_public_key }}"
-        state: present
-      register: remote_keypair
-
-    - name: Create molecule instance(s)
-      digital_ocean_droplet:
-        name: "{{ item.name }}"
-        unique_name: true
-        region: "{{ item.region_id }}"
-        image: "{{ item.image_id }}"
-        size: "{{ item.size_id }}"
-        ssh_keys: "{{ remote_keypair.data.ssh_key.id }}"
-        wait: true
-        wait_timeout: 300
-        state: present
-      register: server
-      loop: "{{ molecule_yml.platforms }}"
-      async: 7200
-      poll: 0
-
-    - name: Wait for instance(s) creation to complete
-      async_status:
-        jid: "{{ item.ansible_job_id }}"
-      register: digitalocean_jobs
-      until: digitalocean_jobs.finished
-      retries: 300
-      loop: "{{ server.results }}"
-
-    # Mandatory configuration for Molecule to function.
-
-    - name: Populate instance config dict
-      set_fact:
-        instance_conf_dict: {
-          'instance': "{{ item.data.droplet.name }}",
-          'address': "{{ item.data.ip_address }}",
-          'user': "{{ ssh_user }}",
-          'port': "{{ ssh_port }}",
-          'identity_file': "{{ keypair_path }}",
-          'droplet_id': "{{ item.data.droplet.id }}",
-          'ssh_key_id': "{{ remote_keypair.data.ssh_key.id }}",
-        }
-      loop: "{{ digitalocean_jobs.results }}"
-      register: instance_config_dict
-      when: server.changed | bool
-
-    - name: Convert instance config dict to a list
-      set_fact:
-        instance_conf: "{{ instance_config_dict.results | map(attribute='ansible_facts.instance_conf_dict') | list }}"
-      when: server.changed | bool
-
-    - name: Dump instance config
-      copy:
-        content: "{{ instance_conf | to_json | from_json | molecule_to_yaml | molecule_header }}"
-        dest: "{{ molecule_instance_config }}"
-      when: server.changed | bool
-
-    - name: Wait for SSH
-      wait_for:
-        port: "{{ ssh_port }}"
-        host: "{{ item.address }}"
-        search_regex: SSH
-        delay: 10
-        timeout: 320
-      loop: "{{ lookup('file', molecule_instance_config) | molecule_from_yaml }}"

molecule/centos8/default

@@ -1 +0,0 @@
-default

molecule/centos8/destroy.yml

@@ -1,54 +0,0 @@
----
-- name: Destroy
-  hosts: localhost
-  connection: local
-  gather_facts: false
-  no_log: "{{ molecule_no_log }}"
-  tasks:
-    - block:
-        - name: Populate instance config
-          set_fact:
-            instance_conf: "{{ lookup('file', molecule_instance_config) | molecule_from_yaml }}"
-            skip_instances: false
-      rescue:
-        - name: Populate instance config when file missing
-          set_fact:
-            instance_conf: {}
-            skip_instances: true
-
-    - name: Destroy molecule instance(s)
-      digital_ocean_droplet:
-        name: "{{ item.instance }}"
-        id: "{{ item.droplet_id }}"
-        state: absent
-      register: server
-      loop: "{{ instance_conf | flatten(levels=1) }}"
-      when: not skip_instances
-      async: 7200
-      poll: 0
-
-    - name: Wait for instance(s) deletion to complete
-      async_status:
-        jid: "{{ item.ansible_job_id }}"
-      register: digitalocean_jobs
-      until: digitalocean_jobs.finished
-      retries: 300
-      loop: "{{ server.results }}"
-
-    - name: Delete remote keypair
-      digital_ocean_sshkey:
-        fingerprint: "{{ item.ssh_key_id }}"
-        state: absent
-      loop: "{{ instance_conf | flatten(levels=1) }}"
-
-    # Mandatory configuration for Molecule to function.
-
-    - name: Populate instance config
-      set_fact:
-        instance_conf: {}
-
-    - name: Dump instance config
-      copy:
-        content: "{{ instance_conf | molecule_to_yaml | molecule_header }}"
-        dest: "{{ molecule_instance_config }}"
-      when: server.changed | bool

molecule/centos8/prepare.yml

@@ -1,9 +0,0 @@
----
-- name: Prepare
-  hosts: all
-  gather_facts: false
-  tasks:
-    - name: Install python for Ansible
-      raw: test -e /usr/bin/python || (dnf -y install python3 && alternatives --set python /usr/bin/python3)
-      become: true
-      changed_when: false

molecule/centos8/tests/test_default.py

@@ -1,14 +0,0 @@
-import os
-
-import testinfra.utils.ansible_runner
-
-import warnings
-warnings.filterwarnings("ignore", category=DeprecationWarning)
-
-testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
-    os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all')
-
-
-def test_certbot_is_installed(host):
-    certbot = host.package("certbot")
-    assert certbot.is_installed

molecule/default

@@ -1 +1 @@
-centos8
+rocky8

molecule/requirements.yml

@@ -0,0 +1,10 @@
+---
+collections:
+  - name: https://gitea.rknet.org/ansible/xoxys.general/releases/download/v2.1.1/xoxys-general-2.1.1.tar.gz
+  - name: community.general
+
+roles:
+  - src: https://gitea.rknet.org/ansible/xoxys.python3.git
+    name: xoxys.python3
+    scm: git
+    version: main

molecule/rocky8/converge.yml

@@ -1,9 +1,6 @@
 ---
 - name: Converge
   hosts: all
-  vars:
-    certbot_packages_extra:
-      - epel-release
-
   roles:
+    - role: xoxys.python3
     - role: xoxys.certbot

molecule/rocky8/create.yml

@@ -0,0 +1,120 @@
+---
+- name: Create
+  hosts: localhost
+  connection: local
+  gather_facts: false
+  no_log: "{{ molecule_no_log }}"
+  vars:
+    ssh_port: 22
+    ssh_user: root
+    ssh_path: "{{ lookup('env', 'MOLECULE_EPHEMERAL_DIRECTORY') }}/ssh_key"
+  tasks:
+    - name: Create SSH key
+      user:
+        name: "{{ lookup('env', 'USER') }}"
+        generate_ssh_key: true
+        ssh_key_file: "{{ ssh_path }}"
+        force: true
+      register: generated_ssh_key
+
+    - name: Register the SSH key name
+      set_fact:
+        ssh_key_name: "molecule-generated-{{ 12345 | random | to_uuid }}"
+
+    - name: Register SSH key for test instance(s)
+      hcloud_ssh_key:
+        name: "{{ ssh_key_name }}"
+        public_key: "{{ generated_ssh_key.ssh_public_key }}"
+        state: present
+
+    - name: Create molecule instance(s)
+      hcloud_server:
+        name: "{{ item.name }}"
+        server_type: "{{ item.server_type }}"
+        ssh_keys:
+          - "{{ ssh_key_name }}"
+        image: "{{ item.image }}"
+        location: "{{ item.location | default(omit) }}"
+        datacenter: "{{ item.datacenter | default(omit) }}"
+        user_data: "{{ item.user_data | default(omit) }}"
+        api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
+        state: present
+      register: server
+      loop: "{{ molecule_yml.platforms }}"
+      async: 7200
+      poll: 0
+
+    - name: Wait for instance(s) creation to complete
+      async_status:
+        jid: "{{ item.ansible_job_id }}"
+      register: hetzner_jobs
+      until: hetzner_jobs.finished
+      retries: 300
+      loop: "{{ server.results }}"
+
+    - name: Create volume(s)
+      hcloud_volume:
+        name: "{{ item.name }}"
+        server: "{{ item.name }}"
+        location: "{{ item.location | default(omit) }}"
+        size: "{{ item.volume_size | default(10) }}"
+        api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
+        state: "present"
+      loop: "{{ molecule_yml.platforms }}"
+      when: item.volume | default(False) | bool
+      register: volumes
+      async: 7200
+      poll: 0
+
+    - name: Wait for volume(s) creation to complete
+      async_status:
+        jid: "{{ item.ansible_job_id }}"
+      register: hetzner_volumes
+      until: hetzner_volumes.finished
+      retries: 300
+      when: volumes.changed
+      loop: "{{ volumes.results }}"
+
+    # Mandatory configuration for Molecule to function.
+
+    - name: Populate instance config dict
+      set_fact:
+        instance_conf_dict:
+          {
+            "instance": "{{ item.hcloud_server.name }}",
+            "ssh_key_name": "{{ ssh_key_name }}",
+            "address": "{{ item.hcloud_server.ipv4_address }}",
+            "user": "{{ ssh_user }}",
+            "port": "{{ ssh_port }}",
+            "identity_file": "{{ ssh_path }}",
+            "volume": "{{ item.item.item.volume | default(False) | bool }}",
+          }
+      loop: "{{ hetzner_jobs.results }}"
+      register: instance_config_dict
+      when: server.changed | bool
+
+    - name: Convert instance config dict to a list
+      set_fact:
+        instance_conf: "{{ instance_config_dict.results | map(attribute='ansible_facts.instance_conf_dict') | list }}"
+      when: server.changed | bool
+
+    - name: Dump instance config
+      copy:
+        content: |
+          # Molecule managed
+
+          {{ instance_conf | to_nice_yaml(indent=2) }}
+        dest: "{{ molecule_instance_config }}"
+      when: server.changed | bool
+
+    - name: Wait for SSH
+      wait_for:
+        port: "{{ ssh_port }}"
+        host: "{{ item.address }}"
+        search_regex: SSH
+        delay: 10
+      loop: "{{ lookup('file', molecule_instance_config) | from_yaml }}"
+
+    - name: Wait for VM to settle down
+      pause:
+        seconds: 30

molecule/rocky8/destroy.yml

@@ -0,0 +1,78 @@
+---
+- name: Destroy
+  hosts: localhost
+  connection: local
+  gather_facts: false
+  no_log: "{{ molecule_no_log }}"
+  tasks:
+    - name: Check existing instance config file
+      stat:
+        path: "{{ molecule_instance_config }}"
+      register: cfg
+
+    - name: Populate the instance config
+      set_fact:
+        instance_conf: "{{ (lookup('file', molecule_instance_config) | from_yaml) if cfg.stat.exists else [] }}"
+
+    - name: Destroy molecule instance(s)
+      hcloud_server:
+        name: "{{ item.instance }}"
+        api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
+        state: absent
+      register: server
+      loop: "{{ instance_conf }}"
+      async: 7200
+      poll: 0
+
+    - name: Wait for instance(s) deletion to complete
+      async_status:
+        jid: "{{ item.ansible_job_id }}"
+      register: hetzner_jobs
+      until: hetzner_jobs.finished
+      retries: 300
+      loop: "{{ server.results }}"
+
+    - pause:
+        seconds: 5
+
+    - name: Destroy volume(s)
+      hcloud_volume:
+        name: "{{ item.instance }}"
+        server: "{{ item.instance }}"
+        api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
+        state: "absent"
+      register: volumes
+      loop: "{{ instance_conf }}"
+      when: item.volume | default(False) | bool
+      async: 7200
+      poll: 0
+
+    - name: Wait for volume(s) deletion to complete
+      async_status:
+        jid: "{{ item.ansible_job_id }}"
+      register: hetzner_volumes
+      until: hetzner_volumes.finished
+      retries: 300
+      when: volumes.changed
+      loop: "{{ volumes.results }}"
+
+    - name: Remove registered SSH key
+      hcloud_ssh_key:
+        name: "{{ instance_conf[0].ssh_key_name }}"
+        state: absent
+      when: (instance_conf | default([])) | length > 0
+
+    # Mandatory configuration for Molecule to function.
+
+    - name: Populate instance config
+      set_fact:
+        instance_conf: {}
+
+    - name: Dump instance config
+      copy:
+        content: |
+          # Molecule managed
+
+          {{ instance_conf | to_nice_yaml(indent=2) }}
+        dest: "{{ molecule_instance_config }}"
+      when: server.changed | bool

molecule/rocky8/molecule.yml

@@ -1,19 +1,24 @@
 ---
 dependency:
   name: galaxy
+  options:
+    role-file: molecule/requirements.yml
+    requirements-file: molecule/requirements.yml
+  env:
+    ANSIBLE_GALAXY_DISPLAY_PROGRESS: "false"
 driver:
   name: delegated
 platforms:
-  - name: centos7-certbot
+  - name: rocky8-certbot
-    region_id: fra1
+    image: rocky-8
-    image_id: centos-8-x64
+    server_type: cx11
-    size_id: s-1vcpu-1gb
 lint: |
-  flake8
+  /usr/local/bin/flake8
 provisioner:
   name: ansible
   env:
     ANSIBLE_FILTER_PLUGINS: ${ANSIBLE_FILTER_PLUGINS:-./plugins/filter}
     ANSIBLE_LIBRARY: ${ANSIBLE_LIBRARY:-./library}
+  log: False
 verifier:
   name: testinfra

molecule/rocky8/prepare.yml

@@ -0,0 +1,15 @@
+---
+- name: Prepare
+  hosts: all
+  gather_facts: false
+  tasks:
+    - name: Bootstrap python for Ansible
+      raw: |
+        command -v python3 python || (
+        (test -e /usr/bin/dnf && sudo dnf install -y python3) ||
+        (test -e /usr/bin/apt && (apt -y update && apt install -y python-minimal)) ||
+        (test -e /usr/bin/yum && sudo yum -y -qq install python3) ||
+        echo "Warning: Python not boostrapped due to unknown platform."
+        )
+      become: true
+      changed_when: false

molecule/rocky8/tests/test_default.py

@@ -0,0 +1,18 @@
+import os
+
+import testinfra.utils.ansible_runner
+
+testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
+    os.environ["MOLECULE_INVENTORY_FILE"]
+).get_hosts("all")
+
+
+def test_certbot_is_installed(host):
+    pkg = host.pip_package.get_packages(pip_path="/opt/python3/certbot/bin/pip")
+    assert "certbot" in pkg
+
+
+def test_certbot_run(host):
+    cmd = host.run("/usr/local/bin/certbot --help")
+    assert "Certbot can obtain and install HTTPS/TLS/SSL certificates." in cmd.stdout
+    assert cmd.succeeded

setup.cfg

@@ -0,0 +1,12 @@
+[flake8]
+ignore = D100, D101, D102, D103, D105, D107, E402, W503
+max-line-length = 99
+inline-quotes = double
+exclude = .git,.tox,__pycache__,build,dist,tests,*.pyc,*.egg-info,.cache,.eggs,env*
+
+[yapf]
+based_on_style = google
+column_limit = 99
+dedent_closing_brackets = true
+coalesce_brackets = true
+split_before_logical_operator = true

tasks/install.yml

@@ -1,17 +1,59 @@
 ---
-- block:
+- name: Create certbot user '{{ certbot_user }}'
-    - name: Install certbot
-      package:
-        name: "{{ item }}"
-        state: present
-      loop: "{{ certbot_packages_extra + __certbot_packages }}"
-
-    - name: Create certbot user '{{ certbot_user }}'
   user:
     name: "{{ certbot_user }}"
   become: True
   become_user: root
   when: not certbot_user == 'root'
+
+- block:
+    - name: Upgrade python dependencies
+      pip:
+        name: "{{ item }}"
+        virtualenv: "{{ certbot_virtualenv }}"
+        virtualenv_command: "{{ certbot_virtualenv_command }}"
+        extra_args: --upgrade
+      loop:
+        - pip
+        - setuptools
+
+    - name: Install dependencies
+      pip:
+        name: "{{ item }}"
+        virtualenv: "{{ certbot_virtualenv }}"
+        virtualenv_command: "{{ certbot_virtualenv_command }}"
+      environment:
+        TMPDIR: /opt/python3/tmp
+      loop: "{{ certbot_packages_extra }}"
+
+    - name: Install certbot
+      pip:
+        name: "{{ item }}"
+        virtualenv: "{{ certbot_virtualenv }}"
+        virtualenv_command: "{{ certbot_virtualenv_command }}"
+      loop: "{{ __certbot_packages }}"
+
+    - name: Adjust file permissions
+      file:
+        name: "{{ certbot_virtualenv }}"
+        recurse: True
+        mode: u+rwX,go+rX,go-w
+        state: directory
+
+    - name: Make certbot binaries executable
+      file:
+        name: "{{ certbot_virtualenv }}/bin/{{ item }}"
+        mode: 0755
+      loop: "{{ __certbot_binaries }}"
+
+    - name: Deploy certbot bin wrappers
+      template:
+        src: usr/local/bin/certbot-wrapper.j2
+        dest: "/usr/local/bin/{{ item }}"
+        owner: root
+        group: root
+        mode: 0755
+      loop: "{{ __certbot_binaries }}"
   become: True
   become_user: root
 
@@ -21,7 +63,7 @@
         path: "{{ item.name }}"
         state: directory
         mode: "{{ item.mode }}"
-      loop: "{{ certbot_environment }}"
+      loop: "{{ __certbot_environment }}"
       loop_control:
         label: "{{ item.name }}"
 
@@ -29,27 +71,33 @@
       template:
         src: config/cli.ini.j2
         dest: "{{ certbot_config_dir }}/cli.ini"
+        mode: 0640
 
     - name: Deploy credentials file
       template:
         src: config/credentials.ini.j2
         dest: "{{ certbot_config_dir }}/credentials.ini"
-      when: certbot_credentials
+        mode: 0600
-      mode: 600
+      when: certbot_credentials | default([]) | length > 0
 
     - name: Schedule certbot run
       cron:
-        name: Certbot automatic renewal
+        name: "Certbot automatic renewal: {{ item.name }}"
         minute: "{{ certbot_cron_minute }}"
         hour: "{{ certbot_cron_hour }}"
         user: "{{ certbot_cron_user | default(certbot_user) }}"
         job: >
-          certbot
+          {{ certbot_bin | default(__certbot_bin) }}
           --config-dir {{ certbot_config_dir }}
           --work-dir {{ certbot_work_dir }}
-          --logs-dir {{ certbot_log_dir }}
+          --logs-dir {{ certbot_log_dir }}/{{ item.name }}
+          --max-log-backups {{ certbot_max_log_backups }}
           {{ certbot_command_arguments | join(' ') }}
+          -n -d {{ item.domains | join(',') }}
         cron_file: "{{ certbot_cron_file | default(omit) }}"
-      when: certbot_scheduler_enabled
+      loop: "{{ certbot_domain_groups }}"
+      loop_control:
+        label: "{{ item.name }}"
+      when: certbot_cron_enabled
   become: True
   become_user: "{{ certbot_user }}"

tasks/setup.yml

@@ -1,17 +1,20 @@
 ---
-- name: Initialise certbot
+- name: Initial run of certbot
-  block:
-    - name: Initial run of certbot
   command: >
-        certbot
+    {{ certbot_bin | default(__certbot_bin) }}
     --config-dir {{ certbot_config_dir }}
     --work-dir {{ certbot_work_dir }}
-        --logs-dir {{ certbot_log_dir }}
+    --logs-dir {{ certbot_log_dir }}/{{ item.name }}
+    --max-log-backups {{ certbot_max_log_backups }}
     --agree-tos
     {{ certbot_command_arguments | join(' ') }}
-      register: certbot_init
+    -n -d {{ item.domains | join(',') }}
-      changed_when: certbot_init.rc == 130
+  register: __certbot_init
+  changed_when: __certbot_init.rc == 130
   ignore_errors: True
+  loop: "{{ certbot_domain_groups }}"
+  loop_control:
+    label: "{{ item.name }}"
+  when: item.init | default(False) | bool
   become: True
   become_user: "{{ certbot_user }}"
-  when: certbot_initial_run_enabled

templates/config/credentials.ini.j2

@@ -0,0 +1,3 @@
+{% for line in certbot_credentials %}
+{{ line }}
+{% endfor %}

templates/usr/local/bin/certbot-wrapper.j2

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+set -eo pipefail
+
+exec {{ certbot_virtualenv }}/bin/{{ item }} "$@"

vars/main.yml

@@ -1,8 +1,16 @@
 ---
 __certbot_packages:
-  - certbot
+  - "certbot{{ '==' + certbot_version if certbot_version is defined else '' }}"
 
 __certbot_environment:
-  - { name: "{{ certbot_work_dir }}", mode: "0755" }
+  - name: "{{ certbot_work_dir }}"
-  - { name: "{{ certbot_config_dir }}", mode: "0755" }
+    mode: "0755"
-  - { name: "{{ certbot_log_dir }}", mode: "0700" }
+  - name: "{{ certbot_config_dir }}"
+    mode: "0755"
+  - name: "{{ certbot_log_dir }}"
+    mode: "0700"
+
+__certbot_binaries:
+  - certbot
+
+__certbot_bin: "/usr/local/bin/certbot"