os-vif: add vif_name to VIFVHostUser class

When dealing with vhostuser ports, plugins need to know the
name of such ports in order to perform plug/unplug.
The current implementation of vhostuser ovs plug computes
this vif name directly in the plugin while this information
could be directly stored in the object class.

This patch adds this port name (vif_name) to the VIFVHostUser
class to prepare future rework of this vhostuser ovs plug and to
enable different vhostuser plug mechanisms (including fast path)
that needs this vif_name as well.

Signed-off-by: Francesco Santoro <francesco.santoro@6wind.com>

Change-Id: I45f73918d51d5fa64a0c0edd557be1fd41db55f7

os_vif/objects/vif.py

@@ -10,6 +10,7 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+from oslo_utils import versionutils
 from oslo_versionedobjects import base
 from oslo_versionedobjects import fields
 
@@ -120,9 +121,12 @@ class VIFDirect(VIFBase):
 class VIFVHostUser(VIFBase):
     # For libvirt drivers, this maps to type='vhostuser'
 
-    VERSION = '1.0'
+    VERSION = '1.1'
 
     fields = {
+        # Name of the vhostuser port to create
+        'vif_name': fields.StringField(),
+
         # UNIX socket path
         'path': fields.StringField(),
 
@@ -130,6 +134,13 @@ class VIFVHostUser(VIFBase):
         'mode': osv_fields.VIFVHostUserModeField(),
     }
 
+    def obj_make_compatible(self, primitive, target_version):
+        super(VIFVHostUser, self).obj_make_compatible(primitive,
+                                                      target_version)
+        target_version = versionutils.convert_version_to_tuple(target_version)
+        if target_version < (1, 1) and 'vif_name' in primitive:
+            del primitive['vif_name']
+
 
 @base.VersionedObjectRegistry.register
 class VIFHostDevice(VIFBase):

os_vif/tests/test_vif.py

@@ -91,7 +91,8 @@ class TestVIFS(base.TestCase):
     def test_vif_vhost_user(self):
         self._test_vif(objects.vif.VIFVHostUser,
                        path="/some/socket.path",
-                       mode=objects.fields.VIFVHostUserMode.CLIENT)
+                       mode=objects.fields.VIFVHostUserMode.CLIENT,
+                       vif_name="vhu123")
 
     def test_vif_host_dev_plain(self):
         self._test_vif(
@@ -128,7 +129,7 @@ object_data = {
     'VIFPortProfile8021Qbh': '1.0-4b945f07d2666ab00a48d1dc225669b1',
     'VIFPortProfileBase': '1.0-77509ea1ea0dd750d5864b9bd87d3f9d',
     'VIFPortProfileOpenVSwitch': '1.0-533126c2a16b1a40ddf38c33e7b1f1c5',
-    'VIFVHostUser': '1.0-374a7599acffa2a1c7290b0812ea0675',
+    'VIFVHostUser': '1.1-1f95b43be1f884f090ca1f4d79adfd35',
 }
 
 
@@ -147,3 +148,13 @@ class TestObjectVersions(base.TestCase):
                          'Some objects have changed; please make sure the '
                          'versions have been bumped, and then update their '
                          'hashes here.')
+
+    def test_vif_vhost_user_obj_make_compatible(self):
+        vif = objects.vif.VIFVHostUser(
+                path="/some/socket.path",
+                mode=objects.fields.VIFVHostUserMode.CLIENT,
+                vif_name="vhu123")
+        primitive = vif.obj_to_primitive()['versioned_object.data']
+        self.assertIn('vif_name', primitive)
+        vif.obj_make_compatible(primitive, '1.0')
+        self.assertNotIn('vif_name', primitive)

releasenotes/notes/extend-vhostuser-object-fada14a1457d4e56.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - The vhostuser vif object has been modified to add the name of the
+    vhostuser port. Previously to this modification, it was responsibility
+    of ovs plugin to compute such name. This should not be necessary
+    with this new field. Because of this new field the VIFVHostUser object
+    version has been updated accordingly (to 1.1).