API definition for SG group rules address groups.

This change adds the API definition for address groups.

Change-Id: Ib478520fbc596554139aa1bee27fc76db4cf6c42
Related-Bug: #1592028

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 address_group
 from neutron_lib.api.definitions import address_scope
 from neutron_lib.api.definitions import agent
 from neutron_lib.api.definitions import agent_resources_synced
@@ -122,6 +123,7 @@ from neutron_lib.api.definitions import vpn_flavors
 
 
 _ALL_API_DEFINITIONS = {
+    address_group,
     address_scope,
     agent,
     agent_resources_synced,

neutron_lib/api/definitions/address_group.py

@@ -0,0 +1,83 @@
+#    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
+from neutron_lib.db import constants as db_const
+
+
+ALIAS = 'address-group'
+IS_SHIM_EXTENSION = False
+IS_STANDARD_ATTR_EXTENSION = False
+NAME = 'Address group'
+DESCRIPTION = 'Support address group'
+UPDATED_TIMESTAMP = '2020-07-15T10:00:00-00:00'
+
+RESOURCE_NAME = 'address-group'
+COLLECTION_NAME = 'address-groups'
+
+RESOURCE_ATTRIBUTE_MAP = {
+    COLLECTION_NAME: {
+        'id': {'allow_post': False, 'allow_put': False,
+               'validate': {'type:uuid': None},
+               'is_visible': True,
+               'is_filter': True,
+               'is_sort_key': True,
+               'primary_key': True},
+        'name': {'allow_post': True, 'allow_put': True, 'default': '',
+                 'validate': {
+                     'type:string': db_const.NAME_FIELD_SIZE},
+                 'is_filter': True,
+                 'is_sort_key': True,
+                 'is_visible': True},
+        'description': {'allow_post': True, 'allow_put': True, 'default': '',
+                        'validate': {
+                            'type:string':
+                                db_const.LONG_DESCRIPTION_FIELD_SIZE},
+                        'is_filter': True,
+                        'is_sort_key': True,
+                        'is_visible': True},
+        'project_id': {'allow_post': True,
+                       'allow_put': False,
+                       'validate': {
+                           'type:string': db_const.PROJECT_ID_FIELD_SIZE},
+                       'required_by_policy': True,
+                       'is_filter': True,
+                       'is_sort_key': True,
+                       'is_visible': True},
+        'addresses': {'allow_post': True, 'allow_put': False,
+                      'convert_to':
+                          converters.convert_none_to_empty_list,
+                      'default': constants.ATTR_NOT_SPECIFIED,
+                      'validate': {'type:subnet_list': None},
+                      'is_visible': True},
+    }
+}
+
+SUB_RESOURCE_ATTRIBUTE_MAP = None
+
+ACTION_MAP = {
+    RESOURCE_NAME: {
+        'add_addresses': 'PUT',
+        'remove_addresses': 'PUT'
+    },
+}
+
+ACTION_STATUS = {
+}
+
+REQUIRED_EXTENSIONS = [
+    'security-group'
+]
+
+OPTIONAL_EXTENSIONS = [
+]

neutron_lib/tests/unit/api/definitions/test_address_group.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 address_group
+from neutron_lib.tests.unit.api.definitions import base
+
+
+class AddressGroupDefinitionTestCase(base.DefinitionBaseTestCase):
+    extension_module = address_group
+    extension_resources = (address_group.COLLECTION_NAME,)
+    extension_attributes = ('name', 'addresses', 'description')

releasenotes/notes/add-extension-address-group-5e306d90666982aa.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Add an API extension ``address-groups`` that enables users to aggregate IP
+    address blocks into an address group object which can be later referenced
+    when creating other resources.