gcp_compute_route.py

#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Copyright (C) 2017 Google
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# ----------------------------------------------------------------------------
#
#     ***     AUTO GENERATED CODE    ***    AUTO GENERATED CODE     ***
#
# ----------------------------------------------------------------------------
#
#     This file is automatically generated by Magic Modules and manual
#     changes will be clobbered when the file is regenerated.
#
#     Please read more about how to change this file at
#     https://www.github.com/GoogleCloudPlatform/magic-modules
#
# ----------------------------------------------------------------------------

from __future__ import absolute_import, division, print_function

import json
import time

from ansible_collections.google.cloud.plugins.module_utils.gcp_utils import (
    GcpModule,
    GcpRequest,
    GcpSession,
    navigate_hash,
    replace_resource_dict,
)

__metaclass__ = type

################################################################################
# Documentation
################################################################################

ANSIBLE_METADATA = {
    "metadata_version": "1.1",
    "status": ["preview"],
    "supported_by": "community",
}

DOCUMENTATION = """
---
module: gcp_compute_route
description:
- Represents a Route resource.
- A route is a rule that specifies how certain packets should be handled by the virtual
  network. Routes are associated with virtual machines by tag, and the set of routes
  for a particular virtual machine is called its routing table. For each packet leaving
  a virtual machine, the system searches that virtual machine's routing table for
  a single best matching route.
- Routes match packets by destination IP address, preferring smaller or more specific
  ranges over larger ones. If there is a tie, the system selects the route with the
  smallest priority value. If there is still a tie, it uses the layer three and four
  packet headers to select just one of the remaining matching routes. The packet is
  then forwarded as specified by the next_hop field of the winning route -- either
  to another virtual machine destination, a virtual machine gateway or a Compute Engine-operated
  gateway. Packets that do not match any route in the sending virtual machine's routing
  table will be dropped.
- A Route resource must have exactly one specification of either nextHopGateway, nextHopInstance,
  nextHopIp, nextHopVpnTunnel, or nextHopIlb.
short_description: Creates a GCP Route
author: Google Inc. (@googlecloudplatform)
requirements:
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
options:
  state:
    description:
    - Whether the given object should exist in GCP
    choices:
    - present
    - absent
    default: present
    type: str
  dest_range:
    description:
    - The destination range of outgoing packets that this route applies to.
    - Only IPv4 is supported.
    required: true
    type: str
  description:
    description:
    - An optional description of this resource. Provide this property when you create
      the resource.
    required: false
    type: str
  name:
    description:
    - Name of the resource. Provided by the client when the resource is created. The
      name must be 1-63 characters long, and comply with RFC1035. Specifically, the
      name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
      which means the first character must be a lowercase letter, and all following
      characters must be a dash, lowercase letter, or digit, except the last character,
      which cannot be a dash.
    required: true
    type: str
  network:
    description:
    - The network that this route applies to.
    - 'This field represents a link to a Network resource in GCP. It can be specified
      in two ways. First, you can place a dictionary with key ''selfLink'' and value
      of your resource''s selfLink Alternatively, you can add `register: name-of-resource`
      to a gcp_compute_network task and then set this network field to "{{ name-of-resource
      }}"'
    required: true
    type: dict
  priority:
    description:
    - The priority of this route. Priority is used to break ties in cases where there
      is more than one matching route of equal prefix length.
    - In the case of two routes with equal prefix length, the one with the lowest-numbered
      priority value wins.
    - Default value is 1000. Valid range is 0 through 65535.
    required: false
    type: int
  tags:
    description:
    - A list of instance tags to which this route applies.
    elements: str
    required: false
    type: list
  next_hop_gateway:
    description:
    - URL to a gateway that should handle matching packets.
    - 'Currently, you can only specify the internet gateway, using a full or partial
      valid URL: * U(https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway)
      * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway
      .'
    required: false
    type: str
  next_hop_instance:
    description:
    - URL to an instance that should handle matching packets.
    - 'You can specify this as a full or partial URL. For example: * U(https://www.googleapis.com/compute/v1/projects/project/zones/zone/)
      instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance
      .'
    - 'This field represents a link to a Instance resource in GCP. It can be specified
      in two ways. First, you can place a dictionary with key ''selfLink'' and value
      of your resource''s selfLink Alternatively, you can add `register: name-of-resource`
      to a gcp_compute_instance task and then set this next_hop_instance field to
      "{{ name-of-resource }}"'
    required: false
    type: dict
  next_hop_ip:
    description:
    - Network IP address of an instance that should handle matching packets.
    required: false
    type: str
  next_hop_vpn_tunnel:
    description:
    - URL to a VpnTunnel that should handle matching packets.
    - 'This field represents a link to a VpnTunnel resource in GCP. It can be specified
      in two ways. First, you can place a dictionary with key ''selfLink'' and value
      of your resource''s selfLink Alternatively, you can add `register: name-of-resource`
      to a gcp_compute_vpn_tunnel task and then set this next_hop_vpn_tunnel field
      to "{{ name-of-resource }}"'
    required: false
    type: dict
  next_hop_ilb:
    description:
    - The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should
      handle matching packets.
    - 'You can only specify the forwarding rule as a partial or full URL. For example,
      the following are all valid URLs: U(https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule)
      regions/region/forwardingRules/forwardingRule Note that this can only be used
      when the destinationRange is a public (non-RFC 1918) IP CIDR range.'
    - 'This field represents a link to a ForwardingRule resource in GCP. It can be
      specified in two ways. First, you can place a dictionary with key ''selfLink''
      and value of your resource''s selfLink Alternatively, you can add `register:
      name-of-resource` to a gcp_compute_forwarding_rule task and then set this next_hop_ilb
      field to "{{ name-of-resource }}"'
    required: false
    type: dict
  project:
    description:
    - The Google Cloud Platform project to use.
    type: str
  auth_kind:
    description:
    - The type of credential used.
    type: str
    required: true
    choices:
    - application
    - machineaccount
    - serviceaccount
  service_account_contents:
    description:
    - The contents of a Service Account JSON file, either in a dictionary or as a
      JSON string that represents it.
    type: jsonarg
  service_account_file:
    description:
    - The path of a Service Account JSON file if serviceaccount is selected as type.
    type: path
  service_account_email:
    description:
    - An optional service account email address if machineaccount is selected and
      the user does not wish to use the default email.
    type: str
  scopes:
    description:
    - Array of scopes to be used
    type: list
    elements: str
  env_type:
    description:
    - Specifies which Ansible environment you're running this module within.
    - This should not be set unless you know what you're doing.
    - This only alters the User Agent string for any API requests.
    type: str
notes:
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/v1/routes)'
- 'Using Routes: U(https://cloud.google.com/vpc/docs/using-routes)'
- for authentication, you can set service_account_file using the C(gcp_service_account_file)
  env variable.
- for authentication, you can set service_account_contents using the C(GCP_SERVICE_ACCOUNT_CONTENTS)
  env variable.
- For authentication, you can set service_account_email using the C(GCP_SERVICE_ACCOUNT_EMAIL)
  env variable.
- For authentication, you can set auth_kind using the C(GCP_AUTH_KIND) env variable.
- For authentication, you can set scopes using the C(GCP_SCOPES) env variable.
- Environment variables values will only be used if the playbook values are not set.
- The I(service_account_email) and I(service_account_file) options are mutually exclusive.
"""

