discovery.py

#!/usr/bin/python
# -*- encoding: utf-8; py-indent-offset: 4 -*-

# Copyright: (c) 2022, Michael Sekania &
#                      Robin Gierse <robin.gierse@checkmk.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function

__metaclass__ = type

DOCUMENTATION = r"""
---
module: discovery

short_description: Discover services in Checkmk.

# If this is part of a collection, you need to use semantic versioning,
# i.e. the version is of the form "2.5.0" and not "2.4".
version_added: "0.0.1"

description:
- Discovery services within Checkmk.

extends_documentation_fragment: [checkmk.general.common]

options:
    host_name:
        description: The host who's services you want to manage. Mutually exclusive with hosts.
        required: false
        type: str
    hosts:
        description:
            - The list of hosts the services of which you want to manage.
              Mutually exclusive with host_name. This enables bulk discovery mode.
        required: false
        type: list
        elements: str
        default: []
    state:
        description: The action to perform during discovery.
        type: str
        default: new
        choices: [new, remove, fix_all, refresh, tabula_rasa, only_host_labels, only_service_labels, monitor_undecided_services]
    do_full_scan:
        description: The option whether to perform a full scan or not. (Bulk mode only).
        type: bool
        default: True
    bulk_size:
        description: The number of hosts to be handled at once. (Bulk mode only).
        type: int
        default: 1
    ignore_errors:
        description: The option whether to ignore errors in single check plugins. (Bulk mode only).
        type: bool
        default: True

author:
    - Robin Gierse (@robin-checkmk)
    - Michael Sekania (@msekania)
    - Max Sickora (@max-checkmk)
"""

EXAMPLES = r"""
# Create a single host.
- name: "Add newly discovered services on host."
  checkmk.general.discovery:
    server_url: "http://myserver/"
    site: "mysite"
    automation_user: "myuser"
    automation_secret: "mysecret"
    host_name: "my_host"
    state: "new"
- name: "Add newly discovered services, update labels and remove vanished services on host."
  checkmk.general.discovery:
    server_url: "http://myserver/"
    site: "mysite"
    automation_user: "myuser"
    automation_secret: "mysecret"
    host_name: "my_host"
    state: "fix_all"
- name: "Add newly discovered services on hosts. (Bulk)"
  checkmk.general.discovery:
    server_url: "http://myserver/"
    site: "mysite"
    automation_user: "myuser"
    automation_secret: "mysecret"
    hosts: ["my_host_0", "my_host_1"]
    state: "new"
- name: "Add newly discovered services, update labels and remove vanished services on host; 3 at once (Bulk)"
  checkmk.general.discovery:
    server_url: "http://myserver/"
    site: "mysite"
    automation_user: "myuser"
    automation_secret: "mysecret"
    hosts: ["my_host_0", "my_host_1", "my_host_2", "my_host_3", "my_host_4", "my_host_5"]
    state: "fix_all"
    bulk_size: 3
"""

RETURN = r"""
http_code:
    description: The HTTP code the Checkmk API returns.
    type: int
    returned: always
    sample: '200'
message:
    description: The output message that the module generates.
    type: str
    returned: always
    sample: 'Host created.'
"""

import json
import time

from ansible.module_utils.basic import AnsibleModule
from ansible_collections.checkmk.general.plugins.module_utils.api import CheckmkAPI
from ansible_collections.checkmk.general.plugins.module_utils.types import RESULT
from ansible_collections.checkmk.general.plugins.module_utils.utils import (
    result_as_dict,
)
from ansible_collections.checkmk.general.plugins.module_utils.version import (
    CheckmkVersion,
)

HTTP_CODES = {
    # http_code: (changed, failed, "Message")
    200: (True, False, "Discovery successful."),
    302: (
        True,
        False,
        "The service discovery background job has been initialized. Redirecting to the 'Wait for service discovery completion' endpoint.",
    ),
    404: (False, True, "Not Found: Host could not be found."),
    409: (False, False, "Conflict: A discovery background job is already running"),
}

HTTP_CODES_SC = {
    # http_code: (changed, failed, "Message")
    200: (True, False, "The service discovery has been completed."),
    302: (
        True,
        False,
        "The service discovery is still running. Redirecting to the 'Wait for completion' endpoint.",
    ),
    404: (False, False, "Not Found: There is no running service discovery"),
}

HTTP_CODES_BULK = {
    # http_code: (changed, failed, "Message")
    200: (True, False, "Discovery successful."),
    409: (False, False, "Conflict: A bulk discovery job is already active"),
}

HTTP_CODES_BULK_SC = {
    # http_code: (changed, failed, "Message")
    200: (True, False, "The service discovery has been completed."),
    404: (False, False, "Not Found: There is no running bulk_discovery job"),
}


class DiscoveryAPI(CheckmkAPI):
    def post(self):
        data = {
            "host_name": self.params.get("host_name"),
            "mode": self.params.get("state"),
        }

        return self._fetch(
            code_mapping=HTTP_CODES,
            endpoint="domain-types/service_discovery_run/actions/start/invoke",
            data=data,
            method="POST",
        )


class oldDiscoveryAPI(CheckmkAPI):
    def post(self):
        data = {
            "mode": self.params.get("state"),
        }

        return self._fetch(
            code_mapping=HTTP_CODES,
            endpoint=(
                "/objects/host/"
                + self.params.get("host_name")
                + "/actions/discover_services/invoke"
            ),
            data=data,
            method="POST",
        )


class ServiceCompletionAPI(CheckmkAPI):
    def get(self):
        data = {}

        return self._fetch(
            code_mapping=HTTP_CODES_SC,
            endpoint=(
                "objects/service_discovery_run/"
                + self.params.get("host_name")
                + "/actions/wait-for-completion/invoke"
            ),
            data=data,
            method="GET",
        )


class BulkDiscoveryAPI(CheckmkAPI):
    def post(self):
        data = {
            "hostnames": self.params.get("hosts", []),
            "mode": self.params.get("state"),
            "do_full_scan": self.params.get("do_full_scan", True),
            "bulk_size": self.params.get("bulk_size", 1),
            "ignore_errors": self.params.get("ignore_errors", True),
        }

        return self._fetch(
            code_mapping=HTTP_CODES_BULK,
            endpoint="domain-types/discovery_run/actions/bulk-discovery-start/invoke",
            data=data,
            method="POST",
        )


class newBulkDiscoveryAPI(CheckmkAPI):
    def post(self):
        options = {
            "monitor_undecided_services": False,
            "remove_vanished_services": False,
            "update_service_labels": False,
            "update_host_labels": False,
        }

        if self.params.get("state") in ["new", "fix_all", "monitor_undecided_services"]:
            options["monitor_undecided_services"] = True
        if self.params.get("state") in ["remove", "fix_all"]:
            options["remove_vanished_services"] = True
        if self.params.get("state") in ["only_service_labels"]:
            options["update_service_labels"] = True
        if self.params.get("state") in ["new", "fix_all", "only_host_labels"]:
            options["update_host_labels"] = True

        if self.params.get("state") == "refresh":
            data = {
                "hostnames": self.params.get("hosts", []),
                "mode": self.params.get("state"),
                "do_full_scan": self.params.get("do_full_scan", True),
                "bulk_size": self.params.get("bulk_size", 1),
                "ignore_errors": self.params.get("ignore_errors", True),
            }
        else:
            data = {
                "hostnames": self.params.get("hosts", []),
                "options": options,
                "do_full_scan": self.params.get("do_full_scan", True),
                "bulk_size": self.params.get("bulk_size", 1),
                "ignore_errors": self.params.get("ignore_errors", True),
            }

        return self._fetch(
            code_mapping=HTTP_CODES_BULK,
            endpoint="domain-types/discovery_run/actions/bulk-discovery-start/invoke",
            data=data,
            method="POST",
        )


class ServiceCompletionBulkAPI(CheckmkAPI):
    def get(self):
        data = {}

        return self._fetch(
            code_mapping=HTTP_CODES_BULK_SC,
            endpoint=("objects/discovery_run/bulk_discovery"),
            data=data,
            method="GET",
        )


# If single_mode check if discovery process is already running. If API returns 302, check the service completion endpoint
# until the discovery has completed successfully (or failed).
# If not single_mode check if bulk_discovery process is already running. If active, check the service completion endpoint
# until the bulk_discovery has completed successfully (or failed).
def wait_for_completion(single_mode, servicecompletion, sleep_time=3):
    while True:
        result = servicecompletion.get()

        if single_mode:
            if result.http_code != 302:
                break
        else:
            if not (json.loads(result.content).get("extensions").get("active")):
                break

            time.sleep(sleep_time)

    return result


