Merge pull request #45 from T-Systems-MMS/fix_absent

when deleting objects, only the object_name is required

Author: rndmh3ro

hacking/update_examples_and_tests.sh

@@ -4,22 +4,27 @@ for module in ../plugins/modules/*.py; do
     module_name="$(basename "${module}" .py)"
 
     # create examples
-    echo "---" | tee "../examples/${module_name}.yml"
+    echo "---" | tee "../examples/${module_name}.yml" 1> /dev/null
     # https://stackoverflow.com/a/22221307
-    sed -n '/EXAMPLES/,/"""/{/EXAMPLES/b;/"""/b;p}' "${module}" | tee -a "../examples/${module_name}.yml"
+    sed -n '/EXAMPLES/,/"""/{/EXAMPLES/b;/"""/b;p}' "${module}" | tee -a "../examples/${module_name}.yml" 1> /dev/null
 
     # create tests
-    echo "---" | tee "../tests/integration/targets/icinga/roles/icinga/tasks/${module_name}.yml"
-    sed -n '/EXAMPLES/,/"""/{/EXAMPLES/b;/"""/b;p}' "${module}" | tee -a "../tests/integration/targets/icinga/roles/icinga/tasks/${module_name}.yml"
+    echo "---" | tee "../tests/integration/targets/icinga/roles/icinga/tasks/${module_name}.yml" 1> /dev/null
+    sed -n '/EXAMPLES/,/"""/{/EXAMPLES/b;/"""/b;p}' "${module}" | tee -a "../tests/integration/targets/icinga/roles/icinga/tasks/${module_name}.yml" 1> /dev/null
 
-    # create create working tests deleting the hosts
-    echo "---" | tee "../tests/integration/targets/icinga/roles/icinga/tasks/absent_${module_name}.yml"
-    sed -n '/EXAMPLES/,/"""/{/EXAMPLES/b;/"""/b;p}' "${module}" | tee -a "../tests/integration/targets/icinga/roles/icinga/tasks/absent_${module_name}.yml"
+    # create working tests deleting the hosts
+    echo "---" | tee "../tests/integration/targets/icinga/roles/icinga/tasks/absent_${module_name}.yml" 1> /dev/null
+    sed -n '/EXAMPLES/,/"""/{/EXAMPLES/b;/"""/b;p}' "${module}" | tee -a "../tests/integration/targets/icinga/roles/icinga/tasks/absent_${module_name}.yml" 1> /dev/null
     sed -i 's/state: present/state: absent/g' "../tests/integration/targets/icinga/roles/icinga/tasks/absent_${module_name}.yml"
 
+    # delete imports and command from the tests, because they aren't necessary to delete an object
+    # regression test for https://github.com/T-Systems-MMS/ansible-collection-icinga-director/issues/44
+    sed -i '/imports:/,+1d' "../tests/integration/targets/icinga/roles/icinga/tasks/absent_${module_name}.yml"
+    sed -i '/^\s*command:/d' "../tests/integration/targets/icinga/roles/icinga/tasks/absent_${module_name}.yml"
+
     # create failing tests with wrong password
-    echo "---" | tee "../tests/integration/targets/icinga/roles/icinga/tasks/wrong_pass_${module_name}.yml"
-    sed -n '/EXAMPLES/,/"""/{/EXAMPLES/b;/"""/b;p}' "${module}" | tee -a "../tests/integration/targets/icinga/roles/icinga/tasks/wrong_pass_${module_name}.yml"
+    echo "---" | tee "../tests/integration/targets/icinga/roles/icinga/tasks/wrong_pass_${module_name}.yml" 1> /dev/null
+    sed -n '/EXAMPLES/,/"""/{/EXAMPLES/b;/"""/b;p}' "${module}" | tee -a "../tests/integration/targets/icinga/roles/icinga/tasks/wrong_pass_${module_name}.yml" 1> /dev/null
     # replace password variable with wrong password
     sed -i 's/{{ icinga_pass }}/iamwrong/g' "../tests/integration/targets/icinga/roles/icinga/tasks/wrong_pass_${module_name}.yml"
 
@@ -37,8 +42,8 @@ for module in ../plugins/modules/*.py; do
 
     # create failing tests with wrong host
     # add test
-    echo "---" | tee "../tests/integration/targets/icinga/roles/icinga/tasks/wrong_host_${module_name}.yml"
-    sed -n '/EXAMPLES/,/"""/{/EXAMPLES/b;/"""/b;p}' "${module}" | tee -a "../tests/integration/targets/icinga/roles/icinga/tasks/wrong_host_${module_name}.yml"
+    echo "---" | tee "../tests/integration/targets/icinga/roles/icinga/tasks/wrong_host_${module_name}.yml" 1> /dev/null
+    sed -n '/EXAMPLES/,/"""/{/EXAMPLES/b;/"""/b;p}' "${module}" | tee -a "../tests/integration/targets/icinga/roles/icinga/tasks/wrong_host_${module_name}.yml" 1> /dev/null
     # replace url varuable with nonexisting url
     sed -i 's/{{ icinga_url }}/http:\/\/nonexistant/g' "../tests/integration/targets/icinga/roles/icinga/tasks/wrong_host_${module_name}.yml"
 

plugins/modules/icinga_command.py

@@ -90,12 +90,11 @@
     type: str
   command:
     description:
-      - The command Icinga should run.
+      - The command Icinga should run. Required when state is C(present).
       - Absolute paths are accepted as provided, relative paths are prefixed with "PluginDir + ", similar Constant prefixes are allowed.
       - Spaces will lead to separation of command path and standalone arguments.
       - Please note that this means that we do not support spaces in plugin names and paths right now.
     type: str
-    required: True
   command_type:
     description:
       - Plugin Check commands are what you need when running checks agains your infrastructure.
@@ -232,7 +231,7 @@ def main():
             type="bool", required=False, default=False, choices=[True, False]
         ),
         vars=dict(type="dict", default={}),
-        command=dict(required=True),
+        command=dict(required=False),
         command_type=dict(
             default="PluginCheck",
             choices=["PluginCheck", "PluginNotification", "PluginEvent"],
@@ -242,9 +241,16 @@ def main():
         arguments=dict(type="dict", default=None),
     )
 
+    # When deleting objects, only the name is necessary, so we cannot use
+    # required=True in the argument_spec. Instead we define here what is
+    # necessary when state is present
+    required_if = [("state", "present", ["command"])]
+
     # Define the main module
     module = AnsibleModule(
-        argument_spec=argument_spec, supports_check_mode=True
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+        required_if=required_if,
     )
 
     # typ von arguments ist eigentlich dict, also ohne Angabe = {}

plugins/modules/icinga_host.py

@@ -132,8 +132,7 @@
     choices: [True, False]
   imports:
     description:
-      - Choose a Host Template
-    required: true
+      - Choose a Host Template. Required when state is C(present).
     type: list
     elements: str
   zone:
@@ -198,7 +197,7 @@ def main():
         object_name=dict(required=True),
         display_name=dict(required=False),
         groups=dict(type="list", elements="str", default=[], required=False),
-        imports=dict(type="list", elements="str", required=True),
+        imports=dict(type="list", elements="str", required=False),
         disabled=dict(type="bool", default=False, choices=[True, False]),
         address=dict(required=False),
         address6=dict(required=False),
@@ -207,9 +206,16 @@ def main():
         check_command=dict(required=False),
     )
 
+    # When deleting objects, only the name is necessary, so we cannot use
+    # required=True in the argument_spec. Instead we define here what is
+    # necessary when state is present
+    required_if = [("state", "present", ["imports"])]
+
     # Define the main module
     module = AnsibleModule(
-        argument_spec=argument_spec, supports_check_mode=True
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+        required_if=required_if,
     )
 
     data = {

plugins/modules/icinga_notification.py

@@ -124,9 +124,8 @@
     type: "str"
   imports:
     description:
-      - Importable templates, add as many as you want.
+      - Importable templates, add as many as you want. Required when state is C(present).
         Please note that order matters when importing properties from multiple templates - last one wins
-    required: true
     type: "list"
     elements: str
 """
@@ -173,17 +172,24 @@ def main():
         state=dict(default="present", choices=["absent", "present"]),
         url=dict(required=True),
         object_name=dict(required=True),
-        imports=dict(type="list", elements="str", required=True),
+        imports=dict(type="list", elements="str", required=False),
         apply_to=dict(required=True, choices=["service", "host"]),
         assign_filter=dict(required=False),
         notification_interval=dict(required=False),
         types=dict(type="list", elements="str", required=False),
         users=dict(type="list", elements="str", required=False),
     )
 
+    # When deleting objects, only the name is necessary, so we cannot use
+    # required=True in the argument_spec. Instead we define here what is
+    # necessary when state is present
+    required_if = [("state", "present", ["imports"])]
+
     # Define the main module
     module = AnsibleModule(
-        argument_spec=argument_spec, supports_check_mode=True
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+        required_if=required_if,
     )
 
     data = {

tests/integration/targets/icinga/roles/icinga/tasks/absent_icinga_command.yml

@@ -40,12 +40,9 @@
         set_if: $centreon_verbose$
       '--warning':
         value: $centreon_warning$
-    command: "/opt/centreon-plugins/centreon_plugins.pl"
     command_type: "PluginCheck"
     disabled: false
     object_name: centreon-plugins
-    imports:
-      - centreon-plugins-template
     timeout: "1m"
     vars:
       centreon_maxrepetitions: 20

tests/integration/targets/icinga/roles/icinga/tasks/absent_icinga_command_template.yml

@@ -40,7 +40,6 @@
         set_if: $centreon_verbose$
       '--warning':
         value: $centreon_warning$
-    command: "/opt/centreon-plugins/centreon_plugins.pl"
     command_type: "PluginCheck"
     object_name: centreon-plugins-template
     timeout: "2m"

tests/integration/targets/icinga/roles/icinga/tasks/absent_icinga_host.yml

@@ -12,8 +12,6 @@
     display_name: "foohost"
     groups:
       - "foohostgroup"
-    imports:
-      - "foohosttemplate"
     vars:
       dnscheck: "no"
     check_command: dummy

tests/integration/targets/icinga/roles/icinga/tasks/absent_icinga_host_template.yml

@@ -11,5 +11,3 @@
     check_command: dummy
     groups:
       - "foohostgroup"
-    imports:
-      - ''

tests/integration/targets/icinga/roles/icinga/tasks/absent_icinga_notification.yml

@@ -7,8 +7,6 @@
     url_password: "{{ icinga_pass }}"
     apply_to: host
     assign_filter: 'host.name="foohost"'
-    imports:
-      - foonotificationtemplate
     notification_interval: '0'
     object_name: E-Mail_host
     types:

tests/integration/targets/icinga/roles/icinga/tasks/absent_icinga_service_apply.yml

@@ -9,8 +9,6 @@
     assign_filter: 'host.vars.HostOS="Linux"'
     apply_for: "host.vars.enabled_notifications"
     display_name: "dummy process"
-    imports:
-      - fooservicetemplate
     groups:
       - fooservicegroup
     vars: