Track usage of --v2-debug usage and final --v2-debug changes

.changes/next-release/enhancement-Migration-48043.json

@@ -1,5 +1,5 @@
 {
   "type": "enhancement",
   "category": "Migration",
-  "description": "Implement a ``--migrate-v2`` flag that detects breaking changes for AWS CLI v2 for entered commands."
+  "description": "Implement a ``--v2-debug`` flag that detects breaking changes for AWS CLI v2 for entered commands."
 }

awscli/clidriver.py

@@ -41,15 +41,14 @@
 )
 from awscli.commands import CLICommand
 from awscli.compat import get_stderr_text_writer
-from awscli.customizations.utils import uni_print
 from awscli.formatter import get_formatter
 from awscli.help import (
     OperationHelpCommand,
     ProviderHelpCommand,
     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
 
@@ -682,7 +681,7 @@ def _detect_binary_file_migration_change(
             # 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 parsed_globals.v2_debug:
+        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)
@@ -692,19 +691,18 @@ def _detect_binary_file_migration_change(
                 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'
-                   and parsed_args_to_check[arg.py_name].startswith('file://')
             ]
             if arg_values_to_check:
-                uni_print(
-                    'AWS CLI v2 MIGRATION WARNING: When specifying a blob-type '
-                    'parameter starting with `file://`, AWS CLI v2 will assume '
-                    'the content of the file is already base64-encoded. To '
-                    'maintain v1 behavior after upgrading to 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',
-                    out_file=sys.stderr
+                print(
+                    'AWS CLI v2 UPGRADE WARNING: When specifying a blob-type '
+                    'parameter, AWS CLI v2 will assume the parameter value is '
+                    'base64-encoded. To maintain v1 behavior after upgrading '
+                    'to 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
                 )
 
 

awscli/customizations/cloudformation/deploy.py

@@ -25,7 +25,7 @@
 from awscli.customizations.commands import BasicCommand
 from awscli.compat import get_stdout_text_writer
 from awscli.customizations.utils import uni_print
-from awscli.utils import create_nested_client, write_exception
+from awscli.utils import create_nested_client, write_exception, resolve_v2_debug_mode
 
 LOG = logging.getLogger(__name__)
 
@@ -317,19 +317,32 @@ 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, getattr(parsed_globals, 'v2_debug', False))
+                           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,
                v2_debug=False):
         try:
+            if v2_debug and fail_on_empty_changeset:
+                uni_print(
+                    'AWS 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. You can add the -–no-fail-on-empty-changeset '
+                    'flag to migrate to v2 behavior and resolve this '
+                    'warning. 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,
@@ -342,18 +355,6 @@ def deploy(self, deployer, stack_name, template_str,
             )
         except exceptions.ChangeEmptyError as ex:
             if fail_on_empty_changeset:
-                if v2_debug:
-                    uni_print(
-                        'AWS CLI v2 MIGRATION WARNING: In AWS CLI v2, '
-                        'deploying an AWS CloudFormation Template that '
-                        'results in an empty changeset will NOT result in an '
-                        'error. You can add the -–no-fail-on-empty-changeset '
-                        'flag to migrate to v2 behavior and resolve this '
-                        'warning. See https://docs.aws.amazon.com/cli/latest/'
-                        'userguide/cliv2-migration-changes.html'
-                        '#cliv2-migration-cfn.\n',
-                        out_file=sys.stderr
-                    )
                 raise
             write_exception(ex, outfile=get_stdout_text_writer())
             return 0

awscli/customizations/globalargs.py

@@ -18,9 +18,12 @@
 from botocore.client import Config
 from botocore import UNSIGNED
 from botocore.endpoint import DEFAULT_TIMEOUT
+from botocore.useragent import register_feature_id
 import jmespath
 
 from awscli.compat import urlparse
+from awscli.utils import resolve_v2_debug_mode
+
 
 def register_parse_global_args(cli):
     cli.register('top-level-args-parsed', resolve_types,
@@ -96,22 +99,37 @@ def resolve_cli_connect_timeout(parsed_args, session, **kwargs):
     _resolve_timeout(session, parsed_args, arg_name)
 
 def detect_migration_breakage(parsed_args, remaining_args, session, **kwargs):
-    if not parsed_args.v2_debug:
+    if not resolve_v2_debug_mode(parsed_args):
         return
     url_params = [
         param for param in remaining_args
         if param.startswith('http://') or param.startswith('https://')
     ]
     region = parsed_args.region or session.get_config_variable('region')
     s3_config = session.get_config_variable('s3')
+    if (
+            not session.get_scoped_config().get('cli_pager', None)
+            == '' and 'AWS_PAGER' not in os.environ
+    ):
+        uni_print(
+            'AWS CLI v2 UPGRADE WARNING: By default, the AWS CLI version 2 '
+            'returns all output through your operating system’s default pager '
+            'program. To retain AWS CLI v1 behavior after upgrading to AWS '
+            'CLI v2, set the `cli_pager` configuration setting, or the '
+            '`AWS_PAGER` environment variable, to the empty string. See '
+            'https://docs.aws.amazon.com/cli/latest/userguide'
+            '/cliv2-migration-changes.html#cliv2-migration-output-pager.\n',
+            out_file=sys.stderr
+        )
     if 'PYTHONUTF8' in os.environ or 'PYTHONIOENCODING' in os.environ:
         if 'AWS_CLI_FILE_ENCODING' not in os.environ:
             uni_print(
-                'AWS CLI v2 MIGRATION WARNING: The PYTHONUTF8 and '
+                'AWS CLI v2 UPGRADE WARNING: The PYTHONUTF8 and '
                 'PYTHONIOENCODING environment variables are unsupported '
-                'in AWS CLI v2. AWS CLI v2 uses AWS_CLI_FILE_ENCODING '
-                'instead, set this environment variable to resolve this. '
-                'See https://docs.aws.amazon.com/cli/latest/userguide/'
+                'in AWS CLI v2. AWS CLI v2 uses the `AWS_CLI_FILE_ENCODING` '
+                'variable instead; set this environment variable to retain '
+                'AWS CLI v1 behavior after upgrading to AWS CLI v2. See '
+                'https://docs.aws.amazon.com/cli/latest/userguide/'
                 'cliv2-migration-changes.html'
                 '#cliv2-migration-encodingenvvar.\n',
                 out_file=sys.stderr
@@ -129,18 +147,18 @@ def detect_migration_breakage(parsed_args, remaining_args, session, **kwargs):
         )
     if session.get_config_variable('api_versions'):
         uni_print(
-            'AWS CLI v2 MIGRATION WARNING: The AWS CLI v2 does not support '
+            'AWS CLI v2 UPGRADE WARNING: The AWS CLI v2 does not support '
             'calling earlier versions of AWS service APIs via the '
             '`api_versions` configuration file setting. To migrate to v2 '
-            'behavior and resolve this warning, remove the `api_versions` '
-            'setting in the configuration file. See '
+            'behavior, remove the `api_versions` configuration setting, and '
+            'test against the latest API versions. See '
             'https://docs.aws.amazon.com/cli/latest/userguide/'
             'cliv2-migration-changes.html#cliv2-migration-api-versions.\n',
             out_file = sys.stderr
         )
     if session.full_config.get('plugins', {}):
         uni_print(
-            'AWS CLI v2 MIGRATION WARNING: In AWS CLI v2, plugin support '
+            'AWS CLI v2 UPGRADE WARNING: In AWS CLI v2, plugin support '
             'is provisional. If you rely on plugins, be sure to lock into '
             'a particular version of the AWS CLI and test the '
             'functionality of your plugins for each upgrade. See '
@@ -151,18 +169,18 @@ def detect_migration_breakage(parsed_args, remaining_args, session, **kwargs):
         )
     if parsed_args.command == 'ecr' and remaining_args[0] == 'get-login':
         uni_print(
-            'AWS CLI v2 MIGRATION WARNING: The ecr get-login command has '
-            'been removed in AWS CLI v2. See https://docs.aws.amazon.com/'
-            'cli/latest/userguide/cliv2-migration-changes.html'
-            '#cliv2-migration-ecr-get-login.\n',
+            'AWS CLI v2 UPGRADE WARNING: The `ecr get-login` command has '
+            'been removed in AWS CLI v2. You must use `ecr get-login-password` '
+            'instead. See https://docs.aws.amazon.com/cli/latest/userguide/'
+            'cliv2-migration-changes.html#cliv2-migration-ecr-get-login.\n',
             out_file=sys.stderr
         )
-    if url_params and session.full_config.get('cli_follow_urlparam', True):
+    if url_params and session.get_scoped_config().get('cli_pager', None):
         uni_print(
-            'AWS CLI v2 MIGRATION WARNING: For input parameters that have '
+            'AWS CLI v2 UPGRADE WARNING: For input parameters that have '
             'a prefix of http:// or https://, AWS CLI v2 will no longer '
             'automatically request the content of the URL for the '
-            'parameter, and the cli_follow_urlparam option has been '
+            'parameter, and the `cli_follow_urlparam` option has been '
             'removed. See https://docs.aws.amazon.com/cli/latest/'
             'userguide/cliv2-migration-changes.html'
             '#cliv2-migration-paramfile.\n',
@@ -179,27 +197,40 @@ def detect_migration_breakage(parsed_args, remaining_args, session, **kwargs):
                 and f"--{working_param}" in remaining_args
         ):
             uni_print(
-                'AWS CLI v2 MIGRATION WARNING: You have entered command '
+                'AWS CLI v2 UPGRADE WARNING: You have entered command '
                 'arguments that uses at least 1 of 21 hidden aliases that '
-                'were removed in AWS CLI v2. See '
+                'were removed in AWS CLI v2. You must replace usage of the '
+                'obsolete alias with the corresponding working parameter. See '
                 'https://docs.aws.amazon.com/cli/latest/userguide'
                 '/cliv2-migration-changes.html#cliv2-migration-aliases.\n',
                 out_file=sys.stderr
             )
+    # Register against the provide-client-params event to ensure that the
+    # feature ID is registered before any API requests are made. We
+    # cannot register the feature ID in this function because no
+    # botocore context is created at this point.
+    session.register(
+        'provide-client-params.*.*',
+        _register_v2_debug_feature_id
+    )
     session.register('choose-signer.s3.*', warn_if_sigv2)
 
+
+def _register_v2_debug_feature_id(params, model, **kwargs):
+    register_feature_id('CLI_V1_TO_V2_MIGRATION_DEBUG_MODE')
+
 def warn_if_east_configured_global_endpoint(request, operation_name, **kwargs):
     # The regional us-east-1 endpoint is used in certain cases (e.g.
     # FIPS/Dual-Stack is enabled). Rather than duplicating this logic
     # from botocore, we check the endpoint URL directly.
     if 's3.amazonaws.com' in request.url:
         uni_print(
-            'AWS CLI v2 MIGRATION WARNING: When you configure AWS CLI v2 '
+            'AWS CLI v2 UPGRADE WARNING: When you configure AWS CLI v2 '
             'to use the `us-east-1` region, it uses the true regional '
-            'endpoint rather than the global endpoint. To continue using '
-            'the global endpoint on v2, configure the region to be '
-            '`aws-global`. See https://docs.aws.amazon.com/cli/latest/'
-            'userguide/cliv2-migration-changes.html'
+            'endpoint rather than the global endpoint. To retain AWS CLI v1 '
+            'behavior after upgrading to AWS CLI v2, configure the `region` '
+            'setting to `aws-global`. See https://docs.aws.amazon.com/cli'
+            '/latest/userguide/cliv2-migration-changes.html'
             '#cliv2-migration-s3-regional-endpoint.\n',
             out_file=sys.stderr
         )
@@ -213,10 +244,10 @@ def warn_if_sigv2(
 ):
     if context.get('auth_type', None) == 'v2':
         uni_print(
-            'AWS CLI v2 MIGRATION WARNING: The AWS CLI v2 only uses Signature '
-            'v4 to authenticate Amazon S3 requests. Run the command `aws '
-            'configure set s3.signature_version s3v4` to migrate to v4 and '
-            'resolve this.\n',
+            'AWS CLI v2 UPGRADE WARNING: The AWS CLI v2 only uses Signature '
+            'v4 to authenticate Amazon S3 requests. To migrate to AWS CLI '
+            'v2 behavior, configure the Signature Version S3 setting to '
+            'version 4.\n',
             out_file=sys.stderr
         )
 

awscli/customizations/paginate.py

@@ -33,7 +33,7 @@
 from botocore import model
 
 from awscli.arguments import BaseCLIArgument
-
+from awscli.utils import resolve_v2_debug_mode
 
 logger = logging.getLogger(__name__)
 
@@ -293,7 +293,7 @@ def check_should_enable_pagination_call_parameters(
     naming space and would be missed by the processing above. This function
     gets called on the calling-command event.
     """
-    if parsed_globals.v2_debug:
+    if resolve_v2_debug_mode(parsed_globals):
         cli_input_json_data = session.emit_first_non_none_response(
             f"get-cli-input-json-data",
         )
@@ -304,11 +304,12 @@ def check_should_enable_pagination_call_parameters(
         ]
         if pagination_params_in_input_tokens:
             uni_print(
-                'AWS CLI v2 MIGRATION WARNING: In AWS CLI v2, if you specify '
+                'AWS CLI v2 UPGRADE WARNING: In AWS CLI v2, if you specify '
                 'pagination parameters by using a file with the '
                 '`--cli-input-json` parameter, automatic pagination will be '
-                'turned off. This is not the case in v1. See '
-                'https://docs.aws.amazon.com/cli/latest/userguide/'
+                'turned off. To retain AWS CLI v1 behavior after upgrading to '
+                'AWS CLI v2, remove all pagination parameters from the input '
+                'JSON. See https://docs.aws.amazon.com/cli/latest/userguide/'
                 'cliv2-migration-changes.html'
                 '#cliv2-migration-skeleton-paging.\n',
                 out_file=sys.stderr

awscli/customizations/s3/subcommands.py

@@ -36,7 +36,7 @@
 from awscli.customizations.s3.syncstrategy.base import MissingFileSync, \
     SizeAndLastModifiedSync, NeverSync
 from awscli.customizations.s3 import transferconfig
-
+from awscli.utils import resolve_v2_debug_mode
 
 LOGGER = logging.getLogger(__name__)
 
@@ -1060,7 +1060,7 @@ def run(self):
         if self.parameters['v2_debug']:
             if operation_name == 'copy':
                 uni_print(
-                    'AWS CLI v2 MIGRATION WARNING: In AWS CLI v2, object '
+                    'AWS CLI v2 UPGRADE WARNING: In AWS CLI v2, object '
                     'properties will be copied from the source in multipart '
                     'copies between S3 buckets. This may result in extra S3 '
                     'API calls being made. Breakage may occur if the principal '
@@ -1464,7 +1464,7 @@ def add_page_size(self, parsed_args):
         self.parameters['page_size'] = getattr(parsed_args, 'page_size', None)
 
     def add_v2_debug(self, parsed_globals):
-        self.parameters['v2_debug'] = parsed_globals.v2_debug
+        self.parameters['v2_debug'] = resolve_v2_debug_mode(parsed_globals)
 
     def _validate_sse_c_args(self):
         self._validate_sse_c_arg()