From 8d77c6cc16eaa91859b98f9dbd9e72bf37b5db30 Mon Sep 17 00:00:00 2001 From: Alex Stephen Date: Wed, 25 Apr 2018 13:11:32 -0700 Subject: [PATCH] Adding support for GCP Compute Https Health Checks (#37437) --- .../google/gcp_compute_https_health_check.py | 401 ++++++++++++++++++ .../gcp_compute_https_health_check/aliases | 2 + .../defaults/main.yml | 3 + .../meta/main.yml | 0 .../tasks/main.yml | 126 ++++++ 5 files changed, 532 insertions(+) create mode 100644 lib/ansible/modules/cloud/google/gcp_compute_https_health_check.py create mode 100644 test/integration/targets/gcp_compute_https_health_check/aliases create mode 100644 test/integration/targets/gcp_compute_https_health_check/defaults/main.yml create mode 100644 test/integration/targets/gcp_compute_https_health_check/meta/main.yml create mode 100644 test/integration/targets/gcp_compute_https_health_check/tasks/main.yml diff --git a/lib/ansible/modules/cloud/google/gcp_compute_https_health_check.py b/lib/ansible/modules/cloud/google/gcp_compute_https_health_check.py new file mode 100644 index 00000000000..4c8c5cc05be --- /dev/null +++ b/lib/ansible/modules/cloud/google/gcp_compute_https_health_check.py @@ -0,0 +1,401 @@ +#!/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 +__metaclass__ = type + +################################################################################ +# Documentation +################################################################################ + +ANSIBLE_METADATA = {'metadata_version': '1.1', + 'status': ["preview"], + 'supported_by': 'community'} + +DOCUMENTATION = ''' +--- +module: gcp_compute_https_health_check +description: + - An HttpsHealthCheck resource. This resource defines a template for how + individual VMs should be checked for health, via HTTPS. +short_description: Creates a GCP HttpsHealthCheck +version_added: 2.6 +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 + required: true + choices: ['present', 'absent'] + default: 'present' + check_interval_sec: + description: + - How often (in seconds) to send a health check. The default value + is 5 seconds. + required: false + description: + description: + - An optional description of this resource. Provide this property + when you create the resource. + required: false + healthy_threshold: + description: + - A so-far unhealthy instance will be marked healthy after this many + consecutive successes. The default value is 2. + required: false + host: + description: + - The value of the host header in the HTTPS health check request. If + left empty (default value), the public IP on behalf of which this + health check is performed will be used. + required: false + 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 + port: + description: + - The TCP port number for the HTTPS health check request. + - The default value is 80. + required: false + request_path: + description: + - The request path of the HTTPS health check request. + - The default value is /. + required: false + timeout_sec: + description: + - How long (in seconds) to wait before claiming failure. + - The default value is 5 seconds. It is invalid for timeoutSec to + have greater value than checkIntervalSec. + required: false + aliases: [timeout_seconds] + unhealthy_threshold: + description: + - A so-far healthy instance will be marked unhealthy after this many + consecutive failures. The default value is 2. + required: false +extends_documentation_fragment: gcp +''' + +EXAMPLES = ''' +- name: create a https health check + gcp_compute_https_health_check: + name: testObject + healthy_threshold: 10 + port: 8080 + timeout_sec: 2 + unhealthy_threshold: 5 + project: testProject + auth_kind: service_account + service_account_file: /tmp/auth.pem + scopes: + - https://www.googleapis.com/auth/compute + state: present +''' + +RETURN = ''' + check_interval_sec: + description: + - How often (in seconds) to send a health check. The default value + is 5 seconds. + returned: success + type: int + creation_timestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. Provide this property + when you create the resource. + returned: success + type: str + healthy_threshold: + description: + - A so-far unhealthy instance will be marked healthy after this many + consecutive successes. The default value is 2. + returned: success + type: int + host: + description: + - The value of the host header in the HTTPS health check request. If + left empty (default value), the public IP on behalf of which this + health check is performed will be used. + returned: success + type: str + id: + description: + - The unique identifier for the resource. This identifier is defined + by the server. + returned: success + type: int + 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 + port: + description: + - The TCP port number for the HTTPS health check request. + - The default value is 80. + returned: success + type: int + request_path: + description: + - The request path of the HTTPS health check request. + - The default value is /. + returned: success + type: str + timeout_sec: + description: + - How long (in seconds) to wait before claiming failure. + - The default value is 5 seconds. It is invalid for timeoutSec to + have greater value than checkIntervalSec. + returned: success + type: int + unhealthy_threshold: + description: + - A so-far healthy instance will be marked unhealthy after this many + consecutive failures. The default value is 2. + returned: success + type: int +''' + +################################################################################ +# Imports +################################################################################ + +from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest, replace_resource_dict +import json +import time + +################################################################################ +# Main +################################################################################ + + +def main(): + """Main function""" + + module = GcpModule( + argument_spec=dict( + state=dict(default='present', choices=['present', 'absent'], type='str'), + check_interval_sec=dict(type='int'), + description=dict(type='str'), + healthy_threshold=dict(type='int'), + host=dict(type='str'), + name=dict(required=True, type='str'), + port=dict(type='int'), + request_path=dict(type='str'), + timeout_sec=dict(type='int', aliases=['timeout_seconds']), + unhealthy_threshold=dict(type='int') + ) + ) + + state = module.params['state'] + kind = 'compute#httpsHealthCheck' + + fetch = fetch_resource(module, self_link(module), kind) + changed = False + + if fetch: + if state == 'present': + if is_different(module, fetch): + fetch = update(module, self_link(module), kind, fetch) + changed = True + else: + delete(module, self_link(module), kind, fetch) + fetch = {} + changed = True + else: + if state == 'present': + fetch = create(module, collection(module), kind) + changed = True + else: + fetch = {} + + fetch.update({'changed': changed}) + + 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, fetch): + auth = GcpSession(module, 'compute') + return wait_for_operation(module, auth.put(link, resource_to_request(module))) + + +def delete(module, link, kind, fetch): + auth = GcpSession(module, 'compute') + return wait_for_operation(module, auth.delete(link)) + + +def resource_to_request(module): + request = { + u'kind': 'compute#httpsHealthCheck', + u'checkIntervalSec': module.params.get('check_interval_sec'), + u'description': module.params.get('description'), + u'healthyThreshold': module.params.get('healthy_threshold'), + u'host': module.params.get('host'), + u'name': module.params.get('name'), + u'port': module.params.get('port'), + u'requestPath': module.params.get('request_path'), + u'timeoutSec': module.params.get('timeout_sec'), + u'unhealthyThreshold': module.params.get('unhealthy_threshold') + } + return_vals = {} + for k, v in request.items(): + if v: + return_vals[k] = v + + return return_vals + + +def fetch_resource(module, link, kind): + auth = GcpSession(module, 'compute') + return return_if_object(module, auth.get(link), kind) + + +def self_link(module): + return "https://www.googleapis.com/compute/v1/projects/{project}/global/httpsHealthChecks/{name}".format(**module.params) + + +def collection(module): + return "https://www.googleapis.com/compute/v1/projects/{project}/global/httpsHealthChecks".format(**module.params) + + +def return_if_object(module, response, kind): + # If not found, return nothing. + if 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) as inst: + module.fail_json(msg="Invalid JSON response with error: %s" % inst) + + if navigate_hash(result, ['error', 'errors']): + module.fail_json(msg=navigate_hash(result, ['error', 'errors'])) + if result['kind'] != kind: + module.fail_json(msg="Incorrect result: {kind}".format(**result)) + + 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'checkIntervalSec': response.get(u'checkIntervalSec'), + u'creationTimestamp': response.get(u'creationTimestamp'), + u'description': response.get(u'description'), + u'healthyThreshold': response.get(u'healthyThreshold'), + u'host': response.get(u'host'), + u'id': response.get(u'id'), + u'name': response.get(u'name'), + u'port': response.get(u'port'), + u'requestPath': response.get(u'requestPath'), + u'timeoutSec': response.get(u'timeoutSec'), + u'unhealthyThreshold': response.get(u'unhealthyThreshold') + } + + +def async_op_url(module, extra_data=None): + if extra_data is None: + extra_data = {} + url = "https://www.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 None + 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#httpsHealthCheck') + + +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'], 'message') + time.sleep(1.0) + if status not in ['PENDING', 'RUNNING', 'DONE']: + module.fail_json(msg="Invalid result %s" % status) + op_result = fetch_resource(module, op_uri, 'compute#operation') + 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() diff --git a/test/integration/targets/gcp_compute_https_health_check/aliases b/test/integration/targets/gcp_compute_https_health_check/aliases new file mode 100644 index 00000000000..9812f019ca4 --- /dev/null +++ b/test/integration/targets/gcp_compute_https_health_check/aliases @@ -0,0 +1,2 @@ +cloud/gcp +unsupported diff --git a/test/integration/targets/gcp_compute_https_health_check/defaults/main.yml b/test/integration/targets/gcp_compute_https_health_check/defaults/main.yml new file mode 100644 index 00000000000..aa87a2a8e0e --- /dev/null +++ b/test/integration/targets/gcp_compute_https_health_check/defaults/main.yml @@ -0,0 +1,3 @@ +--- +# defaults file +resource_name: '{{resource_prefix}}' diff --git a/test/integration/targets/gcp_compute_https_health_check/meta/main.yml b/test/integration/targets/gcp_compute_https_health_check/meta/main.yml new file mode 100644 index 00000000000..e69de29bb2d diff --git a/test/integration/targets/gcp_compute_https_health_check/tasks/main.yml b/test/integration/targets/gcp_compute_https_health_check/tasks/main.yml new file mode 100644 index 00000000000..3fa9c95d1c1 --- /dev/null +++ b/test/integration/targets/gcp_compute_https_health_check/tasks/main.yml @@ -0,0 +1,126 @@ +--- +# ---------------------------------------------------------------------------- +# +# *** 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 +# +# ---------------------------------------------------------------------------- +# Pre-test setup +- name: delete a https health check + gcp_compute_https_health_check: + name: "{{ resource_name }}" + healthy_threshold: 10 + port: 8080 + timeout_sec: 2 + unhealthy_threshold: 5 + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + scopes: + - https://www.googleapis.com/auth/compute + state: absent +#---------------------------------------------------------- +- name: create a https health check + gcp_compute_https_health_check: + name: "{{ resource_name }}" + healthy_threshold: 10 + port: 8080 + timeout_sec: 2 + unhealthy_threshold: 5 + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + scopes: + - https://www.googleapis.com/auth/compute + state: present + register: result +- name: assert changed is true + assert: + that: + - result.changed == true + - "result.kind == 'compute#httpsHealthCheck'" +- name: verify that https_health_check was created + shell: | + gcloud compute https-health-checks describe --project="{{gcp_project}}" "{{ resource_name }}" + register: results +- name: verify that command succeeded + assert: + that: + - results.rc == 0 +# ---------------------------------------------------------------------------- +- name: create a https health check that already exists + gcp_compute_https_health_check: + name: "{{ resource_name }}" + healthy_threshold: 10 + port: 8080 + timeout_sec: 2 + unhealthy_threshold: 5 + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + scopes: + - https://www.googleapis.com/auth/compute + state: present + register: result +- name: assert changed is false + assert: + that: + - result.changed == false + - "result.kind == 'compute#httpsHealthCheck'" +#---------------------------------------------------------- +- name: delete a https health check + gcp_compute_https_health_check: + name: "{{ resource_name }}" + healthy_threshold: 10 + port: 8080 + timeout_sec: 2 + unhealthy_threshold: 5 + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + scopes: + - https://www.googleapis.com/auth/compute + state: absent + register: result +- name: assert changed is true + assert: + that: + - result.changed == true + - result.has_key('kind') == False +- name: verify that https_health_check was deleted + shell: | + gcloud compute https-health-checks describe --project="{{gcp_project}}" "{{ resource_name }}" + register: results + failed_when: results.rc == 0 +- name: verify that command succeeded + assert: + that: + - results.rc == 1 + - "\"'projects/{{ gcp_project }}/global/httpsHealthChecks/{{ resource_name }}' was not found\" in results.stderr" +# ---------------------------------------------------------------------------- +- name: delete a https health check that does not exist + gcp_compute_https_health_check: + name: "{{ resource_name }}" + healthy_threshold: 10 + port: 8080 + timeout_sec: 2 + unhealthy_threshold: 5 + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + scopes: + - https://www.googleapis.com/auth/compute + state: absent + register: result +- name: assert changed is false + assert: + that: + - result.changed == false + - result.has_key('kind') == False