From 209ca8c0e76d9c130d5c143f82e4c17acdc0a34f Mon Sep 17 00:00:00 2001 From: Alex Stephen Date: Wed, 23 Oct 2019 20:58:53 +0000 Subject: [PATCH] Ansible - RuntimeConfig Variables Signed-off-by: Modular Magician --- README.md | 1 + plugins/modules/gcp_runtimeconfig_variable.py | 321 ++++++++++++++++++ .../gcp_runtimeconfig_variable_info.py | 187 ++++++++++ .../gcp_runtimeconfig_variable/aliases | 2 + .../defaults/main.yml | 2 + .../gcp_runtimeconfig_variable/meta/main.yml | 0 .../tasks/autogen.yml | 132 +++++++ .../gcp_runtimeconfig_variable/tasks/main.yml | 2 + 8 files changed, 647 insertions(+) create mode 100644 plugins/modules/gcp_runtimeconfig_variable.py create mode 100644 plugins/modules/gcp_runtimeconfig_variable_info.py create mode 100644 tests/integration/targets/gcp_runtimeconfig_variable/aliases create mode 100644 tests/integration/targets/gcp_runtimeconfig_variable/defaults/main.yml create mode 100644 tests/integration/targets/gcp_runtimeconfig_variable/meta/main.yml create mode 100644 tests/integration/targets/gcp_runtimeconfig_variable/tasks/autogen.yml create mode 100644 tests/integration/targets/gcp_runtimeconfig_variable/tasks/main.yml diff --git a/README.md b/README.md index 5de7620..c9f2219 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,7 @@ ansible-galaxy collection install google.cloud * Cloud Memorystore Instance (gcp_redis_instance, gcp_redis_instance_facts) * Resource Manager Project (gcp_resourcemanager_project, gcp_resourcemanager_project_facts) * Cloud Runtime Configuration Config (gcp_runtimeconfig_config, gcp_runtimeconfig_config_facts) + * Cloud Runtime Configuration Variable (gcp_runtimeconfig_variable, gcp_runtimeconfig_variable_facts) * Cloud Source Repositories Repository (gcp_sourcerepo_repository, gcp_sourcerepo_repository_facts) * Cloud Spanner Instance (gcp_spanner_instance, gcp_spanner_instance_facts) * Cloud Spanner Database (gcp_spanner_database, gcp_spanner_database_facts) diff --git a/plugins/modules/gcp_runtimeconfig_variable.py b/plugins/modules/gcp_runtimeconfig_variable.py new file mode 100644 index 0000000..fa4c1f6 --- /dev/null +++ b/plugins/modules/gcp_runtimeconfig_variable.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_runtimeconfig_variable +description: +- Describes a single variable within a runtime config resource. +short_description: Creates a GCP Variable +version_added: '2.10' +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 + value: + description: + - The binary value of the variable. Either this or `text` can be set. + required: false + type: str + text: + description: + - The string value of the variable. Either this or `value` can be set. + required: false + type: str + name: + description: + - The name of the variable resource. + required: true + type: str + config: + description: + - The name of the runtime config that this variable belongs to. + required: true + type: str + 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 + 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 +''' + +EXAMPLES = ''' +- name: create a config + google.cloud.gcp_runtimeconfig_config: + name: my-config + description: My config + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + state: present + register: config + +- name: create a variable + google.cloud.gcp_runtimeconfig_variable: + name: prod-variables/hostname + config: my-config + text: example.com + project: test_project + auth_kind: serviceaccount + service_account_file: "/tmp/auth.pem" + state: present +''' + +RETURN = ''' +value: + description: + - The binary value of the variable. Either this or `text` can be set. + returned: success + type: str +text: + description: + - The string value of the variable. Either this or `value` can be set. + returned: success + type: str +name: + description: + - The name of the variable resource. + returned: success + type: str +config: + description: + - The name of the runtime config that this variable belongs to. + returned: success + type: str +''' + +################################################################################ +# Imports +################################################################################ + +from ansible_collections.google.cloud.plugins.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest, replace_resource_dict +import json +import re + +################################################################################ +# Main +################################################################################ + + +def main(): + """Main function""" + + module = GcpModule( + argument_spec=dict( + state=dict(default='present', choices=['present', 'absent'], type='str'), + value=dict(type='str'), + text=dict(type='str'), + name=dict(required=True, type='str'), + config=dict(required=True, type='str'), + ) + ) + + if not module.params['scopes']: + module.params['scopes'] = ['https://www.googleapis.com/auth/cloudruntimeconfig'] + + state = module.params['state'] + + fetch = fetch_resource(module, self_link(module)) + changed = False + + if fetch: + if state == 'present': + if is_different(module, fetch): + update(module, self_link(module)) + fetch = fetch_resource(module, self_link(module)) + changed = True + else: + delete(module, self_link(module)) + fetch = {} + changed = True + else: + if state == 'present': + fetch = create(module, collection(module)) + changed = True + else: + fetch = {} + + fetch.update({'changed': changed}) + + module.exit_json(**fetch) + + +def create(module, link): + auth = GcpSession(module, 'runtimeconfig') + return return_if_object(module, auth.post(link, resource_to_request(module))) + + +def update(module, link): + auth = GcpSession(module, 'runtimeconfig') + return return_if_object(module, auth.put(link, resource_to_request(module))) + + +def delete(module, link): + auth = GcpSession(module, 'runtimeconfig') + return return_if_object(module, auth.delete(link)) + + +def resource_to_request(module): + request = { + u'name': name_pattern(module.params.get('name'), module), + u'config': module.params.get('config'), + u'value': module.params.get('value'), + u'text': module.params.get('text'), + } + request = encode_request(request, module) + 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, allow_not_found=True): + auth = GcpSession(module, 'runtimeconfig') + return return_if_object(module, auth.get(link), allow_not_found) + + +def self_link(module): + return "https://runtimeconfig.googleapis.com/v1beta1/projects/{project}/configs/{config}/variables/{name}".format(**module.params) + + +def collection(module): + return "https://runtimeconfig.googleapis.com/v1beta1/projects/{project}/configs/{config}/variables".format(**module.params) + + +def return_if_object(module, response, 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'value': response.get(u'value'), u'text': response.get(u'text')} + + +def name_pattern(name, module): + if name is None: + return + + regex = r"projects/.*/configs/.*/variables/.*" + + if not re.match(regex, name): + name = "projects/{project}/configs/{config}/variables/{name}".format(**module.params) + + return name + + +# `config` is a useful parameter for declarative syntax, but +# is not a part of the GCP API +def encode_request(request, module): + if 'config' in request: + del request['config'] + return request + + +if __name__ == '__main__': + main() diff --git a/plugins/modules/gcp_runtimeconfig_variable_info.py b/plugins/modules/gcp_runtimeconfig_variable_info.py new file mode 100644 index 0000000..d06e7ee --- /dev/null +++ b/plugins/modules/gcp_runtimeconfig_variable_info.py @@ -0,0 +1,187 @@ +#!/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_runtimeconfig_variable_info +description: +- Gather info for GCP Variable +short_description: Gather info for GCP Variable +version_added: '2.10' +author: Google Inc. (@googlecloudplatform) +requirements: +- python >= 2.6 +- requests >= 2.18.4 +- google-auth >= 1.3.0 +options: + config: + description: + - The name of the runtime config that this variable belongs to. + required: true + type: str + 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 + 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: +- 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: get info on a variable + gcp_runtimeconfig_variable_info: + config: my-config + project: test_project + auth_kind: serviceaccount + service_account_file: "/tmp/auth.pem" +''' + +RETURN = ''' +resources: + description: List of resources + returned: always + type: complex + contains: + value: + description: + - The binary value of the variable. Either this or `text` can be set. + returned: success + type: str + text: + description: + - The string value of the variable. Either this or `value` can be set. + returned: success + type: str + name: + description: + - The name of the variable resource. + returned: success + type: str + config: + description: + - The name of the runtime config that this variable belongs to. + returned: success + type: str +''' + +################################################################################ +# Imports +################################################################################ +from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest +import json + +################################################################################ +# Main +################################################################################ + + +def main(): + module = GcpModule(argument_spec=dict(config=dict(required=True, type='str'))) + + if not module.params['scopes']: + module.params['scopes'] = ['https://www.googleapis.com/auth/cloudruntimeconfig'] + + return_value = {'resources': fetch_list(module, collection(module))} + module.exit_json(**return_value) + + +def collection(module): + return "https://runtimeconfig.googleapis.com/v1beta1/projects/{project}/configs/{config}/variables".format(**module.params) + + +def fetch_list(module, link): + auth = GcpSession(module, 'runtimeconfig') + return auth.list(link, return_if_object, array_name='variables') + + +def return_if_object(module, response): + # 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'])) + + return result + + +if __name__ == "__main__": + main() diff --git a/tests/integration/targets/gcp_runtimeconfig_variable/aliases b/tests/integration/targets/gcp_runtimeconfig_variable/aliases new file mode 100644 index 0000000..9812f01 --- /dev/null +++ b/tests/integration/targets/gcp_runtimeconfig_variable/aliases @@ -0,0 +1,2 @@ +cloud/gcp +unsupported diff --git a/tests/integration/targets/gcp_runtimeconfig_variable/defaults/main.yml b/tests/integration/targets/gcp_runtimeconfig_variable/defaults/main.yml new file mode 100644 index 0000000..ba66644 --- /dev/null +++ b/tests/integration/targets/gcp_runtimeconfig_variable/defaults/main.yml @@ -0,0 +1,2 @@ +--- +resource_name: "{{ resource_prefix }}" diff --git a/tests/integration/targets/gcp_runtimeconfig_variable/meta/main.yml b/tests/integration/targets/gcp_runtimeconfig_variable/meta/main.yml new file mode 100644 index 0000000..e69de29 diff --git a/tests/integration/targets/gcp_runtimeconfig_variable/tasks/autogen.yml b/tests/integration/targets/gcp_runtimeconfig_variable/tasks/autogen.yml new file mode 100644 index 0000000..a10f25b --- /dev/null +++ b/tests/integration/targets/gcp_runtimeconfig_variable/tasks/autogen.yml @@ -0,0 +1,132 @@ +--- +# ---------------------------------------------------------------------------- +# +# *** 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 config + google.cloud.gcp_runtimeconfig_config: + name: my-config + description: My config + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + state: present + register: config +- name: delete a variable + google.cloud.gcp_runtimeconfig_variable: + name: prod-variables/hostname + config: my-config + text: example.com + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + state: absent +#---------------------------------------------------------- +- name: create a variable + google.cloud.gcp_runtimeconfig_variable: + name: prod-variables/hostname + config: my-config + text: example.com + 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 +- name: verify that variable was created + google.cloud.gcp_runtimeconfig_variable_info: + config: my-config + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + scopes: + - https://www.googleapis.com/auth/cloudruntimeconfig + register: results +- name: verify that command succeeded + assert: + that: + - results['resources'] | map(attribute='name') | select("match", ".*prod-variables/hostname.*") | list | length == 1 +# ---------------------------------------------------------------------------- +- name: create a variable that already exists + google.cloud.gcp_runtimeconfig_variable: + name: prod-variables/hostname + config: my-config + text: example.com + 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 +#---------------------------------------------------------- +- name: delete a variable + google.cloud.gcp_runtimeconfig_variable: + name: prod-variables/hostname + config: my-config + text: example.com + 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 +- name: verify that variable was deleted + google.cloud.gcp_runtimeconfig_variable_info: + config: my-config + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + scopes: + - https://www.googleapis.com/auth/cloudruntimeconfig + register: results +- name: verify that command succeeded + assert: + that: + - results['resources'] | map(attribute='name') | select("match", ".*prod-variables/hostname.*") | list | length == 0 +# ---------------------------------------------------------------------------- +- name: delete a variable that does not exist + google.cloud.gcp_runtimeconfig_variable: + name: prod-variables/hostname + config: my-config + text: example.com + 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 +#--------------------------------------------------------- +# Post-test teardown +# If errors happen, don't crash the playbook! +- name: delete a config + google.cloud.gcp_runtimeconfig_config: + name: my-config + description: My config + project: "{{ gcp_project }}" + auth_kind: "{{ gcp_cred_kind }}" + service_account_file: "{{ gcp_cred_file }}" + state: absent + register: config + ignore_errors: true diff --git a/tests/integration/targets/gcp_runtimeconfig_variable/tasks/main.yml b/tests/integration/targets/gcp_runtimeconfig_variable/tasks/main.yml new file mode 100644 index 0000000..45d6e49 --- /dev/null +++ b/tests/integration/targets/gcp_runtimeconfig_variable/tasks/main.yml @@ -0,0 +1,2 @@ +--- +- include_tasks: autogen.yml