def run_module():
    module_args = dict(
        server_url=dict(type="str", required=True),
        site=dict(type="str", required=True),
        validate_certs=dict(type="bool", required=False, default=True),
        automation_user=dict(type="str", required=True),
        automation_secret=dict(type="str", required=True, no_log=True),
        host_name=dict(type="str", required=False),
        hosts=dict(type="list", elements="str", required=False, default=[]),
        state=dict(
            type="str",
            default="new",
            choices=[
                "new",
                "remove",
                "fix_all",
                "refresh",
                "tabula_rasa",
                "only_host_labels",
                "only_service_labels",
                "monitor_undecided_services",
            ],
        ),
        do_full_scan=dict(type="bool", default=True),
        bulk_size=dict(type="int", default=1),
        ignore_errors=dict(type="bool", default=True),
    )
    module = AnsibleModule(
        argument_spec=module_args,
        mutually_exclusive=[
            ("host_name", "hosts"),
        ],
        required_one_of=[
            ("host_name", "hosts"),
        ],
        supports_check_mode=False,
    )

    result = RESULT(
        http_code=0,
        msg="Nothing to be done",
        content="",
        etag="",
        failed=False,
        changed=False,
    )

    single_mode = not (
        "hosts" in module.params
        and module.params.get("hosts")
        and len(module.params.get("hosts", [])) > 0
    )

    discovery = None
    servicecompletion = None

    if single_mode:
        discovery = DiscoveryAPI(module)
        servicecompletion = ServiceCompletionAPI(module)
    else:
        discovery = BulkDiscoveryAPI(module)
        servicecompletion = ServiceCompletionBulkAPI(module)

    ver = discovery.getversion()

    if single_mode and ver < CheckmkVersion("2.1.0"):
        discovery = oldDiscoveryAPI(module)

    if ver < CheckmkVersion("2.2.0") and module.params.get("state") == "tabula_rasa":
        result = RESULT(
            http_code=0,
            msg="State 'tabula_rasa' is not supported before 2.2.0",
            content="",
            etag="",
            failed=True,
            changed=False,
        )
        module.fail_json(**result_as_dict(result))

    if not single_mode and module.params.get("state") == "tabula_rasa":
        module.params["state"] = "refresh"

    if module.params.get("state") in [
        "only_service_labels",
        "monitor_undecided_services",
    ]:
        if ver < CheckmkVersion("2.3.0"):
            result = RESULT(
                http_code=0,
                msg="State is not supported before 2.3.0",
                content="",
                etag="",
                failed=True,
                changed=False,
            )
            module.fail_json(**result_as_dict(result))
        if single_mode:
            if module.params.get("state") == "monitor_undecided_services":
                result = RESULT(
                    http_code=0,
                    msg="State can only be used in bulk mode",
                    content="",
                    etag="",
                    failed=True,
                    changed=False,
                )
                module.fail_json(**result_as_dict(result))
            if module.params.get(
                "state"
            ) == "only_service_labels" and ver < CheckmkVersion("2.3.0p3"):
                result = RESULT(
                    http_code=0,
                    msg="State can only be used in bulk mode",
                    content="",
                    etag="",
                    failed=True,
                    changed=False,
                )
                module.fail_json(**result_as_dict(result))

    if not single_mode and ver >= CheckmkVersion("2.3.0"):
        discovery = newBulkDiscoveryAPI(module)

    result = wait_for_completion(single_mode, servicecompletion)

    result = discovery.post()

    # In case the API returns 409 (discovery running) we wait and try again.
    # This can happen as example in versions where the endpoint doesn't respond with the correct redirect.
    while (single_mode and result.http_code == 409) or (
        len(module.params.get("hosts", [])) > 0 and result.http_code == 409
    ):
        if single_mode:
            time.sleep(1)
        else:
            time.sleep(10)

        result = discovery.post()

    # If single_mode and the API returns 302, check the service completion endpoint
    # If not single_mode and the API returns 200, check the service completion endpoint
    if (single_mode and result.http_code == 302) or (
        len(module.params.get("hosts", [])) > 0 and result.http_code == 200
    ):
        result = wait_for_completion(single_mode, servicecompletion)

    # content of json.loads(result.content).get("extensions").get("logs").get("result") is alos quite interesting
    module.exit_json(**result_as_dict(result))


def main():
    run_module()


if __name__ == "__main__":
    main()