Support "--no-property" option in volume snapshot set

Supporting "--no-property" option will apply user a convenient
way to clean all properties of volume snapshot in a short command,
and this kind of behavior is the recommended way to devref.
The patch adds "--no-property" option in "volume snapshot set" command,
and update related test cases and devref document.

Change-Id: I5f10cc2b5814553699920c4343995b2e11416e4e
Implements: blueprint allow-overwrite-set-options

2 files changed, 232 insertions, 54 deletions

diff --git a/openstackclient/tests/functional/volume/v1/test_snapshot.py b/openstackclient/tests/functional/volume/v1/test_snapshot.py
index 1e1c6b21..89a98661 100644
--- a/openstackclient/tests/functional/volume/v1/test_snapshot.py
+++ b/openstackclient/tests/functional/volume/v1/test_snapshot.py
@@ -10,6 +10,7 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+import json
 import time
 import uuid
 
@@ -20,9 +21,6 @@ class VolumeSnapshotTests(common.BaseVolumeTests):
     """Functional tests for volume snapshot. """
 
     VOLLY = uuid.uuid4().hex
-    NAME = uuid.uuid4().hex
-    OTHER_NAME = uuid.uuid4().hex
-    HEADERS = ['"Name"']
 
     @classmethod
     def wait_for_status(cls, command, status, tries):
@@ -30,59 +28,223 @@ class VolumeSnapshotTests(common.BaseVolumeTests):
         for attempt in range(tries):
             time.sleep(1)
             raw_output = cls.openstack(command + opts)
-            if (raw_output == status):
+            if (raw_output.rstrip() == status):
                 return
         cls.assertOutput(status, raw_output)
 
     @classmethod
     def setUpClass(cls):
         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('volume snapshot create --volume ' +
-                                   cls.VOLLY + ' ' + cls.NAME + opts)
-        cls.assertOutput('creating\n', raw_output)
-        cls.wait_for_status(
-            'volume snapshot show ' + cls.NAME, 'available\n', 3)
+        # create a volume for all tests to create snapshot
+        cmd_output = json.loads(cls.openstack(
+            'volume create -f json ' +
+            '--size 1 ' +
+            cls.VOLLY
+        ))
+        cls.wait_for_status('volume show ' + cls.VOLLY, 'available', 6)
+        cls.VOLUME_ID = cmd_output['id']
 
     @classmethod
     def tearDownClass(cls):
-        # Rename test
-        raw_output = cls.openstack(
-            'volume snapshot set --name ' + cls.OTHER_NAME + ' ' + cls.NAME)
+        cls.wait_for_status('volume show ' + cls.VOLLY, 'available', 6)
+        raw_output = cls.openstack('volume delete --force ' + cls.VOLLY)
         cls.assertOutput('', raw_output)
