Skip to content

Commit

Permalink
Removes the f5-sdk from the traffic group module (ansible#48008)
Browse files Browse the repository at this point in the history
  • Loading branch information
@caphrim007
caphrim007 authored Nov 2, 2018
1 parent 8abc7e4 commit d8a8c21
Show file tree
Hide file tree
Showing 2 changed files with 147 additions and 99 deletions.
224 changes: 134 additions & 90 deletions lib/ansible/modules/network/f5/bigip_traffic_group.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
extends_documentation_fragment: f5
author:
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
'''

EXAMPLES = r'''
Expand All @@ -72,58 +73,42 @@
from ansible.module_utils.basic import env_fallback

try:
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.bigip import F5RestClient
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 f5_argument_spec

try:
from library.module_utils.network.f5.common import iControlUnexpectedHTTPError
except ImportError:
HAS_F5SDK = False
from library.module_utils.network.f5.common import transform_name
from library.module_utils.network.f5.common import exit_json
from library.module_utils.network.f5.common import fail_json
except ImportError:
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.bigip import F5RestClient
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 f5_argument_spec

try:
from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
except ImportError:
HAS_F5SDK = False
from ansible.module_utils.network.f5.common import transform_name
from ansible.module_utils.network.f5.common import exit_json
from ansible.module_utils.network.f5.common import fail_json


class Parameters(AnsibleF5Parameters):
api_map = {
'mac': 'mac_address'
'mac': 'mac_address',
}

api_attributes = [
'mac'
'mac',
]

returnables = [
'mac_address'
'mac_address',
]

updatables = [
'mac_address'
'mac_address',
]

def to_return(self):
result = {}
try:
for returnable in self.returnables:
result[returnable] = getattr(self, returnable)
result = self._filter_params(result)
except Exception:
pass
return result


class ApiParameters(Parameters):
pass
Expand All @@ -140,6 +125,19 @@ def mac_address(self):


class Changes(Parameters):
def to_return(self):
result = {}
for returnable in self.returnables:
result[returnable] = getattr(self, returnable)
result = self._filter_params(result)
return result


class UsableChanges(Changes):
pass


class ReportableChanges(Changes):
pass


Expand Down Expand Up @@ -175,16 +173,17 @@ class ModuleManager(object):
def __init__(self, *args, **kwargs):
self.module = kwargs.get('module', None)
self.client = kwargs.get('client', None)
self.have = None
self.want = ModuleParameters(params=self.module.params)
self.changes = Changes()
self.changes = UsableChanges()

def _set_changed_options(self):
changed = {}
for key in Parameters.returnables:
if getattr(self.want, key) is not None:
changed[key] = getattr(self.want, key)
if changed:
self.changes = Changes(params=changed)
self.changes = UsableChanges(params=changed)

def _update_changed_options(self):
diff = Difference(self.want, self.have)
Expand All @@ -200,55 +199,51 @@ def _update_changed_options(self):
else:
changed[k] = change
if changed:
self.changes = Changes(params=changed)
self.changes = UsableChanges(params=changed)
return True
return False

def should_update(self):
result = self._update_changed_options()
if result:
return True
return False
def _announce_deprecations(self, result):
warnings = result.pop('__warnings', [])
for warning in warnings:
self.module.deprecate(
msg=warning['msg'],
version=warning['version']
)

def exec_module(self):
changed = False
result = dict()
state = self.want.state

try:
if state == "present":
changed = self.present()
elif state == "absent":
changed = self.absent()
except iControlUnexpectedHTTPError as e:
raise F5ModuleError(str(e))

changes = self.changes.to_return()
if state == "present":
changed = self.present()
elif state == "absent":
changed = self.absent()

reportable = ReportableChanges(params=self.changes.to_return())
changes = reportable.to_return()
result.update(**changes)
result.update(dict(changed=changed))
self._announce_deprecations(result)
return result

def _announce_deprecations(self, result):
warnings = result.pop('__warnings', [])
for warning in warnings:
self.module.deprecate(
msg=warning['msg'],
version=warning['version']
)

def present(self):
if self.exists():
return self.update()
else:
return self.create()

def exists(self):
result = self.client.api.tm.cm.traffic_groups.traffic_group.exists(
name=self.want.name,
partition=self.want.partition
)
return result
def absent(self):
if self.exists():
return self.remove()
return False

def should_update(self):
result = self._update_changed_options()
if result:
return True
return False

def update(self):
self.have = self.read_current_from_device()
Expand Down Expand Up @@ -278,42 +273,92 @@ def create(self):
self.create_on_device()
return True

def exists(self):
uri = "https://{0}:{1}/mgmt/tm/cm/traffic-group/{2}".format(
self.client.provider['server'],
self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
)
resp = self.client.api.get(uri)
try:
response = resp.json()
except ValueError:
return False
if resp.status == 404 or 'code' in response and response['code'] == 404:
return False
return True

def create_on_device(self):
params = self.want.api_params()
self.client.api.tm.cm.traffic_groups.traffic_group.create(
name=self.want.name,
partition=self.want.partition,
**params
params = self.changes.api_params()
params['name'] = self.want.name
params['partition'] = self.want.partition
uri = "https://{0}:{1}/mgmt/tm/cm/traffic-group/".format(
self.client.provider['server'],
self.client.provider['server_port'],
)
resp = self.client.api.post(uri, json=params)
try:
response = resp.json()
except ValueError as ex:
raise F5ModuleError(str(ex))

if 'code' in response and response['code'] in [400, 403]:
if 'message' in response:
raise F5ModuleError(response['message'])
else:
raise F5ModuleError(resp.content)
return response['selfLink']

def update_on_device(self):
params = self.want.api_params()
resource = self.client.api.tm.cm.traffic_groups.traffic_group.load(
name=self.want.name,
partition=self.want.partition
params = self.changes.api_params()
uri = "https://{0}:{1}/mgmt/tm/cm/traffic-group/{2}".format(
self.client.provider['server'],
self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
)
resource.modify(**params)
resp = self.client.api.patch(uri, json=params)
try:
response = resp.json()
except ValueError as ex:
raise F5ModuleError(str(ex))

def absent(self):
if self.exists():
return self.remove()
return False
if 'code' in response and response['code'] == 400:
if 'message' in response:
raise F5ModuleError(response['message'])
else:
raise F5ModuleError(resp.content)

def remove_from_device(self):
resource = self.client.api.tm.cm.traffic_groups.traffic_group.load(
name=self.want.name,
partition=self.want.partition
def read_current_from_device(self):
uri = "https://{0}:{1}/mgmt/tm/cm/traffic-group/{2}".format(
self.client.provider['server'],
self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
)
if resource:
resource.delete()

def read_current_from_device(self):
resource = self.client.api.tm.cm.traffic_groups.traffic_group.load(
name=self.want.name,
partition=self.want.partition
resp = self.client.api.get(uri)

try:
response = resp.json()
except ValueError as ex:
raise F5ModuleError(str(ex))

if 'code' in response and response['code'] == 400:
if 'message' in response:
raise F5ModuleError(response['message'])
else:
raise F5ModuleError(resp.content)
return ApiParameters(params=response)

def remove_from_device(self):
uri = "https://{0}:{1}/mgmt/tm/cm/traffic-group/{2}".format(
self.client.provider['server'],
self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
)
result = resource.attrs
return ApiParameters(params=result)
response = self.client.api.delete(uri)
if response.status == 200:
return True
raise F5ModuleError(response.content)


class ArgumentSpec(object):
Expand All @@ -340,18 +385,17 @@ def main():
argument_spec=spec.argument_spec,
supports_check_mode=spec.supports_check_mode
)
if not HAS_F5SDK:
module.fail_json(msg="The python f5-sdk module is required")

client = F5RestClient(**module.params)

try:
client = F5Client(**module.params)
mm = ModuleManager(module=module, client=client)
results = mm.exec_module()
cleanup_tokens(client)
module.exit_json(**results)
exit_json(module, results, client)
except F5ModuleError as ex:
cleanup_tokens(client)
module.fail_json(msg=str(ex))
fail_json(module, ex, client)


if __name__ == '__main__':
Expand Down
22 changes: 13 additions & 9 deletions test/units/modules/network/f5/test_bigip_traffic_group.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,38 @@

import os
import json
import pytest
import sys

from nose.plugins.skip import SkipTest
if sys.version_info < (2, 7):
raise SkipTest("F5 Ansible modules require Python >= 2.7")

from units.compat import unittest
from units.compat.mock import Mock
from units.compat.mock import patch
from ansible.module_utils.basic import AnsibleModule

try:
from library.modules.bigip_traffic_group import ApiParameters
from library.modules.bigip_traffic_group import ModuleParameters
from library.modules.bigip_traffic_group import ModuleManager
from library.modules.bigip_traffic_group import ArgumentSpec
from library.module_utils.network.f5.common import F5ModuleError
from library.module_utils.network.f5.common import iControlUnexpectedHTTPError
from test.unit.modules.utils import set_module_args

# In Ansible 2.8, Ansible changed import paths.
from test.units.compat import unittest
from test.units.compat.mock import Mock
from test.units.compat.mock import patch

from test.units.modules.utils import set_module_args
except ImportError:
try:
from ansible.modules.network.f5.bigip_traffic_group import ApiParameters
from ansible.modules.network.f5.bigip_traffic_group import ModuleParameters
from ansible.modules.network.f5.bigip_traffic_group import ModuleManager
from ansible.modules.network.f5.bigip_traffic_group import ArgumentSpec
from ansible.module_utils.network.f5.common import F5ModuleError
from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError

# Ansible 2.8 imports
from units.compat import unittest
from units.compat.mock import Mock
from units.compat.mock import patch

from units.modules.utils import set_module_args
except ImportError:
raise SkipTest("F5 Ansible modules require the f5-sdk Python library")
Expand Down

0 comments on commit d8a8c21

Please sign in to comment.