EXAMPLES = """
- name: create a network
  google.cloud.gcp_compute_network:
    name: network-route
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network

- name: create a route
  google.cloud.gcp_compute_route:
    name: test_object
    dest_range: 192.168.6.0/24
    next_hop_gateway: global/gateways/default-internet-gateway
    network: "{{ network }}"
    tags:
    - backends
    - databases
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present
"""

RETURN = """
destRange:
  description:
  - The destination range of outgoing packets that this route applies to.
  - Only IPv4 is supported.
  returned: success
  type: str
description:
  description:
  - An optional description of this resource. Provide this property when you create
    the resource.
  returned: success
  type: str
name:
  description:
  - Name of the resource. Provided by the client when the resource is created. The
    name must be 1-63 characters long, and comply with RFC1035. Specifically, the
    name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
    which means the first character must be a lowercase letter, and all following
    characters must be a dash, lowercase letter, or digit, except the last character,
    which cannot be a dash.
  returned: success
  type: str
network:
  description:
  - The network that this route applies to.
  returned: success
  type: dict
priority:
  description:
  - The priority of this route. Priority is used to break ties in cases where there
    is more than one matching route of equal prefix length.
  - In the case of two routes with equal prefix length, the one with the lowest-numbered
    priority value wins.
  - Default value is 1000. Valid range is 0 through 65535.
  returned: success
  type: int
tags:
  description:
  - A list of instance tags to which this route applies.
  returned: success
  type: list
nextHopGateway:
  description:
  - URL to a gateway that should handle matching packets.
  - 'Currently, you can only specify the internet gateway, using a full or partial
    valid URL: * U(https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway)
    * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway
    .'
  returned: success
  type: str
nextHopInstance:
  description:
  - URL to an instance that should handle matching packets.
  - 'You can specify this as a full or partial URL. For example: * U(https://www.googleapis.com/compute/v1/projects/project/zones/zone/)
    instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance
    .'
  returned: success
  type: dict
nextHopIp:
  description:
  - Network IP address of an instance that should handle matching packets.
  returned: success
  type: str
nextHopVpnTunnel:
  description:
  - URL to a VpnTunnel that should handle matching packets.
  returned: success
  type: dict
nextHopNetwork:
  description:
  - URL to a Network that should handle matching packets.
  returned: success
  type: str
nextHopIlb:
  description:
  - The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should
    handle matching packets.
  - 'You can only specify the forwarding rule as a partial or full URL. For example,
    the following are all valid URLs: U(https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule)
    regions/region/forwardingRules/forwardingRule Note that this can only be used
    when the destinationRange is a public (non-RFC 1918) IP CIDR range.'
  returned: success
  type: dict
"""

