From 2ac8266baf1fcdce00f0128782ed9a4723b4e0a8 Mon Sep 17 00:00:00 2001
From: Alex Stephen <alexstephen@google.com>
Date: Tue, 28 Aug 2018 11:55:44 -0400
Subject: [PATCH] New GCP Module: gcp_sql_database (#42801)
---
plugins/modules/gcp_sql_database.py | 321 ++++++++++++++++++
tests/integration/gcp_sql_database/aliases | 2 +
.../gcp_sql_database/defaults/main.yml | 3 +
.../gcp_sql_database/meta/main.yml | 0
.../gcp_sql_database/tasks/main.yml | 138 ++++++++
5 files changed, 464 insertions(+)
create mode 100644 plugins/modules/gcp_sql_database.py
create mode 100644 tests/integration/gcp_sql_database/aliases
create mode 100644 tests/integration/gcp_sql_database/defaults/main.yml
create mode 100644 tests/integration/gcp_sql_database/meta/main.yml
create mode 100644 tests/integration/gcp_sql_database/tasks/main.yml
diff --git a/plugins/modules/gcp_sql_database.py b/plugins/modules/gcp_sql_database.py
new file mode 100644
index 0000000..574c001
--- /dev/null
+++ b/plugins/modules/gcp_sql_database.py
@@ -0,0 +1,321 @@
+#!/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_sql_database
+description:
+ - Represents a SQL database inside the Cloud SQL instance, hosted in Google's cloud.
+short_description: Creates a GCP Database
+version_added: 2.7
+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'
+ charset:
+ description:
+ - The MySQL charset value.
+ required: false
+ collation:
+ description:
+ - The MySQL collation value.
+ required: false
+ name:
+ description:
+ - The name of the database in the Cloud SQL instance.
+ - This does not include the project ID or instance name.
+ required: false
+ instance:
+ description:
+ - The name of the Cloud SQL instance. This does not include the project ID.
+ required: true
+extends_documentation_fragment: gcp
+'''
+
+EXAMPLES = '''
+- name: create a instance
+ gcp_sql_instance:
+ name: "instance-database"
+ settings:
+ ip_configuration:
+ authorized_networks:
+ - name: google dns server
+ value: 8.8.8.8/32
+ tier: db-n1-standard-1
+ region: us-central1
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ state: present
+ register: instance
+
+- name: create a database
+ gcp_sql_database:
+ name: "test_object"
+ charset: utf8
+ instance: "{{ instance }}"
+ project: "test_project"
+ auth_kind: "service_account"
+ service_account_file: "/tmp/auth.pem"
+ state: present
+'''
+
+RETURN = '''
+ charset:
+ description:
+ - The MySQL charset value.
+ returned: success
+ type: str
+ collation:
+ description:
+ - The MySQL collation value.
+ returned: success
+ type: str
+ name:
+ description:
+ - The name of the database in the Cloud SQL instance.
+ - This does not include the project ID or instance name.
+ returned: success
+ type: str
+ instance:
+ description:
+ - The name of the Cloud SQL instance. This does not include the project ID.
+ returned: success
+ type: dict
+'''
+
+################################################################################
+# 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'),
+ charset=dict(type='str'),
+ collation=dict(type='str'),
+ name=dict(type='str'),
+ instance=dict(required=True, type='dict')
+ )
+ )
+
+ if not module.params['scopes']:
+ module.params['scopes'] = ['https://www.googleapis.com/auth/sqlservice.admin']
+
+ state = module.params['state']
+ kind = 'sql#database'
+
+ 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)
+ 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})
+
+ module.exit_json(**fetch)
+
+
+def create(module, link, kind):
+ auth = GcpSession(module, 'sql')
+ return wait_for_operation(module, auth.post(link, resource_to_request(module)))
+
+
+def update(module, link, kind):
+ auth = GcpSession(module, 'sql')
+ return wait_for_operation(module, auth.put(link, resource_to_request(module)))
+
+
+def delete(module, link, kind):
+ auth = GcpSession(module, 'sql')
+ return wait_for_operation(module, auth.delete(link))
+
+
+def resource_to_request(module):
+ request = {
+ u'kind': 'sql#database',
+ u'charset': module.params.get('charset'),
+ u'collation': module.params.get('collation'),
+ u'name': module.params.get('name')
+ }
+ 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, 'sql')
+ return return_if_object(module, auth.get(link), kind)
+
+
+def self_link(module):
+ res = {
+ 'project': module.params['project'],
+ 'instance': replace_resource_dict(module.params['instance'], 'name'),
+ 'name': module.params['name']
+ }
+ return "https://www.googleapis.com/sql/v1beta4/projects/{project}/instances/{instance}/databases/{name}".format(**res)
+
+
+def collection(module):
+ res = {
+ 'project': module.params['project'],
+ 'instance': replace_resource_dict(module.params['instance'], 'name')
+ }
+ return "https://www.googleapis.com/sql/v1beta4/projects/{project}/instances/{instance}/databases".format(**res)
+
+
+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
+
+ # SQL only: return on 403 if not exist
+ if response.status_code == 403:
+ return None
+
+ try:
+ 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'charset': response.get(u'charset'),
+ u'collation': response.get(u'collation'),
+ u'name': response.get(u'name')
+ }
+
+
+def async_op_url(module, extra_data=None):
+ if extra_data is None:
+ extra_data = {}
+ url = "https://www.googleapis.com/sql/v1beta4/projects/{project}/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, 'sql#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']), 'sql#database')
+
+
+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, 'sql#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/tests/integration/gcp_sql_database/aliases b/tests/integration/gcp_sql_database/aliases
new file mode 100644
index 0000000..9812f01
--- /dev/null
+++ b/tests/integration/gcp_sql_database/aliases
@@ -0,0 +1,2 @@
+cloud/gcp
+unsupported
diff --git a/tests/integration/gcp_sql_database/defaults/main.yml b/tests/integration/gcp_sql_database/defaults/main.yml
new file mode 100644
index 0000000..aa87a2a
--- /dev/null
+++ b/tests/integration/gcp_sql_database/defaults/main.yml
@@ -0,0 +1,3 @@
+---
+# defaults file
+resource_name: '{{resource_prefix}}'
diff --git a/tests/integration/gcp_sql_database/meta/main.yml b/tests/integration/gcp_sql_database/meta/main.yml
new file mode 100644
index 0000000..e69de29
diff --git a/tests/integration/gcp_sql_database/tasks/main.yml b/tests/integration/gcp_sql_database/tasks/main.yml
new file mode 100644
index 0000000..8122632
--- /dev/null
+++ b/tests/integration/gcp_sql_database/tasks/main.yml
@@ -0,0 +1,138 @@
+---
+# ----------------------------------------------------------------------------
+#
+# *** 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: create a instance
+ gcp_sql_instance:
+ name: "instance-database"
+ settings:
+ ip_configuration:
+ authorized_networks:
+ - name: google dns server
+ value: 8.8.8.8/32
+ tier: db-n1-standard-1
+ region: us-central1
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ state: present
+ register: instance
+- name: delete a database
+ gcp_sql_database:
+ name: "{{ resource_name }}"
+ charset: utf8
+ instance: "{{ instance }}"
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ state: absent
+#----------------------------------------------------------
+- name: create a database
+ gcp_sql_database:
+ name: "{{ resource_name }}"
+ charset: utf8
+ instance: "{{ instance }}"
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ state: present
+ register: result
+- name: assert changed is true
+ assert:
+ that:
+ - result.changed == true
+ - "result.kind == 'sql#database'"
+- name: verify that database was created
+ shell: |
+ gcloud sql databases describe --instance='instance-database' --project="{{ gcp_project}}" "{{ resource_name }}"
+ register: results
+- name: verify that command succeeded
+ assert:
+ that:
+ - results.rc == 0
+# ----------------------------------------------------------------------------
+- name: create a database that already exists
+ gcp_sql_database:
+ name: "{{ resource_name }}"
+ charset: utf8
+ instance: "{{ instance }}"
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ state: present
+ register: result
+- name: assert changed is false
+ assert:
+ that:
+ - result.changed == false
+ - "result.kind == 'sql#database'"
+#----------------------------------------------------------
+- name: delete a database
+ gcp_sql_database:
+ name: "{{ resource_name }}"
+ charset: utf8
+ instance: "{{ instance }}"
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ state: absent
+ register: result
+- name: assert changed is true
+ assert:
+ that:
+ - result.changed == true
+ - result.has_key('kind') == False
+- name: verify that database was deleted
+ shell: |
+ gcloud sql databases describe --instance='instance-database' --project="{{ gcp_project}}" "{{ resource_name }}"
+ register: results
+ failed_when: results.rc == 0
+- name: verify that command succeeded
+ assert:
+ that:
+ - results.rc == 1
+ - "\"(gcloud.sql.databases.describe) HTTPError 404: Not Found\" in results.stderr"
+# ----------------------------------------------------------------------------
+- name: delete a database that does not exist
+ gcp_sql_database:
+ name: "{{ resource_name }}"
+ charset: utf8
+ instance: "{{ instance }}"
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ state: absent
+ register: result
+- name: assert changed is false
+ assert:
+ that:
+ - result.changed == false
+ - result.has_key('kind') == False
+#---------------------------------------------------------
+# Post-test teardown
+- name: delete a instance
+ gcp_sql_instance:
+ name: "instance-database"
+ settings:
+ ip_configuration:
+ authorized_networks:
+ - name: google dns server
+ value: 8.8.8.8/32
+ tier: db-n1-standard-1
+ region: us-central1
+ project: "{{ gcp_project }}"
+ auth_kind: "{{ gcp_cred_kind }}"
+ service_account_file: "{{ gcp_cred_file }}"
+ state: absent
+ register: instance