ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-22 12:50:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Various F5 related fixes for traceback raising (#34820)

Browse source 
The main purpose of this patch is to do the refactor that
supports replacing tracebacks with fail_json. Additionally, the
following was done.

* Removed re-def of cleanup_tokens.
* Changed parameter args to be keywords.
* Changed imports to include new module_util locations.
* Imports also include developing (sideband) module_util locations.
* Changed to using F5Client and plain AnsibleModule to prevent tracebacks caused by missing libraries.
* Removed init and update methods from most Parameter classes (optimization) as its now included in module_utils.
* Changed module and module param references to take into account the new self.module arg.
* Minor bug fixes made during this refactor.
This commit is contained in:
Tim Rupp 2018-01-12 14:43:35 -08:00 • committed by GitHub
commit 0e4e7de000
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
23 changed files with 1149 additions and 1388 deletions
Download patch file Download diff file Expand all files Collapse all files

177
lib/ansible/modules/network/f5/bigip_policy.py
View file

@ -72,11 +72,6 @@ options:
description:
- Device partition to manage resources on.
default: Common
notes:
- Requires the f5-sdk Python package on the host. This is as easy as
pip install f5-sdk
requirements:
- f5-sdk
extends_documentation_fragment: f5
author:
- Tim Rupp (@caphrim007)
@ -166,54 +161,50 @@ rules:
type: list
sample: ['/Common/rule1', '/Common/rule2']
'''
import re
from ansible.module_utils.f5_utils import AnsibleF5Client
from ansible.module_utils.f5_utils import AnsibleF5Parameters
from ansible.module_utils.f5_utils import HAS_F5SDK
from ansible.module_utils.f5_utils import F5ModuleError
from ansible.module_utils.six import iteritems
from collections import defaultdict
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.basic import env_fallback
from distutils.version import LooseVersion
HAS_DEVEL_IMPORTS = False
try:
# Sideband repository used for dev
from library.module_utils.network.f5.bigip import HAS_F5SDK
from library.module_utils.network.f5.bigip import F5Client
from library.module_utils.network.f5.common import F5ModuleError
from library.module_utils.network.f5.common import AnsibleF5Parameters
from library.module_utils.network.f5.common import cleanup_tokens
from library.module_utils.network.f5.common import fqdn_name
from library.module_utils.network.f5.common import f5_argument_spec
try:
from library.module_utils.network.f5.common import iControlUnexpectedHTTPError
except ImportError:
HAS_F5SDK = False
HAS_DEVEL_IMPORTS = True
except ImportError:
# Upstream Ansible
from ansible.module_utils.network.f5.bigip import HAS_F5SDK
from ansible.module_utils.network.f5.bigip import F5Client
from ansible.module_utils.network.f5.common import F5ModuleError
from ansible.module_utils.network.f5.common import AnsibleF5Parameters
from ansible.module_utils.network.f5.common import cleanup_tokens
from ansible.module_utils.network.f5.common import fqdn_name
from ansible.module_utils.network.f5.common import f5_argument_spec
try:
from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
except ImportError:
HAS_F5SDK = False
try:
from ansible.module_utils.f5_utils import iControlUnexpectedHTTPError
from f5.sdk_exception import NonExtantPolicyRule
except ImportError:
HAS_F5SDK = False
class Parameters(AnsibleF5Parameters):
def __init__(self, params=None):
self._values = defaultdict(lambda: None)
if params:
self.update(params=params)
self._values['__warning'] = []
self._values['__deprecated'] = []
def update(self, params=None):
if params:
for k, v in iteritems(params):
if self.api_map is not None and k in self.api_map:
map_key = self.api_map[k]
else:
map_key = k
# Handle weird API parameters like `dns.proxy.__iter__` by
# using a map provided by the module developer
class_attr = getattr(type(self), map_key, None)
if isinstance(class_attr, property):
# There is a mapped value for the api_map key
if class_attr.fset is None:
# If the mapped value does not have an associated setter
self._values[map_key] = v
else:
# The mapped value has a setter
setattr(self, map_key, v)
else:
# If the mapped value is not a @property
self._values[map_key] = v
def to_return(self):
result = {}
for returnable in self.returnables:
@ -221,16 +212,6 @@ class Parameters(AnsibleF5Parameters):
result = self._filter_params(result)
return result
def api_params(self):
result = {}
for api_attribute in self.api_attributes:
if self.api_map is not None and api_attribute in self.api_map:
result[api_attribute] = getattr(self, self.api_map[api_attribute])
else:
result[api_attribute] = getattr(self, api_attribute)
result = self._filter_params(result)
return result
@property
def strategy(self):
if self._values['strategy'] is None:
@ -261,9 +242,7 @@ class Parameters(AnsibleF5Parameters):
return self._get_custom_strategy_name()
def _get_builtin_strategy(self, strategy):
return '/{0}/{1}-match'.format(
self.partition, strategy
)
return '/Common/{0}-match'.format(strategy)
def _get_custom_strategy_name(self):
strategy = self._values['strategy']
@ -314,9 +293,11 @@ class ComplexParameters(Parameters):
class BaseManager(object):
def __init__(self, client):
self.client = client
def __init__(self, *args, **kwargs):
self.module = kwargs.get('module', None)
self.client = kwargs.get('client', None)
self.have = None
self.want = Parameters(params=self.module.params)
def _announce_deprecations(self):
warnings = []
@ -325,7 +306,7 @@ class BaseManager(object):
if self.have:
warnings += self.have._values.get('__deprecated', [])
for warning in warnings:
self.client.module.deprecate(
self.module.deprecate(
msg=warning['msg'],
version=warning['version']
)
@ -337,7 +318,7 @@ class BaseManager(object):
if self.have:
warnings += self.have._values.get('__warning', [])
for warning in warnings:
self.client.module.warn(warning['msg'])
self.module.warn(warning['msg'])
def present(self):
if self.exists():
@ -386,9 +367,9 @@ class BaseManager(object):
class SimpleManager(BaseManager):
def __init__(self, client):
super(SimpleManager, self).__init__(client)
self.want = SimpleParameters(self.client.module.params)
def __init__(self, *args, **kwargs):
super(SimpleManager, self).__init__(**kwargs)
self.want = SimpleParameters(params=self.module.params)
self.have = SimpleParameters()
self.changes = SimpleChanges()
@ -398,7 +379,7 @@ class SimpleManager(BaseManager):
if getattr(self.want, key) is not None:
changed[key] = getattr(self.want, key)
if changed:
self.changes = SimpleChanges(changed)
self.changes = SimpleChanges(params=changed)
def _update_changed_options(self):
diff = Difference(self.want, self.have)
@ -411,7 +392,7 @@ class SimpleManager(BaseManager):
else:
changed[k] = change
if changed:
self.changes = SimpleChanges(changed)
self.changes = SimpleChanges(params=changed)
return True
return False
@ -445,7 +426,7 @@ class SimpleManager(BaseManager):
partition=self.want.partition
)
rules = self._get_rule_names(resource)
result = SimpleParameters(resource.attrs)
result = SimpleParameters(params=resource.attrs)
result.update(dict(rules=rules))
return result
@ -470,7 +451,7 @@ class SimpleManager(BaseManager):
def create(self):
self._validate_creation_parameters()
self._set_changed_options()
if self.client.check_mode:
if self.module.check_mode:
return True
self.create_on_device()
return True
@ -491,7 +472,7 @@ class SimpleManager(BaseManager):
self.have = self.read_current_from_device()
if not self.should_update():
return False
if self.client.check_mode:
if self.module.check_mode:
return True
self.update_on_device()
return True
@ -503,7 +484,7 @@ class SimpleManager(BaseManager):
return changed
def remove(self):
if self.client.check_mode:
if self.module.check_mode:
return True
self.remove_from_device()
if self.exists():
@ -519,9 +500,9 @@ class SimpleManager(BaseManager):
class ComplexManager(BaseManager):
def __init__(self, client):
super(ComplexManager, self).__init__(client)
self.want = ComplexParameters(self.client.module.params)
def __init__(self, *args, **kwargs):
super(ComplexManager, self).__init__(**kwargs)
self.want = ComplexParameters(params=self.module.params)
self.have = ComplexParameters()
self.changes = ComplexChanges()
@ -531,7 +512,7 @@ class ComplexManager(BaseManager):
if getattr(self.want, key) is not None:
changed[key] = getattr(self.want, key)
if changed:
self.changes = ComplexChanges(changed)
self.changes = ComplexChanges(params=changed)
def _update_changed_options(self):
diff = Difference(self.want, self.have)
@ -544,7 +525,7 @@ class ComplexManager(BaseManager):
else:
changed[k] = change
if changed:
self.changes = ComplexChanges(changed)
self.changes = ComplexChanges(params=changed)
return True
return False
@ -595,7 +576,7 @@ class ComplexManager(BaseManager):
return changed
def remove(self):
if self.client.check_mode:
if self.module.check_mode:
return True
self.remove_from_device()
if self.draft_exists() or self.policy_exists():
@ -631,7 +612,7 @@ class ComplexManager(BaseManager):
)
rules = self._get_rule_names(resource)
result = ComplexParameters(resource.attrs)
result = ComplexParameters(params=resource.attrs)
result.update(dict(rules=rules))
return result
@ -697,7 +678,7 @@ class ComplexManager(BaseManager):
self._validate_creation_parameters()
self._set_changed_options()
if self.client.check_mode:
if self.module.check_mode:
return True
if not self.draft_exists():
@ -716,7 +697,7 @@ class ComplexManager(BaseManager):
self.have = self.read_current_from_device()
if not self.should_update():
return False
if self.client.check_mode:
if self.module.check_mode:
return True
if not self.draft_exists():
@ -787,8 +768,10 @@ class Difference(object):
class ModuleManager(object):
def __init__(self, client):
self.client = client
def __init__(self, *args, **kwargs):
self.module = kwargs.get('module', None)
self.client = kwargs.get('client', None)
self.kwargs = kwargs
def exec_module(self):
if self.version_is_less_than_12():
@ -799,9 +782,9 @@ class ModuleManager(object):
def get_manager(self, type):
if type == 'simple':
return SimpleManager(self.client)
return SimpleManager(**self.kwargs)
elif type == 'complex':
return ComplexManager(self.client)
return ComplexManager(**self.kwargs)
def version_is_less_than_12(self):
version = self.client.api.tmos_version
@ -814,7 +797,7 @@ class ModuleManager(object):
class ArgumentSpec(object):
def __init__(self):
self.supports_check_mode = True
self.argument_spec = dict(
argument_spec = dict(
name=dict(
required=True
),
@ -824,32 +807,38 @@ class ArgumentSpec(object):
choices=['first', 'all', 'best']
),
state=dict(
required=False,
default='present',
choices=['absent', 'present', 'draft']
),
partition=dict(
default='Common',
fallback=(env_fallback, ['F5_PARTITION'])
)
)
self.f5_product_name = 'bigip'
self.argument_spec = {}
self.argument_spec.update(f5_argument_spec)
self.argument_spec.update(argument_spec)
def main():
if not HAS_F5SDK:
raise F5ModuleError("The python f5-sdk module is required")
spec = ArgumentSpec()
client = AnsibleF5Client(
module = AnsibleModule(
argument_spec=spec.argument_spec,
supports_check_mode=spec.supports_check_mode,
f5_product_name=spec.f5_product_name
supports_check_mode=spec.supports_check_mode
)
if not HAS_F5SDK:
module.fail_json(msg="The python f5-sdk module is required")
try:
mm = ModuleManager(client)
client = F5Client(**module.params)
mm = ModuleManager(module=module, client=client)
results = mm.exec_module()
client.module.exit_json(**results)
except F5ModuleError as e:
client.module.fail_json(msg=str(e))
cleanup_tokens(client)
module.exit_json(**results)
except F5ModuleError as ex:
cleanup_tokens(client)
module.fail_json(msg=str(ex))
if __name__ == '__main__':