feat(ecr-assets): expose property imageTag separately from imageUri in ECR assets

packages/@aws-cdk/aws-ecr-assets/README.md

@@ -49,6 +49,8 @@ configure it on the asset itself.
 Use `asset.imageUri` to reference the image. It includes both the ECR image URL
 and tag.
 
+Use `asset.synthesizedTag` to reference only the image tag.
+
 You can optionally pass build args to the `docker build` command by specifying
 the `buildArgs` property. It is recommended to skip hashing of `buildArgs` for
 values that can change between different machines to maintain a consistent

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

@@ -243,6 +243,11 @@ export class DockerImageAsset extends Construct implements IAsset {
    */
   public readonly assetHash: string;
 
+  /**
+   * The tag of this asset when it is uploaded to ECR. The tag may differ from the assetHash if a stack synthesizer adds a dockerTagPrefix.
+   */
+  public readonly synthesizedTag: string;
+
   /**
    * The path to the asset, relative to the current Cloud Assembly
    *
@@ -362,6 +367,7 @@ export class DockerImageAsset extends Construct implements IAsset {
 
     this.repository = ecr.Repository.fromRepositoryName(this, 'Repository', location.repositoryName);
     this.imageUri = location.imageUri;
+    this.synthesizedTag = location.imageTag ?? this.assetHash;
   }
 
   /**

packages/@aws-cdk/aws-ecr-assets/lib/tarball-asset.ts

@@ -51,6 +51,11 @@ export class TarballImageAsset extends Construct implements IAsset {
    */
   public readonly assetHash: string;
 
+  /**
+   * The tag of this asset when it is uploaded to ECR. The tag may differ from the assetHash if a stack synthesizer adds a dockerTagPrefix.
+   */
+  public readonly synthesizedTag: string;
+
   constructor(scope: Construct, id: string, props: TarballImageAssetProps) {
     super(scope, id);
 
@@ -78,6 +83,7 @@ export class TarballImageAsset extends Construct implements IAsset {
 
     this.repository = ecr.Repository.fromRepositoryName(this, 'Repository', location.repositoryName);
     this.imageUri = location.imageUri;
+    this.synthesizedTag = location.imageTag ?? this.assetHash;
   }
 }
 

packages/@aws-cdk/aws-ecr-assets/test/image-asset.test.ts

@@ -405,6 +405,30 @@ describe('image asset', () => {
     expect(asset1.assetHash).toEqual('13248c55633f3b198a628bb2ea4663cb5226f8b2801051bd0c725950266fd590');
     expect(asset2.assetHash).toEqual('b78978ca702a8eccd37804ce31d76cd83a695b557dbf95aeb109332ee8b1fd32');
   });
+
+  describe('stack synthesizers', () => { //synthesizedTag and assetHash
+    const stack1 = new Stack();
+    const stack2 = new Stack(undefined, undefined, {
+      synthesizer: new DefaultStackSynthesizer({
+        dockerTagPrefix: 'banana',
+      }),
+    });
+
+    const directory = path.join(__dirname, 'demo-image-custom-docker-file');
+
+    const asset1 = new DockerImageAsset(stack1, 'Asset1', { directory });
+    const asset2 = new DockerImageAsset(stack2, 'Asset2', { directory });
+
+    test('stack with default synthesizer', () => {
+      expect(asset1.assetHash).toEqual('13248c55633f3b198a628bb2ea4663cb5226f8b2801051bd0c725950266fd590');
+      expect(asset1.synthesizedTag).toEqual('13248c55633f3b198a628bb2ea4663cb5226f8b2801051bd0c725950266fd590');
+    });
+
+    test('stack with overwritten synthesizer', () => {
+      expect(asset2.assetHash).toEqual('13248c55633f3b198a628bb2ea4663cb5226f8b2801051bd0c725950266fd590');
+      expect(asset2.synthesizedTag).toEqual('banana13248c55633f3b198a628bb2ea4663cb5226f8b2801051bd0c725950266fd590');
+    });
+  });
 });
 
 function testDockerDirectoryIsStagedWithoutFilesSpecifiedInDockerignore(app: App, ignoreMode?: IgnoreMode) {

packages/@aws-cdk/aws-ecr-assets/test/tarball-asset.test.ts

@@ -4,7 +4,7 @@ import { Template } from '@aws-cdk/assertions';
 import * as iam from '@aws-cdk/aws-iam';
 import { testFutureBehavior } from '@aws-cdk/cdk-build-tools/lib/feature-flag';
 import * as cxschema from '@aws-cdk/cloud-assembly-schema';
-import { App, Stack } from '@aws-cdk/core';
+import { App, Stack, DefaultStackSynthesizer } from '@aws-cdk/core';
 import * as cxapi from '@aws-cdk/cx-api';
 import { TarballImageAsset } from '../lib';
 
@@ -136,6 +136,32 @@ describe('image asset', () => {
     }).toThrow(/Cannot find file at/);
 
   });
+
+  describe('stack synthesizers', () => { //synthesizedTag and assetHash
+    const stack1 = new Stack();
+    const stack2 = new Stack(undefined, undefined, {
+      synthesizer: new DefaultStackSynthesizer({
+        dockerTagPrefix: 'banana',
+      }),
+    });
+    const asset1 = new TarballImageAsset(stack1, 'MyAsset', {
+      tarballFile: 'test/demo-tarball/empty.tar',
+    });
+    const asset2 = new TarballImageAsset(stack2, 'MyAsset', {
+      tarballFile: 'test/demo-tarball/empty.tar',
+    });
+
+    test('stack with default synthesizer', () => {
+      expect(asset1.assetHash).toEqual('95c924c84f5d023be4edee540cb2cb401a49f115d01ed403b288f6cb412771df');
+      expect(asset1.synthesizedTag).toEqual('95c924c84f5d023be4edee540cb2cb401a49f115d01ed403b288f6cb412771df');
+    });
+
+    test('stack with overwritten synthesizer', () => {
+      expect(asset2.assetHash).toEqual('95c924c84f5d023be4edee540cb2cb401a49f115d01ed403b288f6cb412771df');
+      expect(asset2.synthesizedTag).toEqual('banana95c924c84f5d023be4edee540cb2cb401a49f115d01ed403b288f6cb412771df');
+    });
+  });
+
 });
 
 function isAssetManifest(x: cxapi.CloudArtifact): x is cxapi.AssetManifestArtifact {

packages/@aws-cdk/core/lib/assets.ts

@@ -319,4 +319,10 @@ export interface DockerImageAssetLocation {
    * The name of the ECR repository.
    */
   readonly repositoryName: string;
+
+  /**
+   * The tag of the image in Amazon ECR.
+   * @default ${dockerTagPrefix}${asset.sourceHash}
+   */
+  readonly imageTag?: string;
 }

packages/@aws-cdk/core/lib/stack-synthesizers/_asset-manifest-builder.ts

@@ -82,7 +82,7 @@ export class AssetManifestBuilder {
     role?: RoleOptions,
   ): DockerImageAssetLocation {
     validateDockerImageAssetSource(asset);
-    const imageTag = dockerTagPrefix + asset.sourceHash;
+    const imageTag = `${dockerTagPrefix}${asset.sourceHash}`;
 
     // Add to manifest
     this.dockerImages[asset.sourceHash] = {
@@ -114,6 +114,7 @@ export class AssetManifestBuilder {
       imageUri: cfnify(
         `${account}.dkr.ecr.${region}.${urlSuffix}/${repositoryName}:${imageTag}`,
       ),
+      imageTag: cfnify(imageTag),
     };
   }