Implement upgrade debug mode

Author: aemous

.changes/next-release/feature-Migration-29690.json

@@ -0,0 +1,5 @@
+{
+  "type": "feature",
+  "category": "Migration",
+  "description": "Implement a ``--v2-debug`` flag and ``AWS_CLI_UPGRADE_DEBUG_MODE`` environment variable that detects breaking changes for AWS CLI v2 for entered commands."
+}

awscli/alias.py

@@ -183,7 +183,7 @@ def __call__(self, args, parsed_globals):
         parsed_alias_args, remaining = self._parser.parse_known_args(
             alias_args
         )
-        self._update_parsed_globals(parsed_alias_args, parsed_globals)
+        self._update_parsed_globals(parsed_alias_args, parsed_globals, remaining)
         # Take any of the remaining arguments that were not parsed out and
         # prepend them to the remaining args provided to the alias.
         remaining.extend(args)
@@ -228,7 +228,7 @@ def _get_alias_args(self):
         )
         return alias_args
 
-    def _update_parsed_globals(self, parsed_alias_args, parsed_globals):
+    def _update_parsed_globals(self, parsed_alias_args, parsed_globals, remaining):
         global_params_to_update = self._get_global_parameters_to_update(
             parsed_alias_args
         )
@@ -237,7 +237,7 @@ def _update_parsed_globals(self, parsed_alias_args, parsed_globals):
         # global parameters provided in the alias before updating
         # the original provided global parameter values
         # and passing those onto subsequent commands.
-        emit_top_level_args_parsed_event(self._session, parsed_alias_args)
+        emit_top_level_args_parsed_event(self._session, parsed_alias_args, remaining)
         for param_name in global_params_to_update:
             updated_param_value = getattr(parsed_alias_args, param_name)
             setattr(parsed_globals, param_name, updated_param_value)

awscli/argprocess.py