-        # Delete test
-        raw_output_snapshot = cls.openstack(
-            '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('volume snapshot list' + opts)
-        self.assertIn(self.NAME, raw_output)
-
-    def test_snapshot_set_unset_properties(self):
+
+    def test_volume_snapshot__delete(self):
+        """Test create, delete multiple"""
+        name1 = uuid.uuid4().hex
+        cmd_output = json.loads(self.openstack(
+            'volume snapshot create -f json ' +
+            name1 +
+            ' --volume ' + self.VOLLY
+        ))
+        self.assertEqual(
+            name1,
+            cmd_output["display_name"],
+        )
+
+        name2 = uuid.uuid4().hex
+        cmd_output = json.loads(self.openstack(
+            'volume snapshot create -f json ' +
+            name2 +
+            ' --volume ' + self.VOLLY
+        ))
+        self.assertEqual(
+            name2,
+            cmd_output["display_name"],
+        )
+
+        self.wait_for_status(
+            'volume snapshot show ' + name1, 'available', 6)
+        self.wait_for_status(
+            'volume snapshot show ' + name2, 'available', 6)
+
+        del_output = self.openstack(
+            'volume snapshot delete ' + name1 + ' ' + name2)
+        self.assertOutput('', del_output)
+
+    def test_volume_snapshot_list(self):
+        """Test create, list filter"""
+        name1 = uuid.uuid4().hex
+        cmd_output = json.loads(self.openstack(
+            'volume snapshot create -f json ' +
+            name1 +
+            ' --volume ' + self.VOLLY
+        ))
+        self.addCleanup(self.openstack, 'volume snapshot delete ' + name1)
+        self.assertEqual(
+            name1,
+            cmd_output["display_name"],
+        )
+        self.assertEqual(
+            self.VOLUME_ID,
+            cmd_output["volume_id"],
+        )
+        self.assertEqual(
+            1,
+            cmd_output["size"],
+        )
+        self.wait_for_status(
+            'volume snapshot show ' + name1, 'available', 6)
+
+        name2 = uuid.uuid4().hex
+        cmd_output = json.loads(self.openstack(
+            'volume snapshot create -f json ' +
+            name2 +
+            ' --volume ' + self.VOLLY
+        ))
+        self.addCleanup(self.openstack, 'volume snapshot delete ' + name2)
+        self.assertEqual(
+            name2,
+            cmd_output["display_name"],
+        )
+        self.assertEqual(
+            self.VOLUME_ID,
+            cmd_output["volume_id"],
+        )
+        self.assertEqual(
+            1,
+            cmd_output["size"],
+        )
+        self.wait_for_status(
+            'volume snapshot show ' + name2, 'available', 6)
+
+        # Test list --long, --status
+        cmd_output = json.loads(self.openstack(
+            'volume snapshot list -f json ' +
+            '--long ' +
+            '--status error'
+        ))
+        names = [x["Name"] for x in cmd_output]
+        self.assertNotIn(name1, names)
+        self.assertNotIn(name2, names)
+
+        # Test list --volume
+        cmd_output = json.loads(self.openstack(
+            'volume snapshot list -f json ' +
+            '--volume ' + self.VOLLY
+        ))
+        names = [x["Name"] for x in cmd_output]
+        self.assertIn(name1, names)
+        self.assertIn(name2, names)
+
+        # Test list --name
+        cmd_output = json.loads(self.openstack(
+            'volume snapshot list -f json ' +
+            '--name ' + name1
+        ))
+        names = [x["Name"] for x in cmd_output]
+        self.assertIn(name1, names)
+        self.assertNotIn(name2, names)
+
+    def test_snapshot_set(self):
+        """Test create, set, unset, show, delete volume snapshot"""
+        name = uuid.uuid4().hex
+        new_name = name + "_"
+        cmd_output = json.loads(self.openstack(
+            'volume snapshot create -f json ' +
+            '--volume ' + self.VOLLY +
+            ' --description aaaa ' +
+            name
+        ))
+        self.addCleanup(self.openstack, 'volume snapshot delete ' + new_name)
+        self.assertEqual(
+            name,
+            cmd_output["display_name"],
+        )
+        self.assertEqual(
+            1,
+            cmd_output["size"],
+        )
+        self.assertEqual(
+            'aaaa',
+            cmd_output["display_description"],
+        )
+        self.wait_for_status(
+            'volume snapshot show ' + name, 'available', 6)
+
+        # Test volume snapshot set
         raw_output = self.openstack(
-            'volume snapshot set --property a=b --property c=d ' + self.NAME)
-        self.assertEqual("", raw_output)
-        opts = self.get_opts(["properties"])
-        raw_output = self.openstack('volume snapshot show ' + self.NAME + opts)
-        self.assertEqual("a='b', c='d'\n", raw_output)
+            'volume snapshot set ' +
+            '--name ' + new_name +
+            ' --description bbbb ' +
+            '--property Alpha=a ' +
+            '--property Beta=b ' +
+            name,
+        )
+        self.assertOutput('', raw_output)
+
+        # Show snapshot set result
+        cmd_output = json.loads(self.openstack(
+            'volume snapshot show -f json ' +
+            new_name
+        ))
+        self.assertEqual(
+            new_name,
+            cmd_output["display_name"],
+        )
+        self.assertEqual(
+            1,
+            cmd_output["size"],
+        )
+        self.assertEqual(
+            'bbbb',
+            cmd_output["display_description"],
+        )
+        self.assertEqual(
+            "Alpha='a', Beta='b'",
+            cmd_output["properties"],
+        )
 
+        # Test volume unset
         raw_output = self.openstack(
-            'volume snapshot unset --property a ' + self.NAME)
-        self.assertEqual("", raw_output)
-        raw_output = self.openstack('volume snapshot show ' + self.NAME + opts)
-        self.assertEqual("c='d'\n", raw_output)
+            'volume snapshot unset ' +
+            '--property Alpha ' +
+            new_name,
+        )
+        self.assertOutput('', raw_output)
+
+        cmd_output = json.loads(self.openstack(
+            'volume snapshot show -f json ' +
+            new_name
+        ))
+        self.assertEqual(
+            "Beta='b'",
+            cmd_output["properties"],
+        )
 
