Refactor "snapshot" commands

1.change the command name ``snapshot create/delete/list/
show/set/unset`` to ``volume snapshot create/delete/list/
show/set/unset``.

2.change the optional parameter "--name <name>" to a
positional parameter "<snapshot-name>"; Change the
positional parameter "<volume>" to a optional
parameter "--volume <volume>"

Change-Id: If03276ecdf6f0d96893d5ecf91c2aaa64929cff3
Implements: bp backup-snapshot-renamed-for-volume-resource
Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com>

Author: Huanxuan Ao

doc/source/command-objects/snapshot.rst

@@ -8,6 +8,7 @@ snapshot create
 ---------------
 
 Create new snapshot
+(Deprecated, please use ``volume snapshot create`` instead)
 
 .. program:: snapshot create
 .. code:: bash
@@ -46,6 +47,7 @@ snapshot delete
 ---------------
 
 Delete snapshot(s)
+(Deprecated, please use ``volume snapshot delete`` instead)
 
 .. program:: snapshot delete
 .. code:: bash
@@ -62,6 +64,7 @@ snapshot list
 -------------
 
 List snapshots
+(Deprecated, please use ``volume snapshot list`` instead)
 
 .. program:: snapshot list
 .. code:: bash
@@ -96,6 +99,7 @@ snapshot set
 ------------
 
 Set snapshot properties
+(Deprecated, please use ``volume snapshot set`` instead)
 
 .. program:: snapshot set
 .. code:: bash
@@ -137,6 +141,7 @@ snapshot show
 -------------
 
 Display snapshot details
+(Deprecated, please use ``volume snapshot show`` instead)
 
 .. program:: snapshot show
 .. code:: bash
@@ -153,6 +158,7 @@ snapshot unset
 --------------
 
 Unset snapshot properties
+(Deprecated, please use ``volume snapshot unset`` instead)
 
 .. program:: snapshot unset
 .. code:: bash

doc/source/command-objects/volume-snapshot.rst

@@ -0,0 +1,171 @@
+===============
+volume snapshot
+===============
+
+Block Storage v1, v2
+
+volume snapshot create
+----------------------
+
+Create new volume snapshot
+
+.. program:: volume snapshot create
+.. code:: bash
+
+    os volume snapshot create
+        [--volume <volume>]
+        [--description <description>]
+        [--force]
+        [--property <key=value> [...] ]
+        <snapshot-name>
+
+.. option:: --volume <volume>
+
+    Volume to snapshot (name or ID) (default is <snapshot-name>)
+
+.. option:: --description <description>
+
+    Description of the snapshot
+
+.. option:: --force
+
+    Create a snapshot attached to an instance. Default is False
+
+.. option:: --property <key=value>
+
+    Set a property to this snapshot (repeat option to set multiple properties)
+
+    *Volume version 2 only*
+
+.. _volume_snapshot_create-snapshot-name:
+.. describe:: <snapshot-name>
+
+    Name of the new snapshot (default to None)
+
+volume snapshot delete
+----------------------
+
+Delete volume snapshot(s)
+
+.. program:: volume snapshot delete
+.. code:: bash
+
+    os volume snapshot delete
+        <snapshot> [<snapshot> ...]
+
+.. _volume_snapshot_delete-snapshot:
+.. describe:: <snapshot>
+
+    Snapshot(s) to delete (name or ID)
+
+volume snapshot list
+--------------------
+
+List volume snapshots
+
+.. program:: volume snapshot list
+.. code:: bash
+
+    os volume snapshot list
+        [--all-projects]
+        [--long]
+        [--limit <limit>]
+        [--marker <marker>]
+
+.. option:: --all-projects
+
+    Include all projects (admin only)
+
+.. option:: --long
+
+    List additional fields in output
+
+.. option:: --limit <limit>
+
+    Maximum number of snapshots to display
+
+    *Volume version 2 only*
+
+.. option:: --marker <marker>
+
+    The last snapshot ID of the previous page
+
+    *Volume version 2 only*
+
+volume snapshot set
+-------------------
+
+Set volume snapshot properties
+
+.. program:: volume snapshot set
+.. code:: bash
+
+    os volume snapshot set
+        [--name <name>]
+        [--description <description>]
+        [--property <key=value> [...] ]
+        [--state <state>]
+        <snapshot>
+
+.. option:: --name <name>
+
+    New snapshot name
+
+.. option:: --description <description>
+
+    New snapshot description
+
+.. option:: --property <key=value>
+
+    Property to add or modify for this snapshot (repeat option to set multiple properties)
+
+.. option:: --state <state>
+
+    New snapshot state.
+    ("available", "error", "creating", "deleting", or "error_deleting") (admin only)
+    (This option simply changes the state of the snapshot in the database with
+    no regard to actual status, exercise caution when using)
+
+    *Volume version 2 only*
+
+.. _volume_snapshot_set-snapshot:
+.. describe:: <snapshot>
+
+    Snapshot to modify (name or ID)
+
+volume snapshot show
+--------------------
+
+Display volume snapshot details
+
+.. program:: volume snapshot show
+.. code:: bash
+
+    os volume snapshot show
+        <snapshot>
+
+.. _volume_snapshot_show-snapshot:
+.. describe:: <snapshot>
+
+    Snapshot to display (name or ID)
+
+volume snapshot unset
+---------------------
+
+Unset volume snapshot properties
+
+.. program:: volume snapshot unset
+.. code:: bash
+
+    os volume snapshot unset
+        [--property <key>]
+        <snapshot>
+
+.. option:: --property <key>
+
+    Property to remove from snapshot (repeat option to remove multiple properties)
+
+.. _volume_snapshot_unset-snapshot:
+.. describe:: <snapshot>
+
+    Snapshot to modify (name or ID)

