mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-04-06 10:50:28 -07:00
321 lines
8.9 KiB
Python
321 lines
8.9 KiB
Python
#!/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 *** Type: MMv1 ***
|
|
#
|
|
# ----------------------------------------------------------------------------
|
|
#
|
|
# 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
|
|
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
|
|
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
|
|
'''
|
|
|
|
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()
|