rehome qos api definition
This patch rehomes neutron's qos extension's API definition into neutron-lib. UTs and a release note are also included. Reviewers: Please note the difference in the SUB_RESOURCE_ATTRIBUTE_MAP attributes herein vs those in the original. Here we've added conversion to int on a few attributes and also removed the default value of None for those. Change-Id: I8ab3712850ec02278b3efb9161fc03236926b842
This commit is contained in:
Boden R
@@ -38,6 +38,7 @@ from neutron_lib.api.definitions import port_security
|
||||
from neutron_lib.api.definitions import portbindings
|
||||
from neutron_lib.api.definitions import portbindings_extended
|
||||
from neutron_lib.api.definitions import provider_net
|
||||
from neutron_lib.api.definitions import qos
|
||||
from neutron_lib.api.definitions import router_availability_zone
|
||||
from neutron_lib.api.definitions import router_interface_fip
|
||||
from neutron_lib.api.definitions import subnet
|
||||
@@ -76,6 +77,7 @@ _ALL_API_DEFINITIONS = {
|
||||
portbindings,
|
||||
portbindings_extended,
|
||||
provider_net,
|
||||
qos,
|
||||
router_availability_zone,
|
||||
router_interface_fip,
|
||||
subnet,
|
||||
|
||||
158
neutron_lib/api/definitions/qos.py
Normal file
158
neutron_lib/api/definitions/qos.py
Normal file
@@ -0,0 +1,158 @@
|
||||
# Copyright (c) 2015 Red Hat Inc.
|
||||
# All rights reserved.
|
||||
#
|
||||
# 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 neutron_lib.api import converters
|
||||
from neutron_lib.api.definitions import network
|
||||
from neutron_lib.api.definitions import port
|
||||
from neutron_lib import constants
|
||||
from neutron_lib.db import constants as db_const
|
||||
from neutron_lib.services.qos import constants as qos_const
|
||||
|
||||
|
||||
BANDWIDTH_LIMIT_RULES = "bandwidth_limit_rules"
|
||||
RULE_TYPES = "rule_types"
|
||||
POLICIES = 'policies'
|
||||
POLICY = 'policy'
|
||||
DSCP_MARKING_RULES = 'dscp_marking_rules'
|
||||
MIN_BANDWIDTH_RULES = 'minimum_bandwidth_rules'
|
||||
_QOS_RULE_COMMON_FIELDS = {
|
||||
'id': {
|
||||
'allow_post': False, 'allow_put': False,
|
||||
'validate': {'type:uuid': None},
|
||||
'is_visible': True,
|
||||
'primary_key': True
|
||||
},
|
||||
'tenant_id': {
|
||||
'allow_post': True, 'allow_put': False,
|
||||
'required_by_policy': True,
|
||||
'is_visible': True
|
||||
}
|
||||
}
|
||||
|
||||
ALIAS = 'qos'
|
||||
IS_SHIM_EXTENSION = False
|
||||
IS_STANDARD_ATTR_EXTENSION = False
|
||||
NAME = 'Quality of Service'
|
||||
API_PREFIX = '/' + ALIAS
|
||||
DESCRIPTION = 'The Quality of Service extension.'
|
||||
UPDATED_TIMESTAMP = '2015-06-08T10:00:00-00:00'
|
||||
RESOURCE_ATTRIBUTE_MAP = {
|
||||
POLICIES: {
|
||||
'id': {
|
||||
'allow_post': False, 'allow_put': False,
|
||||
'validate': {'type:uuid': None},
|
||||
'is_visible': True, 'primary_key': True
|
||||
},
|
||||
'name': {
|
||||
'allow_post': True, 'allow_put': True,
|
||||
'is_visible': True, 'default': '',
|
||||
'validate': {'type:string': db_const.NAME_FIELD_SIZE}},
|
||||
'shared': {
|
||||
'allow_post': True, 'allow_put': True,
|
||||
'is_visible': True, 'default': False,
|
||||
'convert_to': converters.convert_to_boolean
|
||||
},
|
||||
'tenant_id': {
|
||||
'allow_post': True, 'allow_put': False,
|
||||
'required_by_policy': True,
|
||||
'validate': {'type:string': db_const.PROJECT_ID_FIELD_SIZE},
|
||||
'is_visible': True
|
||||
},
|
||||
'rules': {
|
||||
'allow_post': False,
|
||||
'allow_put': False,
|
||||
'is_visible': True
|
||||
}
|
||||
},
|
||||
RULE_TYPES: {
|
||||
'type': {
|
||||
'allow_post': False, 'allow_put': False,
|
||||
'is_visible': True
|
||||
}
|
||||
},
|
||||
port.COLLECTION_NAME: {
|
||||
qos_const.QOS_POLICY_ID: {
|
||||
'allow_post': True,
|
||||
'allow_put': True,
|
||||
'is_visible': True,
|
||||
'default': None,
|
||||
'validate': {'type:uuid_or_none': None}
|
||||
}
|
||||
},
|
||||
network.COLLECTION_NAME: {
|
||||
qos_const.QOS_POLICY_ID: {
|
||||
'allow_post': True,
|
||||
'allow_put': True,
|
||||
'is_visible': True,
|
||||
'default': None,
|
||||
'validate': {'type:uuid_or_none': None}
|
||||
}
|
||||
}
|
||||
}
|
||||
_PARENT = {
|
||||
'collection_name': POLICIES,
|
||||
'member_name': POLICY
|
||||
}
|
||||
SUB_RESOURCE_ATTRIBUTE_MAP = {
|
||||
BANDWIDTH_LIMIT_RULES: {
|
||||
'parent': _PARENT,
|
||||
'parameters': dict(
|
||||
_QOS_RULE_COMMON_FIELDS,
|
||||
**{'max_kbps': {
|
||||
'allow_post': True, 'allow_put': True,
|
||||
'convert_to': converters.convert_to_int,
|
||||
'is_visible': True,
|
||||
'validate': {
|
||||
'type:range': [0, db_const.DB_INTEGER_MAX_VALUE]}
|
||||
},
|
||||
'max_burst_kbps': {
|
||||
'allow_post': True, 'allow_put': True,
|
||||
'is_visible': True, 'default': 0,
|
||||
'convert_to': converters.convert_to_int,
|
||||
'validate': {
|
||||
'type:range': [0, db_const.DB_INTEGER_MAX_VALUE]}}}),
|
||||
},
|
||||
DSCP_MARKING_RULES: {
|
||||
'parent': _PARENT,
|
||||
'parameters': dict(
|
||||
_QOS_RULE_COMMON_FIELDS,
|
||||
**{'dscp_mark': {
|
||||
'allow_post': True, 'allow_put': True,
|
||||
'convert_to': converters.convert_to_int,
|
||||
'is_visible': True,
|
||||
'validate': {
|
||||
'type:values': constants.VALID_DSCP_MARKS}}})
|
||||
},
|
||||
MIN_BANDWIDTH_RULES: {
|
||||
'parent': _PARENT,
|
||||
'parameters': dict(
|
||||
_QOS_RULE_COMMON_FIELDS,
|
||||
**{'min_kbps': {
|
||||
'allow_post': True, 'allow_put': True,
|
||||
'is_visible': True,
|
||||
'convert_to': converters.convert_to_int,
|
||||
'validate': {
|
||||
'type:range': [0, db_const.DB_INTEGER_MAX_VALUE]}},
|
||||
'direction': {
|
||||
'allow_post': True, 'allow_put': True,
|
||||
'is_visible': True, 'default': constants.EGRESS_DIRECTION,
|
||||
'validate': {
|
||||
'type:values': [constants.EGRESS_DIRECTION]}}})
|
||||
}
|
||||
}
|
||||
ACTION_MAP = {}
|
||||
REQUIRED_EXTENSIONS = []
|
||||
OPTIONAL_EXTENSIONS = []
|
||||
ACTION_STATUS = {}
|
||||
25
neutron_lib/tests/unit/api/definitions/test_qos.py
Normal file
25
neutron_lib/tests/unit/api/definitions/test_qos.py
Normal file
@@ -0,0 +1,25 @@
|
||||
# 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 neutron_lib.api.definitions import qos
|
||||
from neutron_lib.tests.unit.api.definitions import base
|
||||
|
||||
|
||||
class QoSDefinitionTestCase(base.DefinitionBaseTestCase):
|
||||
extension_module = qos
|
||||
extension_resources = (qos.POLICIES, qos.RULE_TYPES)
|
||||
extension_subresources = (qos.BANDWIDTH_LIMIT_RULES,
|
||||
qos.DSCP_MARKING_RULES,
|
||||
qos.MIN_BANDWIDTH_RULES)
|
||||
extension_attributes = ('direction', 'max_burst_kbps', 'type',
|
||||
'dscp_mark', 'min_kbps', 'rules', 'max_kbps',
|
||||
'qos_policy_id')
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
features:
|
||||
- The API definition for neutron's ``qos`` extension is now available in
|
||||
``neutron_lib.api.definitions.qos``.
|
||||
Reference in New Issue
Block a user