Port from PR aws#10044 argparse percent escaping fix to CLI v2

Author: adev-code

awscli/arguments.py

@@ -449,7 +449,7 @@ def add_to_parser(self, parser):
         cli_name = self.cli_name
         parser.add_argument(
             cli_name,
-            help=self.documentation,
+            help=self.documentation.replace('%', '%%'),
             type=self.cli_type,
             required=self.required,
         )
@@ -482,7 +482,7 @@ def _unpack_argument(self, value):
         service_name = self._operation_model.service_model.service_name
         operation_name = xform_name(self._operation_model.name, '-')
         override = self._emit_first_response(
-            'process-cli-arg.%s.%s' % (service_name, operation_name),
+            f'process-cli-arg.{service_name}.{operation_name}',
             param=self.argument_model,
             cli_argument=self,
             value=value,
@@ -548,7 +548,7 @@ def __init__(
         default=None,
         serialized_name=None,
     ):
-        super(BooleanArgument, self).__init__(
+        super().__init__(
             name,
             argument_model,
             operation_model,
@@ -584,7 +584,7 @@ def add_to_arg_table(self, argument_table):
         # ourselves for the negative service.  We then insert both into the
         # arg table.
         argument_table[self.name] = self
-        negative_name = 'no-%s' % self.name
+        negative_name = f'no-{self.name}'
         negative_version = self.__class__(
             negative_name,
             self.argument_model,
@@ -600,7 +600,7 @@ def add_to_arg_table(self, argument_table):
     def add_to_parser(self, parser):
         parser.add_argument(
             self.cli_name,
-            help=self.documentation,
+            help=self.documentation.replace('%', '%%'),
             action=self._action,
             default=self._default,
             dest=self._destination,

tests/unit/test_argprocess.py

@@ -15,6 +15,7 @@
 from botocore import model, xform_name
 from botocore.compat import OrderedDict
 
+from awscli.argparser import ArgTableArgParser
 from awscli.argprocess import (
     ParamError,
     ParamShorthandDocGen,
@@ -69,7 +70,7 @@ def create_argument(self, argument_model, argument_name=None):
 
 class TestURIParams(BaseArgProcessTest):
     def setUp(self):
-        super(TestURIParams, self).setUp()
+        super().setUp()
         self.uri_param = URIArgumentHandler(LOCAL_PREFIX_MAP.copy())
 
     def test_uri_param(self):
@@ -80,7 +81,7 @@ def test_uri_param(self):
             )
             f.write(json_argument)
             f.flush()
-            result = self.uri_param('event-name', p, 'file://%s' % f.name)
+            result = self.uri_param('event-name', p, f'file://{f.name}')
         self.assertEqual(result, json_argument)
 
 
@@ -173,7 +174,7 @@ class TestParamShorthand(BaseArgProcessTest):
     maxDiff = None
 
     def setUp(self):
-        super(TestParamShorthand, self).setUp()
+        super().setUp()
         self._shorthand = ParamShorthandParser()
 
     def parse_shorthand(self, cli_argument, value, event_name=None):
@@ -490,7 +491,7 @@ def test_csv_syntax_errors(self):
 
 class TestParamShorthandCustomArguments(BaseArgProcessTest):
     def setUp(self):
-        super(TestParamShorthandCustomArguments, self).setUp()
+        super().setUp()
         self.shorthand = ParamShorthandParser()
 
     def test_list_structure_list_scalar_custom_arg(self):
@@ -555,7 +556,7 @@ class TestDocGen(BaseArgProcessTest):
     # flexible and allow the docs to slightly change without breaking these
     # tests.
     def setUp(self):
-        super(TestDocGen, self).setUp()
+        super().setUp()
         self.shorthand_documenter = ParamShorthandDocGen()
         self.service_name = 'foo'
         self.operation_name = 'bar'
@@ -728,7 +729,7 @@ def test_gen_structure_list_scalar_docs(self):
 
     def test_can_gen_recursive_structure(self):
         argument = self.get_param_model('dynamodb.PutItem.Item')
-        generated_example = self.get_generated_example_for(argument)
+        self.get_generated_example_for(argument)
 
     def test_can_document_nested_structs(self):
         argument = self.get_param_model('ec2.RunInstances.BlockDeviceMappings')
@@ -885,12 +886,14 @@ def test_structure_within_map(self):
             }
         )
         generated_example = self.get_generated_example_for(argument)
-        self.assertEqual('A={KeyName1={B=string},KeyName2={B=string}}', generated_example)
+        self.assertEqual(
+            'A={KeyName1={B=string},KeyName2={B=string}}', generated_example
+        )
 
 
 class TestUnpackJSONParams(BaseArgProcessTest):
     def setUp(self):
-        super(TestUnpackJSONParams, self).setUp()
+        super().setUp()
         self.simplify = ParamShorthandParser()
 
     def test_json_with_spaces(self):
@@ -925,7 +928,7 @@ def test_json_with_spaces(self):
 
 class TestJSONValueHeaderParams(BaseArgProcessTest):
     def setUp(self):
-        super(TestJSONValueHeaderParams, self).setUp()
+        super().setUp()
         self.p = self.get_param_model(
             'lex-runtime.PostContent.sessionAttributes'
         )
@@ -968,5 +971,46 @@ def test_json_value_decode_error(self):
             unpack_cli_arg(self.p, value)
 
 
+class TestArgumentPercentEscaping(BaseArgProcessTest):
+    def _test_percent_escaping(self, arg_type, arg_class, doc_string):
+        argument = self.create_argument(
+            {
+                'Test': {
+                    'type': arg_type,
+                    'documentation': doc_string,
+                }
+            }
+        )
+        arg = arg_class(
+            'test-arg',
+            argument.argument_model.members['Test'],
+            mock.Mock(),
+            mock.Mock(),
+            is_required=False,
+        )
+        arg_table = {arg.name: arg}
+        parser = ArgTableArgParser(arg_table)
+        help_output = parser.format_help()
+        self.assertIn(doc_string, help_output)
+
+    def test_cli_argument_escapes_percent(self):
+        self._test_percent_escaping('string', CLIArgument, 'Symbols: % ^ & *')
+
+    def test_boolean_argument_escapes_percent(self):
+        self._test_percent_escaping(
+            'boolean', BooleanArgument, 'Symbols: % ^ & *'
+        )
+
+    def test_cli_argument_escapes_url_encoded_percent(self):
+        self._test_percent_escaping(
+            'string', CLIArgument, 'File: test%28file%29.png'
+        )
+
+    def test_boolean_argument_escapes_url_encoded_percent(self):
+        self._test_percent_escaping(
+            'boolean', BooleanArgument, 'File: test%28file%29.png'
+        )
+
+
 if __name__ == '__main__':
     unittest.main()