################################################################################
# Imports
################################################################################


################################################################################
# Main
################################################################################


def main():
    """Main function"""

    module = GcpModule(
        argument_spec=dict(
            state=dict(
                default="present", choices=["present", "absent"], type="str"
            ),
            dest_range=dict(required=True, type="str"),
            description=dict(type="str"),
            name=dict(required=True, type="str"),
            network=dict(required=True, type="dict"),
            priority=dict(type="int"),
            tags=dict(type="list", elements="str"),
            next_hop_gateway=dict(type="str"),
            next_hop_instance=dict(type="dict"),
            next_hop_ip=dict(type="str"),
            next_hop_vpn_tunnel=dict(type="dict"),
            next_hop_ilb=dict(type="dict"),
        )
    )

    if not module.params["scopes"]:
        module.params["scopes"] = ["https://www.googleapis.com/auth/compute"]

    state = module.params["state"]
    kind = "compute#route"

    fetch = fetch_resource(module, self_link(module), kind)
    changed = False

    if fetch:
        if state == "present":
            if is_different(module, fetch):
                update(module, self_link(module), kind)
                fetch = fetch_resource(module, self_link(module), kind)
                changed = True
        else:
            delete(module, self_link(module), kind)
            fetch = {}
            changed = True
    else:
        if state == "present":
            fetch = create(module, collection(module), kind)
            changed = True
        else:
            fetch = {}

    fetch.update({"changed": changed})

    if "warnings" in fetch:
        fetch["warnings"] = fetch["warnings"][0]["message"]
    module.exit_json(**fetch)


def create(module, link, kind):
    auth = GcpSession(module, "compute")
    return wait_for_operation(
        module, auth.post(link, resource_to_request(module))
    )


def update(module, link, kind):
    delete(module, self_link(module), kind)
    create(module, collection(module), kind)


def delete(module, link, kind):
    auth = GcpSession(module, "compute")
    return wait_for_operation(module, auth.delete(link))


def resource_to_request(module):
    request = {
        u"kind": "compute#route",
        u"destRange": module.params.get("dest_range"),
        u"description": module.params.get("description"),
        u"name": module.params.get("name"),
        u"network": replace_resource_dict(
            module.params.get(u"network", {}), "selfLink"
        ),
        u"priority": module.params.get("priority"),
        u"tags": module.params.get("tags"),
        u"nextHopGateway": module.params.get("next_hop_gateway"),
        u"nextHopInstance": replace_resource_dict(
            module.params.get(u"next_hop_instance", {}), "selfLink"
        ),
        u"nextHopIp": module.params.get("next_hop_ip"),
        u"nextHopVpnTunnel": replace_resource_dict(
            module.params.get(u"next_hop_vpn_tunnel", {}), "selfLink"
        ),
        u"nextHopIlb": replace_resource_dict(
            module.params.get(u"next_hop_ilb", {}), "selfLink"
        ),
    }
    return_vals = {}
    for k, v in request.items():
        if v or v is False:
            return_vals[k] = v

    return return_vals