@@ -65,7 +65,7 @@ class TooComplexError(Exception):
 
 
 def unpack_argument(
-    session, service_name, operation_name, cli_argument, value
+    session, service_name, operation_name, cli_argument, value, parsed_globals
 ):
     """
     Unpack an argument's value from the commandline. This is part one of a two
@@ -83,6 +83,7 @@ def unpack_argument(
         value=value,
         service_name=service_name,
         operation_name=operation_name,
+        parsed_globals=parsed_globals,
     )
 
     if value_override is not None:

awscli/clidriver.py

@@ -48,7 +48,7 @@
     ServiceHelpCommand,
 )
 from awscli.plugin import load_plugins
-from awscli.utils import emit_top_level_args_parsed_event, write_exception, create_nested_client
+from awscli.utils import emit_top_level_args_parsed_event, write_exception, create_nested_client, resolve_v2_debug_mode
 from botocore import __version__ as botocore_version
 from botocore import xform_name
 
@@ -225,7 +225,7 @@ def main(self, args=None):
             # that exceptions can be raised, which should have the same
             # general exception handling logic as calling into the
             # command table.  This is why it's in the try/except clause.
-            self._handle_top_level_args(parsed_args)
+            self._handle_top_level_args(parsed_args, remaining)
             self._emit_session_event(parsed_args)
             HISTORY_RECORDER.record(
                 'CLI_VERSION', self.session.user_agent(), 'CLI'
@@ -279,8 +279,8 @@ def _show_error(self, msg):
         sys.stderr.write(msg)
         sys.stderr.write('\n')
 
-    def _handle_top_level_args(self, args):
-        emit_top_level_args_parsed_event(self.session, args)
+    def _handle_top_level_args(self, args, remaining):
+        emit_top_level_args_parsed_event(self.session, args, remaining)
         if args.profile:
             self.session.set_config_variable('profile', args.profile)
         if args.region:
@@ -542,9 +542,15 @@ def __call__(self, args, parsed_globals):
             event, parsed_args=parsed_args, parsed_globals=parsed_globals
         )
         call_parameters = self._build_call_parameters(
-            parsed_args, self.arg_table
+            parsed_args, self.arg_table, parsed_globals
         )
 
+        self._detect_binary_file_migration_change(
+            self._session,
+            parsed_args,
+            parsed_globals,
+            self.arg_table
+        )
         event = f'calling-command.{self._parent_name}.{self._name}'
         override = self._emit_first_non_none_response(
             event,
@@ -590,7 +596,7 @@ def _add_help(self, parser):
         # CLIArguments for values.
         parser.add_argument('help', nargs='?')
 
-    def _build_call_parameters(self, args, arg_table):
+    def _build_call_parameters(self, args, arg_table, parsed_globals):
         # We need to convert the args specified on the command
         # line as valid **kwargs we can hand to botocore.
         service_params = {}
@@ -601,19 +607,19 @@ def _build_call_parameters(self, args, arg_table):
             py_name = arg_object.py_name
             if py_name in parsed_args:
                 value = parsed_args[py_name]
-                value = self._unpack_arg(arg_object, value)
+                value = self._unpack_arg(arg_object, value, parsed_globals)
                 arg_object.add_to_params(service_params, value)
         return service_params
 
-    def _unpack_arg(self, cli_argument, value):
+    def _unpack_arg(self, cli_argument, value, parsed_globals):
         # Unpacks a commandline argument into a Python value by firing the
         # load-cli-arg.service-name.operation-name event.
         session = self._session
         service_name = self._operation_model.service_model.endpoint_prefix
         operation_name = xform_name(self._name, '-')
 
         return unpack_argument(
-            session, service_name, operation_name, cli_argument, value
+            session, service_name, operation_name, cli_argument, value, parsed_globals
         )
 
     def _create_argument_table(self):
@@ -661,6 +667,46 @@ def _create_operation_parser(self, arg_table):
         parser = ArgTableArgParser(arg_table)
         return parser
 
+    def _detect_binary_file_migration_change(
+            self,
+            session,
+            parsed_args,
+            parsed_globals,
+            arg_table
+    ):
+        if (
+                session.get_scoped_config()
+                        .get('cli_binary_format', None) == 'raw-in-base64-out'
+        ):
+            # if cli_binary_format is set to raw-in-base64-out, then v2 behavior will
+            # be the same as v1, so there is no breaking change in this case.
+            return
+        if resolve_v2_debug_mode(parsed_globals):
+            parsed_args_to_check = {
+                arg: getattr(parsed_args, arg)
+                for arg in vars(parsed_args) if getattr(parsed_args, arg)
+            }
+
+            arg_values_to_check = [
+                arg.py_name for arg in arg_table.values()
+                if arg.py_name in parsed_args_to_check
+                   and arg.argument_model.type_name == 'blob'
+            ]
+            if arg_values_to_check:
+                print(
+                    '\nAWS CLI v2 UPGRADE WARNING: When specifying a '
+                    'blob-type parameter, AWS CLI v2 will assume the '
+                    'parameter value is base64-encoded. This is different '
+                    'from v1 behavior, where the AWS CLI will automatically '
+                    'encode the value to base64. To retain v1 behavior in '
+                    'AWS CLI v2, set the `cli_binary_format` configuration '
+                    'variable to `raw-in-base64-out`. See '
+                    'https://docs.aws.amazon.com/cli/latest/userguide/'
+                    'cliv2-migration-changes.html'
+                    '#cliv2-migration-binaryparam.\n',
+                    file=sys.stderr
+                )
+
 
 class CLIOperationCaller:
     """Call an AWS operation and format the response."""

awscli/customizations/cliinputjson.py

@@ -70,6 +70,10 @@ def add_to_call_parameters(self, call_parameters, parsed_args,
             try:
                 # Try to load the JSON string into a python dictionary
                 input_data = json.loads(retrieved_json)
+                self._session.register(
+                    f"get-cli-input-json-data",
+                    lambda **inner_kwargs: input_data
+                )
             except ValueError as e:
                 raise ParamError(
                     self.name, "Invalid JSON: %s\nJSON received: %s"

awscli/customizations/cloudformation/deploy.py

@@ -24,7 +24,8 @@
 
 from awscli.customizations.commands import BasicCommand
 from awscli.compat import get_stdout_text_writer
-from awscli.utils import create_nested_client, write_exception
+from awscli.customizations.utils import uni_print
+from awscli.utils import create_nested_client, write_exception, resolve_v2_debug_mode
 
 LOG = logging.getLogger(__name__)
 
@@ -316,18 +317,33 @@ def _run_main(self, parsed_args, parsed_globals):
             s3_uploader = None
 
         deployer = Deployer(cloudformation_client)
+        v2_debug = resolve_v2_debug_mode(parsed_globals)
         return self.deploy(deployer, stack_name, template_str,
                            parameters, parsed_args.capabilities,
                            parsed_args.execute_changeset, parsed_args.role_arn,
                            parsed_args.notification_arns, s3_uploader,
                            tags, parsed_args.fail_on_empty_changeset,
-                           parsed_args.disable_rollback)
+                           parsed_args.disable_rollback, v2_debug)
 
     def deploy(self, deployer, stack_name, template_str,
                parameters, capabilities, execute_changeset, role_arn,
                notification_arns, s3_uploader, tags,
-               fail_on_empty_changeset=True, disable_rollback=False):
+               fail_on_empty_changeset=True, disable_rollback=False,
+               v2_debug=False):
         try:
+            if v2_debug and fail_on_empty_changeset:
+                uni_print(
+                    '\nAWS CLI v2 UPGRADE WARNING: In AWS CLI v2, deploying '
+                    'an AWS CloudFormation Template that results in an empty '
+                    'changeset will NOT result in an error by default. This '
+                    'is different from v1 behavior, where empty changesets '
+                    'result in an error by default. To migrate to v2 behavior '
+                    'and resolve this warning, you can add the '
+                    '`--no-fail-on-empty-changeset` flag to the command. '
+                    'See https://docs.aws.amazon.com/cli/latest/userguide/'
+                    'cliv2-migration-changes.html#cliv2-migration-cfn.\n',
+                    out_file=sys.stderr
+                )
             result = deployer.create_and_wait_for_changeset(
                 stack_name=stack_name,
                 cfn_template=template_str,

awscli/customizations/commands.py

@@ -154,7 +154,8 @@ def __call__(self, args, parsed_globals):
                 'custom',
                 self.name,
                 cli_argument,
-                value
+                value,
+                parsed_globals
             )
 
             # If this parameter has a schema defined, then allow plugins