feat(aws-cdk): support fixed repository name for DockerImageAsset (#2032)

Add a `repositoryName` argument to `DockerImageAsset` to control the name of the
repository that the image gets uploaded to.

This makes it easier to reference Docker Images created and deployed by CDK from EKS (Kubernetes) YAML resource files.

Author: alex-berger

packages/@aws-cdk/assets-docker/lib/image-asset.ts

@@ -10,6 +10,17 @@ export interface DockerImageAssetProps {
    * The directory where the Dockerfile is stored
    */
   directory: string;
+
+  /**
+   * ECR repository name
+   *
+   * Specify this property if you need to statically address the image, e.g.
+   * from a Kubernetes Pod. Note, this is only the repository name, without the
+   * registry and the tag parts.
+   *
+   * @default automatically derived from the asset's ID.
+   */
+  repositoryName?: string;
 }
 
 /**
@@ -55,7 +66,8 @@ export class DockerImageAsset extends cdk.Construct {
       packaging: 'container-image',
       path: this.directory,
       id: this.node.uniqueId,
-      imageNameParameter: imageNameParameter.logicalId
+      imageNameParameter: imageNameParameter.logicalId,
+      repositoryName: props.repositoryName,
     };
 
     this.node.addMetadata(cxapi.ASSET_METADATA, asset);

packages/@aws-cdk/cx-api/lib/metadata/assets.ts

@@ -73,6 +73,17 @@ export interface ContainerImageAssetMetadataEntry {
    * ECR Repository name and tag (separated by ":") where this asset is stored.
    */
   imageNameParameter: string;
+
+  /**
+   * ECR repository name, if omitted a default name based on the asset's
+   * ID is used instead. Specify this property if you need to statically
+   * address the image, e.g. from a Kubernetes Pod.
+   * Note, this is only the repository name, without the registry and
+   * the tag parts.
+   *
+   * * @default automatically derived from the asset's ID.
+   */
+  repositoryName?: string;
 }
 
 export type AssetMetadataEntry = FileAssetMetadataEntry | ContainerImageAssetMetadataEntry;

packages/aws-cdk/lib/api/toolkit-info.ts

@@ -99,11 +99,17 @@ export class ToolkitInfo {
   /**
    * Prepare an ECR repository for uploading to using Docker
    */
-  public async prepareEcrRepository(assetId: string): Promise<EcrRepositoryInfo> {
+  public async prepareEcrRepository(asset: cxapi.ContainerImageAssetMetadataEntry): Promise<EcrRepositoryInfo> {
     const ecr = await this.props.sdk.ecr(this.props.environment, Mode.ForWriting);
-
-    // Repository name based on asset id
-    const repositoryName = 'cdk/' + assetId.replace(/[:/]/g, '-').toLowerCase();
+    let repositoryName;
+    if ( asset.repositoryName ) {
+      // Repository name provided by user
+      repositoryName = asset.repositoryName;
+    } else {
+      // Repository name based on asset id
+      const assetId = asset.id;
+      repositoryName = 'cdk/' + assetId.replace(/[:/]/g, '-').toLowerCase();
+    }
 
     let repository;
     try {

packages/aws-cdk/lib/docker.ts

@@ -43,7 +43,7 @@ export async function prepareContainerAsset(asset: ContainerImageAssetMetadataEn
 
   const buildHold = new PleaseHold(` ⌛ Building Asset Docker image ${asset.id} from ${asset.path}; this may take a while.`);
   try {
-    const ecr = await toolkitInfo.prepareEcrRepository(asset.id);
+    const ecr = await toolkitInfo.prepareEcrRepository(asset);
     const latest = `${ecr.repositoryUri}:latest`;
 
     let loggedIn = false;

packages/aws-cdk/test/test.docker.ts

@@ -0,0 +1,54 @@
+import cxapi = require('@aws-cdk/cx-api');
+import { Test } from 'nodeunit';
+import { ToolkitInfo } from '../lib';
+import { prepareContainerAsset } from '../lib/docker';
+import { MockSDK } from './util/mock-sdk';
+
+export = {
+  async 'creates repository with given name'(test: Test) {
+    // GIVEN
+
+    let createdName;
+
+    const sdk = new MockSDK();
+    sdk.stubEcr({
+      describeRepositories() {
+        return { repositories: [] };
+      },
+
+      createRepository(req) {
+        createdName = req.repositoryName;
+
+        // Stop the test so that we don't actually docker build
+        throw new Error('STOPTEST');
+      },
+    });
+
+    const toolkit = new ToolkitInfo({
+      sdk,
+      bucketName: 'BUCKET_NAME',
+      bucketEndpoint: 'BUCKET_ENDPOINT',
+      environment: { name: 'env', account: '1234', region: 'abc' }
+    });
+
+    // WHEN
+    const asset: cxapi.ContainerImageAssetMetadataEntry = {
+      id: 'assetId',
+      imageNameParameter: 'MyParameter',
+      packaging: 'container-image',
+      path: '/foo',
+      repositoryName: 'some-name',
+    };
+
+    try {
+      await prepareContainerAsset(asset, toolkit, false);
+    } catch (e) {
+      if (!/STOPTEST/.test(e.toString())) { throw e; }
+    }
+
+    // THEN
+    test.deepEqual(createdName, 'some-name');
+
+    test.done();
+  },
+};

packages/aws-cdk/test/util/mock-sdk.ts

@@ -21,6 +21,13 @@ export class MockSDK extends SDK {
   public stubCloudFormation(stubs: SyncHandlerSubsetOf<AWS.CloudFormation>) {
     this.sandbox.stub(this, 'cloudFormation').returns(Promise.resolve(partialAwsService<AWS.CloudFormation>(stubs)));
   }
+
+  /**
+   * Replace the ECR client with the given object
+   */
+  public stubEcr(stubs: SyncHandlerSubsetOf<AWS.ECR>) {
+    this.sandbox.stub(this, 'ecr').returns(Promise.resolve(partialAwsService<AWS.ECR>(stubs)));
+  }
 }
 
 /**