Rehome providernet api-def

This patch rehomes the neutron.extensions.providernet
extension into neutron-lib. Tests and release note are also
included as well as a minor change to the base API definition
test case to support ATTR_NOT_SPECIFIED parameter values.

Change-Id: I54a1fa31f97c291b223971409e7915df24ee3ad1

neutron_lib/api/definitions/provider_net.py

@@ -0,0 +1,107 @@
+# 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 import constants
+
+# The alias of the extension.
+ALIAS = 'provider'
+
+# 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
+
+# The name of the extension.
+NAME = 'Provider Network'
+
+# A prefix for API resources. An empty prefix means that the API is going
+# to be exposed at the v2/ level as any other core resource.
+API_PREFIX = ''
+
+# The description of the extension.
+DESCRIPTION = "Expose mapping of virtual networks to physical networks"
+
+# A timestamp of when the extension was introduced.
+UPDATED_TIMESTAMP = "2012-09-07T10:00:00-00:00"
+
+# The name of the resource.
+RESOURCE_NAME = 'network'
+
+# The plural for the resource.
+COLLECTION_NAME = 'networks'
+
+NETWORK_TYPE = 'provider:network_type'
+PHYSICAL_NETWORK = 'provider:physical_network'
+SEGMENTATION_ID = 'provider:segmentation_id'
+ATTRIBUTES = (NETWORK_TYPE, PHYSICAL_NETWORK, SEGMENTATION_ID)
+
+# Common definitions for maximum string field length
+NETWORK_TYPE_MAX_LEN = 32
+PHYSICAL_NETWORK_MAX_LEN = 64
+
+RESOURCE_ATTRIBUTE_MAP = {
+    COLLECTION_NAME: {
+        NETWORK_TYPE: {'allow_post': True, 'allow_put': True,
+                       'validate': {'type:string': NETWORK_TYPE_MAX_LEN},
+                       'default': constants.ATTR_NOT_SPECIFIED,
+                       'enforce_policy': True,
+                       'is_visible': True},
+        PHYSICAL_NETWORK: {'allow_post': True, 'allow_put': True,
+                           'validate': {'type:string':
+                                        PHYSICAL_NETWORK_MAX_LEN},
+                           'default': constants.ATTR_NOT_SPECIFIED,
+                           'enforce_policy': True,
+                           'is_visible': True},
+        SEGMENTATION_ID: {'allow_post': True, 'allow_put': True,
+                          'convert_to': converters.convert_to_int,
+                          'enforce_policy': True,
+                          'default': constants.ATTR_NOT_SPECIFIED,
+                          'is_visible': True},
+    }
+}
+
+# The subresource attribute map for the extension. It adds child resources
+# to main extension's resource. The subresource map must have a parent and
+# a parameters entry. If an extension does not need such a map, None can
+# be specified (mandatory).
+SUB_RESOURCE_ATTRIBUTE_MAP = None
+
+# The action map: it associates verbs with methods to be performed on
+# the API resource. For example:
+#
+# ACTION_MAP = {
+#     RESOURCE_NAME: {
+#        'add_my_foo_bars': 'PUT',
+#        'remove_my_foo_bars': 'PUT',
+#        'get_my_foo_bars': 'GET'
+#    }
+# }
+ACTION_MAP = {
+}
+
+# The list of required extensions.
+REQUIRED_EXTENSIONS = [
+]
+
+# The list of optional extensions.
+OPTIONAL_EXTENSIONS = [
+]

neutron_lib/tests/unit/api/definitions/base.py

@@ -12,6 +12,7 @@
 
 from neutron_lib.api.definitions import base
 from neutron_lib.api import validators
+from neutron_lib import constants
 from neutron_lib.tests import _base as test_base
 
 
@@ -22,6 +23,8 @@ def assert_bool(tester, attribute, attribute_dict, keyword, value):
 
 
 def assert_converter(tester, attribute, attribute_dict, keyword, value):
+    if attribute_dict['default'] is constants.ATTR_NOT_SPECIFIED:
+        return
     try:
         attribute_dict['convert_to'](attribute_dict['default'])
     except KeyError:

neutron_lib/tests/unit/api/definitions/test_provider_net.py

@@ -0,0 +1,20 @@
+#    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 provider_net
+from neutron_lib.tests.unit.api.definitions import base
+
+
+class ProviderNetTestCase(base.DefinitionBaseTestCase):
+    extension_module = provider_net
+    extension_resources = (provider_net.COLLECTION_NAME,)
+    extension_attributes = provider_net.ATTRIBUTES

releasenotes/notes/provider-net-apidef-9ebe9f56840c79f7.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - The Neutron ``Provider network`` extension API definition has been added as
+    ``neutron_lib.api.definitions.provider_net``.