test: add unit tests for docker build extra params

Author: reedham-aws

tests/unit/lib/build_module/test_app_builder.py

@@ -1774,6 +1774,24 @@ def test_build_lambda_image_raises_for_non_dict_docker_build_args(self):
         with self.assertRaises(DockerBuildFailed):
             self.builder._build_lambda_image("Name", metadata, X86_64)
 
+    def test_can_build_image_function_with_extra_params(self):
+        metadata = {
+            "Dockerfile": "Dockerfile",
+            "DockerContext": "context",
+            "DockerTag": "Tag",
+            "DockerBuildArgs": {"a": "b"},
+            "DockerBuildExtraParams": ["--ssh", "default"],
+        }
+
+        mock_build_client = Mock()
+        mock_build_client.build_image.return_value = iter([])
+        self.builder._image_build_client = mock_build_client
+
+        self.builder._build_lambda_image("Name", metadata, X86_64)
+
+        call_kwargs = mock_build_client.build_image.call_args[1]
+        self.assertEqual(call_kwargs["extra_params"], ["--ssh", "default"])
+
     def test_build_lambda_image_uses_latest_tag_when_not_specified(self):
         metadata = {
             "Dockerfile": "Dockerfile",

tests/unit/lib/samlib/test_resource_metadata_normalizer.py

@@ -80,6 +80,7 @@ def test_replace_all_resources_that_contain_metadata(self):
 
     def test_replace_all_resources_that_contain_image_metadata(self):
         docker_build_args = {"arg1": "val1", "arg2": "val2"}
+        docker_build_extra_params = ["--param1", "value1"]
         asset_path = pathlib.Path("/path", "to", "asset")
         dockerfile_path = pathlib.Path("path", "to", "Dockerfile")
         template_data = {
@@ -97,6 +98,7 @@ def test_replace_all_resources_that_contain_image_metadata(self):
                         "aws:asset:property": "Code.ImageUri",
                         "aws:asset:dockerfile-path": dockerfile_path,
                         "aws:asset:docker-build-args": docker_build_args,
+                        "aws:asset:docker-build-extra-params": docker_build_extra_params,
                     },
                 },
             }
@@ -112,6 +114,9 @@ def test_replace_all_resources_that_contain_image_metadata(self):
         expected_dockerfile_path = str(pathlib.Path("path", "to", "Dockerfile").as_posix())
         self.assertEqual(expected_dockerfile_path, template_data["Resources"]["Function1"]["Metadata"]["Dockerfile"])
         self.assertEqual(docker_build_args, template_data["Resources"]["Function1"]["Metadata"]["DockerBuildArgs"])
+        self.assertEqual(
+            docker_build_extra_params, template_data["Resources"]["Function1"]["Metadata"]["DockerBuildExtraParams"]
+        )
         self.assertEqual("Function1", template_data["Resources"]["Function1"]["Metadata"]["SamResourceId"])
 
     def test_replace_all_resources_that_contain_image_metadata_dockerfile_extensions(self):

tests/unit/local/docker/test_image_build_client.py

@@ -56,6 +56,19 @@ def test_build_image_minimal(self):
             rm=True,
         )
 
+    @patch("samcli.local.docker.image_build_client.LOG")
+    def test_build_image_extra_params_logs_warning(self, mock_log):
+        """Test that extra_params triggers a warning and is not passed to SDK"""
+        mock_image = Mock()
+        mock_logs = iter([])
+
+        self.mock_container_client.images.build.return_value = (mock_image, mock_logs)
+        self.client.build_image(**self.base_build_args, extra_params=["--ssh", "default"])
+        mock_log.warning.assert_called_once()
+        self.assertIn("DockerBuildExtraParams", mock_log.warning.call_args[0][0])
+
+        self.mock_container_client.images.build.assert_called_once_with(**self.base_build_args, rm=True)
+
     def test_is_available_returns_true(self):
         """Test that is_available always returns True for SDK"""
         result = SDKBuildClient.is_available("docker")
@@ -202,6 +215,28 @@ def test_build_image_handles_failure(self, mock_popen):
         self.assertIn("Build failed with exit code 1", str(context.exception))
         self.assertEqual(context.exception.build_log, [{"stream": "Step 1/5\n"}, {"stream": "Error: build failed\n"}])
 
+    @patch("samcli.local.docker.image_build_client.subprocess.Popen")
+    def test_build_image_docker_with_extra_params(self, mock_popen):
+        """Test that extra_params are appended to the docker command"""
+        mock_process = Mock()
+        mock_process.stdout = iter(["Done\n"])
+        mock_process.returncode = 0
+        mock_popen.return_value = mock_process
+
+        list(
+            self.docker_client.build_image(
+                **self.base_build_args,
+                extra_params=["--ssh", "default", "--secret", "id=mysecret,src=secret.txt"],
+            )
+        )
+
+        actual_cmd = mock_popen.call_args[0][0]
+        self.assertEqual(actual_cmd[-1], self.base_build_args["path"])
+        self.assertIn("--ssh", actual_cmd)
+        self.assertIn("default", actual_cmd)
+        self.assertIn("--secret", actual_cmd)
+        self.assertIn("id=mysecret,src=secret.txt", actual_cmd)
+
     @patch("samcli.local.docker.image_build_client.shutil.which")
     @patch("samcli.local.docker.image_build_client.subprocess.run")
     def test_is_available_docker_success(self, mock_run, mock_which):