Add portgroups to support LAG interfaces - objs

Ironic should be able to provide the requisite connectivity
information to the Neutron ML2 plugin to allow drivers to
provision the top-of-rack switch for the bare metal server.
The addition of portgroups in Ironic allows the concept of
link aggregation to be handled in Ironic in order to provide
support for cases where multiple interfaces on the bare metal
server connect to switch ports of a single LAG.

This commit includes changes to:
- the objects (extension of port and addition of portgroup)
- the object tests

Partial-bug: #1526403
DocImpact
Co-Authored-By: Jenny Moorehead (jenny.moorehead@sap.com)
Co-Authored-By: Will Stevenson (will.stevenson@sap.com)

Change-Id: Id13eeafbdd9a4d9e679121f1b60be0073430499b

1 files changed, 288 insertions, 0 deletions

diff --git a/ironic/objects/portgroup.py b/ironic/objects/portgroup.py
new file mode 100644
index 000000000..b3d83a531
--- /dev/null
+++ b/ironic/objects/portgroup.py
@@ -0,0 +1,288 @@
+# coding=utf-8
+#
+#
+#    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 oslo_utils import strutils
+from oslo_utils import uuidutils
+from oslo_versionedobjects import base as object_base
+
+from ironic.common import exception
+from ironic.common import utils
+from ironic.db import api as dbapi
+from ironic.objects import base
+from ironic.objects import fields as object_fields
+
+
+@base.IronicObjectRegistry.register
+class Portgroup(base.IronicObject, object_base.VersionedObjectDictCompat):
+    # Version 1.0: Initial version
+    VERSION = '1.0'
+
+    dbapi = dbapi.get_instance()
+
+    fields = {
+        'id': object_fields.IntegerField(),
+        'uuid': object_fields.UUIDField(nullable=True),
+        'name': object_fields.StringField(nullable=True),
+        'node_id': object_fields.IntegerField(nullable=True),
+        'address': object_fields.MACAddressField(nullable=True),
+        'extra': object_fields.FlexibleDictField(nullable=True),
+    }
+
+    @staticmethod
+    def _from_db_object(portgroup, db_portgroup):
+        """Converts a database entity to a formal object."""
+        for field in portgroup.fields:
+            portgroup[field] = db_portgroup[field]
+
+        portgroup.obj_reset_changes()
+        return portgroup
+
+    @staticmethod
+    def _from_db_object_list(db_objects, cls, context):
+        """Converts a list of database entities to a list of formal objects."""
+        return [Portgroup._from_db_object(cls(context), obj) for obj in
+                db_objects]
+
+    # NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
+    # methods can be used in the future to replace current explicit RPC calls.
+    # Implications of calling new remote procedures should be thought through.
+    # @object_base.remotable_classmethod
+    @classmethod
+    def get(cls, context, portgroup_ident):
+        """Find a portgroup based on its id, uuid, name or address.
+
+        :param portgroup_ident: The id, uuid, name or address of a portgroup.
+        :param context: Security context
+        :returns: A :class:`Portgroup` object.
+        :raises: InvalidIdentity
+
+        """
+        if strutils.is_int_like(portgroup_ident):
+            return cls.get_by_id(context, portgroup_ident)
+        elif uuidutils.is_uuid_like(portgroup_ident):
+            return cls.get_by_uuid(context, portgroup_ident)
+        elif utils.is_valid_mac(portgroup_ident):
+            return cls.get_by_address(context, portgroup_ident)
+        elif utils.is_valid_logical_name(portgroup_ident):
+            return cls.get_by_name(context, portgroup_ident)
+        else:
+            raise exception.InvalidIdentity(identity=portgroup_ident)
+
+    # NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
+    # methods can be used in the future to replace current explicit RPC calls.
+    # Implications of calling new remote procedures should be thought through.
+    # @object_base.remotable_classmethod
+    @classmethod
+    def get_by_id(cls, context, portgroup_id):
+        """Find a portgroup based on its integer id and return a Portgroup object.
+
+        :param portgroup id: The id of a portgroup.
+        :param context: Security context
+        :returns: A :class:`Portgroup` object.
+        :raises: PortgroupNotFound
+
+        """
+        db_portgroup = cls.dbapi.get_portgroup_by_id(portgroup_id)
+        portgroup = Portgroup._from_db_object(cls(context), db_portgroup)
+        return portgroup
+
+    # NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
+    # methods can be used in the future to replace current explicit RPC calls.
+    # Implications of calling new remote procedures should be thought through.
+    # @object_base.remotable_classmethod
+    @classmethod
+    def get_by_uuid(cls, context, uuid):
+        """Find a portgroup based on uuid and return a :class:`Portgroup` object.
+
+        :param uuid: The uuid of a portgroup.
+        :param context: Security context
+        :returns: A :class:`Portgroup` object.
+        :raises: PortgroupNotFound
+
+        """
+        db_portgroup = cls.dbapi.get_portgroup_by_uuid(uuid)
+        portgroup = Portgroup._from_db_object(cls(context), db_portgroup)
+        return portgroup
+
+    # NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
+    # methods can be used in the future to replace current explicit RPC calls.
+    # Implications of calling new remote procedures should be thought through.
+    # @object_base.remotable_classmethod
+    @classmethod
+    def get_by_address(cls, context, address):
+        """Find a portgroup based on address and return a :class:`Portgroup` object.
+
+        :param address: The MAC address of a portgroup.
+        :param context: Security context
+        :returns: A :class:`Portgroup` object.
+        :raises: PortgroupNotFound
+
+        """
+        db_portgroup = cls.dbapi.get_portgroup_by_address(address)
+        portgroup = Portgroup._from_db_object(cls(context), db_portgroup)
+        return portgroup
+
+    # NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
+    # methods can be used in the future to replace current explicit RPC calls.
+    # Implications of calling new remote procedures should be thought through.
+    # @object_base.remotable_classmethod
+    @classmethod
+    def get_by_name(cls, context, name):
+        """Find a portgroup based on name and return a :class:`Portgroup` object.
+
+        :param name: The name of a portgroup.
+        :param context: Security context
+        :returns: A :class:`Portgroup` object.
+        :raises: PortgroupNotFound
+
+        """
+        db_portgroup = cls.dbapi.get_portgroup_by_name(name)
+        portgroup = Portgroup._from_db_object(cls(context), db_portgroup)
+        return portgroup
+
+    # NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
+    # methods can be used in the future to replace current explicit RPC calls.
+    # Implications of calling new remote procedures should be thought through.
+    # @object_base.remotable_classmethod
+    @classmethod
+    def list(cls, context, limit=None, marker=None,
+             sort_key=None, sort_dir=None):
+        """Return a list of Portgroup objects.
+
+        :param context: Security context.
+        :param limit: Maximum number of resources to return in a single result.
+        :param marker: Pagination marker for large data sets.
+        :param sort_key: Column to sort results by.
+        :param sort_dir: Direction to sort. "asc" or "desc".
+        :returns: A list of :class:`Portgroup` object.
+        :raises: InvalidParameterValue
+
+        """
+        db_portgroups = cls.dbapi.get_portgroup_list(limit=limit,
+                                                     marker=marker,
+                                                     sort_key=sort_key,
+                                                     sort_dir=sort_dir)
+        return Portgroup._from_db_object_list(db_portgroups, cls, context)
+
+    # NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
+    # methods can be used in the future to replace current explicit RPC calls.
+    # Implications of calling new remote procedures should be thought through.
+    # @object_base.remotable_classmethod
+    @classmethod
+    def list_by_node_id(cls, context, node_id, limit=None, marker=None,
+                        sort_key=None, sort_dir=None):
+        """Return a list of Portgroup objects associated with a given node ID.
+
+        :param context: Security context.
+        :param node_id: The ID of the node.
+        :param limit: Maximum number of resources to return in a single result.
+        :param marker: Pagination marker for large data sets.
+        :param sort_key: Column to sort results by.
+        :param sort_dir: Direction to sort. "asc" or "desc".
+        :returns: A list of :class:`Portgroup` object.
+        :raises: InvalidParameterValue
+
+        """
+        db_portgroups = cls.dbapi.get_portgroups_by_node_id(node_id,
+                                                            limit=limit,
+                                                            marker=marker,
+                                                            sort_key=sort_key,
+                                                            sort_dir=sort_dir)
+        return Portgroup._from_db_object_list(db_portgroups, cls, context)
+
+    # NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
+    # methods can be used in the future to replace current explicit RPC calls.
+    # Implications of calling new remote procedures should be thought through.
+    # @object_base.remotable
+    def create(self, context=None):
+        """Create a Portgroup record in the DB.
+
+        :param context: Security context. NOTE: This should only
+                        be used internally by the indirection_api.
+                        Unfortunately, RPC requires context as the first
+                        argument, even though we don't use it.
+                        A context should be set when instantiating the
+                        object, e.g.: Portgroup(context)
+        :raises: DuplicateName, MACAlreadyExists, PortgroupAlreadyExists
+
+        """
+        values = self.obj_get_changes()
+        db_portgroup = self.dbapi.create_portgroup(values)
+        self._from_db_object(self, db_portgroup)
+
+    # NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
+    # methods can be used in the future to replace current explicit RPC calls.
+    # Implications of calling new remote procedures should be thought through.
+    # @object_base.remotable
+    def destroy(self, context=None):
+        """Delete the Portgroup from the DB.
+
+        :param context: Security context. NOTE: This should only
+                        be used internally by the indirection_api.
+                        Unfortunately, RPC requires context as the first
+                        argument, even though we don't use it.
+                        A context should be set when instantiating the
+                        object, e.g.: Portgroup(context)
+        :raises: PortgroupNotEmpty, PortgroupNotFound
+
+        """
+        self.dbapi.destroy_portgroup(self.uuid)
+        self.obj_reset_changes()
+
+    # NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
+    # methods can be used in the future to replace current explicit RPC calls.
+    # Implications of calling new remote procedures should be thought through.
+    # @object_base.remotable
+    def save(self, context=None):
+        """Save updates to this Portgroup.
+
+        Updates will be made column by column based on the result
+        of self.what_changed().
+
+        :param context: Security context. NOTE: This should only
+                        be used internally by the indirection_api.
+                        Unfortunately, RPC requires context as the first
+                        argument, even though we don't use it.
+                        A context should be set when instantiating the
+                        object, e.g.: Portgroup(context)
+        :raises: PortgroupNotFound, DuplicateName, MACAlreadyExists
+
+        """
+        updates = self.obj_get_changes()
+        updated_portgroup = self.dbapi.update_portgroup(self.uuid, updates)
+        self._from_db_object(self, updated_portgroup)
+
+    # NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
+    # methods can be used in the future to replace current explicit RPC calls.
+    # Implications of calling new remote procedures should be thought through.
+    # @object_base.remotable
+    def refresh(self, context=None):
+        """Loads updates for this Portgroup.
+
+        Loads a portgroup with the same uuid from the database and
+        checks for updated attributes. Updates are applied from
+        the loaded portgroup column by column, if there are any updates.
+
+        :param context: Security context. NOTE: This should only
+                        be used internally by the indirection_api.
+                        Unfortunately, RPC requires context as the first
+                        argument, even though we don't use it.
+                        A context should be set when instantiating the
+                        object, e.g.: Portgroup(context)
+        :raises: PortgroupNotFound
+
+        """
+        current = self.__class__.get_by_uuid(self._context, uuid=self.uuid)
+        self.obj_refresh(current)