doc/source/commands.rst

@@ -74,7 +74,6 @@ referring to both Compute and Volume quotas.
 * ``address scope``: (**Network**) a scope of IPv4 or IPv6 addresses
 * ``aggregate``: (**Compute**) a grouping of compute hosts
 * ``availability zone``: (**Compute**, **Network**, **Volume**) a logical partition of hosts or block storage or network services
-* ``backup``: (**Volume**) a volume copy
 * ``catalog``: (**Identity**) service catalog
 * ``command``: (**Internal**) installed commands in the OSC process
 * ``compute agent``: (**Compute**) a cloud Compute agent available to a hypervisor
@@ -134,7 +133,6 @@ referring to both Compute and Volume quotas.
 * ``server image``: (**Compute**) saved server disk image
 * ``service``: (**Identity**) a cloud service
 * ``service provider``: (**Identity**) a resource that consumes assertions from an ``identity provider``
-* ``snapshot``: (**Volume**) a point-in-time copy of a volume
 * ``subnet``: (**Network**) - a contiguous range of IP addresses assigned to a network
 * ``subnet pool``: (**Network**) - a pool of subnets
 * ``token``: (**Identity**) a bearer token managed by Identity service
@@ -145,6 +143,7 @@ referring to both Compute and Volume quotas.
 * ``volume``: (**Volume**) block volumes
 * ``volume backup``: (**Volume**) backup for volumes
 * ``volume qos``: (**Volume**) quality-of-service (QoS) specification for volumes
+* ``volume snapshot``: (**Volume**) a point-in-time copy of a volume
 * ``volume type``: (**Volume**) deployment-specific types of volumes available
 * ``volume service``: (**Volume**) services to manage block storage operations
 * ``volume transfer request``: (**Volume**) volume owner transfer request

openstackclient/tests/functional/volume/v1/test_snapshot.py

@@ -16,8 +16,8 @@
 from openstackclient.tests.functional.volume.v1 import common
 
 
