Merge pull request #360 from Checkmk/devel

Release 2.1.0

Author: robin-checkmk

SUPPORT.md

@@ -29,4 +29,5 @@ Collection Version | Checkmk Versions | Ansible Versions | Remarks
 0.22.0 | 2.1.0p27, 2.0.0p35, 2.2.0b6 | 2.12, 2.13, 2.14 | None
 0.23.0 | 2.1.0p28, 2.0.0p36, 2.2.0b8 | 2.13, 2.14, 2.15 | None
 1.0.0 | 2.1.0p28, 2.0.0p36, 2.2.0b8 | 2.13, 2.14, 2.15 | None
-2.0.0 | 2.0.0p36, 2.1.0p28, 2.2.0p1 | 2.13, 2.14, 2.15 | None
+2.0.0 | 2.0.0p36, 2.1.0p28, 2.2.0p1 | 2.13, 2.14, 2.15 | None
+2.1.0 | 2.0.0p36, 2.1.0p29, 2.2.0p3 | 2.13, 2.14, 2.15 | None

Vagrantfile

@@ -19,16 +19,16 @@ Vagrant.configure("2") do |config|
       end
       $script = <<-SCRIPT
       apt-get -y update --quiet
-      apt-get -y install python3.9 python3-pip ca-certificates curl gnupg lsb-release
-      wget "https://download.checkmk.com/checkmk/2.1.0p24/check-mk-raw-2.1.0p24_0.focal_amd64.deb" -O /tmp/checkmk-stable.deb
-      wget "https://download.checkmk.com/checkmk/2.2.0-$(date +%Y.%m.%d)/check-mk-raw-2.2.0-$(date +%Y.%m.%d)_0.focal_amd64.deb" -O /tmp/checkmk-beta.deb
-      apt-get install -y /tmp/checkmk-stable.deb
+      apt-get -y install python3-pip ca-certificates curl gnupg lsb-release
+      wget "https://download.checkmk.com/checkmk/2.1.0p29/check-mk-raw-2.1.0p29_0.focal_amd64.deb" -O /tmp/checkmk-oldstable.deb
+      wget "https://download.checkmk.com/checkmk/2.2.0p3/check-mk-raw-2.2.0p3_0.focal_amd64.deb" -O /tmp/checkmk-stable.deb
+      apt-get install -y /tmp/checkmk-oldstable.deb
       omd create --admin-password 'd7589df1-01db-4eda-9858-dbcff8d0c361' stable
-      apt-get install -y /tmp/checkmk-beta.deb
+      apt-get install -y /tmp/checkmk-stable.deb
       omd create --admin-password 'd7589df1-01db-4eda-9858-dbcff8d0c361' beta
       omd status -b stable || omd start stable
       omd status -b beta || omd start beta
-      python3.9 -m pip install -r /vagrant/requirements.txt
+      python3 -m pip install -r /vagrant/requirements.txt
       sudo -u vagrant ansible-galaxy collection install -f -r /vagrant/requirements.yml
       mkdir -p /home/vagrant/ansible_collections/checkmk/general
       mkdir -p /etc/apt/keyrings

changelogs/fragments/activation.yml

@@ -0,0 +1,5 @@
+bugfixes:
+  - Utils - With Checkmk 2.2.0p3 the activation introduces a breaking change, which we need to handle. As a workaround we added the 'If-Match' header to all API requests.
+
+known_issues:
+  - Utils - All API calls send the 'If-Match' header. This is a workaround and will be fixed in a future release.

changelogs/fragments/discovery.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - Discovery module - Properly handle redirects to wait for completion of background jobs.

changelogs/fragments/downtime.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - Downtime module - The module handles timezones properly now.

changelogs/fragments/modules.yml

@@ -0,0 +1,6 @@
+major_changes:
+  - Bakery module - Migrated to use module_utils.
+  - Discovery module - Migrated to use module_utils.
+  - contact_group module - The module was not compatible with Checkmk 2.2. This is fixed now.
+  - host_group module - The module was not compatible with Checkmk 2.2. This is fixed now.
+  - service_group module - The module was not compatible with Checkmk 2.2. This is fixed now.

changelogs/fragments/tests.yml

