fix(docker): Fix handling Docker Image name with digest (#7896) (#7918)

* fix(docker): Fix handling Docker Image name with digest * feat(docker): Fix digest support in manual docker trigger * Fix feedback for DockerImageUtils Co-Authored-By: Maggie Neterval <mneterval@google.com> * fix(docker): Call "this.updateArtifact" in "lookupTypeChanged" instead of "this.props.updateCommand" in DockerTriggerTemplate Co-authored-by: Maggie Neterval <mneterval@google.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Ryuzo Yamamoto <ryuzo.yamamoto@gmail.com> Co-authored-by: Maggie Neterval <mneterval@google.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
spinnaker · Feb 19, 2020 · 0e9ec86 · 0e9ec86
1 parent b64c7bb
commit 0e9ec86
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 9 deletions.
diff --git a/app/scripts/modules/docker/src/image/DockerImageUtils.spec.ts b/app/scripts/modules/docker/src/image/DockerImageUtils.spec.ts
@@ -61,7 +61,7 @@ describe('imageId parsing', () => {
   });
 
   it('parses image with organization and correctly distinguishes digest from tag', () => {
-    const imageId = 'organization/image:sha256:abc123';
+    const imageId = 'organization/image@sha256:abc123';
     expect(DockerImageUtils.splitImageId(imageId)).toEqual({
       organization: 'organization',
       repository: 'organization/image',
@@ -91,7 +91,7 @@ describe('imageId parsing', () => {
   });
 
   it('parses image with nested organization and correctly distinguishes digest from tag', () => {
-    const imageId = 'nested/organization/image:sha256:abc123';
+    const imageId = 'nested/organization/image@sha256:abc123';
     expect(DockerImageUtils.splitImageId(imageId)).toEqual({
       organization: 'nested/organization',
       repository: 'nested/organization/image',
@@ -100,3 +100,49 @@ describe('imageId parsing', () => {
     });
   });
 });
+
+describe('imageId generating', () => {
+  it('generate imageId without repository', () => {
+    expect(
+      DockerImageUtils.generateImageId({
+        organization: 'gcr.io/project',
+        repository: '',
+        digest: undefined,
+        tag: undefined,
+      }),
+    ).toEqual(undefined);
+  });
+
+  it('generate imageId with repository but no tag/digest', () => {
+    expect(
+      DockerImageUtils.generateImageId({
+        organization: 'gcr.io/project',
+        repository: 'gcr.io/project/my-image',
+        digest: undefined,
+        tag: undefined,
+      }),
+    ).toEqual(undefined);
+  });
+
+  it('generate imageId with digest', () => {
+    expect(
+      DockerImageUtils.generateImageId({
+        organization: 'gcr.io/project',
+        repository: 'gcr.io/project/my-image',
+        digest: 'sha256:28f82eba',
+        tag: undefined,
+      }),
+    ).toEqual('gcr.io/project/my-image@sha256:28f82eba');
+  });
+
+  it('generate imageId with tag', () => {
+    expect(
+      DockerImageUtils.generateImageId({
+        organization: 'gcr.io/project',
+        repository: 'gcr.io/project/my-image',
+        digest: undefined,
+        tag: 'v1.2',
+      }),
+    ).toEqual('gcr.io/project/my-image:v1.2');
+  });
+});
diff --git a/app/scripts/modules/docker/src/image/DockerImageUtils.ts b/app/scripts/modules/docker/src/image/DockerImageUtils.ts
@@ -8,7 +8,12 @@ export interface IDockerImageParts {
 export class DockerImageUtils {
   // Split the image id up into the selectable parts to feed the UI
   public static splitImageId(imageId = ''): IDockerImageParts {
-    const imageParts = imageId.split(':');
+    let imageParts: string[];
+    if (imageId.includes('@')) {
+      imageParts = imageId.split('@');
+    } else {
+      imageParts = imageId.split(':');
+    }
     const repository = imageParts[0];
     const repositoryParts = repository.split('/');
     // Everything before the last slash is considered the organization
@@ -34,6 +39,14 @@ export class DockerImageUtils {
       return undefined;
     }
 
-    return `${parts.repository}:${parts.digest ? parts.digest : parts.tag}`;
+    let imageId: string;
+
+    if (parts.digest) {
+      imageId = `${parts.repository}@${parts.digest}`;
+    } else {
+      imageId = `${parts.repository}:${parts.tag}`;
+    }
+
+    return imageId;
   }
 }
diff --git a/app/scripts/modules/docker/src/pipeline/trigger/DockerTriggerTemplate.tsx b/app/scripts/modules/docker/src/pipeline/trigger/DockerTriggerTemplate.tsx
@@ -66,25 +66,33 @@ export class DockerTriggerTemplate extends React.Component<
 
   private lookupTypeChanged = (o: Option<IDockerLookupType>) => {
     const newType = o.value;
-    this.props.updateCommand('extraFields.tag', newType === 'tag' ? this.state.selectedTag : this.state.digest);
+    this.updateArtifact(this.props.command, newType === 'tag' ? this.state.selectedTag : this.state.digest);
     this.setState({ lookupType: newType });
   };
 
-  private updateArtifact(command: IPipelineCommand, tag: string) {
-    this.props.updateCommand('extraFields.tag', tag);
+  private updateArtifact(command: IPipelineCommand, tagOrDigest: string) {
+    this.props.updateCommand('extraFields.tag', tagOrDigest);
     const trigger = command.trigger as IDockerTrigger;
     if (trigger && trigger.repository) {
       let imageName = '';
       if (trigger.registry) {
         imageName += trigger.registry + '/';
       }
       imageName += trigger.repository;
+
+      let imageReference = '';
+      if (this.state.lookupType === 'digest') {
+        imageReference = `${imageName}@${tagOrDigest}`;
+      } else {
+        imageReference = `${imageName}:${tagOrDigest}`;
+      }
+
       this.props.updateCommand('extraFields.artifacts', [
         {
           type: 'docker/image',
           name: imageName,
-          version: tag,
-          reference: imageName + ':' + tag,
+          version: tagOrDigest,
+          reference: imageReference,
         },
       ]);
     }