-class SnapshotTests(common.BaseVolumeTests):
-    """Functional tests for snapshot. """
+class VolumeSnapshotTests(common.BaseVolumeTests):
+    """Functional tests for volume snapshot. """
 
     VOLLY = uuid.uuid4().hex
     NAME = uuid.uuid4().hex
@@ -36,51 +36,53 @@ def wait_for_status(cls, command, status, tries):
 
     @classmethod
     def setUpClass(cls):
-        super(SnapshotTests, cls).setUpClass()
+        super(VolumeSnapshotTests, cls).setUpClass()
         cls.openstack('volume create --size 1 ' + cls.VOLLY)
         cls.wait_for_status('volume show ' + cls.VOLLY, 'available\n', 3)
         opts = cls.get_opts(['status'])
-        raw_output = cls.openstack('snapshot create --name ' + cls.NAME +
-                                   ' ' + cls.VOLLY + opts)
+        raw_output = cls.openstack('volume snapshot create --volume ' +
+                                   cls.VOLLY + ' ' + cls.NAME + opts)
         cls.assertOutput('creating\n', raw_output)
-        cls.wait_for_status('snapshot show ' + cls.NAME, 'available\n', 3)
+        cls.wait_for_status(
+            'volume snapshot show ' + cls.NAME, 'available\n', 3)
 
     @classmethod
     def tearDownClass(cls):
         # Rename test
         raw_output = cls.openstack(
-            'snapshot set --name ' + cls.OTHER_NAME + ' ' + cls.NAME)
+            'volume snapshot set --name ' + cls.OTHER_NAME + ' ' + cls.NAME)
         cls.assertOutput('', raw_output)
         # Delete test
         raw_output_snapshot = cls.openstack(
-            'snapshot delete ' + cls.OTHER_NAME)
+            'volume snapshot delete ' + cls.OTHER_NAME)
         cls.wait_for_status('volume show ' + cls.VOLLY, 'available\n', 6)
         raw_output_volume = cls.openstack('volume delete --force ' + cls.VOLLY)
         cls.assertOutput('', raw_output_snapshot)
         cls.assertOutput('', raw_output_volume)
 
     def test_snapshot_list(self):
         opts = self.get_opts(self.HEADERS)
-        raw_output = self.openstack('snapshot list' + opts)
+        raw_output = self.openstack('volume snapshot list' + opts)
         self.assertIn(self.NAME, raw_output)
 
     def test_snapshot_set_unset_properties(self):
         raw_output = self.openstack(
-            'snapshot set --property a=b --property c=d ' + self.NAME)
+            'volume snapshot set --property a=b --property c=d ' + self.NAME)
         self.assertEqual("", raw_output)
         opts = self.get_opts(["properties"])
-        raw_output = self.openstack('snapshot show ' + self.NAME + opts)
+        raw_output = self.openstack('volume snapshot show ' + self.NAME + opts)
         self.assertEqual("a='b', c='d'\n", raw_output)
 
-        raw_output = self.openstack('snapshot unset --property a ' + self.NAME)
+        raw_output = self.openstack(
+            'volume snapshot unset --property a ' + self.NAME)
         self.assertEqual("", raw_output)
-        raw_output = self.openstack('snapshot show ' + self.NAME + opts)
+        raw_output = self.openstack('volume snapshot show ' + self.NAME + opts)
         self.assertEqual("c='d'\n", raw_output)
 
     def test_snapshot_set_description(self):
         raw_output = self.openstack(
-            'snapshot set --description backup ' + self.NAME)
+            'volume snapshot set --description backup ' + self.NAME)
         self.assertEqual("", raw_output)
         opts = self.get_opts(["display_description", "display_name"])
-        raw_output = self.openstack('snapshot show ' + self.NAME + opts)
+        raw_output = self.openstack('volume snapshot show ' + self.NAME + opts)
         self.assertEqual("backup\n" + self.NAME + "\n", raw_output)

openstackclient/tests/functional/volume/v2/test_snapshot.py

@@ -16,8 +16,8 @@
 from openstackclient.tests.functional.volume.v2 import common
 
 
