Mini Shell

"""
Manage DNS records and zones using libcloud

    :codeauthor: Anthony Shaw <anthonyshaw@apache.org>

.. versionadded:: 2016.11.0

Create and delete DNS records or zones through Libcloud. Libcloud's DNS system supports over 20 DNS
providers including Amazon, Google, GoDaddy, Softlayer

This module uses ``libcloud``, which can be installed via package, or pip.

:configuration:
    This module uses a configuration profile for one or multiple DNS providers

    .. code-block:: yaml

        libcloud_dns:
          profile1:
            driver: godaddy
            key: 2orgk34kgk34g
          profile2:
            driver: route53
            key: blah
            secret: blah

Example:

.. code-block:: yaml

    my-zone:
      libcloud_dns.zone_present:
        - name: mywebsite.com
        - profile: profile1
    my-website:
      libcloud_dns.record_present:
        - name: www
        - zone: mywebsite.com
        - type: A
        - data: 12.34.32.3
        - profile: profile1
        - require:
          - libcloud_dns: my-zone


:depends: apache-libcloud
"""


def __virtual__():
    if "libcloud_dns.list_zones" in __salt__:
        return True
    return (False, "libcloud_dns module could not be loaded")


def state_result(result, message, name, changes=None):
    if changes is None:
        changes = {}
    return {"result": result, "comment": message, "name": name, "changes": changes}


def zone_present(domain, type, profile):
    """
    Ensures a record is present.

    :param domain: Zone name, i.e. the domain name
    :type  domain: ``str``

    :param type: Zone type (master / slave), defaults to master
    :type  type: ``str``

    :param profile: The profile key
    :type  profile: ``str``
    """
    zones = __salt__["libcloud_dns.list_zones"](profile)
    if not type:
        type = "master"
    matching_zone = [z for z in zones if z["domain"] == domain]
    if len(matching_zone) > 0:
        return state_result(True, "Zone already exists", domain)
    else:
        result = __salt__["libcloud_dns.create_zone"](domain, profile, type)
        return state_result(True, "Created new zone", domain, result)


def zone_absent(domain, profile):
    """
    Ensures a record is absent.

    :param domain: Zone name, i.e. the domain name
    :type  domain: ``str``

    :param profile: The profile key
    :type  profile: ``str``
    """
    zones = __salt__["libcloud_dns.list_zones"](profile)
    matching_zone = [z for z in zones if z["domain"] == domain]
    if len(matching_zone) == 0:
        return state_result(True, "Zone already absent", domain)
    else:
        result = __salt__["libcloud_dns.delete_zone"](matching_zone[0]["id"], profile)
        return state_result(result, "Deleted zone", domain)


def record_present(name, zone, type, data, profile):
    """
    Ensures a record is present.

    :param name: Record name without the domain name (e.g. www).
                 Note: If you want to create a record for a base domain
                 name, you should specify empty string ('') for this
                 argument.
    :type  name: ``str``

    :param zone: Zone where the requested record is created, the domain name
    :type  zone: ``str``

    :param type: DNS record type (A, AAAA, ...).
    :type  type: ``str``

    :param data: Data for the record (depends on the record type).
    :type  data: ``str``

    :param profile: The profile key
    :type  profile: ``str``
    """
    zones = __salt__["libcloud_dns.list_zones"](profile)
    try:
        matching_zone = [z for z in zones if z["domain"] == zone][0]
    except IndexError:
        return state_result(False, "Could not locate zone", name)
    records = __salt__["libcloud_dns.list_records"](matching_zone["id"], profile)
    matching_records = [
        record
        for record in records
        if record["name"] == name and record["type"] == type and record["data"] == data
    ]
    if len(matching_records) == 0:
        result = __salt__["libcloud_dns.create_record"](
            name, matching_zone["id"], type, data, profile
        )
        return state_result(True, "Created new record", name, result)
    else:
        return state_result(True, "Record already exists", name)


def record_absent(name, zone, type, data, profile):
    """
    Ensures a record is absent.

    :param name: Record name without the domain name (e.g. www).
                 Note: If you want to create a record for a base domain
                 name, you should specify empty string ('') for this
                 argument.
    :type  name: ``str``

    :param zone: Zone where the requested record is created, the domain name
    :type  zone: ``str``

    :param type: DNS record type (A, AAAA, ...).
    :type  type: ``str``

    :param data: Data for the record (depends on the record type).
    :type  data: ``str``

    :param profile: The profile key
    :type  profile: ``str``
    """
    zones = __salt__["libcloud_dns.list_zones"](profile)
    try:
        matching_zone = [z for z in zones if z["domain"] == zone][0]
    except IndexError:
        return state_result(False, "Zone could not be found", name)
    records = __salt__["libcloud_dns.list_records"](matching_zone["id"], profile)
    matching_records = [
        record
        for record in records
        if record["name"] == name and record["type"] == type and record["data"] == data
    ]
    if len(matching_records) > 0:
        result = []
        for record in matching_records:
            result.append(
                __salt__["libcloud_dns.delete_record"](
                    matching_zone["id"], record["id"], profile
                )
            )
        return state_result(all(result), f"Removed {len(result)} records", name)
    else:
        return state_result(True, "Records already absent", name)