Testing

Author: Christine WANJAU

src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_kv_commands.py

@@ -309,6 +309,37 @@ def test_azconfig_kv(self):
         with self.assertRaisesRegex(MutuallyExclusiveArgumentError, "The '--dry-run' and '--yes' options cannot be specified together."):
             self.cmd('appconfig kv restore --datetime "2019-05-01T11:24:12Z" --endpoint {endpoint} --auth-mode login --key {key} --label {label} --dry-run -y')
 
+        # Description property: set with --description, verify it is returned, preserved on edit, and overwritten
+        self.kwargs.update({
+            'key': "DescKey",
+            'value': "Red",
+            'description': "The theme color"
+        })
+        self.cmd('appconfig kv set --endpoint {endpoint} --auth-mode login --key {key} --value {value} --description "{description}" -y',
+                 checks=[self.check('key', "DescKey"),
+                         self.check('value', "Red"),
+                         self.check('description', "The theme color")])
+
+        # Description is returned by show
+        self.cmd('appconfig kv show --endpoint {endpoint} --auth-mode login --key {key}',
+                 checks=[self.check('description', "The theme color")])
+
+        # Description is selectable via --fields
+        partial_kv = self.cmd('appconfig kv list --endpoint {endpoint} --auth-mode login --key {key} --fields description').get_output_in_json()
+        self.assertEqual(partial_kv[0]['description'], "The theme color")
+        self.assertNotIn('value', partial_kv[0])
+
+        # Updating another property without --description preserves the existing description
+        self.kwargs.update({'value': "Green"})
+        self.cmd('appconfig kv set --endpoint {endpoint} --auth-mode login --key {key} --value {value} -y',
+                 checks=[self.check('value', "Green"),
+                         self.check('description', "The theme color")])
+
+        # Explicitly updating the description overwrites it
+        self.kwargs.update({'description': "The updated theme color"})
+        self.cmd('appconfig kv set --endpoint {endpoint} --auth-mode login --key {key} --description "{description}" -y',
+                 checks=[self.check('description', "The updated theme color")])
+
 
     @AllowLargeResponse()
     @ResourceGroupPreparer()
@@ -519,70 +550,4 @@ def test_azconfig_kv_revision_list(self):
         revisions = self.cmd('appconfig revision list --endpoint {endpoint} --auth-mode login --key {key} --label *').get_output_in_json()
         assert len(revisions) == 3
 
-    @AllowLargeResponse()
-    # Uses Entra ID auth (store created with local auth disabled); target a resource group where the
-    # recording principal holds "App Configuration Data Owner". Override via AZURE_CLI_APPCONFIG_TEST_RG.
-    def test_azconfig_kv_description(self):
-        # Lowercase store-name prefix so the HTTP-lowercased '<name>.azconfig.io' host matches the
-        # name registered with the recording name-replacer, keeping cassettes scrubbed for playback.
-        config_store_prefix = get_resource_name_prefix('kvdesctest')
-        config_store_name = self.create_random_name(prefix=config_store_prefix, length=24)
-
-        location = 'eastus'
-        sku = 'standard'
-        self.kwargs.update({
-            'config_store_name': config_store_name,
-            'rg_loc': location,
-            'rg': get_test_resource_group(),
-            'sku': sku,
-            'endpoint': 'https://' + config_store_name + '.azconfig.io'
-        })
-        create_config_store(self, self.kwargs, disable_local_auth=True)
-
-        entry_key = "Color"
-        entry_value = "Red"
-        entry_description = "The theme color"
-
-        self.kwargs.update({
-            'key': entry_key,
-            'value': entry_value,
-            'description': entry_description
-        })
-
-        # Set a key-value with a description
-        self.cmd('appconfig kv set --endpoint {endpoint} --auth-mode login --key {key} --value {value} --description "{description}" -y',
-                 checks=[self.check('key', entry_key),
-                         self.check('value', entry_value),
-                         self.check('description', entry_description)])
-
-        # Show the key-value and verify the description is returned
-        self.cmd('appconfig kv show --endpoint {endpoint} --auth-mode login --key {key}',
-                 checks=[self.check('key', entry_key),
-                         self.check('value', entry_value),
-                         self.check('description', entry_description)])
-
-        # List with only the description field selected
-        partial_kv = self.cmd('appconfig kv list --endpoint {endpoint} --auth-mode login --key {key} --fields description').get_output_in_json()
-        self.assertEqual(partial_kv[0]['description'], entry_description)
-        self.assertNotIn('value', partial_kv[0])
-
-        # Updating another property without --description should preserve the existing description
-        updated_value = "Green"
-        self.kwargs.update({
-            'value': updated_value
-        })
-        self.cmd('appconfig kv set --endpoint {endpoint} --auth-mode login --key {key} --value {value} -y',
-                 checks=[self.check('key', entry_key),
-                         self.check('value', updated_value),
-                         self.check('description', entry_description)])
-
-        # Explicitly updating the description should overwrite the previous value
-        updated_description = "The updated theme color"
-        self.kwargs.update({
-            'description': updated_description
-        })
-        self.cmd('appconfig kv set --endpoint {endpoint} --auth-mode login --key {key} --description "{description}" -y',
-                 checks=[self.check('key', entry_key),
-                         self.check('value', updated_value),
-                         self.check('description', updated_description)])
 

src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_snapshot_commands.py

@@ -92,24 +92,32 @@ def test_azconfig_snapshot_mgmt(self):
             'retention_period': retention_period
         })
 
