mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-24 04:54:00 -07:00
Adds bigip_iapp_service module (#25808)
This module allows a user to manage the iApp services on a bigip that they created using the bigip_iapp_template module. Unit tests are provided. Integration tests can be found here https://github.com/F5Networks/f5-ansible/blob/devel/test/integration/bigip_iapp_service.yaml#L23 https://github.com/F5Networks/f5-ansible/tree/devel/test/integration/targets/bigip_iapp_service/tasks
This commit is contained in:
Tim Rupp
John R Barker
parent
26b8f90c9a
commit
59d470ae84
4 changed files with 1126 additions and 0 deletions
|
|
@ -0,0 +1,195 @@
|
|||
{
|
||||
"name": "http_example",
|
||||
"partition": "Common",
|
||||
"template": "/Common/f5.http",
|
||||
"lists": [
|
||||
{
|
||||
"name": "irules__irules",
|
||||
"encrypted": "no",
|
||||
"value": [
|
||||
"/Common/lgyft"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "net__client_vlan",
|
||||
"encrypted": "no",
|
||||
"value": [
|
||||
"/Common/net2"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tables": [
|
||||
{
|
||||
"columnNames": [
|
||||
"name"
|
||||
],
|
||||
"name": "pool__hosts",
|
||||
"rows": [
|
||||
{
|
||||
"row": [
|
||||
"demo.example.com"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"columnNames": [
|
||||
"addr",
|
||||
"connection_limit"
|
||||
],
|
||||
"name": "pool__members",
|
||||
"rows": [
|
||||
{
|
||||
"row": [
|
||||
"10.1.1.1",
|
||||
"0"
|
||||
]
|
||||
},
|
||||
{
|
||||
"row": [
|
||||
"10.1.1.2",
|
||||
"0"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"variables": [
|
||||
{
|
||||
"name": "afm__policy",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "afm__dos_security_profile",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "afm__protocol_security_profile",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "asm__use_asm",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "client__http_compression",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "client__standard_caching_without_wa",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "client__tcp_wan_opt",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "monitor__monitor",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "monitor__frequency",
|
||||
"value": "30"
|
||||
},
|
||||
{
|
||||
"name": "monitor__uri",
|
||||
"value": "/my/path"
|
||||
},
|
||||
{
|
||||
"name": "monitor__response",
|
||||
"value": ""
|
||||
},
|
||||
{
|
||||
"name": "net__client_mode",
|
||||
"value": "wan"
|
||||
},
|
||||
{
|
||||
"name": "net__server_mode",
|
||||
"value": "lan"
|
||||
},
|
||||
{
|
||||
"name": "net__vlan_mode",
|
||||
"value": "all"
|
||||
},
|
||||
{
|
||||
"name": "pool__addr",
|
||||
"value": "10.10.10.10"
|
||||
},
|
||||
{
|
||||
"name": "pool__http",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "pool__mask",
|
||||
"value": ""
|
||||
},
|
||||
{
|
||||
"name": "pool__persist",
|
||||
"value": "/#cookie#"
|
||||
},
|
||||
{
|
||||
"name": "pool__lb_method",
|
||||
"value": "least-connections-member"
|
||||
},
|
||||
{
|
||||
"name": "pool__pool_to_use",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "pool__port_secure",
|
||||
"value": "443"
|
||||
},
|
||||
{
|
||||
"name": "pool__redirect_port",
|
||||
"value": "80"
|
||||
},
|
||||
{
|
||||
"name": "pool__redirect_to_https",
|
||||
"value": "yes"
|
||||
},
|
||||
{
|
||||
"name": "pool__xff",
|
||||
"value": "yes"
|
||||
},
|
||||
{
|
||||
"name": "server__oneconnect",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "server__tcp_lan_opt",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "ssl__cert",
|
||||
"value": "/Common/default.crt"
|
||||
},
|
||||
{
|
||||
"name": "ssl__client_ssl_profile",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "ssl__key",
|
||||
"value": "/Common/default.key"
|
||||
},
|
||||
{
|
||||
"name": "ssl__mode",
|
||||
"value": "client_ssl"
|
||||
},
|
||||
{
|
||||
"name": "ssl__use_chain_cert",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "ssl_encryption_questions__advanced",
|
||||
"value": "yes"
|
||||
},
|
||||
{
|
||||
"name": "stats__analytics",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "stats__request_logging",
|
||||
"value": "/#do_not_use#"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,195 @@
|
|||
{
|
||||
"name": "http_example",
|
||||
"partition": "Common",
|
||||
"template": "/Common/f5.http",
|
||||
"lists": [
|
||||
{
|
||||
"name": "irules__irules",
|
||||
"encrypted": "no",
|
||||
"value": [
|
||||
"/Common/lgyft"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "net__client_vlan",
|
||||
"encrypted": "no",
|
||||
"value": [
|
||||
"/Common/net2"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tables": [
|
||||
{
|
||||
"columnNames": [
|
||||
"name"
|
||||
],
|
||||
"name": "pool__hosts",
|
||||
"rows": [
|
||||
{
|
||||
"row": [
|
||||
"demo.example.com"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"columnNames": [
|
||||
"addr",
|
||||
"connection_limit"
|
||||
],
|
||||
"name": "pool__members",
|
||||
"rows": [
|
||||
{
|
||||
"row": [
|
||||
"20.1.1.1",
|
||||
"0"
|
||||
]
|
||||
},
|
||||
{
|
||||
"row": [
|
||||
"10.1.1.2",
|
||||
"0"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"variables": [
|
||||
{
|
||||
"name": "afm__policy",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "afm__dos_security_profile",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "afm__protocol_security_profile",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "asm__use_asm",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "client__http_compression",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "client__standard_caching_without_wa",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "client__tcp_wan_opt",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "monitor__monitor",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "monitor__frequency",
|
||||
"value": "30"
|
||||
},
|
||||
{
|
||||
"name": "monitor__uri",
|
||||
"value": "/my/path"
|
||||
},
|
||||
{
|
||||
"name": "monitor__response",
|
||||
"value": ""
|
||||
},
|
||||
{
|
||||
"name": "net__client_mode",
|
||||
"value": "wan"
|
||||
},
|
||||
{
|
||||
"name": "net__server_mode",
|
||||
"value": "lan"
|
||||
},
|
||||
{
|
||||
"name": "net__vlan_mode",
|
||||
"value": "all"
|
||||
},
|
||||
{
|
||||
"name": "pool__addr",
|
||||
"value": "10.10.10.10"
|
||||
},
|
||||
{
|
||||
"name": "pool__http",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "pool__mask",
|
||||
"value": ""
|
||||
},
|
||||
{
|
||||
"name": "pool__persist",
|
||||
"value": "/#cookie#"
|
||||
},
|
||||
{
|
||||
"name": "pool__lb_method",
|
||||
"value": "least-connections-member"
|
||||
},
|
||||
{
|
||||
"name": "pool__pool_to_use",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "pool__port_secure",
|
||||
"value": "443"
|
||||
},
|
||||
{
|
||||
"name": "pool__redirect_port",
|
||||
"value": "80"
|
||||
},
|
||||
{
|
||||
"name": "pool__redirect_to_https",
|
||||
"value": "yes"
|
||||
},
|
||||
{
|
||||
"name": "pool__xff",
|
||||
"value": "yes"
|
||||
},
|
||||
{
|
||||
"name": "server__oneconnect",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "server__tcp_lan_opt",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "ssl__cert",
|
||||
"value": "/Common/default.crt"
|
||||
},
|
||||
{
|
||||
"name": "ssl__client_ssl_profile",
|
||||
"value": "/#create_new#"
|
||||
},
|
||||
{
|
||||
"name": "ssl__key",
|
||||
"value": "/Common/default.key"
|
||||
},
|
||||
{
|
||||
"name": "ssl__mode",
|
||||
"value": "client_ssl"
|
||||
},
|
||||
{
|
||||
"name": "ssl__use_chain_cert",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "ssl_encryption_questions__advanced",
|
||||
"value": "yes"
|
||||
},
|
||||
{
|
||||
"name": "stats__analytics",
|
||||
"value": "/#do_not_use#"
|
||||
},
|
||||
{
|
||||
"name": "stats__request_logging",
|
||||
"value": "/#do_not_use#"
|
||||
}
|
||||
]
|
||||
}
|
||||
264
test/units/modules/network/f5/test_bigip_iapp_service.py
Normal file
264
test/units/modules/network/f5/test_bigip_iapp_service.py
Normal file
|
|
@ -0,0 +1,264 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright 2017 F5 Networks Inc.
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
import os
|
||||
import json
|
||||
import sys
|
||||
|
||||
from nose.plugins.skip import SkipTest
|
||||
if sys.version_info < (2, 7):
|
||||
raise SkipTest("F5 Ansible modules require Python >= 2.7")
|
||||
|
||||
from ansible.compat.tests import unittest
|
||||
from ansible.compat.tests.mock import patch, Mock
|
||||
from ansible.module_utils import basic
|
||||
from ansible.module_utils._text import to_bytes
|
||||
from ansible.module_utils.f5_utils import AnsibleF5Client
|
||||
|
||||
try:
|
||||
from library.bigip_iapp_service import Parameters
|
||||
from library.bigip_iapp_service import ModuleManager
|
||||
from library.bigip_iapp_service import ArgumentSpec
|
||||
except ImportError:
|
||||
try:
|
||||
from ansible.modules.network.f5.bigip_iapp_service import Parameters
|
||||
from ansible.modules.network.f5.bigip_iapp_service import ModuleManager
|
||||
from ansible.modules.network.f5.bigip_iapp_service import ArgumentSpec
|
||||
except ImportError:
|
||||
raise SkipTest("F5 Ansible modules require the f5-sdk Python library")
|
||||
|
||||
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
|
||||
fixture_data = {}
|
||||
|
||||
|
||||
def set_module_args(args):
|
||||
args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
|
||||
basic._ANSIBLE_ARGS = to_bytes(args)
|
||||
|
||||
|
||||
def load_fixture(name):
|
||||
path = os.path.join(fixture_path, name)
|
||||
|
||||
if path in fixture_data:
|
||||
return fixture_data[path]
|
||||
|
||||
with open(path) as f:
|
||||
data = f.read()
|
||||
|
||||
try:
|
||||
data = json.loads(data)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
fixture_data[path] = data
|
||||
return data
|
||||
|
||||
|
||||
class TestParameters(unittest.TestCase):
|
||||
|
||||
def test_module_parameters_keys(self):
|
||||
args = load_fixture('create_iapp_service_parameters_f5_http.json')
|
||||
p = Parameters(args)
|
||||
|
||||
# Assert the top-level keys
|
||||
assert p.name == 'http_example'
|
||||
assert p.partition == 'Common'
|
||||
assert p.template == '/Common/f5.http'
|
||||
|
||||
def test_module_parameters_lists(self):
|
||||
args = load_fixture('create_iapp_service_parameters_f5_http.json')
|
||||
p = Parameters(args)
|
||||
|
||||
assert 'lists' in p._values
|
||||
|
||||
assert p.lists[0]['name'] == 'irules__irules'
|
||||
assert p.lists[0]['encrypted'] == 'no'
|
||||
assert len(p.lists[0]['value']) == 1
|
||||
assert p.lists[0]['value'][0] == '/Common/lgyft'
|
||||
|
||||
assert p.lists[1]['name'] == 'net__client_vlan'
|
||||
assert p.lists[1]['encrypted'] == 'no'
|
||||
assert len(p.lists[1]['value']) == 1
|
||||
assert p.lists[1]['value'][0] == '/Common/net2'
|
||||
|
||||
def test_module_parameters_tables(self):
|
||||
args = load_fixture('create_iapp_service_parameters_f5_http.json')
|
||||
p = Parameters(args)
|
||||
|
||||
assert 'tables' in p._values
|
||||
|
||||
assert 'columnNames' in p.tables[0]
|
||||
assert len(p.tables[0]['columnNames']) == 1
|
||||
assert p.tables[0]['columnNames'][0] == 'name'
|
||||
|
||||
assert 'name' in p.tables[0]
|
||||
assert p.tables[0]['name'] == 'pool__hosts'
|
||||
|
||||
assert 'rows' in p.tables[0]
|
||||
assert len(p.tables[0]['rows']) == 1
|
||||
assert 'row' in p.tables[0]['rows'][0]
|
||||
assert len(p.tables[0]['rows'][0]['row']) == 1
|
||||
assert p.tables[0]['rows'][0]['row'][0] == 'demo.example.com'
|
||||
|
||||
assert len(p.tables[1]['rows']) == 2
|
||||
assert 'row' in p.tables[0]['rows'][0]
|
||||
assert len(p.tables[1]['rows'][0]['row']) == 2
|
||||
assert p.tables[1]['rows'][0]['row'][0] == '10.1.1.1'
|
||||
assert p.tables[1]['rows'][0]['row'][1] == '0'
|
||||
assert p.tables[1]['rows'][1]['row'][0] == '10.1.1.2'
|
||||
assert p.tables[1]['rows'][1]['row'][1] == '0'
|
||||
|
||||
def test_module_parameters_variables(self):
|
||||
args = load_fixture('create_iapp_service_parameters_f5_http.json')
|
||||
p = Parameters(args)
|
||||
|
||||
assert 'variables' in p._values
|
||||
assert len(p.variables) == 34
|
||||
|
||||
# Assert one configuration value
|
||||
assert 'name' in p.variables[0]
|
||||
assert 'value' in p.variables[0]
|
||||
assert p.variables[0]['name'] == 'afm__dos_security_profile'
|
||||
assert p.variables[0]['value'] == '/#do_not_use#'
|
||||
|
||||
# Assert a second configuration value
|
||||
assert 'name' in p.variables[1]
|
||||
assert 'value' in p.variables[1]
|
||||
assert p.variables[1]['name'] == 'afm__policy'
|
||||
assert p.variables[1]['value'] == '/#do_not_use#'
|
||||
|
||||
def test_api_parameters_variables(self):
|
||||
args = dict(
|
||||
variables=[
|
||||
dict(
|
||||
name="client__http_compression",
|
||||
encrypted="no",
|
||||
value="/#create_new#"
|
||||
)
|
||||
]
|
||||
)
|
||||
p = Parameters(args)
|
||||
assert p.variables[0]['name'] == 'client__http_compression'
|
||||
|
||||
def test_api_parameters_tables(self):
|
||||
args = dict(
|
||||
tables=[
|
||||
{
|
||||
"name": "pool__members",
|
||||
"columnNames": [
|
||||
"addr",
|
||||
"port",
|
||||
"connection_limit"
|
||||
],
|
||||
"rows": [
|
||||
{
|
||||
"row": [
|
||||
"12.12.12.12",
|
||||
"80",
|
||||
"0"
|
||||
]
|
||||
},
|
||||
{
|
||||
"row": [
|
||||
"13.13.13.13",
|
||||
"443",
|
||||
10
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
)
|
||||
p = Parameters(args)
|
||||
assert p.tables[0]['name'] == 'pool__members'
|
||||
assert p.tables[0]['columnNames'] == ['addr', 'port', 'connection_limit']
|
||||
assert len(p.tables[0]['rows']) == 2
|
||||
assert 'row' in p.tables[0]['rows'][0]
|
||||
assert 'row' in p.tables[0]['rows'][1]
|
||||
assert p.tables[0]['rows'][0]['row'] == ['12.12.12.12', '80', '0']
|
||||
assert p.tables[0]['rows'][1]['row'] == ['13.13.13.13', '443', '10']
|
||||
|
||||
|
||||
@patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root',
|
||||
return_value=True)
|
||||
class TestManager(unittest.TestCase):
|
||||
|
||||
def setUp(self):
|
||||
self.spec = ArgumentSpec()
|
||||
|
||||
def test_create_service(self, *args):
|
||||
parameters = load_fixture('create_iapp_service_parameters_f5_http.json')
|
||||
set_module_args(dict(
|
||||
name='foo',
|
||||
template='f5.http',
|
||||
parameters=parameters,
|
||||
state='present',
|
||||
password='passsword',
|
||||
server='localhost',
|
||||
user='admin'
|
||||
))
|
||||
|
||||
client = AnsibleF5Client(
|
||||
argument_spec=self.spec.argument_spec,
|
||||
supports_check_mode=self.spec.supports_check_mode,
|
||||
f5_product_name=self.spec.f5_product_name
|
||||
)
|
||||
mm = ModuleManager(client)
|
||||
|
||||
# Override methods to force specific logic in the module to happen
|
||||
mm.exists = Mock(return_value=False)
|
||||
mm.create_on_device = Mock(return_value=True)
|
||||
|
||||
results = mm.exec_module()
|
||||
assert results['changed'] is True
|
||||
|
||||
def test_update_agent_status_traps(self, *args):
|
||||
parameters = load_fixture('update_iapp_service_parameters_f5_http.json')
|
||||
set_module_args(dict(
|
||||
name='foo',
|
||||
template='f5.http',
|
||||
parameters=parameters,
|
||||
state='present',
|
||||
password='passsword',
|
||||
server='localhost',
|
||||
user='admin'
|
||||
))
|
||||
|
||||
# Configure the parameters that would be returned by querying the
|
||||
# remote device
|
||||
parameters = load_fixture('create_iapp_service_parameters_f5_http.json')
|
||||
current = Parameters(parameters)
|
||||
|
||||
client = AnsibleF5Client(
|
||||
argument_spec=self.spec.argument_spec,
|
||||
supports_check_mode=self.spec.supports_check_mode,
|
||||
f5_product_name=self.spec.f5_product_name
|
||||
)
|
||||
mm = ModuleManager(client)
|
||||
|
||||
# Override methods to force specific logic in the module to happen
|
||||
mm.exists = Mock(return_value=True)
|
||||
mm.update_on_device = Mock(return_value=True)
|
||||
mm.read_current_from_device = Mock(return_value=current)
|
||||
|
||||
results = mm.exec_module()
|
||||
assert results['changed'] is True
|
||||
Loading…
Add table
Add a link
Reference in a new issue