StorageVolumeSnapshot now has a .name

CHANGES.rst

@@ -13,6 +13,13 @@ Compute
   (GITHUB-857)
   [Allard Hoeve]
 
+- StorageVolumeSnapshot now has an attribute `name` that has the name of the snapshot
+  if the provider supports it. This used to be `.extra['name']`, but that is inconsistent
+  with `Node` and `StorageVolume`. The `extra` dict still holds `name` for backwards
+  compatibility.
+  (GITHUB-867)
+  [Allard Hoeve]
+
 Container
 ~~~~~~~~~
 

libcloud/compute/base.py

@@ -559,7 +559,7 @@ class VolumeSnapshot(object):
     A base VolumeSnapshot class to derive from.
     """
     def __init__(self, id, driver, size=None, extra=None, created=None,
-                 state=None):
+                 state=None, name=None):
         """
         VolumeSnapshot constructor.
 
@@ -583,13 +583,17 @@ def __init__(self, id, driver, size=None, extra=None, created=None,
         :param      state: A string representing the state the snapshot is
                            in. See `libcloud.compute.types.StorageVolumeState`.
         :type       state: ``str``
+
+        :param      name: A string representing the name of the snapshot
+        :type       name: ``str``
         """
         self.id = id
         self.driver = driver
         self.size = size
         self.extra = extra or {}
         self.created = created
         self.state = state
+        self.name = name
 
     def destroy(self):
         """
@@ -600,8 +604,8 @@ def destroy(self):
         return self.driver.destroy_volume_snapshot(snapshot=self)
 
     def __repr__(self):
-        return ('<VolumeSnapshot id=%s size=%s driver=%s state=%s>' %
-                (self.id, self.size, self.driver.name, self.state))
+        return ('<VolumeSnapshot "%s" id=%s size=%s driver=%s state=%s>' %
+                (self.name, self.id, self.size, self.driver.name, self.state))
 
 
 class KeyPair(object):

libcloud/compute/drivers/ec2.py

@@ -5601,7 +5601,8 @@ def _to_snapshot(self, element, name=None):
                               driver=self,
                               extra=extra,
                               created=created,
-                              state=state)
+                              state=state,
+                              name=name)
 
     def _to_key_pairs(self, elems):
         key_pairs = [self._to_key_pair(elem=elem) for elem in elems]

libcloud/compute/drivers/gce.py

@@ -709,9 +709,9 @@ def __repr__(self):
 class GCESnapshot(VolumeSnapshot):
     def __init__(self, id, name, size, status, driver, extra=None,
                  created=None):
-        self.name = name
         self.status = status
-        super(GCESnapshot, self).__init__(id, driver, size, extra, created)
+        super(GCESnapshot, self).__init__(id, driver, size, extra,
+                                          created, name=name)
 
 
 class GCETargetHttpProxy(UuidMixin):

libcloud/compute/drivers/openstack.py

@@ -2191,7 +2191,8 @@ def _to_snapshot(self, data):
 
         snapshot = VolumeSnapshot(id=data['id'], driver=self,
                                   size=data['size'], extra=extra,
-                                  created=created_dt, state=state)
+                                  created=created_dt, state=state,
+                                  name=display_name)
         return snapshot
 
     def _to_size(self, api_flavor, price=None, bandwidth=None):

libcloud/compute/drivers/rackspace.py

@@ -242,7 +242,8 @@ def _to_snapshot(self, api_node):
                                   size=api_node['size'],
                                   extra=extra,
                                   created=created_td,
-                                  state=state)
+                                  state=state,
+                                  name=api_node['displayName'])
         return snapshot
 
     def _ex_connection_class_kwargs(self):

libcloud/test/compute/test_ec2.py

@@ -903,6 +903,7 @@ def test_list_snapshots(self):
         self.assertEqual('Daily Backup', snaps[0].extra['description'])
 
         self.assertEqual('snap-18349159', snaps[1].id)
+        self.assertEqual('DB Backup 1', snaps[1].name)
         self.assertEqual(VolumeSnapshotState.AVAILABLE, snaps[1].state)
         self.assertEqual('vol-b5a2c1v9', snaps[1].extra['volume_id'])
         self.assertEqual(15, snaps[1].size)

libcloud/test/compute/test_gce.py

@@ -1049,6 +1049,7 @@ def test_ex_create_volume_snapshot(self):
         snapshot_name = 'lcsnapshot'
         volume = self.driver.ex_get_volume('lcdisk')
         snapshot = volume.snapshot(snapshot_name)
+
         self.assertEqual(snapshot.name, snapshot_name)
         self.assertEqual(snapshot.size, '10')
 

libcloud/test/compute/test_openstack.py

@@ -1468,6 +1468,7 @@ def test_ex_list_snapshots(self):
         self.assertEqual(snapshots[0].created, datetime.datetime(2012, 2, 29, 3, 50, 7, tzinfo=UTC))
         self.assertEqual(snapshots[0].extra['created'], "2012-02-29T03:50:07Z")
         self.assertEqual(snapshots[0].extra['name'], 'snap-001')
+        self.assertEqual(snapshots[0].name, 'snap-001')
         self.assertEqual(snapshots[0].state, VolumeSnapshotState.AVAILABLE)
 
         # invalid date is parsed as None