def fetch_resource(module, link, kind, allow_not_found=True):
    auth = GcpSession(module, "compute")
    return return_if_object(module, auth.get(link), kind, allow_not_found)


def self_link(module):
    return "https://compute.googleapis.com/compute/v1/projects/{project}/global/routes/{name}".format(**module.params)


def collection(module):
    return "https://compute.googleapis.com/compute/v1/projects/{project}/global/routes".format(**module.params)


def return_if_object(module, response, kind, allow_not_found=False):
    # If not found, return nothing.
    if allow_not_found and response.status_code == 404:
        return None

    # If no content, return nothing.
    if response.status_code == 204:
        return None

    try:
        module.raise_for_status(response)
        result = response.json()
    except getattr(json.decoder, "JSONDecodeError", ValueError):
        module.fail_json(
            msg="Invalid JSON response with error: %s" % response.text
        )

    if navigate_hash(result, ["error", "errors"]):
        module.fail_json(msg=navigate_hash(result, ["error", "errors"]))

    return result


def is_different(module, response):
    request = resource_to_request(module)
    response = response_to_hash(module, response)

    # Remove all output-only from response.
    response_vals = {}
    for k, v in response.items():
        if k in request:
            response_vals[k] = v

    request_vals = {}
    for k, v in request.items():
        if k in response:
            request_vals[k] = v

    return GcpRequest(request_vals) != GcpRequest(response_vals)


# Remove unnecessary properties from the response.
# This is for doing comparisons with Ansible's current parameters.
def response_to_hash(module, response):
    return {
        u"destRange": response.get(u"destRange"),
        u"description": response.get(u"description"),
        u"name": response.get(u"name"),
        u"network": replace_resource_dict(
            module.params.get(u"network", {}), "selfLink"
        ),
        u"priority": module.params.get("priority"),
        u"tags": module.params.get("tags"),
        u"nextHopGateway": module.params.get("next_hop_gateway"),
        u"nextHopInstance": replace_resource_dict(
            module.params.get(u"next_hop_instance", {}), "selfLink"
        ),
        u"nextHopIp": module.params.get("next_hop_ip"),
        u"nextHopVpnTunnel": replace_resource_dict(
            module.params.get(u"next_hop_vpn_tunnel", {}), "selfLink"
        ),
        u"nextHopNetwork": response.get(u"nextHopNetwork"),
        u"nextHopIlb": replace_resource_dict(
            module.params.get(u"next_hop_ilb", {}), "selfLink"
        ),
    }


def async_op_url(module, extra_data=None):
    if extra_data is None:
        extra_data = {}
    url = "https://compute.googleapis.com/compute/v1/projects/{project}/global/operations/{op_id}"
    combined = extra_data.copy()
    combined.update(module.params)
    return url.format(**combined)


def wait_for_operation(module, response):
    op_result = return_if_object(module, response, "compute#operation")
    if op_result is None:
        return {}
    status = navigate_hash(op_result, ["status"])
    wait_done = wait_for_completion(status, op_result, module)
    return fetch_resource(
        module, navigate_hash(wait_done, ["targetLink"]), "compute#route"
    )


def wait_for_completion(status, op_result, module):
    op_id = navigate_hash(op_result, ["name"])
    op_uri = async_op_url(module, {"op_id": op_id})
    while status != "DONE":
        raise_if_errors(op_result, ["error", "errors"], module)
        time.sleep(1.0)
        op_result = fetch_resource(module, op_uri, "compute#operation", False)
        status = navigate_hash(op_result, ["status"])
    return op_result


def raise_if_errors(response, err_path, module):
    errors = navigate_hash(response, err_path)
    if errors is not None:
        module.fail_json(msg=errors)


if __name__ == "__main__":
    main()