specify --profile for cli (#874)

rrhodes · web-flow · commit bd8a2c058f6b · 2023-01-05T10:07:58.000-08:00
* wip to optionally specify aws profile for cli

* update documentation

* remove extra parameter doc bracket

* add new unit tests for profile arg

* support profiles in type schema loader
diff --git a/doc_source/resource-type-cli-invoke.md b/doc_source/resource-type-cli-invoke.md
@@ -10,6 +10,7 @@ Performs contract tests on the specified handler of a resource type\.
   cfn invoke
 [--endpoint <value>]
 [--function-name <value>]
+[--profile <value>]
 [--region <value>]
 [--max-reinvoke <value>]
 action
@@ -30,6 +31,10 @@ The logical Lambda function name in the SAM template\. Alternately, you can also
 
 Default: `TypeFunction`
 
+`--profile <value>`
+
+The AWS profile to use\. If no profile is specified, the client applies credentials specified in the [Boto3 credentials chain](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html)\.
+
 `--region <value>`
 
 The region to configure the client to interact with\.
diff --git a/doc_source/resource-type-cli-submit.md b/doc_source/resource-type-cli-submit.md
@@ -22,6 +22,7 @@ The user registering the extension must be able to access the schema handler pac
   cfn submit
 [--dry-run]
 [--endpoint-url <value>]
+[--profile <value>]
 [--region <value>]
 [--role-arn <value>]
 [--no-role]
@@ -42,6 +43,10 @@ The CloudFormation endpoint to use\.
 
 The AWS Region in which to register the extension\. If no Region is specified, the extension is registered in the default region\.
 
+`--profile <value>`
+
+The AWS profile to use\. If no profile is specified, the CloudFormation CLI applies credentials specified in the [Boto3 credentials chain](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html)\.
+
 `--role-arn <value>`
 
 A specific IAM role to use when invoking handler operations\.
diff --git a/doc_source/resource-type-cli-test.md b/doc_source/resource-type-cli-test.md
@@ -10,6 +10,7 @@ Performs contract tests on the handlers of a resource type\.
   cfn test
 [--endpoint <value>]
 [--function-name <value>]
+[--profile <value>]
 [--region <value>]
 [--role-arn <value>]
 ```
@@ -28,6 +29,10 @@ The logical Lambda function name in the SAM template\. Alternately, you can also
 
 Default: `TestEntrypoint`
 
+`--profile <value>`
+
+The AWS profile to use\. If no profile is specified, the contract tests apply credentials specified in the [Boto3 credentials chain](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html)\.
+
 `--region <value>`
 
 The region to use for temporary credentials\.
diff --git a/src/rpdk/core/boto_helpers.py b/src/rpdk/core/boto_helpers.py
@@ -14,14 +14,14 @@
 LOWER_CAMEL_CRED_KEYS = ("accessKeyId", "secretAccessKey", "sessionToken")
 
 
-def create_sdk_session(region_name=None):
+def create_sdk_session(region_name=None, profile_name=None):
     def _known_error(msg):
         raise CLIMisconfiguredError(
             msg + ". Please ensure your AWS CLI is configured correctly: "
             "https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html"
         )
 
-    session = Boto3Session(region_name=region_name)
+    session = Boto3Session(profile_name=profile_name, region_name=region_name)
 
     if session.region_name is None:
         _known_error("No region specified")
diff --git a/src/rpdk/core/contract/hook_client.py b/src/rpdk/core/contract/hook_client.py
@@ -59,9 +59,10 @@ def __init__(
         docker_image=None,
         executable_entrypoint=None,
         target_info=None,
-    ):  # pylint: disable=too-many-arguments
+        profile=None,
+    ):  # pylint: disable=too-many-arguments,too-many-locals
         self._schema = schema
-        self._session = create_sdk_session(region)
+        self._session = create_sdk_session(region, profile)
         self._role_arn = role_arn
         self._type_name = type_name
         self._log_group_name = log_group_name
diff --git a/src/rpdk/core/contract/resource_client.py b/src/rpdk/core/contract/resource_client.py
@@ -169,8 +169,9 @@ def __init__(
         log_role_arn=None,
         docker_image=None,
         executable_entrypoint=None,
+        profile=None,
     ):  # pylint: disable=too-many-arguments
-        self._session = create_sdk_session(region)
+        self._session = create_sdk_session(region, profile)
         self._role_arn = role_arn
         self._type_name = type_name
         self._log_group_name = log_group_name
diff --git a/src/rpdk/core/generate.py b/src/rpdk/core/generate.py
@@ -13,7 +13,11 @@ def generate(args):
     project = Project()
     project.load()
     project.generate(
-        args.endpoint_url, args.region, args.local_only, args.target_schemas
+        args.endpoint_url,
+        args.region,
+        args.local_only,
+        args.target_schemas,
+        args.profile,
     )
     project.generate_docs()
 
@@ -33,3 +37,4 @@ def setup_subparser(subparsers, parents):
     parser.add_argument(
         "--target-schemas", help="Path to target schemas.", nargs="*", default=[]
     )
+    parser.add_argument("--profile", help="AWS profile to use.")
diff --git a/src/rpdk/core/hook/init_hook.py b/src/rpdk/core/hook/init_hook.py
@@ -31,7 +31,7 @@ def init_hook(args, project):
     }
 
     project.init_hook(type_name, language, settings)
-    project.generate(args.endpoint_url, args.region, args.target_schemas)
+    project.generate(args.endpoint_url, args.region, args.target_schemas, args.profile)
     project.generate_docs()
 
 
diff --git a/src/rpdk/core/init.py b/src/rpdk/core/init.py
@@ -199,3 +199,5 @@ def setup_subparser(subparsers, parents):
         default=[],
         type=lambda s: [i.strip() for i in s.split(",")],
     )
+
+    parser.add_argument("--profile", help="AWS profile to use.")
diff --git a/src/rpdk/core/invoke.py b/src/rpdk/core/invoke.py
@@ -58,6 +58,7 @@ def get_contract_client(args, project):
             {},
             executable_entrypoint=project.executable_entrypoint,
             docker_image=args.docker_image,
+            profile=args.profile,
         )
 
     return ResourceClient(
@@ -68,6 +69,7 @@ def get_contract_client(args, project):
         {},
         executable_entrypoint=project.executable_entrypoint,
         docker_image=args.docker_image,
+        profile=args.profile,
     )
 
 
diff --git a/src/rpdk/core/project.py b/src/rpdk/core/project.py
@@ -478,8 +478,13 @@ def safewrite(self, path, contents):
                 LOG.info("File already exists, not overwriting '%s'", path)
 
     def generate(
-        self, endpoint_url=None, region_name=None, local_only=False, target_schemas=None
-    ):
+        self,
+        endpoint_url=None,
+        region_name=None,
+        local_only=False,
+        target_schemas=None,
+        profile_name=None,
+    ):  # pylint: disable=too-many-arguments
         if self.artifact_type == ARTIFACT_TYPE_MODULE:
             return  # for Modules, the schema is already generated in cfn validate
 
@@ -536,6 +541,7 @@ def generate(
                 region_name,
                 type_schemas=target_schemas,
                 local_only=local_only,
+                profile_name=profile_name,
             )
 
         self._plugin.generate(self)
@@ -607,7 +613,14 @@ def _validate_fragments(template_fragment):
         template_fragment.validate_fragments()
 
     def submit(
-        self, dry_run, endpoint_url, region_name, role_arn, use_role, set_default
+        self,
+        dry_run,
+        endpoint_url,
+        region_name,
+        role_arn,
+        use_role,
+        set_default,
+        profile_name,
     ):  # pylint: disable=too-many-arguments
         context_mgr = self._create_context_manager(dry_run)
 
@@ -631,7 +644,9 @@ def submit(
                 if self.artifact_type == ARTIFACT_TYPE_MODULE:
                     self._add_modules_content_to_zip(zip_file)
                 elif self.artifact_type == ARTIFACT_TYPE_HOOK:
-                    self._add_hooks_content_to_zip(zip_file, endpoint_url, region_name)
+                    self._add_hooks_content_to_zip(
+                        zip_file, endpoint_url, region_name, profile_name
+                    )
                 else:
                     self._add_resources_content_to_zip(zip_file)
 
@@ -642,7 +657,13 @@ def submit(
             else:
                 f.seek(0)
                 self._upload(
-                    f, endpoint_url, region_name, role_arn, use_role, set_default
+                    f,
+                    endpoint_url,
+                    region_name,
+                    role_arn,
+                    use_role,
+                    set_default,
+                    profile_name,
                 )
 
     def _add_overrides_file_to_zip(self, zip_file):
@@ -672,7 +693,9 @@ def _add_resources_content_to_zip(self, zip_file):
         cli_metadata["cli-version"] = __version__
         zip_file.writestr(CFN_METADATA_FILENAME, json.dumps(cli_metadata))
 
-    def _add_hooks_content_to_zip(self, zip_file, endpoint_url=None, region_name=None):
+    def _add_hooks_content_to_zip(
+        self, zip_file, endpoint_url=None, region_name=None, profile_name=None
+    ):
         zip_file.write(self.schema_path, SCHEMA_UPLOAD_FILENAME)
         if os.path.isdir(self.inputs_path):
             for filename in os.listdir(self.inputs_path):
@@ -687,7 +710,9 @@ def _add_hooks_content_to_zip(self, zip_file, endpoint_url=None, region_name=Non
             target_info = (
                 self.target_info
                 if self.target_info
-                else self._load_target_info(endpoint_url, region_name)
+                else self._load_target_info(
+                    endpoint_url, region_name, profile_name=profile_name
+                )
             )
         except RPDKBaseException as e:
             LOG.warning("Failed to load target info, attempting local...", exc_info=e)
@@ -1039,10 +1064,17 @@ def __set_property_type(prop_type, single_type=True):
         return prop
 
     def _upload(
-        self, fileobj, endpoint_url, region_name, role_arn, use_role, set_default
+        self,
+        fileobj,
+        endpoint_url,
+        region_name,
+        role_arn,
+        use_role,
+        set_default,
+        profile_name,
     ):  # pylint: disable=too-many-arguments, too-many-locals
         LOG.debug("Packaging complete, uploading...")
-        session = create_sdk_session(region_name)
+        session = create_sdk_session(region_name, profile_name)
         LOG.debug("Uploading to region '%s'", session.region_name)
         cfn_client = session.client("cloudformation", endpoint_url=endpoint_url)
         s3_client = session.client("s3")
@@ -1137,8 +1169,13 @@ def _wait_for_registration(cfn_client, registration_token, set_default):
     # flake8: noqa: C901
     # pylint: disable=R0914
     def _load_target_info(
-        self, endpoint_url, region_name, type_schemas=None, local_only=False
-    ):
+        self,
+        endpoint_url,
+        region_name,
+        type_schemas=None,
+        local_only=False,
+        profile_name=None,
+    ):  # pylint: disable=too-many-arguments
         if self.artifact_type != ARTIFACT_TYPE_HOOK or not self.schema:
             return {}
 
@@ -1175,7 +1212,7 @@ def _load_target_info(
             )
             loader = TypeSchemaLoader(None, None, local_only=local_only)
         else:
-            session = create_sdk_session(region_name)
+            session = create_sdk_session(region_name, profile_name)
             cfn_client = session.client("cloudformation", endpoint_url=endpoint_url)
             s3_client = session.client("s3")
 
diff --git a/src/rpdk/core/submit.py b/src/rpdk/core/submit.py
@@ -19,6 +19,7 @@ def submit(args):
         args.role_arn,
         args.use_role,
         args.set_default,
+        args.profile,
     )
 
 
@@ -37,6 +38,7 @@ def setup_subparser(subparsers, parents):
         action="store_true",
         help="If registration is successful, set submitted version to the default.",
     )
+    parser.add_argument("--profile", help="AWS profile to use.")
     role_group = parser.add_mutually_exclusive_group()
     role_group.add_argument(
         "--role-arn",
diff --git a/src/rpdk/core/test.py b/src/rpdk/core/test.py
diff --git a/tests/test_boto_helpers.py b/tests/test_boto_helpers.py
diff --git a/tests/test_generate.py b/tests/test_generate.py
diff --git a/tests/test_init.py b/tests/test_init.py
diff --git a/tests/test_project.py b/tests/test_project.py
diff --git a/tests/test_test.py b/tests/test_test.py

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ def init_hook(args, project):`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`project.init_hook(type_name, language, settings)`
`34`		`- project.generate(args.endpoint_url, args.region, args.target_schemas)`
	`34`	`+ project.generate(args.endpoint_url, args.region, args.target_schemas, args.profile)`
`35`	`35`	`project.generate_docs()`
`36`	`36`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -199,3 +199,5 @@ def setup_subparser(subparsers, parents):`
`199`	`199`	`default=[],`
`200`	`200`	`type=lambda s: [i.strip() for i in s.split(",")],`
`201`	`201`	`)`
	`202`	`+`
	`203`	`+ parser.add_argument("--profile", help="AWS profile to use.")`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ def get_contract_client(args, project):`
`58`	`58`	`{},`
`59`	`59`	`executable_entrypoint=project.executable_entrypoint,`
`60`	`60`	`docker_image=args.docker_image,`
	`61`	`+ profile=args.profile,`
`61`	`62`	`)`
`62`	`63`
`63`	`64`	`return ResourceClient(`
`@@ -68,6 +69,7 @@ def get_contract_client(args, project):`
`68`	`69`	`{},`
`69`	`70`	`executable_entrypoint=project.executable_entrypoint,`
`70`	`71`	`docker_image=args.docker_image,`
	`72`	`+ profile=args.profile,`
`71`	`73`	`)`
`72`	`74`
`73`	`75`