use module.fail_json to report import errors. document valid duration units

This commit is contained in:
Steve Gargan 2015-04-27 13:40:21 +01:00 committed by Matt Clay
parent e1ff0feb58
commit 366f163495
4 changed files with 78 additions and 32 deletions

View file

@ -37,6 +37,9 @@ description:
result this does not attempt to determine changes and will always report a result this does not attempt to determine changes and will always report a
changed occurred. An api method is planned to supply this metadata so at that changed occurred. An api method is planned to supply this metadata so at that
stage change management will be added. stage change management will be added.
requirements:
- python-consul
- requests
version_added: "1.9" version_added: "1.9"
author: Steve Gargan (steve.gargan@gmail.com) author: Steve Gargan (steve.gargan@gmail.com)
options: options:
@ -172,12 +175,10 @@ except ImportError:
try: try:
import consul import consul
from requests.exceptions import ConnectionError
python_consul_installed = True
except ImportError, e: except ImportError, e:
print "failed=True msg='python-consul required for this module. "\ python_consul_installed = False
"see http://python-consul.readthedocs.org/en/latest/#installation'"
sys.exit(1)
from requests.exceptions import ConnectionError
def register_with_consul(module): def register_with_consul(module):
@ -462,6 +463,10 @@ class ConsulCheck():
except: except:
pass pass
def test_dependencies(module):
if not python_consul_installed:
module.fail_json(msg="python-consul required for this module. "\
"see http://python-consul.readthedocs.org/en/latest/#installation")
def main(): def main():
module = AnsibleModule( module = AnsibleModule(
@ -485,6 +490,9 @@ def main():
), ),
supports_check_mode=False, supports_check_mode=False,
) )
test_dependencies(module)
try: try:
register_with_consul(module) register_with_consul(module)
except ConnectionError, e: except ConnectionError, e:

View file

@ -23,7 +23,11 @@ short_description: "manipulate consul acl keys and rules"
description: description:
- allows the addition, modification and deletion of ACL keys and associated - allows the addition, modification and deletion of ACL keys and associated
rules in a consul cluster via the agent. For more details on using and rules in a consul cluster via the agent. For more details on using and
configuring ACLs, see https://www.consul.io/docs/internals/acl.html configuring ACLs, see https://www.consul.io/docs/internals/acl.html.
requirements:
- python-consul
- pyhcl
- requests
version_added: "1.9" version_added: "1.9"
author: Steve Gargan (steve.gargan@gmail.com) author: Steve Gargan (steve.gargan@gmail.com)
options: options:
@ -91,17 +95,16 @@ import urllib2
try: try:
import consul import consul
from requests.exceptions import ConnectionError
python_consul_installed = True
except ImportError, e: except ImportError, e:
print "failed=True msg='python-consul required for this module. "\ python_consul_installed = False
"see http://python-consul.readthedocs.org/en/latest/#installation'"
sys.exit(1)
try: try:
import hcl import hcl
pyhcl_installed = True
except ImportError: except ImportError:
print "failed=True msg='pyhcl required for this module."\ pyhcl_installed = False
" see https://pypi.python.org/pypi/pyhcl'"
sys.exit(1)
from requests.exceptions import ConnectionError from requests.exceptions import ConnectionError
@ -271,6 +274,7 @@ class Rule:
def __str__(self): def __str__(self):
return '%s %s' % (self.key, self.policy) return '%s %s' % (self.key, self.policy)
def get_consul_api(module, token=None): def get_consul_api(module, token=None):
if not token: if not token:
token = token = module.params.get('token') token = token = module.params.get('token')
@ -278,6 +282,14 @@ def get_consul_api(module, token=None):
port=module.params.get('port'), port=module.params.get('port'),
token=token) token=token)
def test_dependencies(module):
if not python_consul_installed:
module.fail_json(msg="python-consul required for this module. "\
"see http://python-consul.readthedocs.org/en/latest/#installation")
if not pyhcl_installed:
module.fail_json( msg="pyhcl required for this module."\
" see https://pypi.python.org/pypi/pyhcl")
def main(): def main():
argument_spec = dict( argument_spec = dict(
@ -291,8 +303,9 @@ def main():
token_type=dict( token_type=dict(
required=False, choices=['client', 'management'], default='client') required=False, choices=['client', 'management'], default='client')
) )
module = AnsibleModule(argument_spec, supports_check_mode=False)
module = AnsibleModule(argument_spec, supports_check_mode=True) test_dependencies(module)
try: try:
execute(module) execute(module)

View file