@@ -0,0 +1,57 @@
+###########################################################
+#                                                         #
+# Please use this template when writing changelogs.       #
+# Remove all comment lines, once you added your changes.  #
+# Refer to the archive, if you need examples.             #
+#                                                         #
+###########################################################
+
+bugfixes:
+  - Integration tests - A bug was fixed, where the integration tests did not use the correct Checkmk version.
+
+#
+## Line Format:
+#
+
+# When writing a changelog entry, use the following format:
+
+# - scope - description starting with a uppercase letter and ending with a period at the very end. Multiple sentences are allowed.
+
+# The scope is usually a module or plugin name or group of modules or plugins, for example, lookup plugins. While module names can (and should) be mentioned directly (foo_module), plugin names should always be followed by the type (foo inventory plugin).
+
+# For changes that are not really scoped (for example, which affect a whole collection), use the following format:
+
+# - Description starting with an uppercase letter and ending with a dot at the very end. Multiple sentences are allowed.
+
+
+#
+## Possible keys:
+#
+# release_summary
+#     Adds a single line release summary to the changelog.
+
+# breaking_changes
+#     Changes that break existing playbooks or roles. This includes any change to existing behavior that forces users to update tasks. Displayed in both the changelogs and the Porting Guides.
+
+# major_changes
+#     Major changes to Ansible itself. Generally does not include module or plugin changes. Displayed in both the changelogs and the Porting Guides.
+
+# minor_changes
+#     Minor changes to Ansible, modules, or plugins. This includes new features, new parameters added to modules, or behavior changes to existing parameters.
+
+# deprecated_features
+#     Features that have been deprecated and are scheduled for removal in a future release. Displayed in both the changelogs and the Porting Guides.
+
+# removed_features
+#     Features that were previously deprecated and are now removed. Displayed in both the changelogs and the Porting Guides.
+
+# security_fixes
+#     Fixes that address CVEs or resolve security concerns. Include links to CVE information.
+
+# bugfixes
+#     Fixes that resolve issues.
+
+# known_issues
+#     Known issues that are currently not fixed or will not be fixed.
+
+# Reference: https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to

galaxy.yml

@@ -10,7 +10,7 @@ name: general
 
 # The version of the collection. Must be compatible with semantic versioning
 
-version: 2.0.0
+version: 2.1.0
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md

plugins/module_utils/api.py

@@ -10,6 +10,8 @@
 
 __metaclass__ = type
 
+import json
+
 from ansible.module_utils.urls import fetch_url
 from ansible_collections.checkmk.general.plugins.module_utils.types import RESULT
 from ansible_collections.checkmk.general.plugins.module_utils.utils import (
@@ -33,6 +35,7 @@ def __init__(self, module):
             "Accept": "application/json",
             "Content-Type": "application/json",
             "Authorization": "Bearer %s %s" % (user, secret),
+            "If-Match": "*",
         }
         self.current = {}
         self.required = {}
@@ -62,6 +65,9 @@ def _fetch(self, code_mapping, endpoint="", data=None, method="GET"):
         # Better translate to json later and keep the original response here.
         content = response.read() if response else ""
         msg = "%s - %s" % (str(http_code), http_readable)
