Merge "Add commands for "consistency group snapshot""

Author: Jenkins

doc/source/command-objects/consistency-group-snapshot.rst

@@ -0,0 +1,96 @@
+==========================
+consistency group snapshot
+==========================
+
+Block Storage v2
+
+consistency group snapshot create
+---------------------------------
+
+Create new consistency group snapshot.
+
+.. program:: consistency group snapshot create
+.. code:: bash
+
+    os consistency group snapshot create
+        [--consistency-group <consistency-group>]
+        [--description <description>]
+        [<snapshot-name>]
+
+.. option:: --consistency-group <consistency-group>
+
+    Consistency group to snapshot (name or ID)
+    (default to be the same as <snapshot-name>)
+
+.. option:: --description <description>
+
+    Description of this consistency group snapshot
+
+.. _consistency_group_snapshot_create-snapshot-name:
+.. option:: <snapshot-name>
+
+    Name of new consistency group snapshot (default to None)
+
+consistency group snapshot delete
+---------------------------------
+
+Delete consistency group snapshot(s)
+
+.. program:: consistency group snapshot delete
+.. code:: bash
+
+    os consistency group snapshot delete
+        <consistency-group-snapshot> [<consistency-group-snapshot> ...]
+
+.. _consistency_group_snapshot_delete-consistency-group-snapshot:
+.. describe:: <consistency-group-snapshot>
+
+    Consistency group snapshot(s) to delete (name or ID)
+
+consistency group snapshot list
+-------------------------------
+
+List consistency group snapshots.
+
+.. program:: consistency group snapshot list
+.. code:: bash
+
+    os consistency group snapshot list
+        [--all-projects]
+        [--long]
+        [--status <status>]
+        [--consistency-group <consistency-group>]
+
+.. option:: --all-projects
+
+    Show detail for all projects. Admin only.
+    (defaults to False)
+
+.. option:: --long
+
+    List additional fields in output
+
+.. option:: --status <status>
+
+    Filters results by a status
+    ("available", "error", "creating", "deleting" or "error_deleting")
+
+.. option:: --consistency-group <consistency-group>
+
+    Filters results by a consistency group (name or ID)
+
+consistency group snapshot show
+-------------------------------
+
+Display consistency group snapshot details.
+
+.. program:: consistency group snapshot show
+.. code:: bash
+
+    os consistency group snapshot show
+        <consistency-group-snapshot>
+
+.. _consistency_group_snapshot_show-consistency-group-snapshot:
+.. describe:: <consistency-group-snapshot>
+
+    Consistency group snapshot to display (name or ID)

doc/source/commands.rst

@@ -81,6 +81,7 @@ referring to both Compute and Volume quotas.
 * ``compute service``: (**Compute**) a cloud Compute process running on a host
 * ``configuration``: (**Internal**) OpenStack client configuration
 * ``consistency group``: (**Volume**) a consistency group of volumes
+* ``consistency group snapshot``: (**Volume**) a point-in-time copy of a consistency group
 * ``console log``: (**Compute**) server console text dump
 * ``console url``: (**Compute**) server remote console URL
 * ``consumer``: (**Identity**) OAuth-based delegatee

openstackclient/tests/unit/volume/v2/fakes.py

@@ -224,6 +224,8 @@ def __init__(self, **kwargs):
         self.quota_classes.resource_class = fakes.FakeResource(None, {})
         self.consistencygroups = mock.Mock()
         self.consistencygroups.resource_class = fakes.FakeResource(None, {})
+        self.cgsnapshots = mock.Mock()
+        self.cgsnapshots.resource_class = fakes.FakeResource(None, {})
         self.auth_token = kwargs['token']
         self.management_url = kwargs['endpoint']
 
@@ -548,6 +550,82 @@ def create_consistency_groups(attrs=None, count=2):
         return consistency_groups
 
 
+class FakeConsistencyGroupSnapshot(object):
+    """Fake one or more consistency group snapshot."""
+
+    @staticmethod
+    def create_one_consistency_group_snapshot(attrs=None):
+        """Create a fake consistency group snapshot.
+
+        :param Dictionary attrs:
+            A dictionary with all attributes
+        :return:
+            A FakeResource object with id, name, description, etc.
+        """
+        attrs = attrs or {}
+
+        # Set default attributes.
+        consistency_group_snapshot_info = {
+            "id": 'id-' + uuid.uuid4().hex,
+            "name": 'backup-name-' + uuid.uuid4().hex,
+            "description": 'description-' + uuid.uuid4().hex,
+            "status": "error",
+            "consistencygroup_id": 'consistency-group-id' + uuid.uuid4().hex,
+            "created_at": 'time-' + uuid.uuid4().hex,
+        }
+
+        # Overwrite default attributes.
+        consistency_group_snapshot_info.update(attrs)
+
+        consistency_group_snapshot = fakes.FakeResource(
+            info=copy.deepcopy(consistency_group_snapshot_info),
+            loaded=True)
+        return consistency_group_snapshot
+
+    @staticmethod
+    def create_consistency_group_snapshots(attrs=None, count=2):
+        """Create multiple fake consistency group snapshots.
+
+        :param Dictionary attrs:
+            A dictionary with all attributes
+        :param int count:
+            The number of consistency group snapshots to fake
+        :return:
+            A list of FakeResource objects faking the
+            consistency group snapshots
+        """
+        consistency_group_snapshots = []
+        for i in range(0, count):
+            consistency_group_snapshot = (
+                FakeConsistencyGroupSnapshot.
+                create_one_consistency_group_snapshot(attrs)
+            )
+            consistency_group_snapshots.append(consistency_group_snapshot)
+
+        return consistency_group_snapshots
+
+    @staticmethod
+    def get_consistency_group_snapshots(snapshots=None, count=2):
+        """Get an iterable MagicMock object with a list of faked cgsnapshots.
+
+        If consistenct group snapshots list is provided, then initialize
+        the Mock object with the list. Otherwise create one.
+
+        :param List snapshots:
+            A list of FakeResource objects faking consistency group snapshots
+        :param Integer count:
+            The number of consistency group snapshots to be faked
+        :return
+            An iterable Mock object with side_effect set to a list of faked
+            consistency groups
+        """
+        if snapshots is None:
+            snapshots = (FakeConsistencyGroupSnapshot.
+                         create_consistency_group_snapshots(count))
+
+        return mock.Mock(side_effect=snapshots)
+
+
 class FakeExtension(object):
     """Fake one or more extension."""