fix: propagate role_arn to companion stack CloudFormation calls (#5051)

samcli/commands/deploy/command.py

@@ -341,6 +341,7 @@ def do_cli(
                 config_file=config_file,
                 disable_rollback=disable_rollback,
                 language_extensions_enabled=language_extensions_enabled,
+                role_arn=role_arn,
             )
             guided_context.run()
         else:
@@ -362,7 +363,7 @@ def do_cli(
             # after we figure out how to enable resolve-images-repos in package
             if resolve_image_repos:
                 image_repositories = sync_ecr_stack(
-                    template_file, stack_name, region, s3_bucket, s3_prefix, image_repositories
+                    template_file, stack_name, region, s3_bucket, s3_prefix, image_repositories, role_arn
                 )
         with osutils.tempfile_platform_independent() as output_template_file:
             if guided:

samcli/commands/deploy/guided_context.py

@@ -63,6 +63,7 @@ def __init__(
         config_file=None,
         disable_rollback=None,
         language_extensions_enabled: bool = False,
+        role_arn: Optional[str] = None,
     ):
         self.template_file = template_file
         self.stack_name = stack_name
@@ -97,6 +98,7 @@ def __init__(
         self.function_provider: Optional[SamFunctionProvider] = None
         self.disable_rollback = disable_rollback
         self._language_extensions_enabled = language_extensions_enabled
+        self.role_arn = role_arn
 
     @property
     def guided_capabilities(self):
@@ -189,7 +191,13 @@ def guided_prompts(self, parameter_override_keys):
 
         image_repositories = (
             sync_ecr_stack(
-                self.template_file, stack_name, region, managed_s3_bucket, self.s3_prefix, self.image_repositories
+                self.template_file,
+                stack_name,
+                region,
+                managed_s3_bucket,
+                self.s3_prefix,
+                self.image_repositories,
+                self.role_arn,
             )
             if self.resolve_image_repositories
             else self.prompt_image_repository(
@@ -359,7 +367,7 @@ def prompt_image_repository(
             if repo_full_path:
                 updated_repositories[repo_full_path] = image_repo_uri
         self.function_provider = SamFunctionProvider(stacks, ignore_code_extraction_warnings=True)
-        manager = CompanionStackManager(stack_name, region, s3_bucket, s3_prefix)
+        manager = CompanionStackManager(stack_name, region, s3_bucket, s3_prefix, self.role_arn)
 
         function_logical_ids = [
             function.full_path for function in self.function_provider.get_all() if function.packagetype == IMAGE

samcli/lib/bootstrap/companion_stack/companion_stack_manager.py

@@ -38,17 +38,19 @@ class CompanionStackManager:
     _delete_stack_waiter_config: WaiterConfigTypeDef
     _s3_bucket: str
     _s3_prefix: str
+    _role_arn: Optional[str]
     _cfn_client: CloudFormationClient
     _s3_client: S3Client
 
-    def __init__(self, stack_name, region, s3_bucket, s3_prefix):
+    def __init__(self, stack_name, region, s3_bucket, s3_prefix, role_arn: Optional[str] = None):
         self._companion_stack = CompanionStack(stack_name)
         self._builder = CompanionStackBuilder(self._companion_stack)
         self._boto_config = Config(region_name=region if region else None)
         self._update_stack_waiter_config = {"Delay": 10, "MaxAttempts": 120}
         self._delete_stack_waiter_config = {"Delay": 10, "MaxAttempts": 120}
         self._s3_bucket = s3_bucket
         self._s3_prefix = s3_prefix
+        self._role_arn = role_arn
         try:
             self._cfn_client = boto3.client("cloudformation", config=self._boto_config)
             self._ecr_client = boto3.client("ecr", config=self._boto_config)
@@ -116,16 +118,24 @@ def update_companion_stack(self) -> None:
 
         template_url = s3_uploader.to_path_style_s3_url(parts["Key"], parts.get("Version", None))
 
+        extra_args = {"RoleARN": self._role_arn} if self._role_arn else {}
+
         exists = self.does_companion_stack_exist()
         if exists:
             self._cfn_client.update_stack(
-                StackName=stack_name, TemplateURL=template_url, Capabilities=["CAPABILITY_AUTO_EXPAND"]
+                StackName=stack_name,
+                TemplateURL=template_url,
+                Capabilities=["CAPABILITY_AUTO_EXPAND"],
+                **extra_args,
             )
             update_waiter = self._cfn_client.get_waiter("stack_update_complete")
             update_waiter.wait(StackName=stack_name, WaiterConfig=self._update_stack_waiter_config)
         else:
             self._cfn_client.create_stack(
-                StackName=stack_name, TemplateURL=template_url, Capabilities=["CAPABILITY_AUTO_EXPAND"]
+                StackName=stack_name,
+                TemplateURL=template_url,
+                Capabilities=["CAPABILITY_AUTO_EXPAND"],
+                **extra_args,
             )
             create_waiter = self._cfn_client.get_waiter("stack_create_complete")
             create_waiter.wait(StackName=stack_name, WaiterConfig=self._update_stack_waiter_config)
@@ -193,6 +203,8 @@ def delete_unreferenced_repos(self) -> None:
         repos = self.get_unreferenced_repos()
         for repo in repos:
             try:
+                # self._ecr_client uses ambient credentials, not role_arn, so the caller's
+                # credentials (not the assumed role) need ecr:DeleteRepository permission.
                 self._ecr_client.delete_repository(repositoryName=repo.physical_id, force=True)
             except self._ecr_client.exceptions.RepositoryNotFoundException:
                 LOG.debug("Image repo [%s] not found in companion stack. Skipping deletion.", repo.physical_id)
@@ -279,7 +291,13 @@ def is_repo_uri(self, repo_uri: Optional[str], function_logical_id: str) -> bool
 
 
 def sync_ecr_stack(
-    template_file: str, stack_name: str, region: str, s3_bucket: str, s3_prefix: str, image_repositories: Dict[str, str]
+    template_file: str,
+    stack_name: str,
+    region: str,
+    s3_bucket: str,
+    s3_prefix: str,
+    image_repositories: Dict[str, str],
+    role_arn: Optional[str] = None,
 ) -> Dict[str, str]:
     """Blocking call to sync local functions with ECR Companion Stack
 
@@ -297,6 +315,8 @@ def sync_ecr_stack(
         S3 prefix for the bucket
     image_repositories : Dict[str, str]
         Mapping between function logical ID and ECR URI
+    role_arn : Optional[str]
+        IAM role ARN used when creating/updating the companion stack
 
     Returns
     -------
@@ -305,7 +325,7 @@ def sync_ecr_stack(
         for Functions without a repo specified.
     """
     image_repositories = image_repositories.copy() if image_repositories else {}
-    manager = CompanionStackManager(stack_name, region, s3_bucket, s3_prefix)
+    manager = CompanionStackManager(stack_name, region, s3_bucket, s3_prefix, role_arn)
 
     stacks = SamLocalStackProvider.get_stacks(template_file, language_extensions_enabled=False)[0]
     function_provider = SamFunctionProvider(stacks, ignore_code_extraction_warnings=True)

tests/unit/commands/deploy/test_command.py

@@ -455,6 +455,16 @@ def test_all_args_guided_use_defaults(
                 express=self.express,
             )
 
+            mock_sync_ecr_stack.assert_called_with(
+                self.template_file,
+                "sam-app",
+                "us-east-1",
+                "managed-s3-bucket",
+                self.s3_prefix,
+                None,
+                self.role_arn,
+            )
+
             mock_deploy_context.assert_called_with(
                 template_file=ANY,
                 stack_name="sam-app",
@@ -1284,6 +1294,10 @@ def test_all_args_resolve_image_repos(
             output="text",
         )
 
+        mock_sync_ecr_stack.assert_called_with(
+            self.template_file, self.stack_name, self.region, self.s3_bucket, self.s3_prefix, None, self.role_arn
+        )
+
         mock_deploy_context.assert_called_with(
             template_file=ANY,
             stack_name=self.stack_name,

tests/unit/commands/deploy/test_guided_context.py

@@ -22,6 +22,7 @@ def setUp(self):
             image_repository=None,
             image_repositories={"RandomFunction": "image-repo"},
             disable_rollback=False,
+            role_arn="role_arn",
         )
 
         self.unreferenced_repo_mock = MagicMock()
@@ -237,6 +238,10 @@ def test_guided_prompts_check_defaults_public_resources_images(
         ]
         self.assertEqual(expected_click_secho_calls, patched_click_secho.call_args_list)
 
+        self.companion_stack_manager_mock.assert_called_once_with(
+            "sam-app", "region", "managed_s3_stack", self.gc.s3_prefix, "role_arn"
+        )
+
     @patch("samcli.commands.deploy.guided_context.get_resource_full_path_by_id")
     @patch("samcli.commands.deploy.guided_context.prompt")
     @patch("samcli.commands.deploy.guided_context.confirm")

tests/unit/lib/bootstrap/companion_stack/test_companion_stack_manager.py

@@ -70,6 +70,27 @@ def test_create_companion_stack(
         self.cfn_client.get_waiter.assert_called_once_with("stack_create_complete")
         cfn_waiter.wait.assert_called_once_with(StackName=self.companion_stack_name, WaiterConfig=ANY)
 
+    @patch("samcli.lib.bootstrap.companion_stack.companion_stack_manager.mktempfile")
+    @patch("samcli.lib.bootstrap.companion_stack.companion_stack_manager.S3Uploader")
+    @patch("samcli.lib.bootstrap.companion_stack.companion_stack_manager.parse_s3_url")
+    def test_create_companion_stack_with_role_arn(
+        self,
+        parse_s3_url_mock,
+        s3_uploader_mock,
+        mktempfile_mock,
+    ):
+        cfn_waiter = Mock()
+        self.cfn_client.get_waiter.return_value = cfn_waiter
+
+        self.manager._role_arn = "role-arn"
+        self.manager.does_companion_stack_exist = lambda: False
+
+        self.manager.update_companion_stack()
+
+        self.cfn_client.create_stack.assert_called_once_with(
+            StackName=self.companion_stack_name, TemplateURL=ANY, Capabilities=ANY, RoleARN="role-arn"
+        )
+
     @patch("samcli.lib.bootstrap.companion_stack.companion_stack_manager.mktempfile")
     @patch("samcli.lib.bootstrap.companion_stack.companion_stack_manager.S3Uploader")
     @patch("samcli.lib.bootstrap.companion_stack.companion_stack_manager.parse_s3_url")
@@ -94,6 +115,27 @@ def test_update_companion_stack(
         self.cfn_client.get_waiter.assert_called_once_with("stack_update_complete")
         cfn_waiter.wait.assert_called_once_with(StackName=self.companion_stack_name, WaiterConfig=ANY)
 
+    @patch("samcli.lib.bootstrap.companion_stack.companion_stack_manager.mktempfile")
+    @patch("samcli.lib.bootstrap.companion_stack.companion_stack_manager.S3Uploader")
+    @patch("samcli.lib.bootstrap.companion_stack.companion_stack_manager.parse_s3_url")
+    def test_update_companion_stack_with_role_arn(
+        self,
+        parse_s3_url_mock,
+        s3_uploader_mock,
+        mktempfile_mock,
+    ):
+        cfn_waiter = Mock()
+        self.cfn_client.get_waiter.return_value = cfn_waiter
+
+        self.manager._role_arn = "role-arn"
+        self.manager.does_companion_stack_exist = lambda: True
+
+        self.manager.update_companion_stack()
+
+        self.cfn_client.update_stack.assert_called_once_with(
+            StackName=self.companion_stack_name, TemplateURL=ANY, Capabilities=ANY, RoleARN="role-arn"
+        )
+
     def test_delete_companion_stack(self):
         cfn_waiter = Mock()
         self.cfn_client.get_waiter.return_value = cfn_waiter
@@ -276,8 +318,23 @@ def test_sync_ecr_stack(self, function_provider_mock, stack_provider_mock, manag
 
         result = sync_ecr_stack("template.yaml", "stack-name", "region", "s3-bucket", "s3-prefix", image_repositories)
 
-        manager_mock.assert_called_once_with("stack-name", "region", "s3-bucket", "s3-prefix")
+        manager_mock.assert_called_once_with("stack-name", "region", "s3-bucket", "s3-prefix", None)
         function_provider_mock.assert_called_once_with(stacks, ignore_code_extraction_warnings=True)
         manager_mock.return_value.sync_repos.assert_called_once_with()
 
         self.assertEqual(result, {"Function1": "uri1", "Function2": "uri2"})
+
+    @patch("samcli.lib.bootstrap.companion_stack.companion_stack_manager.CompanionStackManager")
+    @patch("samcli.lib.bootstrap.companion_stack.companion_stack_manager.SamLocalStackProvider")
+    @patch("samcli.lib.bootstrap.companion_stack.companion_stack_manager.SamFunctionProvider")
+    def test_sync_ecr_stack_with_role_arn(self, function_provider_mock, stack_provider_mock, manager_mock):
+        image_repositories = {"Function1": "uri1"}
+        stacks = MagicMock()
+        stack_provider_mock.get_stacks.return_value = (stacks, None)
+        manager_mock.return_value.get_repository_mapping.return_value = {"Function2": "uri2"}
+
+        sync_ecr_stack(
+            "template.yaml", "stack-name", "region", "s3-bucket", "s3-prefix", image_repositories, "role-arn"
+        )
+
+        manager_mock.assert_called_once_with("stack-name", "region", "s3-bucket", "s3-prefix", "role-arn")