-class SnapshotTests(common.BaseVolumeTests):
-    """Functional tests for snapshot. """
+class VolumeSnapshotTests(common.BaseVolumeTests):
+    """Functional tests for volume snapshot. """
 
     VOLLY = uuid.uuid4().hex
     NAME = uuid.uuid4().hex
@@ -36,51 +36,53 @@ def wait_for_status(cls, command, status, tries):
 
     @classmethod
     def setUpClass(cls):
-        super(SnapshotTests, cls).setUpClass()
+        super(VolumeSnapshotTests, cls).setUpClass()
         cls.openstack('volume create --size 1 ' + cls.VOLLY)
         cls.wait_for_status('volume show ' + cls.VOLLY, 'available\n', 3)
         opts = cls.get_opts(['status'])
-        raw_output = cls.openstack('snapshot create --name ' + cls.NAME +
-                                   ' ' + cls.VOLLY + opts)
+        raw_output = cls.openstack('volume snapshot create --volume ' +
+                                   cls.VOLLY + ' ' + cls.NAME + opts)
         cls.assertOutput('creating\n', raw_output)
-        cls.wait_for_status('snapshot show ' + cls.NAME, 'available\n', 3)
+        cls.wait_for_status(
+            'volume snapshot show ' + cls.NAME, 'available\n', 3)
 
     @classmethod
     def tearDownClass(cls):
         # Rename test
         raw_output = cls.openstack(
-            'snapshot set --name ' + cls.OTHER_NAME + ' ' + cls.NAME)
+            'volume snapshot set --name ' + cls.OTHER_NAME + ' ' + cls.NAME)
         cls.assertOutput('', raw_output)
         # Delete test
         raw_output_snapshot = cls.openstack(
-            'snapshot delete ' + cls.OTHER_NAME)
+            'volume snapshot delete ' + cls.OTHER_NAME)
         cls.wait_for_status('volume show ' + cls.VOLLY, 'available\n', 6)
         raw_output_volume = cls.openstack('volume delete --force ' + cls.VOLLY)
         cls.assertOutput('', raw_output_snapshot)
         cls.assertOutput('', raw_output_volume)
 
     def test_snapshot_list(self):
         opts = self.get_opts(self.HEADERS)
-        raw_output = self.openstack('snapshot list' + opts)
+        raw_output = self.openstack('volume snapshot list' + opts)
         self.assertIn(self.NAME, raw_output)
 
     def test_snapshot_properties(self):
         raw_output = self.openstack(
-            'snapshot set --property a=b --property c=d ' + self.NAME)
+            'volume snapshot set --property a=b --property c=d ' + self.NAME)
         self.assertEqual("", raw_output)
         opts = self.get_opts(["properties"])
-        raw_output = self.openstack('snapshot show ' + self.NAME + opts)
+        raw_output = self.openstack('volume snapshot show ' + self.NAME + opts)
         self.assertEqual("a='b', c='d'\n", raw_output)
 
-        raw_output = self.openstack('snapshot unset --property a ' + self.NAME)
+        raw_output = self.openstack(
+            'volume snapshot unset --property a ' + self.NAME)
         self.assertEqual("", raw_output)
-        raw_output = self.openstack('snapshot show ' + self.NAME + opts)
+        raw_output = self.openstack('volume snapshot show ' + self.NAME + opts)
         self.assertEqual("c='d'\n", raw_output)
 
     def test_snapshot_set(self):
         raw_output = self.openstack(
-            'snapshot set --description backup ' + self.NAME)
+            'volume snapshot set --description backup ' + self.NAME)
         self.assertEqual("", raw_output)
         opts = self.get_opts(["description", "name"])
-        raw_output = self.openstack('snapshot show ' + self.NAME + opts)
+        raw_output = self.openstack('volume snapshot show ' + self.NAME + opts)
         self.assertEqual("backup\n" + self.NAME + "\n", raw_output)