+        if failed:
+            details = info.get("body", info.get("msg", "N/A"))
+            msg += " Details: %s" % details
 
         result = RESULT(
             http_code=http_code,
@@ -75,3 +81,20 @@ def _fetch(self, code_mapping, endpoint="", data=None, method="GET"):
         if failed:
             self.module.fail_json(**result_as_dict(result))
         return result
+
+    def getversion(self):
+        data = {}
+
+        result = self._fetch(
+            code_mapping={
+                200: (True, False, "Discovery successful."),
+                406: (False, True, "Not Acceptable."),
+            },
+            endpoint="version",
+            data=data,
+            method="GET",
+        )
+
+        content = result.content
+        checkmkinfo = json.loads(content)
+        return (checkmkinfo.get("versions").get("checkmk")).split(".")

plugins/modules/bakery.py

@@ -35,8 +35,8 @@
 
     state:
         description: State - Baked, signed or baked and signed
+        required: true
         choices: ["baked", "signed", "baked_signed"]
-        default: "baked"
         type: str
 
 author:
@@ -87,8 +87,61 @@
     sample: 'Done.'
 """
 
+import time
+
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.urls import fetch_url
+from ansible_collections.checkmk.general.plugins.module_utils.api import CheckmkAPI
+from ansible_collections.checkmk.general.plugins.module_utils.utils import (
+    result_as_dict,
+)
+
+HTTP_CODES = {
+    # http_code: (changed, failed, "Message")
+    200: (True, False, "The operation was done successfully."),
+    204: (
+        True,
+        False,
+        "No Content: Operation done successfully. No further output.",
+    ),
+    400: (False, True, "Bad Request: Parameter or validation failure."),
+    403: (False, True, "Forbidden: Configuration via WATO is disabled."),
+    406: (
+        False,
+        True,
+        "Not Acceptable: The requests accept headers can not be satisfied.",
+    ),
+    415: (
+        False,
+        True,
+        "Unsupported Media Type: The submitted content-type is not supported.",
+    ),
+    500: (False, True, "General Server Error."),
+}
+
+
+class BakeryAPI(CheckmkAPI):
+    def post(self):
+        if self.params.get("state", "") != "baked":
+            data = {
+                "key_id": self.params.get("signature_key_id", ""),
+                "passphrase": self.params.get("signature_key_passphrase", ""),
+            }
+        else:
+            data = ""
+
+        if self.params.get("state", "") == "baked":
+            action = "bake"
+        if self.params.get("state", "") == "signed":
+            action = "sign"
+        if self.params.get("state", "") == "baked_signed":
+            action = "bake_and_sign"
+
+        return self._fetch(
+            code_mapping=HTTP_CODES,
+            endpoint="/domain-types/agent/actions/%s/invoke" % action,
+            data=data,
+            method="POST",
+        )
 
 
 def run_module():
@@ -102,109 +155,18 @@ def run_module():
         signature_key_passphrase=dict(type="str", required=False, no_log=True),
         state=dict(
             type="str",
-            default="baked",
             choices=["baked", "signed", "baked_signed"],
-            required=False,
+            required=True,
         ),
     )
-
-    result = dict(changed=False, failed=False, http_code="", msg="")
-
     module = AnsibleModule(argument_spec=module_args, supports_check_mode=False)
 
-    changed = False
-    failed = False
-    http_code = ""
-
-    http_code_mapping = {
-        # http_code: (changed, failed, "Message")
-        200: (True, False, "The operation was done successfully."),
-        204: (
-            True,
-            False,
-            "No Content: Operation done successfully. No further output.",
-        ),
-        400: (False, True, "Bad Request: Parameter or validation failure."),
-        403: (False, True, "Forbidden: Configuration via WATO is disabled."),
-        406: (
-            False,
-            True,
-            "Not Acceptable: The requests accept headers can not be satisfied.",
-        ),
-        415: (
-            False,
-            True,
-            "Unsupported Media Type: The submitted content-type is not supported.",
-        ),
-        500: (False, True, "General Server Error."),
-    }
-
-    # Declare headers including authentication to send to the Checkmk API
-    headers = {
-        "Accept": "application/json",
-        "Content-Type": "application/json",
-        "Authorization": "Bearer %s %s"
-        % (
-            module.params.get("automation_user", ""),
-            module.params.get("automation_secret", ""),
-        ),
-    }
-
-    base_url = "%s/%s/check_mk/api/1.0" % (
-        module.params.get("server_url", ""),
-        module.params.get("site", ""),
-    )
-
-    action = module.params.get("state", "")
-
-    if action == "baked":
-        api_endpoint = "/domain-types/agent/actions/bake/invoke"
-        params = ()
-
-    elif action == "signed":
-        api_endpoint = "/domain-types/agent/actions/sign/invoke"
-        params = {
-            "key_id": module.params.get("signature_key_id", ""),
-            "passphrase": module.params.get("signature_key_passphrase", ""),
-        }
-
-    elif action == "baked_signed":
-        api_endpoint = "/domain-types/agent/actions/bake_and_sign/invoke"
-        params = {
-            "key_id": module.params.get("signature_key_id", ""),
-            "passphrase": module.params.get("signature_key_passphrase", ""),
-        }
-
-    url = base_url + api_endpoint
-    response, info = fetch_url(
-        module, url, module.jsonify(params), headers=headers, method="POST", timeout=60
-    )
-
-    http_code = info["status"]
-
-    # Kudos to Lars G.!
-    if http_code in http_code_mapping.keys():
-        changed, failed, msg = http_code_mapping[http_code]
-    else:
-        changed, failed, msg = (
-            False,
-            True,
-            "Error calling API. HTTP Return Code is %d" % http_code,
-        )
-
-    if failed:
-        details = info.get("body", info.get("msg", "N/A"))
-        msg += " Details: %s" % details
-
-    result["msg"] = msg
-    result["changed"] = changed
-    result["failed"] = failed
-    result["http_code"] = http_code
+    bakery = BakeryAPI(module)
+    result = bakery.post()
 
-    if result["failed"]:
-        module.fail_json(**result)
+    time.sleep(3)
 
-    module.exit_json(**result)
+    module.exit_json(**result_as_dict(result))
 
 
 def main():