@ -27,6 +27,9 @@ description:
the indices, flags and session are returned as 'value'. If the key the indices, flags and session are returned as 'value'. If the key
represents a prefix then Note that when a value is removed, the existing represents a prefix then Note that when a value is removed, the existing
value if any is returned as part of the results. value if any is returned as part of the results.
requirements:
- python-consul
- requests
version_added: "1.9" version_added: "1.9"
author: Steve Gargan (steve.gargan@gmail.com) author: Steve Gargan (steve.gargan@gmail.com)
options: options:
@ -126,10 +129,10 @@ except ImportError:
try: try:
import consul import consul
from requests.exceptions import ConnectionError
python_consul_installed = True
except ImportError, e: except ImportError, e:
print """failed=True msg='python-consul required for this module. \ python_consul_installed = False
see http://python-consul.readthedocs.org/en/latest/#installation'"""
sys.exit(1)
from requests.exceptions import ConnectionError from requests.exceptions import ConnectionError
@ -222,6 +225,10 @@ def get_consul_api(module, token=None):
port=module.params.get('port'), port=module.params.get('port'),
token=module.params.get('token')) token=module.params.get('token'))
def test_dependencies(module):
if not python_consul_installed:
module.fail_json(msg="python-consul required for this module. "\
"see http://python-consul.readthedocs.org/en/latest/#installation")
def main(): def main():
@ -238,7 +245,9 @@ def main():
value=dict(required=False) value=dict(required=False)
) )
module = AnsibleModule(argument_spec, supports_check_mode=True) module = AnsibleModule(argument_spec, supports_check_mode=False)
test_dependencies(module)
try: try:
execute(module) execute(module)

View file

@ -25,6 +25,9 @@ description:
cluster. These sessions can then be used in conjunction with key value pairs cluster. These sessions can then be used in conjunction with key value pairs
to implement distributed locks. In depth documentation for working with to implement distributed locks. In depth documentation for working with
sessions can be found here http://www.consul.io/docs/internals/sessions.html sessions can be found here http://www.consul.io/docs/internals/sessions.html
requirements:
- python-consul
- requests
version_added: "1.9" version_added: "1.9"
author: Steve Gargan (steve.gargan@gmail.com) author: Steve Gargan (steve.gargan@gmail.com)
options: options:
@ -50,7 +53,8 @@ options:
description: description:
- the optional lock delay that can be attached to the session when it - the optional lock delay that can be attached to the session when it
is created. Locks for invalidated sessions ar blocked from being is created. Locks for invalidated sessions ar blocked from being
acquired until this delay has expired. acquired until this delay has expired. Valid units for delays
include 'ns', 'us', 'ms', 's', 'm', 'h'
default: 15s default: 15s
required: false required: false
node: node:
@ -99,7 +103,7 @@ EXAMPLES = '''
- name: register a session with lock_delay - name: register a session with lock_delay
consul_session: consul_session:
name: session_with_delay name: session_with_delay
delay: 20 delay: 20s
- name: retrieve info about session by id - name: retrieve info about session by id
consul_session: id=session_id state=info consul_session: id=session_id state=info
@ -113,12 +117,10 @@ import urllib2
try: try:
import consul import consul
from requests.exceptions import ConnectionError
python_consul_installed = True
except ImportError, e: except ImportError, e:
print "failed=True msg='python-consul required for this module. see "\ python_consul_installed = False
"http://python-consul.readthedocs.org/en/latest/#installation'"
sys.exit(1)
from requests.errors import ConnectionError
def execute(module): def execute(module):
@ -186,7 +188,7 @@ def update_session(module):
session = consul.session.create( session = consul.session.create(
name=name, name=name,
node=node, node=node,
lock_delay=delay, lock_delay=validate_duration('delay', delay),
dc=datacenter, dc=datacenter,
checks=checks checks=checks
) )
@ -219,15 +221,27 @@ def remove_session(module):
module.fail_json(msg="Could not remove session with id '%s' %s" % ( module.fail_json(msg="Could not remove session with id '%s' %s" % (
session_id, e)) session_id, e))
def validate_duration(name, duration):
if duration:
duration_units = ['ns', 'us', 'ms', 's', 'm', 'h']
if not any((duration.endswith(suffix) for suffix in duration_units)):
raise Exception('Invalid %s %s you must specify units (%s)' %
(name, duration, ', '.join(duration_units)))
return duration
def get_consul_api(module): def get_consul_api(module):
return consul.Consul(host=module.params.get('host'), return consul.Consul(host=module.params.get('host'),
port=module.params.get('port')) port=module.params.get('port'))
def test_dependencies(module):
if not python_consul_installed:
module.fail_json(msg="python-consul required for this module. "\
"see http://python-consul.readthedocs.org/en/latest/#installation")
def main(): def main():
argument_spec = dict( argument_spec = dict(
checks=dict(default=None, required=False, type='list'), checks=dict(default=None, required=False, type='list'),
delay=dict(required=False,type='int', default=15), delay=dict(required=False,type='str', default='15s'),
host=dict(default='localhost'), host=dict(default='localhost'),
port=dict(default=8500, type='int'), port=dict(default=8500, type='int'),
id=dict(required=False), id=dict(required=False),
@ -237,7 +251,9 @@ def main():
choices=['present', 'absent', 'info', 'node', 'list']) choices=['present', 'absent', 'info', 'node', 'list'])
) )
module = AnsibleModule(argument_spec, supports_check_mode=True) module = AnsibleModule(argument_spec, supports_check_mode=False)
test_dependencies(module)
try: try:
execute(module) execute(module)