Add new resource l7rule
Add support of new neutron lbaas l7rule resource. Implements: bp lbaas-l7-rules-support Partial-bug: #1563041 Change-Id: I0e8f99db73b07b8bd6914e37e2688f06432dab9b
This commit is contained in:
Dmitriy Uvarenkov
parent
b2ab0c20df
commit
b5a7d143dd
|
|
@ -0,0 +1,216 @@
|
|||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
# not use this file except in compliance with the License. You may obtain
|
||||
# a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
from heat.common import exception
|
||||
from heat.common.i18n import _
|
||||
from heat.engine import constraints
|
||||
from heat.engine import properties
|
||||
from heat.engine.resources.openstack.neutron import neutron
|
||||
from heat.engine import support
|
||||
|
||||
|
||||
class L7Rule(neutron.NeutronResource):
|
||||
"""A resource for managing LBaaS v2 L7Rules.
|
||||
|
||||
This resource manages Neutron-LBaaS v2 L7Rules, which represent
|
||||
a set of attributes that defines which part of the request should
|
||||
be matched and how it should be matched.
|
||||
"""
|
||||
|
||||
support_status = support.SupportStatus(version='7.0.0')
|
||||
|
||||
required_service_extension = 'lbaasv2'
|
||||
|
||||
PROPERTIES = (
|
||||
ADMIN_STATE_UP, L7POLICY, TYPE, COMPARE_TYPE,
|
||||
INVERT, KEY, VALUE
|
||||
) = (
|
||||
'admin_state_up', 'l7policy', 'type', 'compare_type',
|
||||
'invert', 'key', 'value'
|
||||
)
|
||||
|
||||
L7RULE_TYPES = (
|
||||
HOST_NAME, PATH, FILE_TYPE, HEADER, COOKIE
|
||||
) = (
|
||||
'HOST_NAME', 'PATH', 'FILE_TYPE', 'HEADER', 'COOKIE'
|
||||
)
|
||||
|
||||
L7COMPARE_TYPES = (
|
||||
REGEX, STARTS_WITH, ENDS_WITH, CONTAINS, EQUAL_TO
|
||||
) = (
|
||||
'REGEX', 'STARTS_WITH', 'ENDS_WITH', 'CONTAINS', 'EQUAL_TO'
|
||||
)
|
||||
|
||||
properties_schema = {
|
||||
ADMIN_STATE_UP: properties.Schema(
|
||||
properties.Schema.BOOLEAN,
|
||||
_('The administrative state of the rule.'),
|
||||
default=True,
|
||||
update_allowed=True
|
||||
),
|
||||
L7POLICY: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('ID or name of L7 policy this rule belongs to.'),
|
||||
required=True
|
||||
),
|
||||
TYPE: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('Rule type.'),
|
||||
constraints=[constraints.AllowedValues(L7RULE_TYPES)],
|
||||
update_allowed=True,
|
||||
required=True
|
||||
),
|
||||
COMPARE_TYPE: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('Rule compare type.'),
|
||||
constraints=[constraints.AllowedValues(L7COMPARE_TYPES)],
|
||||
update_allowed=True,
|
||||
required=True
|
||||
),
|
||||
INVERT: properties.Schema(
|
||||
properties.Schema.BOOLEAN,
|
||||
_('Invert the compare type.'),
|
||||
default=False,
|
||||
update_allowed=True
|
||||
),
|
||||
KEY: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('Key to compare. Relevant for HEADER and COOKIE types only.'),
|
||||
update_allowed=True
|
||||
),
|
||||
VALUE: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('Value to compare.'),
|
||||
update_allowed=True,
|
||||
required=True
|
||||
)
|
||||
}
|
||||
|
||||
def __init__(self, name, definition, stack):
|
||||
super(L7Rule, self).__init__(name, definition, stack)
|
||||
self._l7p_id = None
|
||||
self._lb_id = None
|
||||
|
||||
@property
|
||||
def l7policy_id(self):
|
||||
if self._l7p_id is None:
|
||||
self._l7p_id = self.client_plugin().find_resourceid_by_name_or_id(
|
||||
self.L7POLICY,
|
||||
self.properties[self.L7POLICY],
|
||||
cmd_resource='lbaas_l7policy')
|
||||
return self._l7p_id
|
||||
|
||||
@property
|
||||
def lb_id(self):
|
||||
if self._lb_id is None:
|
||||
policy = self.client().show_lbaas_l7policy(
|
||||
self.l7policy_id)['l7policy']
|
||||
listener_id = policy['listener_id']
|
||||
listener = self.client().show_listener(listener_id)['listener']
|
||||
self._lb_id = listener['loadbalancers'][0]['id']
|
||||
return self._lb_id
|
||||
|
||||
def _check_lb_status(self):
|
||||
return self.client_plugin().check_lb_status(self.lb_id)
|
||||
|
||||
def validate(self):
|
||||
res = super(L7Rule, self).validate()
|
||||
if res:
|
||||
return res
|
||||
|
||||
if (self.properties[self.TYPE] in (self.HEADER, self.COOKIE) and
|
||||
self.properties[self.KEY] is None):
|
||||
msg = (_('Property %(key)s is missing. '
|
||||
'This property should be specified for '
|
||||
'rules of %(header)s and %(cookie)s types.') %
|
||||
{'key': self.KEY,
|
||||
'header': self.HEADER,
|
||||
'cookie': self.COOKIE})
|
||||
raise exception.StackValidationFailed(message=msg)
|
||||
|
||||
def handle_create(self):
|
||||
rule_args = dict((k, v) for k, v in self.properties.items()
|
||||
if k is not self.L7POLICY)
|
||||
return rule_args
|
||||
|
||||
def check_create_complete(self, rule_args):
|
||||
if self.resource_id is None:
|
||||
try:
|
||||
l7rule = self.client().create_lbaas_l7rule(
|
||||
self.l7policy_id,
|
||||
{'rule': rule_args})['rule']
|
||||
self.resource_id_set(l7rule['id'])
|
||||
except Exception as ex:
|
||||
if self.client_plugin().is_invalid(ex):
|
||||
return False
|
||||
raise
|
||||
|
||||
return self._check_lb_status()
|
||||
|
||||
def _show_resource(self):
|
||||
return self.client().show_lbaas_l7rule(
|
||||
self.resource_id, self.l7policy_id)['rule']
|
||||
|
||||
def handle_update(self, json_snippet, tmpl_diff, prop_diff):
|
||||
self._update_called = False
|
||||
if (prop_diff.get(self.TYPE) in (self.COOKIE, self.HEADER) and
|
||||
prop_diff.get(self.KEY) is None):
|
||||
prop_diff[self.KEY] = tmpl_diff['Properties'].get(self.KEY)
|
||||
|
||||
return prop_diff
|
||||
|
||||
def check_update_complete(self, prop_diff):
|
||||
if not prop_diff:
|
||||
return True
|
||||
|
||||
if not self._update_called:
|
||||
try:
|
||||
self.client().update_lbaas_l7rule(
|
||||
self.resource_id,
|
||||
self.l7policy_id,
|
||||
{'rule': prop_diff})
|
||||
self._update_called = True
|
||||
except Exception as ex:
|
||||
if self.client_plugin().is_invalid(ex):
|
||||
return False
|
||||
raise
|
||||
|
||||
return self._check_lb_status()
|
||||
|
||||
def handle_delete(self):
|
||||
self._delete_called = False
|
||||
|
||||
def check_delete_complete(self, data):
|
||||
if self.resource_id is None:
|
||||
return True
|
||||
|
||||
if not self._delete_called:
|
||||
try:
|
||||
self.client().delete_lbaas_l7rule(
|
||||
self.resource_id,
|
||||
self.l7policy_id)
|
||||
self._delete_called = True
|
||||
except Exception as ex:
|
||||
if self.client_plugin().is_invalid(ex):
|
||||
return False
|
||||
elif self.client_plugin().is_not_found(ex):
|
||||
return True
|
||||
raise
|
||||
|
||||
return self._check_lb_status()
|
||||
|
||||
|
||||
def resource_mapping():
|
||||
return {
|
||||
'OS::Neutron::LBaaS::L7Rule': L7Rule
|
||||
}
|
||||
|
|
@ -171,3 +171,19 @@ resources:
|
|||
listener: 123
|
||||
position: 1
|
||||
'''
|
||||
|
||||
L7RULE_TEMPLATE = '''
|
||||
heat_template_version: 2016-04-08
|
||||
description: Template to test L7Rule Neutron resource
|
||||
resources:
|
||||
l7rule:
|
||||
type: OS::Neutron::LBaaS::L7Rule
|
||||
properties:
|
||||
admin_state_up: True
|
||||
l7policy: 123
|
||||
type: HEADER
|
||||
compare_type: ENDS_WITH
|
||||
key: test_key
|
||||
value: test_value
|
||||
invert: False
|
||||
'''
|
||||
|
|
|
|||
|
|
@ -0,0 +1,176 @@
|
|||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
# not use this file except in compliance with the License. You may obtain
|
||||
# a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
import mock
|
||||
import yaml
|
||||
|
||||
from neutronclient.common import exceptions
|
||||
|
||||
from heat.common import exception
|
||||
from heat.common.i18n import _
|
||||
from heat.common import template_format
|
||||
from heat.engine.resources.openstack.neutron.lbaas import l7rule
|
||||
from heat.tests import common
|
||||
from heat.tests.openstack.neutron import inline_templates
|
||||
from heat.tests import utils
|
||||
|
||||
|
||||
class L7RuleTest(common.HeatTestCase):
|
||||
|
||||
def test_resource_mapping(self):
|
||||
mapping = l7rule.resource_mapping()
|
||||
self.assertEqual(mapping['OS::Neutron::LBaaS::L7Rule'],
|
||||
l7rule.L7Rule)
|
||||
|
||||
@mock.patch('heat.engine.clients.os.neutron.'
|
||||
'NeutronClientPlugin.has_extension', return_value=True)
|
||||
def _create_stack(self, ext_func, tmpl=inline_templates.L7RULE_TEMPLATE):
|
||||
self.t = template_format.parse(tmpl)
|
||||
self.stack = utils.parse_stack(self.t)
|
||||
self.l7rule = self.stack['l7rule']
|
||||
|
||||
self.neutron_client = mock.MagicMock()
|
||||
self.l7rule.client = mock.MagicMock(return_value=self.neutron_client)
|
||||
|
||||
self.l7rule.client_plugin().find_resourceid_by_name_or_id = (
|
||||
mock.MagicMock(return_value='123'))
|
||||
self.l7rule.client_plugin().client = mock.MagicMock(
|
||||
return_value=self.neutron_client)
|
||||
self.neutron_client.show_loadbalancer.side_effect = [
|
||||
{'loadbalancer': {'provisioning_status': 'PENDING_UPDATE'}},
|
||||
{'loadbalancer': {'provisioning_status': 'PENDING_UPDATE'}},
|
||||
{'loadbalancer': {'provisioning_status': 'ACTIVE'}},
|
||||
]
|
||||
|
||||
def test_validate_when_key_required(self):
|
||||
tmpl = yaml.load(inline_templates.L7RULE_TEMPLATE)
|
||||
props = tmpl['resources']['l7rule']['properties']
|
||||
del props['key']
|
||||
self._create_stack(tmpl=yaml.dump(tmpl))
|
||||
|
||||
msg = _('Property key is missing. This property should be '
|
||||
'specified for rules of HEADER and COOKIE types.')
|
||||
with mock.patch('heat.engine.clients.os.neutron.NeutronClientPlugin.'
|
||||
'has_extension', return_value=True):
|
||||
self.assertRaisesRegexp(exception.StackValidationFailed,
|
||||
msg, self.l7rule.validate)
|
||||
|
||||
def test_create(self):
|
||||
self._create_stack()
|
||||
self.neutron_client.create_lbaas_l7rule.side_effect = [
|
||||
exceptions.StateInvalidClient,
|
||||
{'rule': {'id': '1234'}}
|
||||
]
|
||||
expected = (
|
||||
'123',
|
||||
{
|
||||
'rule': {
|
||||
'admin_state_up': True,
|
||||
'invert': False,
|
||||
'type': u'HEADER',
|
||||
'compare_type': u'ENDS_WITH',
|
||||
'key': u'test_key',
|
||||
'value': u'test_value',
|
||||
'invert': False
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
props = self.l7rule.handle_create()
|
||||
|
||||
self.assertFalse(self.l7rule.check_create_complete(props))
|
||||
self.neutron_client.create_lbaas_l7rule.assert_called_with(*expected)
|
||||
self.assertFalse(self.l7rule.check_create_complete(props))
|
||||
self.neutron_client.create_lbaas_l7rule.assert_called_with(*expected)
|
||||
self.assertFalse(self.l7rule.check_create_complete(props))
|
||||
self.assertTrue(self.l7rule.check_create_complete(props))
|
||||
|
||||
def test_create_missing_properties(self):
|
||||
for prop in ('l7policy', 'type', 'compare_type', 'value'):
|
||||
tmpl = yaml.load(inline_templates.L7RULE_TEMPLATE)
|
||||
del tmpl['resources']['l7rule']['properties'][prop]
|
||||
self._create_stack(tmpl=yaml.dump(tmpl))
|
||||
|
||||
self.assertRaises(exception.StackValidationFailed,
|
||||
self.l7rule.validate)
|
||||
|
||||
def test_show_resource(self):
|
||||
self._create_stack()
|
||||
self.l7rule.resource_id_set('1234')
|
||||
self.neutron_client.show_lbaas_l7rule.return_value = {
|
||||
'rule': {'id': '1234'}
|
||||
}
|
||||
|
||||
self.assertEqual({'id': '1234'}, self.l7rule._show_resource())
|
||||
|
||||
self.neutron_client.show_lbaas_l7rule.assert_called_with('1234', '123')
|
||||
|
||||
def test_update(self):
|
||||
self._create_stack()
|
||||
self.l7rule.resource_id_set('1234')
|
||||
self.neutron_client.update_lbaas_l7rule.side_effect = [
|
||||
exceptions.StateInvalidClient, None]
|
||||
prop_diff = {
|
||||
'admin_state_up': False,
|
||||
'name': 'your_l7policy',
|
||||
'redirect_url': 'http://www.google.com'
|
||||
}
|
||||
|
||||
prop_diff = self.l7rule.handle_update(None, None, prop_diff)
|
||||
|
||||
self.assertFalse(self.l7rule.check_update_complete(prop_diff))
|
||||
self.assertFalse(self.l7rule._update_called)
|
||||
self.neutron_client.update_lbaas_l7rule.assert_called_with(
|
||||
'1234', '123', {'rule': prop_diff})
|
||||
self.assertFalse(self.l7rule.check_update_complete(prop_diff))
|
||||
self.assertTrue(self.l7rule._update_called)
|
||||
self.neutron_client.update_lbaas_l7rule.assert_called_with(
|
||||
'1234', '123', {'rule': prop_diff})
|
||||
self.assertFalse(self.l7rule.check_update_complete(prop_diff))
|
||||
self.assertTrue(self.l7rule.check_update_complete(prop_diff))
|
||||
|
||||
def test_delete(self):
|
||||
self._create_stack()
|
||||
self.l7rule.resource_id_set('1234')
|
||||
self.neutron_client.delete_lbaas_l7rule.side_effect = [
|
||||
exceptions.StateInvalidClient, None]
|
||||
|
||||
self.l7rule.handle_delete()
|
||||
|
||||
self.assertFalse(self.l7rule.check_delete_complete(None))
|
||||
self.assertFalse(self.l7rule._delete_called)
|
||||
self.assertFalse(self.l7rule.check_delete_complete(None))
|
||||
self.assertTrue(self.l7rule._delete_called)
|
||||
self.neutron_client.delete_lbaas_l7rule.assert_called_with(
|
||||
'1234', '123')
|
||||
self.assertFalse(self.l7rule.check_delete_complete(None))
|
||||
self.assertTrue(self.l7rule.check_delete_complete(None))
|
||||
|
||||
def test_delete_already_gone(self):
|
||||
self._create_stack()
|
||||
self.l7rule.resource_id_set('1234')
|
||||
self.neutron_client.delete_lbaas_l7rule.side_effect = (
|
||||
exceptions.NotFound)
|
||||
|
||||
self.l7rule.handle_delete()
|
||||
self.assertTrue(self.l7rule.check_delete_complete(None))
|
||||
|
||||
def test_delete_failed(self):
|
||||
self._create_stack()
|
||||
self.l7rule.resource_id_set('1234')
|
||||
self.neutron_client.delete_lbaas_l7rule.side_effect = (
|
||||
exceptions.Unauthorized)
|
||||
|
||||
self.l7rule.handle_delete()
|
||||
self.assertRaises(exceptions.Unauthorized,
|
||||
self.l7rule.check_delete_complete, None)
|
||||
Loading…
Reference in New Issue