Add action_group to enable module default groups (#175)

* Add action_group to enable module default groups

This is to support a feature provided by ansible-core >= 2.12 that enables providing default values for a group of modules instead of each module seperately. See https://docs.ansible.com/ansible/latest/user_guide/playbooks_module_defaults.html#module-defaults-groups for more details.

* Add integration test for module group defaults

* Document usage of module defaults groups

* Run defaults_test only on ansible-core >= 2.12

Co-authored-by: Jens Rudolf <jens.rudolf@aida.de>

Author: jensrudolf

.github/workflows/main.yml

@@ -154,7 +154,11 @@ jobs:
         run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check
 
       - name: Run integration tests
-        run: ansible-test integration -v --color --retry-on-error --continue-on-error --diff --python ${{ matrix.python }} --requirements --coverage
+        run: ansible-test integration --exclude defaults_test -v --color --retry-on-error --continue-on-error --diff --python ${{ matrix.python }} --requirements --coverage
+
+      - name: Run integration tests for defaults module on ansible 2.12 and above
+        run: ansible-test integration defaults_test -v --color --retry-on-error --continue-on-error --diff --python ${{ matrix.python }} --requirements --coverage
+        if: (matrix.ansible != 'stable-2.9') && (matrix.ansible != 'stable-2.10') && (matrix.ansible != 'stable-2.11')
 
       # ansible-test support producing code coverage date
       - name: Generate coverage report

README.md

@@ -133,6 +133,31 @@ Then you can use the dynamic inventory like this:
 ansible-playbook -i inventory.icinga_director_inventory.yaml path/to/your/playbook.yml
 ```
 
+## Example using module defaults groups
+
+With ansible-core >= 2.12 it is possible to specify defaults paramters for all modules in this collection using [Module defaults groups](https://docs.ansible.com/ansible/latest/user_guide/playbooks_module_defaults.html#module-defaults-groups). Use it like this:
+
+```
+- hosts: localhost
+
+  module_defaults:
+    group/t_systems_mms.icinga_director.icinga:
+      url: "https://example.com"
+      url_username: foo
+      url_password: bar
+
+  tasks:
+    - name: Create host
+      t_systems_mms.icinga_director.icinga_host:
+        object_name: myhost
+        address: 172.0.0.1
+
+    - name: Create command
+      t_systems_mms.icinga_director.icinga_command:
+        object_name: my-command
+        command: my-command.sh
+```
+
 ## Contributing
 
 See [Contributing](CONTRIBUTING.md).

meta/runtime.yml

@@ -1,2 +1,43 @@
 ---
 requires_ansible: '>=2.9.10'
+
+action_groups:
+  icinga:
+    - icinga_command
+    - icinga_command_info
+    - icinga_command_template
+    - icinga_command_template_info
+    - icinga_endpoint
+    - icinga_endpoint_info
+    - icinga_host
+    - icinga_host_info
+    - icinga_host_template
+    - icinga_host_template_info
+    - icinga_hostgroup
+    - icinga_hostgroup_info
+    - icinga_notification
+    - icinga_notification_info
+    - icinga_notification_template
+    - icinga_notification_template_info
+    - icinga_scheduled_downtime
+    - icinga_service
+    - icinga_service_apply
+    - icinga_service_apply_info
+    - icinga_service_info
+    - icinga_service_template
+    - icinga_service_template_info
+    - icinga_servicegroup
+    - icinga_servicegroup_info
+    - icinga_serviceset
+    - icinga_timeperiod
+    - icinga_timeperiod_info
+    - icinga_timeperiod_template
+    - icinga_timeperiod_template_info
+    - icinga_user
+    - icinga_user_group
+    - icinga_user_group_info
+    - icinga_user_info
+    - icinga_user_template
+    - icinga_user_template_info
+    - icinga_zone
+    - icinga_zone_info

tests/integration/targets/defaults_test/defaults_test.yml

@@ -0,0 +1,15 @@
+---
+- name: provide module defaults
+  hosts: localhost
+  module_defaults:
+    group/t_systems_mms.icinga_director.icinga:
+      url: "http://127.0.0.1/icingaweb2"
+      url_username: "icingaadmin"
+      url_password: "icinga"
+  tasks:
+    - name: Create command
+      t_systems_mms.icinga_director.icinga_command:
+        state: present
+        command: "true"
+        command_type: "PluginCheck"
+        object_name: defaults_test

tests/integration/targets/defaults_test/runme.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -eux
+
+ansible-playbook defaults_test.yml -v --diff