[App Config] az appconfig kv import/export/restore: Add dry-run feature (#30842)

Co-authored-by: Christine WANJAU <cwanjau@microsoft.com>

Author: ChristineWanjau

src/azure-cli/azure/cli/command_modules/appconfig/_help.py

@@ -177,6 +177,8 @@
     text: az appconfig kv export -n MyAppConfiguration -d appconfig --tags tag1=value1 tag2=value2 --dest-name AnotherAppConfiguration
   - name: Export all keys and feature flags to another App Configuration store and apply new tags.
     text: az appconfig kv export -n MyAppConfiguration -d appconfig --dest-name AnotherAppConfiguration --dest-tags newtag1=newvalue1
+  - name: Preview the export result without making any changes to the App Configuration store.
+    text: az appconfig kv export -n MyAppConfiguration --label test -d file --path D:/abc.json --format json --dry-run
 """
 
 helps['appconfig kv import'] = """
@@ -203,8 +205,10 @@
     text: az appconfig kv import -n MyAppConfiguration -s file --path D:/abc.json --format json --profile appconfig/kvset
   - name: Import all keys and feature flags with specific tags from an App Configuration store and apply new tags.
     text: az appconfig kv import -n MyAppConfiguration -s appconfig --src-name AnotherAppConfiguration --src-tags tag1=value1 tag2=value2 --tags newtag1=newvalue1
-  - name: Import allkeys and feature flags from a file and apply new tags.
+  - name: Import all keys and feature flags from a file and apply new tags.
     text: az appconfig kv import -n MyAppConfiguration -s file --path D:/abc.json --format json --tags tag1=value1
+  - name: Preview the import result without making any changes to the App Configuration store.
+    text: az appconfig kv import -n MyAppConfiguration -s file --path D:/abc.json --format json --dry-run
 
 """
 
@@ -254,6 +258,8 @@
     text: az appconfig kv restore --key color --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx --label v1.* --datetime "2019-05-01T11:24:12Z"
   - name: Restore all key-values with specific tags to a specific point in time.
     text: az appconfig kv restore -n MyAppConfiguration --tags tag1=value1 tag2=value2 --datetime "2019-05-01T11:24:12Z"
+  - name: Preview the restore result without making any changes to the App Configuration store.
+    text: az appconfig kv restore -n MyAppConfiguration --datetime "2019-05-01T11:24:12Z" --dry-run
 """
 
 helps['appconfig kv set'] = """

src/azure-cli/azure/cli/command_modules/appconfig/_kv_export_helpers.py

@@ -373,7 +373,7 @@ def __export_keyvalue(key_segments, value, constructed_data):
 
 
 # Helper functions
-def __export_kvset_to_file(file_path, keyvalues, yes):
+def __export_kvset_to_file(file_path, keyvalues, yes, dry_run=False):
     if len(keyvalues) == 0:
         logger.warning("\nSource configuration is empty. Nothing to export.")
         return
@@ -387,6 +387,9 @@ def __export_kvset_to_file(file_path, keyvalues, yes):
         updates, level="kvset", yes=yes, title="KVSet", indent=2, show_update_diff=False
     )
 
+    if dry_run:
+        return
+
     if not yes:
         user_confirmation("Do you want to continue? \n")
     try:

src/azure-cli/azure/cli/command_modules/appconfig/_kv_import_helpers.py

@@ -457,6 +457,7 @@ def __import_kvset_from_file(
     path,
     strict,
     yes,
+    dry_run=False,
     import_mode=ImportMode.IGNORE_MATCH,
     correlation_request_id=None,
 ):
@@ -498,7 +499,7 @@ def __import_kvset_from_file(
         show_update_diff=False,
     )
 
-    if not changes_detected:
+    if not changes_detected or dry_run:
         return
 
     if not yes:

src/azure-cli/azure/cli/command_modules/appconfig/_params.py

@@ -27,7 +27,7 @@
                           validate_resolve_keyvault, validate_export_profile, validate_import_profile,
                           validate_strict_import, validate_export_as_reference, validate_snapshot_filters,
                           validate_snapshot_export, validate_snapshot_import, validate_tag_filters,
-                          validate_import_tag_filters)
+                          validate_import_tag_filters, validate_dry_run)
 
 
 def load_arguments(self, _):
@@ -228,6 +228,7 @@ def load_arguments(self, _):
         c.argument('skip_features', help="Import only key values and exclude all feature flags. By default, all feature flags will be imported from file or appconfig. Not applicable for appservice.", arg_type=get_three_state_flag())
         c.argument('content_type', help='Content type of all imported items.')
         c.argument('import_mode', arg_type=get_enum_type([ImportMode.ALL, ImportMode.IGNORE_MATCH]), help='If import mode is "ignore-match", only source key-values that do not already exist or whose value, content-type or tags are different from that of an existing key-value with the same key and label, will be written. Import mode "all" writes all key-values to the destination regardless of whether they exist or not.')
+        c.argument('dry_run', validator=validate_dry_run, help="Preview the result of import operation without making any changes to the App Configuration store.")
 
     with self.argument_context('appconfig kv import', arg_group='File') as c:
         c.argument('path', help='Local configuration file path. Required for file arguments.')
@@ -265,6 +266,7 @@ def load_arguments(self, _):
         c.argument('snapshot', validator=validate_snapshot_export,
                    help="Export all keys in a given snapshot of the App Configuration store. If no snapshot is specified, the keys currently in the store are exported based on the specified key and label filters.")
         c.argument('tags', arg_type=tags_arg_type, help="Key-values which contain the specified tags in source AppConfig will be exported. If no tags are specified, all key-values with any tags can be exported. Support space-separated tag filters: key[=value] [key[=value] ...].")
+        c.argument('dry_run', validator=validate_dry_run, help="Preview the result of export operation without making any changes to the App Configuration store.")
 
     with self.argument_context('appconfig kv export', arg_group='File') as c:
         c.argument('path', help='Local configuration file path. Required for file arguments.')
@@ -324,6 +326,7 @@ def load_arguments(self, _):
         c.argument('key', help='If no key specified, restore all keys by default. Support star sign as filters, for instance abc* means keys with abc as prefix.')
         c.argument('label', help="If no label specified, restore all key-value pairs with all labels. Support star sign as filters, for instance abc* means labels with abc as prefix. Use '\\0' for null label.")
         c.argument('tags', arg_type=tags_arg_type, help="If no tags are specified, restore all key-values with any tags. Support space-separated tags: key[=value] [key[=value] ...].")
+        c.argument('dry_run', validator=validate_dry_run, help="Preview the result of restore operation without making any changes to the App Configuration store.")
 
     with self.argument_context('appconfig kv lock') as c:
         c.argument('key', help='Key to be locked.')

src/azure-cli/azure/cli/command_modules/appconfig/_validators.py

@@ -453,3 +453,8 @@ def validate_tag_filters(namespace):
 def validate_import_tag_filters(namespace):
     """Validates tag filters in the 'src_tags' attribute."""
     _validate_tag_filter_list(getattr(namespace, 'src_tags', None))
+
+
+def validate_dry_run(namespace):
+    if namespace.dry_run and namespace.yes:
+        raise MutuallyExclusiveArgumentError("The '--dry-run' and '--yes' options cannot be specified together.")

src/azure-cli/azure/cli/command_modules/appconfig/keyvalue.py

@@ -73,6 +73,7 @@ def import_config(cmd,
                   auth_mode="key",
                   endpoint=None,
                   import_mode=ImportMode.IGNORE_MATCH,
+                  dry_run=False,
                   # from-file parameters
                   path=None,
                   format_=None,
@@ -108,7 +109,7 @@ def import_config(cmd,
     # fetch key values from source
     if source == 'file':
         if profile == ImportExportProfiles.KVSET:
-            __import_kvset_from_file(client=azconfig_client, path=path, strict=strict, yes=yes, import_mode=import_mode, correlation_request_id=correlation_request_id)
+            __import_kvset_from_file(client=azconfig_client, path=path, strict=strict, yes=yes, dry_run=dry_run, import_mode=import_mode, correlation_request_id=correlation_request_id)
             return
         if format_ and content_type:
             # JSON content type is only supported with JSON format.
@@ -219,7 +220,7 @@ def import_config(cmd,
         ff_diff = ff_comparer.compare(dest_kvs=dest_features, strict=strict, ignore_matching_kvs=import_mode == ImportMode.IGNORE_MATCH)
         need_feature_change = print_preview(ff_diff, source, yes=yes, strict=strict, title="Feature Flags")
 
-    if not need_kv_change and not need_feature_change:
+    if (not need_kv_change and not need_feature_change) or dry_run:
         return
 
     if not yes:
@@ -273,6 +274,7 @@ def export_config(cmd,
                   auth_mode="key",
                   endpoint=None,
                   snapshot=None,
+                  dry_run=False,
                   # to-file parameters
                   path=None,
                   format_=None,
@@ -360,7 +362,7 @@ def export_config(cmd,
         __discard_features_from_retrieved_kv(src_kvs)
 
     if profile == ImportExportProfiles.KVSET:
-        __export_kvset_to_file(file_path=path, keyvalues=src_kvs, yes=yes)
+        __export_kvset_to_file(file_path=path, keyvalues=src_kvs, yes=yes, dry_run=dry_run)
         return
 
     if destination == 'appservice' and export_as_reference:
@@ -419,8 +421,9 @@ def export_config(cmd,
         ff_diff = ff_comparer.compare(dest_kvs=__convert_featureflag_list_to_keyvalue_list(dest_features))
         need_feature_change = print_preview(ff_diff, destination, yes=yes, title="Feature Flags")
 
-    if not need_feature_change and not need_kv_change:
+    if (not need_feature_change and not need_kv_change) or dry_run:
         return
+
     # if customer needs preview & confirmation
     if not yes:
         user_confirmation("Do you want to continue? \n")
@@ -824,6 +827,7 @@ def restore_key(cmd,
                 connection_string=None,
                 yes=False,
                 auth_mode="key",
+                dry_run=False,
                 endpoint=None):
     azconfig_client = get_appconfig_data_client(cmd, name, connection_string, auth_mode, endpoint)
 
@@ -849,11 +853,10 @@ def restore_key(cmd,
 
         need_change = __print_restore_preview(restore_diff, yes=yes)
 
-        if not yes:
-            if need_change is False:
-                logger.debug('Canceling the restore operation based on user selection.')
-                return
+        if dry_run or not need_change:
+            return
 
+        if not yes:
             user_confirmation("Do you want to continue? \n")
 
         kvs_to_restore = restore_diff.get(JsonDiff.ADD, [])