-    def test_snapshot_set_description(self):
+        # Test volume snapshot set --no-property
         raw_output = self.openstack(
-            'volume snapshot set --description backup ' + self.NAME)
-        self.assertEqual("", raw_output)
-        opts = self.get_opts(["display_description", "display_name"])
-        raw_output = self.openstack('volume snapshot show ' + self.NAME + opts)
-        self.assertEqual("backup\n" + self.NAME + "\n", raw_output)
+            'volume snapshot set ' +
+            '--no-property ' +
+            new_name,
+        )
+        self.assertOutput('', raw_output)
+        cmd_output = json.loads(self.openstack(
+            'volume snapshot show -f json ' +
+            new_name
+        ))
+        self.assertNotIn(
+            "Beta='b'",
+            cmd_output["properties"],
+        )
diff --git a/openstackclient/tests/functional/volume/v2/test_snapshot.py b/openstackclient/tests/functional/volume/v2/test_snapshot.py
index c83e79f8..422e5b7c 100644
--- a/openstackclient/tests/functional/volume/v2/test_snapshot.py
+++ b/openstackclient/tests/functional/volume/v2/test_snapshot.py
@@ -28,7 +28,7 @@ class VolumeSnapshotTests(common.BaseVolumeTests):
         for attempt in range(tries):
             time.sleep(1)
             raw_output = cls.openstack(command + opts)
-            if (raw_output == status):
+            if (raw_output.rstrip() == status):
                 return
         cls.assertOutput(status, raw_output)
 
@@ -41,12 +41,12 @@ class VolumeSnapshotTests(common.BaseVolumeTests):
             '--size 1 ' +
             cls.VOLLY
         ))
-        cls.wait_for_status('volume show ' + cls.VOLLY, 'available\n', 6)
+        cls.wait_for_status('volume show ' + cls.VOLLY, 'available', 6)
         cls.VOLUME_ID = cmd_output['id']
 
     @classmethod
     def tearDownClass(cls):
-        cls.wait_for_status('volume show ' + cls.VOLLY, 'available\n', 6)
+        cls.wait_for_status('volume show ' + cls.VOLLY, 'available', 6)
         raw_output = cls.openstack('volume delete --force ' + cls.VOLLY)
         cls.assertOutput('', raw_output)
 
@@ -75,9 +75,9 @@ class VolumeSnapshotTests(common.BaseVolumeTests):
         )
 
         self.wait_for_status(
-            'volume snapshot show ' + name1, 'available\n', 6)
+            'volume snapshot show ' + name1, 'available', 6)
         self.wait_for_status(
-            'volume snapshot show ' + name2, 'available\n', 6)
+            'volume snapshot show ' + name2, 'available', 6)
 
         del_output = self.openstack(
             'volume snapshot delete ' + name1 + ' ' + name2)
@@ -105,7 +105,7 @@ class VolumeSnapshotTests(common.BaseVolumeTests):
             cmd_output["size"],
         )
         self.wait_for_status(
-            'volume snapshot show ' + name1, 'available\n', 6)
+            'volume snapshot show ' + name1, 'available', 6)
 
         name2 = uuid.uuid4().hex
         cmd_output = json.loads(self.openstack(
@@ -127,7 +127,7 @@ class VolumeSnapshotTests(common.BaseVolumeTests):
             cmd_output["size"],
         )
         self.wait_for_status(
-            'volume snapshot show ' + name2, 'available\n', 6)
+            'volume snapshot show ' + name2, 'available', 6)
         raw_output = self.openstack(
             'volume snapshot set ' +
             '--state error ' +
@@ -163,7 +163,7 @@ class VolumeSnapshotTests(common.BaseVolumeTests):
         self.assertIn(name1, names)
         self.assertNotIn(name2, names)
 
-    def test_snapshot_set(self):
+    def test_volume_snapshot_set(self):
         """Test create, set, unset, show, delete volume snapshot"""
         name = uuid.uuid4().hex
         new_name = name + "_"
@@ -192,7 +192,7 @@ class VolumeSnapshotTests(common.BaseVolumeTests):
             cmd_output["properties"],
         )
         self.wait_for_status(
-            'volume snapshot show ' + name, 'available\n', 6)
+            'volume snapshot show ' + name, 'available', 6)
 
         # Test volume snapshot set
         raw_output = self.openstack(
@@ -227,7 +227,7 @@ class VolumeSnapshotTests(common.BaseVolumeTests):
             cmd_output["properties"],
         )
 
-        # Test volume unset
+        # Test volume snapshot unset
         raw_output = self.openstack(
             'volume snapshot unset ' +
             '--property Alpha ' +
@@ -243,3 +243,19 @@ class VolumeSnapshotTests(common.BaseVolumeTests):
             "Beta='b'",
             cmd_output["properties"],
         )
+
+        # Test volume snapshot set --no-property
+        raw_output = self.openstack(
+            'volume snapshot set ' +
+            '--no-property ' +
+            new_name,
+        )
+        self.assertOutput('', raw_output)
+        cmd_output = json.loads(self.openstack(
+            'volume snapshot show -f json ' +
+            new_name
+        ))
+        self.assertNotIn(
+            "Beta='b'",
+            cmd_output["properties"],
+        )