-        self.cmd('appconfig snapshot create --endpoint {endpoint} --auth-mode login --snapshot-name {snapshot_name} --filters {filter} --retention-period {retention_period} --composition-type key_label --tags tag1=value1',
+        snapshot_description = "Snapshot of Test key-values"
+        self.kwargs.update({
+            'snapshot_description': snapshot_description
+        })
+
+        self.cmd('appconfig snapshot create --endpoint {endpoint} --auth-mode login --snapshot-name {snapshot_name} --filters {filter} --retention-period {retention_period} --composition-type key_label --tags tag1=value1 --description "{snapshot_description}"',
                  checks=[self.check('itemsCount', 2),
-                         self.check('status', 'ready')])
+                         self.check('status', 'ready'),
+                         self.check('description', snapshot_description)])
 
 
         # Test showing created snapshot
-        created_snapshot = self.cmd('appconfig snapshot show --endpoint {endpoint} --auth-mode login --snapshot-name {snapshot_name} --fields name status items_count filters').get_output_in_json()
+        created_snapshot = self.cmd('appconfig snapshot show --endpoint {endpoint} --auth-mode login --snapshot-name {snapshot_name} --fields name status items_count filters description').get_output_in_json()
 
         self.assertEqual(created_snapshot['items_count'], 2)
         self.check(created_snapshot['status'], 'ready')
         self.assertDictEqual(created_snapshot['filters'][0], filter_dict)
+        self.assertEqual(created_snapshot['description'], snapshot_description)
         self.assertRaises(KeyError, lambda: created_snapshot['created'])
 
         # Test listing snapshots
-        created_snapshots = self.cmd('appconfig snapshot list --snapshot-name {snapshot_name} --endpoint {endpoint} --auth-mode login --fields name status items_count filters').get_output_in_json()
+        created_snapshots = self.cmd('appconfig snapshot list --snapshot-name {snapshot_name} --endpoint {endpoint} --auth-mode login --fields name status items_count filters description').get_output_in_json()
         self.assertEqual(created_snapshots[0]['items_count'], 2)
         self.assertEqual(created_snapshots[0]['status'], 'ready')
         self.assertDictEqual(created_snapshots[0]['filters'][0], filter_dict)
+        self.assertEqual(created_snapshots[0]['description'], snapshot_description)
 
         # Test snapshot archive
         archived_snapshot = self.cmd('appconfig snapshot archive --endpoint {endpoint} --auth-mode login --snapshot-name {snapshot_name}').get_output_in_json()
@@ -358,71 +366,3 @@ def test_azconfig_snapshot_filtering(self):
                          self.check('status', 'ready')])
 
 
-    @AllowLargeResponse()
-    # Uses Entra ID auth (store created with local auth disabled); target a resource group where the
-    # recording principal holds "App Configuration Data Owner". Override via AZURE_CLI_APPCONFIG_TEST_RG.
-    def test_azconfig_snapshot_description(self):
-        store_name_prefix = get_resource_name_prefix('snapshotdesc')
-        config_store_name = self.create_random_name(prefix=store_name_prefix, length=24)
-        snapshot_name = "DescriptionSnapshot"
-        snapshot_description = "Snapshot of Test key-values"
-        store_location = 'francecentral'
-        sku = 'standard'
-
-        self.kwargs.update({
-            'config_store_name': config_store_name,
-            'snapshot_name': snapshot_name,
-            'snapshot_description': snapshot_description,
-            'rg_loc': store_location,
-            'rg': get_test_resource_group(),
-            'sku': sku,
-            'retention_days': 1,
-            'enable_purge_protection': False,
-            'endpoint': 'https://' + config_store_name + '.azconfig.io'
-        })
-
-        create_config_store(self, self.kwargs, disable_local_auth=True)
-
-        # Create a couple of key-values to include in the snapshot
-        self.kwargs.update({
-            'key': "TestKey1",
-            'value': "TestValue1",
-        })
-        self.cmd('appconfig kv set --endpoint {endpoint} --auth-mode login --key {key} --value {value} -y',
-                 checks=[self.check('key', "TestKey1"),
-                         self.check('value', "TestValue1")])
-
-        self.kwargs.update({
-            'key': "TestKey2",
-            'value': "TestValue2",
-        })
-        self.cmd('appconfig kv set --endpoint {endpoint} --auth-mode login --key {key} --value {value} -y',
-                 checks=[self.check('key', "TestKey2"),
-                         self.check('value', "TestValue2")])
-
-        # Create a snapshot with a description
-        filter_dict = {"key": "Test*"}
-        self.kwargs.update({
-            'filter': '\'{}\''.format(json.dumps(filter_dict)),
-            'retention_period': 3600
-        })
-
-        self.cmd('appconfig snapshot create --endpoint {endpoint} --auth-mode login --snapshot-name {snapshot_name} --filters {filter} --retention-period {retention_period} --description "{snapshot_description}"',
-                 checks=[self.check('itemsCount', 2),
-                         self.check('status', 'ready'),
-                         self.check('description', snapshot_description)])
-
-        # Show the snapshot and verify the description is returned
-        self.cmd('appconfig snapshot show --endpoint {endpoint} --auth-mode login --snapshot-name {snapshot_name}',
-                 checks=[self.check('name', snapshot_name),
-                         self.check('description', snapshot_description)])
-
-        # Show only the description field
-        partial_snapshot = self.cmd('appconfig snapshot show --endpoint {endpoint} --auth-mode login --snapshot-name {snapshot_name} --fields description').get_output_in_json()
-        self.assertEqual(partial_snapshot['description'], snapshot_description)
-        self.assertRaises(KeyError, lambda: partial_snapshot['name'])
-
-        # List snapshots and verify the description is returned
-        listed_snapshots = self.cmd('appconfig snapshot list --endpoint {endpoint} --auth-mode login --snapshot-name {snapshot_name}').get_output_in_json()
-        self.assertEqual(listed_snapshots[0]['description'], snapshot_description)
-