archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Remove the f5-sdk from bigip_firewall_port_list module (#48492)

Browse Source
pull/48499/head
Tim Rupp 6 years ago committed by GitHub
parent fd0f3ad648
commit 1afbe4d61b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 132 additions and 69 deletions
Show Stats Download Patch File Download Diff File

166
lib/ansible/modules/network/f5/bigip_firewall_port_list.py
Unescape Escape View File

@ -58,6 +58,7 @@ options:
extends_documentation_fragment: f5 extends_documentation_fragment: f5
author: author:
- Tim Rupp (@caphrim007) - Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
''' '''
EXAMPLES = r''' EXAMPLES = r'''
@ -162,46 +163,44 @@ from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.basic import env_fallback from ansible.module_utils.basic import env_fallback
try: try:
from library.module_utils.network.f5.bigip import HAS_F5SDK from library.module_utils.network.f5.bigip import F5RestClient
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 F5ModuleError
from library.module_utils.network.f5.common import AnsibleF5Parameters 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 cleanup_tokens
from library.module_utils.network.f5.common import fq_name from library.module_utils.network.f5.common import fq_name
from library.module_utils.network.f5.common import f5_argument_spec from library.module_utils.network.f5.common import f5_argument_spec
try: from library.module_utils.network.f5.common import transform_name
from library.module_utils.network.f5.common import iControlUnexpectedHTTPError from library.module_utils.network.f5.common import exit_json
except ImportError: from library.module_utils.network.f5.common import fail_json
HAS_F5SDK = False from library.module_utils.network.f5.icontrol import module_provisioned
except ImportError: except ImportError:
from ansible.module_utils.network.f5.bigip import HAS_F5SDK from ansible.module_utils.network.f5.bigip import F5RestClient
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 F5ModuleError
from ansible.module_utils.network.f5.common import AnsibleF5Parameters 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 cleanup_tokens
from ansible.module_utils.network.f5.common import fq_name from ansible.module_utils.network.f5.common import fq_name
from ansible.module_utils.network.f5.common import f5_argument_spec from ansible.module_utils.network.f5.common import f5_argument_spec
try: from ansible.module_utils.network.f5.common import transform_name
from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError from ansible.module_utils.network.f5.common import exit_json
except ImportError: from ansible.module_utils.network.f5.common import fail_json
HAS_F5SDK = False from ansible.module_utils.network.f5.icontrol import module_provisioned
class Parameters(AnsibleF5Parameters): class Parameters(AnsibleF5Parameters):
api_map = { api_map = {
'portLists': 'port_lists' 'portLists': 'port_lists',
} }
api_attributes = [ api_attributes = [
'portLists', 'ports', 'description' 'portLists', 'ports', 'description',
] ]
returnables = [ returnables = [
'ports', 'port_ranges', 'port_lists', 'description' 'ports', 'port_ranges', 'port_lists', 'description',
] ]
updatables = [ updatables = [
'description', 'ports', 'port_ranges', 'port_lists' 'description', 'ports', 'port_ranges', 'port_lists',
] ]
@ -446,17 +445,18 @@ class ModuleManager(object):
return False return False
def exec_module(self): def exec_module(self):
if not module_provisioned(self.client, 'afm'):
raise F5ModuleError(
"AFM must be provisioned to use this module."
)
changed = False changed = False
result = dict() result = dict()
state = self.want.state state = self.want.state
try: if state == "present":
if state == "present": changed = self.present()
changed = self.present() elif state == "absent":
elif state == "absent": changed = self.absent()
changed = self.absent()
except iControlUnexpectedHTTPError as e:
raise F5ModuleError(str(e))
reportable = ReportableChanges(params=self.changes.to_return()) reportable = ReportableChanges(params=self.changes.to_return())
changes = reportable.to_return() changes = reportable.to_return()
@ -479,12 +479,10 @@ class ModuleManager(object):
else: else:
return self.create() return self.create()
def exists(self): def absent(self):
result = self.client.api.tm.security.firewall.port_lists.port_list.exists( if self.exists():
name=self.want.name, return self.remove()
partition=self.want.partition return False
)
return result
def update(self): def update(self):
self.have = self.read_current_from_device() self.have = self.read_current_from_device()
@ -510,42 +508,91 @@ class ModuleManager(object):
self.create_on_device() self.create_on_device()
return True return True
def create_on_device(self): def exists(self):
params = self.changes.api_params() uri = "https://{0}:{1}/mgmt/tm/security/firewall/port-list/{2}".format(
self.client.api.tm.security.firewall.port_lists.port_list.create( self.client.provider['server'],
name=self.want.name, self.client.provider['server_port'],
partition=self.want.partition, transform_name(self.want.partition, self.want.name)
**params
) )
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 update_on_device(self): def update_on_device(self):
params = self.changes.api_params() params = self.changes.api_params()
resource = self.client.api.tm.security.firewall.port_lists.port_list.load( uri = "https://{0}:{1}/mgmt/tm/security/firewall/port-list/{2}".format(
name=self.want.name, self.client.provider['server'],
partition=self.want.partition 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 'code' in response and response['code'] == 400:
if self.exists(): if 'message' in response:
return self.remove() raise F5ModuleError(response['message'])
return False else:
raise F5ModuleError(resp.content)
def remove_from_device(self): def read_current_from_device(self):
resource = self.client.api.tm.security.firewall.port_lists.port_list.load( uri = "https://{0}:{1}/mgmt/tm/security/firewall/port-list/{2}".format(
name=self.want.name, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
) )
if resource: resp = self.client.api.get(uri)
resource.delete()
def read_current_from_device(self): try:
resource = self.client.api.tm.security.firewall.port_lists.port_list.load( response = resp.json()
name=self.want.name, except ValueError as ex:
partition=self.want.partition 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 create_on_device(self):
params = self.changes.api_params()
params['name'] = self.want.name
params['partition'] = self.want.partition
uri = "https://{0}:{1}/mgmt/tm/security/firewall/port-list/".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 remove_from_device(self):
uri = "https://{0}:{1}/mgmt/tm/security/firewall/port-list/{2}".format(
self.client.provider['server'],
self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
) )
result = resource.attrs response = self.client.api.delete(uri)
return ApiParameters(params=result) if response.status == 200:
return True
raise F5ModuleError(response.content)
class ArgumentSpec(object): class ArgumentSpec(object):
@ -578,18 +625,17 @@ def main():
argument_spec=spec.argument_spec, argument_spec=spec.argument_spec,
supports_check_mode=spec.supports_check_mode 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: try:
client = F5Client(**module.params)
mm = ModuleManager(module=module, client=client) mm = ModuleManager(module=module, client=client)
results = mm.exec_module() results = mm.exec_module()
cleanup_tokens(client) cleanup_tokens(client)
module.exit_json(**results) exit_json(module, results, client)
except F5ModuleError as ex: except F5ModuleError as ex:
cleanup_tokens(client) cleanup_tokens(client)
module.fail_json(msg=str(ex)) fail_json(module, ex, client)
if __name__ == '__main__': if __name__ == '__main__':

35
test/units/modules/network/f5/test_bigip_firewall_port_list.py
Unescape Escape View File

@ -8,16 +8,12 @@ __metaclass__ = type
import os import os
import json import json
import pytest
import sys import sys
from nose.plugins.skip import SkipTest from nose.plugins.skip import SkipTest
if sys.version_info < (2, 7): if sys.version_info < (2, 7):
raise SkipTest("F5 Ansible modules require Python >= 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 from ansible.module_utils.basic import AnsibleModule
try: try:
@ -25,17 +21,25 @@ try:
from library.modules.bigip_firewall_port_list import ModuleParameters from library.modules.bigip_firewall_port_list import ModuleParameters
from library.modules.bigip_firewall_port_list import ModuleManager from library.modules.bigip_firewall_port_list import ModuleManager
from library.modules.bigip_firewall_port_list import ArgumentSpec from library.modules.bigip_firewall_port_list import ArgumentSpec
from library.module_utils.network.f5.common import F5ModuleError
from library.module_utils.network.f5.common import iControlUnexpectedHTTPError # In Ansible 2.8, Ansible changed import paths.
from test.unit.modules.utils import set_module_args 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: except ImportError:
try: try:
from ansible.modules.network.f5.bigip_firewall_port_list import ApiParameters from ansible.modules.network.f5.bigip_firewall_port_list import ApiParameters
from ansible.modules.network.f5.bigip_firewall_port_list import ModuleParameters from ansible.modules.network.f5.bigip_firewall_port_list import ModuleParameters
from ansible.modules.network.f5.bigip_firewall_port_list import ModuleManager from ansible.modules.network.f5.bigip_firewall_port_list import ModuleManager
from ansible.modules.network.f5.bigip_firewall_port_list import ArgumentSpec from ansible.modules.network.f5.bigip_firewall_port_list 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 from units.modules.utils import set_module_args
except ImportError: except ImportError:
raise SkipTest("F5 Ansible modules require the f5-sdk Python library") raise SkipTest("F5 Ansible modules require the f5-sdk Python library")
@ -96,6 +100,18 @@ class TestManager(unittest.TestCase):
def setUp(self): def setUp(self):
self.spec = ArgumentSpec() self.spec = ArgumentSpec()
try:
self.p1 = patch('library.modules.bigip_firewall_port_list.module_provisioned')
self.m1 = self.p1.start()
self.m1.return_value = True
except Exception:
self.p1 = patch('ansible.modules.network.f5.bigip_firewall_port_list.module_provisioned')
self.m1 = self.p1.start()
self.m1.return_value = True
def tearDown(self):
self.p1.stop()
def test_create(self, *args): def test_create(self, *args):
set_module_args(dict( set_module_args(dict(
name='foo', name='foo',
@ -117,6 +133,7 @@ class TestManager(unittest.TestCase):
# Override methods to force specific logic in the module to happen # Override methods to force specific logic in the module to happen
mm.exists = Mock(side_effect=[False, True]) mm.exists = Mock(side_effect=[False, True])
mm.create_on_device = Mock(return_value=True) mm.create_on_device = Mock(return_value=True)
mm.module_provisioned = Mock(return_value=True)
results = mm.exec_module() results = mm.exec_module()

Write Preview
Loading…
Cancel
Save