diff --git a/lib/ansible/module_utils/memset.py b/lib/ansible/module_utils/memset.py index a156c401aa7..13a4cbf40ba 100644 --- a/lib/ansible/module_utils/memset.py +++ b/lib/ansible/module_utils/memset.py @@ -81,14 +81,13 @@ def memset_api_call(api_key, api_method, payload=None): errorcode = None has_failed = True - error_json = json.loads(e.read().decode('utf-8')) response.content = e.read().decode('utf8') - response.status_code = e.code + response.status_code = errorcode if response.status_code is not None: - msg = "Memset API returned a {0} response ({1}, {2})." . format(response.status_code, error_json['error_type'], error_json['error']) + msg = "Memset API returned a {0} response ({1}, {2})." . format(response.status_code, response.json()['error_type'], response.json()['error']) else: - msg = "Memset API returned an error ({0}, {1})." . format(error_json['error_type'], error_json['error']) + msg = "Memset API returned an error ({0}, {1})." . format(response.json()['error_type'], response.json()['error']) del payload['api_key'] diff --git a/lib/ansible/modules/cloud/memset/memset_dns_reload.py b/lib/ansible/modules/cloud/memset/memset_dns_reload.py new file mode 100644 index 00000000000..0705a090537 --- /dev/null +++ b/lib/ansible/modules/cloud/memset/memset_dns_reload.py @@ -0,0 +1,190 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# +# Copyright (c) 2018, Simon Weald +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +ANSIBLE_METADATA = { + 'metadata_version': '1.1', + 'status': ['preview'], + 'supported_by': 'community' +} + +DOCUMENTATION = ''' +--- +module: memset_dns_reload +author: "Simon Weald (@analbeard)" +version_added: "2.6" +short_description: Request reload of Memset's DNS infrastructure, +notes: + - DNS reload requests are a best-effort service provided by Memset; these generally + happen every 15 minutes by default, however you can request an immediate reload if + later tasks rely on the records being created. An API key generated via the + Memset customer control panel is required with the following minimum scope - + I(dns.reload). If you wish to poll the job status to wait until the reload has + completed, then I(job.status) is also required. +description: + - Request a reload of Memset's DNS infrastructure, and optionally poll until it finishes. +options: + api_key: + required: true + description: + - The API key obtained from the Memset control panel. + poll: + default: false + type: bool + description: + - Boolean value, if set will poll the reload job's status and return + when the job has completed (unless the 30 second timeout is reached first). + If the timeout is reached then the task will not be marked as failed, but + stderr will indicate that the polling failed. +''' + +EXAMPLES = ''' +- name: submit DNS reload and poll. + memset_dns_reload: + api_key: 5eb86c9196ab03919abcf03857163741 + poll: True + delegate_to: localhost +''' + +RETURN = ''' +--- +memset_api: + description: Raw response from the Memset API. + returned: always + type: complex + contains: + error: + description: Whether the job ended in error state. + returned: always + type: bool + sample: true + finished: + description: Whether the job completed before the result was returned. + returned: always + type: bool + sample: true + id: + description: Job ID. + returned: always + type: string + sample: "c9cc8ad2a3e3fb8c63ed83c424928ef8" + status: + description: Job status. + returned: always + type: string + sample: "DONE" + type: + description: Job type. + returned: always + type: string + sample: "dns" +''' + +from time import sleep + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.memset import memset_api_call + + +def poll_reload_status(api_key=None, job_id=None, payload=None): + ''' + We poll the `job.status` endpoint every 5 seconds up to a + maximum of 6 times. This is a relatively arbitrary choice of + timeout, however requests rarely take longer than 15 seconds + to complete. + ''' + memset_api, stderr, msg = None, None, None + payload['id'] = job_id + + api_method = 'job.status' + _has_failed, _msg, response = memset_api_call(api_key=api_key, api_method=api_method, payload=payload) + + while not response.json()['finished']: + counter = 0 + while counter < 6: + sleep(5) + _has_failed, msg, response = memset_api_call(api_key=api_key, api_method=api_method, payload=payload) + counter += 1 + if response.json()['error']: + # the reload job was submitted but polling failed. Don't return this as an overall task failure. + stderr = "Reload submitted successfully, but the Memset API returned a job error when attempting to poll the reload status." + msg = msg + else: + memset_api = response.json() + msg = None + + return(memset_api, msg, stderr) + + +def reload_dns(args=None): + ''' + DNS reloads are a single API call and therefore there's not much + which can go wrong outside of auth errors. + ''' + retvals, payload = dict(), dict() + has_changed, has_failed = False, False + memset_api, msg, stderr = None, None, None + + api_method = 'dns.reload' + has_failed, msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method) + + if has_failed: + # this is the first time the API is called; incorrect credentials will + # manifest themselves at this point so we need to ensure the user is + # informed of the reason. + retvals['failed'] = has_failed + retvals['memset_api'] = response.json() + retvals['msg'] = msg + return(retvals) + + # set changed to true if the reload request was accepted. + has_changed = True + memset_api = msg + # empty msg var as we don't want to return the API's json response twice. + msg = None + + if args['poll']: + # hand off to the poll function. + job_id = response.json()['id'] + memset_api, msg, stderr = poll_reload_status(api_key=args['api_key'], job_id=job_id, payload=payload) + + # assemble return variables. + retvals['failed'] = has_failed + retvals['changed'] = has_changed + for val in ['msg', 'stderr', 'memset_api']: + if val is not None: + retvals[val] = eval(val) + + return(retvals) + + +def main(): + global module + module = AnsibleModule( + argument_spec=dict( + api_key=dict(required=True, type='str', no_log=True), + poll=dict(required=False, default=False, type='bool') + ), + supports_check_mode=False + ) + + # populate the dict with the user-provided vars. + args = dict() + for key, arg in module.params.items(): + args[key] = arg + + retvals = reload_dns(args) + + if retvals['failed']: + module.fail_json(**retvals) + else: + module.exit_json(**retvals) + + +if __name__ == '__main__': + main() diff --git a/test/integration/targets/memset_dns_reload/aliases b/test/integration/targets/memset_dns_reload/aliases new file mode 100644 index 00000000000..ad7ccf7ada2 --- /dev/null +++ b/test/integration/targets/memset_dns_reload/aliases @@ -0,0 +1 @@ +unsupported diff --git a/test/integration/targets/memset_dns_reload/meta/main.yml b/test/integration/targets/memset_dns_reload/meta/main.yml new file mode 100644 index 00000000000..73b314ff7c7 --- /dev/null +++ b/test/integration/targets/memset_dns_reload/meta/main.yml @@ -0,0 +1 @@ +--- \ No newline at end of file diff --git a/test/integration/targets/memset_dns_reload/tasks/main.yml b/test/integration/targets/memset_dns_reload/tasks/main.yml new file mode 100644 index 00000000000..e7782655939 --- /dev/null +++ b/test/integration/targets/memset_dns_reload/tasks/main.yml @@ -0,0 +1,26 @@ +--- +- name: request reload with invalid API key + local_action: + module: memset_dns_reload + api_key: "wa9aerahhie0eekee9iaphoorovooyia" + ignore_errors: true + register: result + +- name: check API response with invalid API key + assert: + that: + - "'Memset API returned a 403 response (ApiErrorForbidden, Bad api_key)' in result.msg" + - result is not successful + +- name: request reload and poll + local_action: + module: memset_dns_reload + api_key: "{{ api_key }}" + poll: true + register: result + +- name: check reload succeeded + assert: + that: + - result is changed + - result is successful