mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Memset: initial module, integration tests, module_utils and supporting documentation. (#40071)
* * Memset: * module_utils and associated documentation. * module to manage DNS zones. * integration tests to run against Memset's API. * * memset.py: * remove import of requests from memset.py in favour of internal Ansible modules. * import necessary Ansible modules for request and response handling. * create a response object in order to retain a stable interface to memset_api_call from existing modules. * rework memset_api_call to remove requests. * memset_zone.py: * improve short description to be more verbose. * ensure all imports directly follow documentation. * remove any reference to requests. * correct keyerror carried over from elsewhere. * remove dependency on requests from documentation string * disable integration tests until we have a cleanup method available
This commit is contained in:
parent
9e3ad96fa9
commit
fb6ae90f60
8 changed files with 600 additions and 0 deletions
|
@ -23,6 +23,7 @@ The following is a list of module_utils files and a general description. The mod
|
||||||
- keycloak.py - Definitions and helper functions for modules working with the Keycloak API
|
- keycloak.py - Definitions and helper functions for modules working with the Keycloak API
|
||||||
- known_hosts.py - utilities for working with known_hosts file
|
- known_hosts.py - utilities for working with known_hosts file
|
||||||
- manageiq.py - Functions and utilities for modules that work with ManageIQ platform and its resources.
|
- manageiq.py - Functions and utilities for modules that work with ManageIQ platform and its resources.
|
||||||
|
- memset.py - Helper functions and utilities for interacting with Memset's API.
|
||||||
- mysql.py - Allows modules to connect to a MySQL instance
|
- mysql.py - Allows modules to connect to a MySQL instance
|
||||||
- netapp.py - Functions and utilities for modules that work with the NetApp storage platforms.
|
- netapp.py - Functions and utilities for modules that work with the NetApp storage platforms.
|
||||||
- network/a10/a10.py - Utilities used by the a10_server module to manage A10 Networks devices.
|
- network/a10/a10.py - Utilities used by the a10_server module to manage A10 Networks devices.
|
||||||
|
|
155
lib/ansible/module_utils/memset.py
Normal file
155
lib/ansible/module_utils/memset.py
Normal file
|
@ -0,0 +1,155 @@
|
||||||
|
# This code is part of Ansible, but is an independent component.
|
||||||
|
# This particular file snippet, and this file snippet only, is BSD licensed.
|
||||||
|
# Modules you write using this snippet, which is embedded dynamically by Ansible
|
||||||
|
# still belong to the author of the module, and may assign their own license
|
||||||
|
# to the complete work.
|
||||||
|
#
|
||||||
|
# Copyright (c) 2018, Simon Weald <ansible@simonweald.com>
|
||||||
|
#
|
||||||
|
# Redistribution and use in source and binary forms, with or without modification,
|
||||||
|
# are permitted provided that the following conditions are met:
|
||||||
|
#
|
||||||
|
# * Redistributions of source code must retain the above copyright
|
||||||
|
# notice, this list of conditions and the following disclaimer.
|
||||||
|
# * Redistributions in binary form must reproduce the above copyright notice,
|
||||||
|
# this list of conditions and the following disclaimer in the documentation
|
||||||
|
# and/or other materials provided with the distribution.
|
||||||
|
#
|
||||||
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||||
|
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||||
|
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
||||||
|
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||||||
|
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||||
|
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
|
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
||||||
|
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
from ansible.module_utils.six.moves.urllib.parse import urlencode
|
||||||
|
from ansible.module_utils.urls import open_url, urllib_error
|
||||||
|
from ansible.module_utils.basic import json
|
||||||
|
|
||||||
|
|
||||||
|
class Response(object):
|
||||||
|
'''
|
||||||
|
Create a response object to mimic that of requests.
|
||||||
|
'''
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.content = None
|
||||||
|
self.status_code = None
|
||||||
|
|
||||||
|
def json(self):
|
||||||
|
return json.loads(self.content)
|
||||||
|
|
||||||
|
|
||||||
|
def memset_api_call(api_key, api_method, payload=None):
|
||||||
|
'''
|
||||||
|
Generic function which returns results back to calling function.
|
||||||
|
|
||||||
|
Requires an API key and an API method to assemble the API URL.
|
||||||
|
Returns response text to be analysed.
|
||||||
|
'''
|
||||||
|
# instantiate a response object
|
||||||
|
response = Response()
|
||||||
|
|
||||||
|
# if we've already started preloading the payload then copy it
|
||||||
|
# and use that, otherwise we need to isntantiate it.
|
||||||
|
if payload is None:
|
||||||
|
payload = dict()
|
||||||
|
else:
|
||||||
|
payload = payload.copy()
|
||||||
|
|
||||||
|
payload['api_key'] = api_key
|
||||||
|
# set some sane defaults
|
||||||
|
has_failed = False
|
||||||
|
msg = None
|
||||||
|
|
||||||
|
data = urlencode(payload)
|
||||||
|
headers = {'Content-Type': 'application/x-www-form-urlencoded'}
|
||||||
|
api_uri_base = 'https://api.memset.com/v1/json/'
|
||||||
|
api_uri = '{0}{1}/' . format(api_uri_base, api_method)
|
||||||
|
|
||||||
|
try:
|
||||||
|
resp = open_url(api_uri, data=data, headers=headers, method="POST")
|
||||||
|
response.content = resp.read().decode('utf-8')
|
||||||
|
response.status_code = resp.getcode()
|
||||||
|
except urllib_error.HTTPError as e:
|
||||||
|
try:
|
||||||
|
errorcode = e.code
|
||||||
|
except AttributeError:
|
||||||
|
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
|
||||||
|
|
||||||
|
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'])
|
||||||
|
else:
|
||||||
|
msg = "Memset API returned an error ({0}, {1})." . format(error_json['error_type'], error_json['error'])
|
||||||
|
|
||||||
|
del payload['api_key']
|
||||||
|
|
||||||
|
if msg is None:
|
||||||
|
msg = response.json()
|
||||||
|
|
||||||
|
return(has_failed, msg, response)
|
||||||
|
|
||||||
|
|
||||||
|
def check_zone_domain(data, domain):
|
||||||
|
'''
|
||||||
|
Returns true if domain already exists, and false if not.
|
||||||
|
'''
|
||||||
|
exists = False
|
||||||
|
|
||||||
|
if data.status_code in [201, 200]:
|
||||||
|
for zone_domain in data.json():
|
||||||
|
if zone_domain['domain'] == domain:
|
||||||
|
exists = True
|
||||||
|
|
||||||
|
return(exists)
|
||||||
|
|
||||||
|
|
||||||
|
def check_zone(data, name):
|
||||||
|
'''
|
||||||
|
Returns true if zone already exists, and false if not.
|
||||||
|
'''
|
||||||
|
counter = 0
|
||||||
|
exists = False
|
||||||
|
|
||||||
|
if data.status_code in [201, 200]:
|
||||||
|
for zone in data.json():
|
||||||
|
if zone['nickname'] == name:
|
||||||
|
counter += 1
|
||||||
|
if counter == 1:
|
||||||
|
exists = True
|
||||||
|
|
||||||
|
return(exists, counter)
|
||||||
|
|
||||||
|
|
||||||
|
def get_zone_id(zone_name, current_zones):
|
||||||
|
'''
|
||||||
|
Returns the zone's id if it exists and is unique
|
||||||
|
'''
|
||||||
|
zone_exists = False
|
||||||
|
zone_id, msg = None, None
|
||||||
|
zone_list = []
|
||||||
|
|
||||||
|
for zone in current_zones:
|
||||||
|
if zone['nickname'] == zone_name:
|
||||||
|
zone_list.append(zone['id'])
|
||||||
|
|
||||||
|
counter = len(zone_list)
|
||||||
|
|
||||||
|
if counter == 0:
|
||||||
|
msg = 'No matching zone found'
|
||||||
|
elif counter == 1:
|
||||||
|
zone_id = zone_list[0]
|
||||||
|
zone_exists = True
|
||||||
|
elif counter > 1:
|
||||||
|
zone_id = None
|
||||||
|
msg = 'Zone ID could not be returned as duplicate zone names were detected'
|
||||||
|
|
||||||
|
return(zone_exists, msg, counter, zone_id)
|
0
lib/ansible/modules/cloud/memset/__init__.py
Normal file
0
lib/ansible/modules/cloud/memset/__init__.py
Normal file
316
lib/ansible/modules/cloud/memset/memset_zone.py
Normal file
316
lib/ansible/modules/cloud/memset/memset_zone.py
Normal file
|
@ -0,0 +1,316 @@
|
||||||
|
#!/usr/bin/python
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# Copyright (c) 2018, Simon Weald <ansible@simonweald.com>
|
||||||
|
# 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_zone
|
||||||
|
author: "Simon Weald (@analbeard)"
|
||||||
|
version_added: "2.6"
|
||||||
|
short_description: Creates and deletes Memset DNS zones.
|
||||||
|
notes:
|
||||||
|
- Zones can be thought of as a logical group of domains, all of which share the
|
||||||
|
same DNS records (i.e. they point to the same IP). An API key generated via the
|
||||||
|
Memset customer control panel is needed with the following minimum scope -
|
||||||
|
I(dns.zone_create), I(dns.zone_delete), I(dns.zone_list).
|
||||||
|
description:
|
||||||
|
- Manage DNS zones in a Memset account.
|
||||||
|
options:
|
||||||
|
state:
|
||||||
|
required: true
|
||||||
|
description:
|
||||||
|
- Indicates desired state of resource.
|
||||||
|
choices: [ absent, present ]
|
||||||
|
api_key:
|
||||||
|
required: true
|
||||||
|
description:
|
||||||
|
- The API key obtained from the Memset control panel.
|
||||||
|
name:
|
||||||
|
required: true
|
||||||
|
description:
|
||||||
|
- The zone nickname; usually the same as the main domain. Ensure this
|
||||||
|
value has at most 250 characters.
|
||||||
|
aliases: [ nickname ]
|
||||||
|
ttl:
|
||||||
|
description:
|
||||||
|
- The default TTL for all records created in the zone. This must be a
|
||||||
|
valid int from U(https://www.memset.com/apidocs/methods_dns.html#dns.zone_create).
|
||||||
|
choices: [ 0, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400 ]
|
||||||
|
force:
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: bool
|
||||||
|
description:
|
||||||
|
- Forces deletion of a zone and all zone domains/zone records it contains.
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLES = '''
|
||||||
|
# Create the zone 'test'
|
||||||
|
- name: create zone
|
||||||
|
memset_zone:
|
||||||
|
name: test
|
||||||
|
state: present
|
||||||
|
api_key: 5eb86c9196ab03919abcf03857163741
|
||||||
|
ttl: 300
|
||||||
|
delegate_to: localhost
|
||||||
|
|
||||||
|
# Force zone deletion
|
||||||
|
- name: force delete zone
|
||||||
|
memset_zone:
|
||||||
|
name: test
|
||||||
|
state: absent
|
||||||
|
api_key: 5eb86c9196ab03919abcf03857163741
|
||||||
|
force: true
|
||||||
|
delegate_to: localhost
|
||||||
|
'''
|
||||||
|
|
||||||
|
RETURN = '''
|
||||||
|
memset_api:
|
||||||
|
description: Zone info from the Memset API
|
||||||
|
returned: when state == present
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
domains:
|
||||||
|
description: List of domains in this zone
|
||||||
|
returned: always
|
||||||
|
type: list
|
||||||
|
sample: []
|
||||||
|
id:
|
||||||
|
description: Zone id
|
||||||
|
returned: always
|
||||||
|
type: string
|
||||||
|
sample: "b0bb1ce851aeea6feeb2dc32fe83bf9c"
|
||||||
|
nickname:
|
||||||
|
description: Zone name
|
||||||
|
returned: always
|
||||||
|
type: string
|
||||||
|
sample: "example.com"
|
||||||
|
records:
|
||||||
|
description: List of DNS records for domains in this zone
|
||||||
|
returned: always
|
||||||
|
type: list
|
||||||
|
sample: []
|
||||||
|
ttl:
|
||||||
|
description: Default TTL for domains in this zone
|
||||||
|
returned: always
|
||||||
|
type: int
|
||||||
|
sample: 300
|
||||||
|
'''
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
from ansible.module_utils.memset import check_zone
|
||||||
|
from ansible.module_utils.memset import get_zone_id
|
||||||
|
from ansible.module_utils.memset import memset_api_call
|
||||||
|
|
||||||
|
|
||||||
|
def api_validation(args=None):
|
||||||
|
'''
|
||||||
|
Perform some validation which will be enforced by Memset's API (see:
|
||||||
|
https://www.memset.com/apidocs/methods_dns.html#dns.zone_record_create)
|
||||||
|
'''
|
||||||
|
# zone domain length must be less than 250 chars.
|
||||||
|
if len(args['name']) > 250:
|
||||||
|
stderr = 'Zone name must be less than 250 characters in length.'
|
||||||
|
module.fail_json(failed=True, msg=stderr, stderr=stderr)
|
||||||
|
|
||||||
|
|
||||||
|
def check(args=None):
|
||||||
|
'''
|
||||||
|
Support for running with check mode.
|
||||||
|
'''
|
||||||
|
retvals = dict()
|
||||||
|
|
||||||
|
api_method = 'dns.zone_list'
|
||||||
|
has_failed, _msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method)
|
||||||
|
|
||||||
|
zone_exists, counter = check_zone(data=response, name=args['name'])
|
||||||
|
|
||||||
|
# set changed to true if the operation would cause a change.
|
||||||
|
has_changed = ((zone_exists and args['state'] == 'absent') or (not zone_exists and args['state'] == 'present'))
|
||||||
|
|
||||||
|
retvals['changed'] = has_changed
|
||||||
|
retvals['failed'] = has_failed
|
||||||
|
|
||||||
|
return(retvals)
|
||||||
|
|
||||||
|
|
||||||
|
def create_zone(args=None, zone_exists=None, payload=None):
|
||||||
|
'''
|
||||||
|
At this point we already know whether the zone exists, so we
|
||||||
|
just need to make the API reflect the desired state.
|
||||||
|
'''
|
||||||
|
has_changed, has_failed = False, False
|
||||||
|
msg, memset_api = None, None
|
||||||
|
|
||||||
|
if not zone_exists:
|
||||||
|
payload['ttl'] = args['ttl']
|
||||||
|
payload['nickname'] = args['name']
|
||||||
|
api_method = 'dns.zone_create'
|
||||||
|
has_failed, msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method, payload=payload)
|
||||||
|
if not has_failed:
|
||||||
|
has_changed = True
|
||||||
|
else:
|
||||||
|
api_method = 'dns.zone_list'
|
||||||
|
_has_failed, _msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method)
|
||||||
|
for zone in response.json():
|
||||||
|
if zone['nickname'] == args['name']:
|
||||||
|
break
|
||||||
|
if zone['ttl'] != args['ttl']:
|
||||||
|
# update the zone if the desired TTL is different.
|
||||||
|
payload['id'] = zone['id']
|
||||||
|
payload['ttl'] = args['ttl']
|
||||||
|
api_method = 'dns.zone_update'
|
||||||
|
has_failed, msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method, payload=payload)
|
||||||
|
if not has_failed:
|
||||||
|
has_changed = True
|
||||||
|
|
||||||
|
# populate return var with zone info.
|
||||||
|
api_method = 'dns.zone_list'
|
||||||
|
_has_failed, _msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method)
|
||||||
|
|
||||||
|
zone_exists, msg, counter, zone_id = get_zone_id(zone_name=args['name'], current_zones=response.json())
|
||||||
|
|
||||||
|
if zone_exists:
|
||||||
|
payload = dict()
|
||||||
|
payload['id'] = zone_id
|
||||||
|
api_method = 'dns.zone_info'
|
||||||
|
_has_failed, _msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method, payload=payload)
|
||||||
|
memset_api = response.json()
|
||||||
|
else:
|
||||||
|
msg = msg
|
||||||
|
|
||||||
|
return(has_failed, has_changed, memset_api, msg)
|
||||||
|
|
||||||
|
|
||||||
|
def delete_zone(args=None, zone_exists=None, payload=None):
|
||||||
|
'''
|
||||||
|
Deletion requires extra sanity checking as the zone cannot be
|
||||||
|
deleted if it contains domains or records. Setting force=true
|
||||||
|
will override this behaviour.
|
||||||
|
'''
|
||||||
|
has_changed, has_failed = False, False
|
||||||
|
msg, memset_api = None, None
|
||||||
|
|
||||||
|
if zone_exists:
|
||||||
|
api_method = 'dns.zone_list'
|
||||||
|
_has_failed, _msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method, payload=payload)
|
||||||
|
counter = 0
|
||||||
|
for zone in response.json():
|
||||||
|
if zone['nickname'] == args['name']:
|
||||||
|
counter += 1
|
||||||
|
if counter == 1:
|
||||||
|
for zone in response.json():
|
||||||
|
if zone['nickname'] == args['name']:
|
||||||
|
zone_id = zone['id']
|
||||||
|
domain_count = len(zone['domains'])
|
||||||
|
record_count = len(zone['records'])
|
||||||
|
if (domain_count > 0 or record_count > 0) and args['force'] is False:
|
||||||
|
# we need to fail out if force was not explicitly set.
|
||||||
|
stderr = 'Zone contains domains or records and force was not used.'
|
||||||
|
has_failed = True
|
||||||
|
has_changed = False
|
||||||
|
module.fail_json(failed=has_failed, changed=has_changed, msg=msg, stderr=stderr, rc=1)
|
||||||
|
api_method = 'dns.zone_delete'
|
||||||
|
payload['id'] = zone_id
|
||||||
|
has_failed, msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method, payload=payload)
|
||||||
|
if not has_failed:
|
||||||
|
has_changed = True
|
||||||
|
# return raw JSON from API in named var and then unset msg var so we aren't returning the same thing twice.
|
||||||
|
memset_api = msg
|
||||||
|
msg = None
|
||||||
|
else:
|
||||||
|
# zone names are not unique, so we cannot safely delete the requested
|
||||||
|
# zone at this time.
|
||||||
|
has_failed = True
|
||||||
|
has_changed = False
|
||||||
|
msg = 'Unable to delete zone as multiple zones with the same name exist.'
|
||||||
|
else:
|
||||||
|
has_failed, has_changed = False, False
|
||||||
|
|
||||||
|
return(has_failed, has_changed, memset_api, msg)
|
||||||
|
|
||||||
|
|
||||||
|
def create_or_delete(args=None):
|
||||||
|
'''
|
||||||
|
We need to perform some initial sanity checking and also look
|
||||||
|
up required info before handing it off to create or delete.
|
||||||
|
'''
|
||||||
|
retvals, payload = dict(), dict()
|
||||||
|
has_failed, has_changed = False, False
|
||||||
|
msg, memset_api, stderr = None, None, None
|
||||||
|
|
||||||
|
# get the zones and check if the relevant zone exists.
|
||||||
|
api_method = 'dns.zone_list'
|
||||||
|
_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['msg'] = _msg
|
||||||
|
|
||||||
|
return(retvals)
|
||||||
|
|
||||||
|
zone_exists, _msg, counter, _zone_id = get_zone_id(zone_name=args['name'], current_zones=response.json())
|
||||||
|
|
||||||
|
if args['state'] == 'present':
|
||||||
|
has_failed, has_changed, memset_api, msg = create_zone(args=args, zone_exists=zone_exists, payload=payload)
|
||||||
|
|
||||||
|
elif args['state'] == 'absent':
|
||||||
|
has_failed, has_changed, memset_api, msg = delete_zone(args=args, zone_exists=zone_exists, payload=payload)
|
||||||
|
|
||||||
|
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(
|
||||||
|
state=dict(required=True, choices=['present', 'absent'], type='str'),
|
||||||
|
api_key=dict(required=True, type='str', no_log=True),
|
||||||
|
name=dict(required=True, aliases=['nickname'], type='str'),
|
||||||
|
ttl=dict(required=False, default=0, choices=[0, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400], type='int'),
|
||||||
|
force=dict(required=False, default=False, type='bool')
|
||||||
|
),
|
||||||
|
supports_check_mode=True
|
||||||
|
)
|
||||||
|
|
||||||
|
# populate the dict with the user-provided vars.
|
||||||
|
args = dict()
|
||||||
|
for key, arg in module.params.items():
|
||||||
|
args[key] = arg
|
||||||
|
args['check_mode'] = module.check_mode
|
||||||
|
|
||||||
|
# validate some API-specific limitations.
|
||||||
|
api_validation(args=args)
|
||||||
|
|
||||||
|
if module.check_mode:
|
||||||
|
retvals = check(args)
|
||||||
|
else:
|
||||||
|
retvals = create_or_delete(args)
|
||||||
|
|
||||||
|
if retvals['failed']:
|
||||||
|
module.fail_json(**retvals)
|
||||||
|
else:
|
||||||
|
module.exit_json(**retvals)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
1
test/integration/targets/memset_zone/aliases
Normal file
1
test/integration/targets/memset_zone/aliases
Normal file
|
@ -0,0 +1 @@
|
||||||
|
unsupported
|
1
test/integration/targets/memset_zone/meta/main.yml
Normal file
1
test/integration/targets/memset_zone/meta/main.yml
Normal file
|
@ -0,0 +1 @@
|
||||||
|
---
|
124
test/integration/targets/memset_zone/tasks/main.yml
Normal file
124
test/integration/targets/memset_zone/tasks/main.yml
Normal file
|
@ -0,0 +1,124 @@
|
||||||
|
---
|
||||||
|
- name: create random string
|
||||||
|
set_fact:
|
||||||
|
zone_name: "{{ 65535 | random | string }}.ansible.example.com"
|
||||||
|
|
||||||
|
- name: create zone with incorrect API key
|
||||||
|
local_action:
|
||||||
|
module: memset_zone
|
||||||
|
api_key: "wa9aerahhie0eekee9iaphoorovooyia"
|
||||||
|
state: present
|
||||||
|
name: "{{ zone_name }}"
|
||||||
|
ttl: 300
|
||||||
|
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: test creating zone
|
||||||
|
local_action:
|
||||||
|
module: memset_zone
|
||||||
|
api_key: "{{ api_key }}"
|
||||||
|
state: present
|
||||||
|
name: "{{ zone_name }}"
|
||||||
|
ttl: 300
|
||||||
|
check_mode: true
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: check if the zone would be created
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- result is changed
|
||||||
|
- result is successful
|
||||||
|
|
||||||
|
- name: create zone
|
||||||
|
local_action:
|
||||||
|
module: memset_zone
|
||||||
|
api_key: "{{ api_key }}"
|
||||||
|
state: present
|
||||||
|
name: "{{ zone_name }}"
|
||||||
|
ttl: 300
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: create the zone
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- result is changed
|
||||||
|
- result is successful
|
||||||
|
|
||||||
|
- name: create duplicate zone
|
||||||
|
local_action:
|
||||||
|
module: memset_zone
|
||||||
|
api_key: "{{ api_key }}"
|
||||||
|
state: present
|
||||||
|
name: "{{ zone_name }}"
|
||||||
|
ttl: 300
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: ensure we can't create duplicate zones
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- result is not changed
|
||||||
|
|
||||||
|
- name: test deleting zone
|
||||||
|
local_action:
|
||||||
|
module: memset_zone
|
||||||
|
api_key: "{{ api_key }}"
|
||||||
|
state: absent
|
||||||
|
name: "{{ zone_name }}"
|
||||||
|
check_mode: true
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: check if the zone would be deleted
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- result is changed
|
||||||
|
- result is successful
|
||||||
|
|
||||||
|
- name: delete empty zone
|
||||||
|
local_action:
|
||||||
|
module: memset_zone
|
||||||
|
api_key: "{{ api_key }}"
|
||||||
|
state: absent
|
||||||
|
name: "{{ zone_name }}"
|
||||||
|
force: false
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: delete the zone
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- result is changed
|
||||||
|
- result is successful
|
||||||
|
|
||||||
|
- name: create zone for deletion test
|
||||||
|
local_action:
|
||||||
|
module: memset_zone
|
||||||
|
api_key: "{{ api_key }}"
|
||||||
|
state: present
|
||||||
|
name: "{{ zone_name }}"
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: ensure we can't create duplicate zones
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- result is changed
|
||||||
|
- result is successful
|
||||||
|
|
||||||
|
- name: delete zone with force
|
||||||
|
local_action:
|
||||||
|
module: memset_zone
|
||||||
|
api_key: "{{ api_key }}"
|
||||||
|
state: absent
|
||||||
|
name: "{{ zone_name }}"
|
||||||
|
force: true
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: ensure force is respected
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- result is changed
|
||||||
|
- result is successful
|
2
test/integration/targets/memset_zone/vars/main.yml
Normal file
2
test/integration/targets/memset_zone/vars/main.yml
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
---
|
||||||
|
random_string: "baiqui8ci6miedoo9eivohJ0aixei7oo"
|
Loading…
Reference in a new issue