Merge "rehome neutron's agent extension API definition"

neutron_lib/api/definitions/__init__.py

@@ -10,6 +10,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+from neutron_lib.api.definitions import agent
 from neutron_lib.api.definitions import bgpvpn
 from neutron_lib.api.definitions import bgpvpn_routes_control
 from neutron_lib.api.definitions import data_plane_status
@@ -37,6 +38,7 @@ from neutron_lib.api.definitions import trunk_details
 
 
 _ALL_API_DEFINITIONS = {
+    agent,
     bgpvpn,
     bgpvpn_routes_control,
     data_plane_status,

neutron_lib/api/definitions/agent.py

@@ -0,0 +1,66 @@
+# Copyright (c) 2013 OpenStack Foundation.
+#
+# 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.db import constants
+
+ALIAS = 'agent'
+LABEL = ALIAS
+IS_SHIM_EXTENSION = False
+IS_STANDARD_ATTR_EXTENSION = False
+NAME = ALIAS
+API_PREFIX = ''
+DESCRIPTION = 'The agent management extension.'
+UPDATED_TIMESTAMP = '2013-02-03T10:00:00-00:00'
+RESOURCE_NAME = ALIAS
+COLLECTION_NAME = ALIAS + 's'
+RESOURCE_ATTRIBUTE_MAP = {
+    COLLECTION_NAME: {
+        'id': {'allow_post': False, 'allow_put': False,
+               'validate': {'type:uuid': None},
+               'is_visible': True},
+        'agent_type': {'allow_post': False, 'allow_put': False,
+                       'is_visible': True},
+        'binary': {'allow_post': False, 'allow_put': False,
+                   'is_visible': True},
+        'topic': {'allow_post': False, 'allow_put': False,
+                  'is_visible': True},
+        'host': {'allow_post': False, 'allow_put': False,
+                 'is_visible': True},
+        'admin_state_up': {'allow_post': False, 'allow_put': True,
+                           'convert_to': converters.convert_to_boolean,
+                           'is_visible': True},
+        'created_at': {'allow_post': False, 'allow_put': False,
+                       'is_visible': True},
+        'started_at': {'allow_post': False, 'allow_put': False,
+                       'is_visible': True},
+        'heartbeat_timestamp': {'allow_post': False, 'allow_put': False,
+                                'is_visible': True},
+        'alive': {'allow_post': False, 'allow_put': False,
+                  'is_visible': True},
+        'configurations': {'allow_post': False, 'allow_put': False,
+                           'is_visible': True},
+        'description': {
+            'allow_post': False, 'allow_put': True,
+            'is_visible': True,
+            'validate': {
+                'type:string_or_none': constants.DESCRIPTION_FIELD_SIZE}},
+    }
+}
+SUB_RESOURCE_ATTRIBUTE_MAP = {}
+ACTION_MAP = {}
+REQUIRED_EXTENSIONS = []
+OPTIONAL_EXTENSIONS = []
+ACTION_STATUS = {}

neutron_lib/exceptions/agent.py

@@ -0,0 +1,30 @@
+# 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 AgentNotFound(exceptions.NotFound):
+    message = _("Agent %(id)s could not be found.")
+
+
+class AgentNotFoundByTypeHost(exceptions.NotFound):
+    message = _("Agent with agent_type=%(agent_type)s and host=%(host)s "
+                "could not be found.")
+
+
+class MultipleAgentFoundByTypeHost(exceptions.Conflict):
+    message = _("Multiple agents with agent_type=%(agent_type)s and "
+                "host=%(host)s found.")

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

@@ -0,0 +1,24 @@
+# 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 agent
+from neutron_lib.tests.unit.api.definitions import base
+
+
+class AgentDefinitionTestCase(base.DefinitionBaseTestCase):
+    extension_module = agent
+    extension_resources = (agent.COLLECTION_NAME,)
+    extension_attributes = ('topic', 'agent_type', 'created_at',
+                            'configurations', 'heartbeat_timestamp',
+                            'binary', 'started_at', 'host', 'alive',)

releasenotes/notes/rehome-agent-apidef-7a2dde6a9810f55c.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - The neutron ``agent`` extension's API definition is now available as
+    ``neutron_lib.api.definitions.agent``.