openstack
/
neutron-lib
Code Issues Proposed changes

Introduce API for port bindings extended 

This is a neutron-lib part that contains API resource definition of
extended port bindings.

Partial-Bug: #1580880

Change-Id: I431be79975f6fc371822038ed4acdf02e7b8e99b
This commit is contained in:
Jakub Libosvar 2017-07-17 14:35:14 +00:00 committed by Jakub Libosvar
parent 9488b976f5
commit 6803dc6ddd
5 changed files with 161 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
neutron_lib/api/definitions/__init__.py
View File

@ -29,6 +29,7 @@ from neutron_lib.api.definitions import network_mtu
from neutron_lib.api.definitions import port
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 router_interface_fip
from neutron_lib.api.definitions import subnet
@ -57,6 +58,7 @@ _ALL_API_DEFINITIONS = {
port,
port_security,
portbindings,
portbindings_extended,
provider_net,
router_interface_fip,
subnet,

124
neutron_lib/api/definitions/portbindings_extended.py Normal file
View File

@ -0,0 +1,124 @@
# 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.definitions import port
from neutron_lib.api.definitions import portbindings
from neutron_lib import constants
from neutron_lib.db import constants as db_const
# Plural of the resource
COLLECTION_NAME = 'bindings'
# Name of the resource
RESOURCE_NAME = 'binding'
# Parent
PARENT_RESOURCE_NAME = port.RESOURCE_NAME
PARENT_COLLECTION_NAME = port.COLLECTION_NAME
# Whether or not this extension is simply signaling behavior to the user
# or it actively modifies the attribute map.
IS_SHIM_EXTENSION = False
# Whether the extension is marking the adoption of standardattr model for
# legacy resources, or introducing new standardattr attributes. False or
# None if the standardattr model is adopted since the introduction of
# resource extension.
# If this is True, the alias for the extension should be prefixed with
# 'standard-attr-'.
IS_STANDARD_ATTR_EXTENSION = False
# Name of the extension
NAME = "Port Bindings Extended"
# Extension alias
ALIAS = 'binding-extended'
# Extension description
DESCRIPTION = "Expose port bindings of a virtual port to external application"
# Action name for activating a port binding
ACTIVATE_BINDING = 'activate'
# Timestamp of last update of this extension
UPDATED_TIMESTAMP = "2017-07-17T10:00:00-00:00"
# Extension attributes
HOST = 'host'
VIF_TYPE = 'vif_type'
VIF_DETAILS = 'vif_details'
VNIC_TYPE = 'vnic_type'
PROFILE = 'profile'
STATUS = 'status'
PROJECT_ID = 'project_id'
# No attribute map, this extension defines only sub resource
RESOURCE_ATTRIBUTE_MAP = {}
# Attribute map of bindings
SUB_RESOURCE_ATTRIBUTE_MAP = {
COLLECTION_NAME: {
'parent': {
'collection_name': PARENT_COLLECTION_NAME,
'member_name': PARENT_RESOURCE_NAME},
'parameters': {
HOST: {'allow_post': True, 'allow_put': True,
'is_visible': True, 'primary_key': True},
VIF_TYPE: {'allow_post': False, 'allow_put': False,
'default': constants.ATTR_NOT_SPECIFIED,
'enforce_policy': True,
'is_visible': True},
VIF_DETAILS: {'allow_post': False, 'allow_put': False,
'default': constants.ATTR_NOT_SPECIFIED,
'enforce_policy': True,
'is_visible': True},
VNIC_TYPE: {'allow_post': True, 'allow_put': True,
'default': portbindings.VNIC_NORMAL,
'is_visible': True,
'validate': {'type:values': portbindings.VNIC_TYPES},
'enforce_policy': True},
PROFILE: {'allow_post': True, 'allow_put': True,
'default': constants.ATTR_NOT_SPECIFIED,
'enforce_policy': True,
'validate': {'type:dict_or_none': None},
'is_visible': True},
STATUS: {'allow_post': False, 'allow_put': False,
'is_visible': True},
PROJECT_ID: {'allow_post': True, 'allow_put': False,
'required_by_policy': True,
'validate': {
'type:string': db_const.PROJECT_ID_FIELD_SIZE},
'is_visible': True},
}
}
}
# activate is an action
ACTION_MAP = {
RESOURCE_NAME: {
ACTIVATE_BINDING: 'PUT',
},
}
# No action statuses are required
ACTION_STATUS = {
}
# The list of required extensions
REQUIRED_EXTENSIONS = [
portbindings.ALIAS,
]
# The list of optional extensions
OPTIONAL_EXTENSIONS = []

6
neutron_lib/tests/unit/api/definitions/base.py
View File

@ -104,8 +104,10 @@ class DefinitionBaseTestCase(test_base.BaseTestCase):
self.skipTest('API definition is not related to standardattr.')
def test_resource_map(self):
if not self.resource_map and not self.is_shim_extension:
self.fail('Missing resource map, what is this extension doing?')
if (not self.resource_map and not self.subresource_map
and not self.is_shim_extension):
self.fail('Missing resource and subresource map, '
'what is this extension doing?')
elif self.is_shim_extension:
self.skipTest('Shim extension with no API changes.')

26
neutron_lib/tests/unit/api/definitions/test_portbindings_extended.py Normal file
View File

@ -0,0 +1,26 @@
# 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 portbindings_extended as pbe
from neutron_lib.tests.unit.api.definitions import base
class PortbindingsExtendedDefinitionTestCase(base.DefinitionBaseTestCase):
extension_module = pbe
extension_attributes = (pbe.VIF_TYPE,
pbe.VIF_DETAILS,
pbe.VNIC_TYPE,
pbe.HOST,
pbe.PROFILE,
pbe.STATUS,
pbe.PROJECT_ID)
extension_subresources = (pbe.COLLECTION_NAME,)

5
releasenotes/notes/portbindings-extended-3a89560ee63824e1.yaml Normal file
View File

@ -0,0 +1,5 @@
---
features:
- |
API reference for ``extended port bindings`` extension for ``port``
resource.