Use the same DockerContext and Dockerfile paths as the CDK is using (#…

…4074) * Use the same DockerContext and Dockerfile paths as the CDK is using * Add tests to ensure `Dockerfile` can be a path to a docker file via subdirectories. This means images can share code more easily. * Add tests to ensure SAM supports CDK apps where Docker image asset `file` is a path to a docker file via subdirectories. * Fixed failing test after merge conflict with commit fa26bff Co-authored-by: Wing Fung Lau <4760060+hawflau@users.noreply.github.com> Co-authored-by: Mohamed Elasmar <71043312+moelasmar@users.noreply.github.com> Co-authored-by: Mehmet Nuri Deveci <5735811+mndeveci@users.noreply.github.com>
aws · Nov 4, 2022 · c29d13e · c29d13e
1 parent 339e8d6
commit c29d13e
Show file tree

Hide file tree

Showing 27 changed files with 458 additions and 14 deletions.
diff --git a/samcli/lib/samlib/resource_metadata_normalizer.py b/samcli/lib/samlib/resource_metadata_normalizer.py
@@ -186,11 +186,9 @@ def _extract_image_asset_metadata(metadata):
         """
         asset_path = Path(metadata.get(ASSET_PATH_METADATA_KEY, ""))
         dockerfile_path = Path(metadata.get(ASSET_DOCKERFILE_PATH_KEY), "")
-        dockerfile, path_from_asset = dockerfile_path.name, dockerfile_path.parent
-        dockerfile_context = str(Path(asset_path.joinpath(path_from_asset)))
         return {
-            SAM_METADATA_DOCKERFILE_KEY: dockerfile,
-            SAM_METADATA_DOCKER_CONTEXT_KEY: dockerfile_context,
+            SAM_METADATA_DOCKERFILE_KEY: str(dockerfile_path),
+            SAM_METADATA_DOCKER_CONTEXT_KEY: str(asset_path),
             SAM_METADATA_DOCKER_BUILD_ARGS_KEY: metadata.get(ASSET_DOCKERFILE_BUILD_ARGS_KEY, {}),
         }
 

diff --git a/tests/iac_integration/cdk/test_sam_cdk_integration.py b/tests/iac_integration/cdk/test_sam_cdk_integration.py
@@ -111,6 +111,16 @@ def random_port():
             ("/restapis/normal/functionGoRuntime", "Hello World from function construct with go runtime"),
             ("/restapis/normal/dockerImageFunction", "Hello World from docker image function construct"),
             ("/restapis/normal/functionImageAsset", "Hello World from function construct with image asset"),
+            (
+                "/restapis/normal/dockerImageFunctionWithSharedCode",
+                "Hello World from docker image function construct "
+                "with a Dockerfile that shares code with another Dockerfile",
+            ),
+            (
+                "/restapis/normal/functionImageAssetWithSharedCode",
+                "Hello World from function construct with image asset "
+                "with a Dockerfile that shares code with another Dockerfile",
+            ),
         ]
     )
     @pytest.mark.flaky(reruns=3)

diff --git a/tests/iac_integration/cdk/testdata/cdk_v1/java/src/main/java/com/myorg/JavaStack.java b/tests/iac_integration/cdk/testdata/cdk_v1/java/src/main/java/com/myorg/JavaStack.java
@@ -192,6 +192,23 @@ public JavaStack(final Construct scope, final String id, final StackProps props)
                 .tracing(Tracing.ACTIVE)
                 .build();
 
+        // both ways work when 'file' is a path via subfolders to the Dockerfile
+        // this is useful when multiple docker images share some common code
+        DockerImageFunction dockerImageFunctionWithSharedCode = DockerImageFunction.Builder.create(this, "DockerImageFunctionWithSharedCode")
+                .code(DockerImageCode.fromImageAsset("../../src/docker/ImagesWithSharedCode",
+                        AssetImageCodeProps.builder().file("DockerImageFunctionWithSharedCode/Dockerfile").build()
+                        )
+                ).tracing(Tracing.ACTIVE)
+                .build();
+
+        Function functionImageAssetWithSharedCode = Function.Builder.create(this, "FunctionImageAssetWithSharedCode")
+                .code(Code.fromAssetImage("../../src/docker/ImagesWithSharedCode",
+                        AssetImageCodeProps.builder().file("FunctionImageAssetWithSharedCode/Dockerfile").build()))
+                .handler(Handler.FROM_IMAGE)
+                .runtime(Runtime.FROM_IMAGE)
+                .tracing(Tracing.ACTIVE)
+                .build();
+
         //Rest APIs
 
         // Spec Rest Api
@@ -239,6 +256,10 @@ public JavaStack(final Construct scope, final String id, final StackProps props)
                 .addMethod("GET", new LambdaIntegration(dockerImageFunction));
         normalRootResource.addResource("functionImageAsset")
                 .addMethod("GET", new LambdaIntegration(functionImageAsset));
+        normalRootResource.addResource("dockerImageFunctionWithSharedCode")
+                .addMethod("GET", new LambdaIntegration(dockerImageFunctionWithSharedCode));
+        normalRootResource.addResource("functionImageAssetWithSharedCode")
+                .addMethod("GET", new LambdaIntegration(functionImageAssetWithSharedCode));
 
         // Nested Stack
         new NestedStack1(this, "NestedStack");

diff --git a/tests/iac_integration/cdk/testdata/cdk_v1/python/python/python_stack.py b/tests/iac_integration/cdk/testdata/cdk_v1/python/python/python_stack.py
@@ -217,7 +217,7 @@ def __init__(self, scope: cdk.Construct, construct_id: str, **kwargs) -> None:
             self,
             "DockerImageFunction",
             code=lambda1.DockerImageCode.from_image_asset(
-                "../../src/docker/DockerImageFunctionConstruct",
+                directory="../../src/docker/DockerImageFunctionConstruct",
                 file="Dockerfile",
             ),
             tracing=lambda1.Tracing.ACTIVE,
@@ -228,14 +228,38 @@ def __init__(self, scope: cdk.Construct, construct_id: str, **kwargs) -> None:
             self,
             "FunctionImageAsset",
             code=lambda1.Code.from_asset_image(
-                "../../src/docker/FunctionConstructWithImageAssetCode",
+                directory="../../src/docker/FunctionConstructWithImageAssetCode",
                 file="Dockerfile",
             ),
             handler=lambda1.Handler.FROM_IMAGE,
             runtime=lambda1.Runtime.FROM_IMAGE,
             tracing=lambda1.Tracing.ACTIVE,
         )
 
+        # both ways work when 'file' is a path via subfolders to the Dockerfile
+        # this is useful when multiple docker images share some common code
+        docker_image_function_with_shared_code = lambda1.DockerImageFunction(
+            self,
+            "DockerImageFunctionWithSharedCode",
+            code=lambda1.DockerImageCode.from_image_asset(
+                directory="../../src/docker/ImagesWithSharedCode",
+                file="DockerImageFunctionWithSharedCode/Dockerfile",
+            ),
+            tracing=lambda1.Tracing.ACTIVE,
+        )
+
+        function_image_asset_with_shared_code = lambda1.Function(
+            self,
+            "FunctionImageAssetWithSharedCode",
+            code=lambda1.Code.from_asset_image(
+                directory="../../src/docker/ImagesWithSharedCode",
+                file="FunctionImageAssetWithSharedCode/Dockerfile",
+            ),
+            handler=lambda1.Handler.FROM_IMAGE,
+            runtime=lambda1.Runtime.FROM_IMAGE,
+            tracing=lambda1.Tracing.ACTIVE,
+        )
+
         # Rest APIs
 
         # Spec Rest Api
@@ -287,6 +311,12 @@ def __init__(self, scope: cdk.Construct, construct_id: str, **kwargs) -> None:
         normal_root_resource.add_resource("functionImageAsset").add_method(
             "GET", LambdaIntegration(function_image_asset)
         )
+        normal_root_resource.add_resource("dockerImageFunctionWithSharedCode").add_method(
+            "GET", LambdaIntegration(docker_image_function_with_shared_code)
+        )
+        normal_root_resource.add_resource("functionImageAssetWithSharedCode").add_method(
+            "GET", LambdaIntegration(function_image_asset_with_shared_code)
+        )
 
         # Nested Stack
         NestedStack1(self, "NestedStack")
diff --git a/tests/iac_integration/cdk/testdata/cdk_v1/typescript/lib/test-stack.ts b/tests/iac_integration/cdk/testdata/cdk_v1/typescript/lib/test-stack.ts
@@ -191,6 +191,25 @@ export class CDKSupportDemoRootStack extends cdk.Stack {
       tracing: lambda.Tracing.ACTIVE,
     });
 
+    // both ways work when 'file' is a path via subfolders to the Dockerfile
+    // this is useful when multiple docker images share some common code
+    const dockerImageFunctionWithSharedCode = new lambda.DockerImageFunction(this, "DockerImageFunctionWithSharedCode", {
+      code: lambda.DockerImageCode.fromImageAsset("../../src/docker/ImagesWithSharedCode", {
+        file: "DockerImageFunctionWithSharedCode/Dockerfile",
+      }),
+      tracing: lambda.Tracing.ACTIVE,
+    });
+
+    // another way
+    const functionImageAssetWithSharedCode = new lambda.Function(this, "FunctionImageAssetWithSharedCode", {
+      code: lambda.Code.fromAssetImage("../../src/docker/ImagesWithSharedCode", {
+        file: "FunctionImageAssetWithSharedCode/Dockerfile",
+      }),
+      handler: lambda.Handler.FROM_IMAGE,
+      runtime: lambda.Runtime.FROM_IMAGE,
+      tracing: lambda.Tracing.ACTIVE,
+    });
+
 
     //Rest APIs
 
@@ -246,6 +265,12 @@ export class CDKSupportDemoRootStack extends cdk.Stack {
 
     normalRootResource.addResource('functionImageAsset')
       .addMethod('GET', new LambdaIntegration(functionImageAsset));
+
+    normalRootResource.addResource('dockerImageFunctionWithSharedCode')
+      .addMethod('GET', new LambdaIntegration(dockerImageFunctionWithSharedCode));
+
+    normalRootResource.addResource('functionImageAssetWithSharedCode')
+      .addMethod('GET', new LambdaIntegration(functionImageAssetWithSharedCode));
 
     // Nested Stack
     new NestedStack1(this, 'NestedStack' ,{});

diff --git a/tests/iac_integration/cdk/testdata/cdk_v2/java/src/main/java/com/myorg/JavaStack.java b/tests/iac_integration/cdk/testdata/cdk_v2/java/src/main/java/com/myorg/JavaStack.java
@@ -193,6 +193,23 @@ public JavaStack(final Construct scope, final String id, final StackProps props)
                 .tracing(Tracing.ACTIVE)
                 .build();
 
+        // both ways work when 'file' is a path via subfolders to the Dockerfile
+        // this is useful when multiple docker images share some common code
+        DockerImageFunction dockerImageFunctionWithSharedCode = DockerImageFunction.Builder.create(this, "DockerImageFunctionWithSharedCode")
+                .code(DockerImageCode.fromImageAsset("../../src/docker/ImagesWithSharedCode",
+                        AssetImageCodeProps.builder().file("DockerImageFunctionWithSharedCode/Dockerfile").build()
+                        )
+                ).tracing(Tracing.ACTIVE)
+                .build();
+
+        Function functionImageAssetWithSharedCode = Function.Builder.create(this, "FunctionImageAssetWithSharedCode")
+                .code(Code.fromAssetImage("../../src/docker/ImagesWithSharedCode",
+                        AssetImageCodeProps.builder().file("FunctionImageAssetWithSharedCode/Dockerfile").build()))
+                .handler(Handler.FROM_IMAGE)
+                .runtime(Runtime.FROM_IMAGE)
+                .tracing(Tracing.ACTIVE)
+                .build();
+
         //Rest APIs
 
         // Spec Rest Api
@@ -240,6 +257,11 @@ public JavaStack(final Construct scope, final String id, final StackProps props)
                 .addMethod("GET", new LambdaIntegration(dockerImageFunction));
         normalRootResource.addResource("functionImageAsset")
                 .addMethod("GET", new LambdaIntegration(functionImageAsset));
+        normalRootResource.addResource("dockerImageFunctionWithSharedCode")
+                .addMethod("GET", new LambdaIntegration(dockerImageFunctionWithSharedCode));
+        normalRootResource.addResource("functionImageAssetWithSharedCode")
+                .addMethod("GET", new LambdaIntegration(functionImageAssetWithSharedCode));
+
         // Nested Stack
         new NestedStack1(this, "NestedStack");
 

diff --git a/tests/iac_integration/cdk/testdata/cdk_v2/python/python/python_stack.py b/tests/iac_integration/cdk/testdata/cdk_v2/python/python/python_stack.py
@@ -217,7 +217,7 @@ def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
             self,
             "DockerImageFunction",
             code=lambda1.DockerImageCode.from_image_asset(
-                "../../src/docker/DockerImageFunctionConstruct",
+                directory="../../src/docker/DockerImageFunctionConstruct",
                 file="Dockerfile",
             ),
             tracing=lambda1.Tracing.ACTIVE,
@@ -228,14 +228,38 @@ def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
             self,
             "FunctionImageAsset",
             code=lambda1.Code.from_asset_image(
-                "../../src/docker/FunctionConstructWithImageAssetCode",
+                directory="../../src/docker/FunctionConstructWithImageAssetCode",
                 file="Dockerfile",
             ),
             handler=lambda1.Handler.FROM_IMAGE,
             runtime=lambda1.Runtime.FROM_IMAGE,
             tracing=lambda1.Tracing.ACTIVE,
         )
 
+        # both ways work when 'file' is a path via subfolders to the Dockerfile
+        # this is useful when multiple docker images share some common code
+        docker_image_function_with_shared_code = lambda1.DockerImageFunction(
+            self,
+            "DockerImageFunctionWithSharedCode",
+            code=lambda1.DockerImageCode.from_image_asset(
+                directory="../../src/docker/ImagesWithSharedCode",
+                file="DockerImageFunctionWithSharedCode/Dockerfile",
+            ),
+            tracing=lambda1.Tracing.ACTIVE,
+        )
+
+        function_image_asset_with_shared_code = lambda1.Function(
+            self,
+            "FunctionImageAssetWithSharedCode",
+            code=lambda1.Code.from_asset_image(
+                directory="../../src/docker/ImagesWithSharedCode",
+                file="FunctionImageAssetWithSharedCode/Dockerfile",
+            ),
+            handler=lambda1.Handler.FROM_IMAGE,
+            runtime=lambda1.Runtime.FROM_IMAGE,
+            tracing=lambda1.Tracing.ACTIVE,
+        )
+
         # Rest APIs
 
         # Spec Rest Api
@@ -287,6 +311,12 @@ def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
         normal_root_resource.add_resource("functionImageAsset").add_method(
             "GET", LambdaIntegration(function_image_asset)
         )
+        normal_root_resource.add_resource("dockerImageFunctionWithSharedCode").add_method(
+            "GET", LambdaIntegration(docker_image_function_with_shared_code)
+        )
+        normal_root_resource.add_resource("functionImageAssetWithSharedCode").add_method(
+            "GET", LambdaIntegration(function_image_asset_with_shared_code)
+        )
 
         # Nested Stack
         NestedStack1(self, "NestedStack")
diff --git a/tests/iac_integration/cdk/testdata/cdk_v2/typescript/lib/test-stack.ts b/tests/iac_integration/cdk/testdata/cdk_v2/typescript/lib/test-stack.ts
@@ -190,6 +190,25 @@ export class CDKSupportDemoRootStack extends cdk.Stack {
       tracing: lambda.Tracing.ACTIVE,
     });
 
+    // both ways work when 'file' is a path via subfolders to the Dockerfile
+    // this is useful when multiple docker images share some common code
+    const dockerImageFunctionWithSharedCode = new lambda.DockerImageFunction(this, "DockerImageFunctionWithSharedCode", {
+      code: lambda.DockerImageCode.fromImageAsset("../../src/docker/ImagesWithSharedCode", {
+        file: "DockerImageFunctionWithSharedCode/Dockerfile",
+      }),
+      tracing: lambda.Tracing.ACTIVE,
+    });
+
+    // another way
+    const functionImageAssetWithSharedCode = new lambda.Function(this, "FunctionImageAssetWithSharedCode", {
+      code: lambda.Code.fromAssetImage("../../src/docker/ImagesWithSharedCode", {
+        file: "FunctionImageAssetWithSharedCode/Dockerfile",
+      }),
+      handler: lambda.Handler.FROM_IMAGE,
+      runtime: lambda.Runtime.FROM_IMAGE,
+      tracing: lambda.Tracing.ACTIVE,
+    });
+
 
     //Rest APIs
 
@@ -246,6 +265,12 @@ export class CDKSupportDemoRootStack extends cdk.Stack {
     normalRootResource.addResource('functionImageAsset')
       .addMethod('GET', new LambdaIntegration(functionImageAsset));
 
+    normalRootResource.addResource('dockerImageFunctionWithSharedCode')
+      .addMethod('GET', new LambdaIntegration(dockerImageFunctionWithSharedCode));
+
+    normalRootResource.addResource('functionImageAssetWithSharedCode')
+      .addMethod('GET', new LambdaIntegration(functionImageAssetWithSharedCode));
+
     // Nested Stack
     new NestedStack1(this, 'NestedStack' ,{});
   }

diff --git a/...cdk/testdata/src/docker/ImagesWithSharedCode/DockerImageFunctionWithSharedCode/Dockerfile b/...cdk/testdata/src/docker/ImagesWithSharedCode/DockerImageFunctionWithSharedCode/Dockerfile
@@ -0,0 +1,16 @@
+FROM public.ecr.aws/lambda/nodejs:14
+
+# Add the lambda handler for this feature
+COPY DockerImageFunctionWithSharedCode/app.js  ./
+
+# Add the shared code
+COPY SharedCode/ ./SharedCode
+
+# Add the shared dependencies
+COPY package.json ./
+
+# Install the dependencies
+RUN npm install
+
+# Set the CMD to your handler (could also be done as a parameter override outside of the Dockerfile)
+CMD [ "app.lambdaHandler" ]
diff --git a/...ion/cdk/testdata/src/docker/ImagesWithSharedCode/DockerImageFunctionWithSharedCode/app.js b/...ion/cdk/testdata/src/docker/ImagesWithSharedCode/DockerImageFunctionWithSharedCode/app.js
@@ -0,0 +1,24 @@
+var gen = require('unique-names-generator');
+const {sayHelloWorld} = require("./SharedCode/shared");
+
+const colorName = gen.uniqueNamesGenerator({
+    dictionaries: [gen.colors]
+});
+
+
+exports.lambdaHandler = async(event, context) => {
+    let response;
+
+    try {
+        response = {
+            'statusCode': 200,
+            'body': JSON.stringify({
+                message: sayHelloWorld("docker image function construct"),
+            }),
+        };
+    } catch (err) {
+        console.log(err);
+        return err;
+    }
+    return response;
+};
diff --git a/.../cdk/testdata/src/docker/ImagesWithSharedCode/FunctionImageAssetWithSharedCode/Dockerfile b/.../cdk/testdata/src/docker/ImagesWithSharedCode/FunctionImageAssetWithSharedCode/Dockerfile
@@ -0,0 +1,16 @@
+FROM public.ecr.aws/lambda/nodejs:14
+
+# Add the lambda handler for this feature
+COPY FunctionImageAssetWithSharedCode/app.js  ./
+
+# Add the shared code
+COPY SharedCode/ ./SharedCode
+
+# Add the shared dependencies
+COPY package.json ./
+
+# Install the dependencies
+RUN npm install
+
+# Set the CMD to your handler (could also be done as a parameter override outside of the Dockerfile)
+CMD [ "app.lambdaHandler" ]
diff --git a/...tion/cdk/testdata/src/docker/ImagesWithSharedCode/FunctionImageAssetWithSharedCode/app.js b/...tion/cdk/testdata/src/docker/ImagesWithSharedCode/FunctionImageAssetWithSharedCode/app.js
@@ -0,0 +1,24 @@
+var gen = require('unique-names-generator');
+const {sayHelloWorld} = require("./SharedCode/shared");
+
+const colorName = gen.uniqueNamesGenerator({
+    dictionaries: [gen.colors]
+});
+
+
+exports.lambdaHandler = async(event, context) => {
+    let response;
+
+    try {
+        response = {
+            'statusCode': 200,
+            'body': JSON.stringify({
+                message: sayHelloWorld("function construct with image asset"),
+            }),
+        };
+    } catch (err) {
+        console.log(err);
+        return err;
+    }
+    return response;
+};
diff --git a/tests/iac_integration/cdk/testdata/src/docker/ImagesWithSharedCode/SharedCode/shared.js b/tests/iac_integration/cdk/testdata/src/docker/ImagesWithSharedCode/SharedCode/shared.js
@@ -0,0 +1,4 @@
+
+exports.sayHelloWorld = (from) => {
+  return `Hello World from ${from} with a Dockerfile that shares code with another Dockerfile`;
+}