rehome external net api definition

This patch rehomes neutron's external-net API definition into
neutron-lib. It also includes the related exception. While this
exception is not used externally today [1], it seems anyone implementing
this extension may need to use it.

UTs and a release note are also included.

[1] http://codesearch.openstack.org/?q=ExternalNetworkInUse

Change-Id: I9933b91d1e82db3891b3b72f06e94316e56a4f15

neutron_lib/api/definitions/__init__.py

@@ -18,6 +18,7 @@ from neutron_lib.api.definitions import bgpvpn_routes_control
 from neutron_lib.api.definitions import data_plane_status
 from neutron_lib.api.definitions import dns
 from neutron_lib.api.definitions import dns_domain_ports
+from neutron_lib.api.definitions import external_net
 from neutron_lib.api.definitions import extra_dhcp_opt
 from neutron_lib.api.definitions import fip64
 from neutron_lib.api.definitions import firewall
@@ -48,6 +49,7 @@ _ALL_API_DEFINITIONS = {
     data_plane_status,
     dns,
     dns_domain_ports,
+    external_net,
     extra_dhcp_opt,
     fip64,
     firewall,

neutron_lib/api/definitions/external_net.py

@@ -0,0 +1,49 @@
+# Copyright (c) 2013 OpenStack Foundation.
+# 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
+
+
+# For backward compatibility the 'router' prefix is kept.
+EXTERNAL = 'router:external'
+
+ALIAS = 'external-net'
+IS_SHIM_EXTENSION = False
+IS_STANDARD_ATTR_EXTENSION = False
+NAME = 'Neutron external network'
+API_PREFIX = ''
+DESCRIPTION = 'Adds external network attribute to network resource.'
+UPDATED_TIMESTAMP = '2013-01-14T10:00:00-00:00'
+RESOURCE_NAME = network.RESOURCE_NAME
+COLLECTION_NAME = network.COLLECTION_NAME
+RESOURCE_ATTRIBUTE_MAP = {
+    COLLECTION_NAME: {
+        EXTERNAL: {
+            'allow_post': True,
+            'allow_put': True,
+            'default': False,
+            'is_visible': True,
+            'convert_to': converters.convert_to_boolean,
+            'enforce_policy': True,
+            'required_by_policy': True
+        }
+    }
+}
+SUB_RESOURCE_ATTRIBUTE_MAP = {}
+ACTION_MAP = {}
+REQUIRED_EXTENSIONS = []
+OPTIONAL_EXTENSIONS = []
+ACTION_STATUS = {}

neutron_lib/exceptions/external_net.py

@@ -0,0 +1,22 @@
+# Copyright (c) 2013 OpenStack Foundation.
+# 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._i18n import _
+from neutron_lib import exceptions
+
+
+class ExternalNetworkInUse(exceptions.InUse):
+    message = _("External network %(net_id)s cannot be updated to be made "
+                "non-external, since it has existing gateway ports.")

neutron_lib/tests/unit/api/definitions/test_external_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 external_net
+from neutron_lib.tests.unit.api.definitions import base
+
+
+class ExternalNetDefinitionTestCase(base.DefinitionBaseTestCase):
+    extension_module = external_net
+    extension_resources = ()
+    extension_attributes = (external_net.EXTERNAL,)

releasenotes/notes/rehome-externalnet-apidef-d377f87da900eabe.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - The ``external-net`` API extension's API definition is now available in
+    ``neutron_lib.api.definitions.external_net``.
+  - External network related exceptions are now available in
+    ``neutron_lib.exceptions.external_net``.