@spinnaker/docker 0.0.0-main-2

package/src/image/DockerImageReader.ts

@@ -0,0 +1,42 @@
+import type { IFindImageParams, IFindTagsParams, IImage } from '@spinnaker/core';
+import { REST, RetryService } from '@spinnaker/core';
+
+export interface IDockerImage extends IImage {
+  account: string;
+  registry: string;
+  repository: string;
+  tag: string;
+}
+
+export class DockerImageReader {
+  public static getImage(imageName: string, region: string, credentials: string): PromiseLike<IDockerImage> {
+    return REST('/images')
+      .path(credentials, region, imageName)
+      .query({ provider: 'docker' })
+      .get()
+      .then((results: IDockerImage[]) => (results && results.length ? results[0] : null))
+      .catch((): IDockerImage => null);
+  }
+
+  public static findImages(params: IFindImageParams): PromiseLike<IDockerImage[]> {
+    return RetryService.buildRetrySequence<IDockerImage[]>(
+      () => REST('/images/find').query(params).get(),
+      (results: IDockerImage[]) => results.length > 0,
+      10,
+      1000,
+    )
+      .then((results: IDockerImage[]) => results)
+      .catch((): IDockerImage[] => []);
+  }
+
+  public static findTags(params: IFindTagsParams): PromiseLike<string[]> {
+    return RetryService.buildRetrySequence<string[]>(
+      () => REST('/images/tags').query(params).get(),
+      (results: string[]) => results.length > 0,
+      10,
+      1000,
+    )
+      .then((results: string[]) => results)
+      .catch((): string[] => []);
+  }
+}

package/src/image/DockerImageUtils.spec.ts

@@ -0,0 +1,148 @@
+import { DockerImageUtils } from './DockerImageUtils';
+
+describe('imageId parsing', () => {
+  it('parses undefined without choking', () => {
+    expect(DockerImageUtils.splitImageId(undefined)).toEqual({
+      organization: '',
+      repository: '',
+      digest: undefined,
+      tag: undefined,
+    });
+  });
+
+  it('parses image with no organization and no tag/digest', () => {
+    const imageId = 'image';
+    expect(DockerImageUtils.splitImageId(imageId)).toEqual({
+      organization: '',
+      repository: 'image',
+      digest: undefined,
+      tag: undefined,
+    });
+  });
+
+  it('parses image with tag but no organization', () => {
+    const imageId = 'image:tag';
+    expect(DockerImageUtils.splitImageId(imageId)).toEqual({
+      organization: '',
+      repository: 'image',
+      digest: undefined,
+      tag: 'tag',
+    });
+  });
+
+  it('parses image with no organization and correctly distinguishes digest from tag', () => {
+    const imageId = 'image:sha256:abc123';
+    expect(DockerImageUtils.splitImageId(imageId)).toEqual({
+      organization: '',
+      repository: 'image',
+      digest: 'sha256:abc123',
+      tag: undefined,
+    });
+  });
+
+  it('parses image with organization but no tag/digest', () => {
+    const imageId = 'organization/image';
+    expect(DockerImageUtils.splitImageId(imageId)).toEqual({
+      organization: 'organization',
+      repository: 'organization/image',
+      digest: undefined,
+      tag: undefined,
+    });
+  });
+
+  it('parses image with organization and tag', () => {
+    const imageId = 'organization/image:tag';
+    expect(DockerImageUtils.splitImageId(imageId)).toEqual({
+      organization: 'organization',
+      repository: 'organization/image',
+      digest: undefined,
+      tag: 'tag',
+    });
+  });
+
+  it('parses image with organization and correctly distinguishes digest from tag', () => {
+    const imageId = 'organization/image@sha256:abc123';
+    expect(DockerImageUtils.splitImageId(imageId)).toEqual({
+      organization: 'organization',
+      repository: 'organization/image',
+      digest: 'sha256:abc123',
+      tag: undefined,
+    });
+  });
+
+  it('parses image with nested organization', () => {
+    const imageId = 'nested/organization/image';
+    expect(DockerImageUtils.splitImageId(imageId)).toEqual({
+      organization: 'nested/organization',
+      repository: 'nested/organization/image',
+      digest: undefined,
+      tag: undefined,
+    });
+  });
+
+  it('parses image with tag and nested organization', () => {
+    const imageId = 'nested/organization/image:tag';
+    expect(DockerImageUtils.splitImageId(imageId)).toEqual({
+      organization: 'nested/organization',
+      repository: 'nested/organization/image',
+      digest: undefined,
+      tag: 'tag',
+    });
+  });
+
+  it('parses image with nested organization and correctly distinguishes digest from tag', () => {
+    const imageId = 'nested/organization/image@sha256:abc123';
+    expect(DockerImageUtils.splitImageId(imageId)).toEqual({
+      organization: 'nested/organization',
+      repository: 'nested/organization/image',
+      digest: 'sha256:abc123',
+      tag: undefined,
+    });
+  });
+});
+
+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');
+  });
+});

package/src/image/DockerImageUtils.ts

@@ -0,0 +1,52 @@
+export interface IDockerImageParts {
+  organization: string;
+  repository: string;
+  tag?: string;
+  digest?: string;
+}
+
+export class DockerImageUtils {
+  // Split the image id up into the selectable parts to feed the UI
+  public static splitImageId(imageId = ''): IDockerImageParts {
+    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
+    const organization = repositoryParts.slice(0, -1).join('/');
+
+    const lookup = imageParts.length > 1 ? imageParts.slice(1).join(':') : '';
+
+    let tag: string;
+    let digest: string;
+    if (lookup) {
+      if (lookup.startsWith('sha256:')) {
+        digest = lookup;
+      } else {
+        tag = lookup;
+      }
+    }
+
+    return { organization, repository, digest, tag };
+  }
+
+  public static generateImageId(parts: IDockerImageParts): string {
+    if (!parts.repository || !(parts.digest || parts.tag)) {
+      return undefined;
+    }
+
+    let imageId: string;
+
+    if (parts.digest) {
+      imageId = `${parts.repository}@${parts.digest}`;
+    } else {
+      imageId = `${parts.repository}:${parts.tag}`;
+    }
+
+    return imageId;
+  }
+}

package/src/image/index.ts

@@ -0,0 +1,3 @@
+export * from './DockerImageReader';
+export * from './DockerImageAndTagSelector';
+export * from './DockerImageUtils';

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './image';
+export * from './docker.module';

package/src/pipeline/stages/bake/bakeExecutionDetails.controller.js

@@ -0,0 +1,36 @@
+'use strict';
+
+import UIROUTER_ANGULARJS from '@uirouter/angularjs';
+import { module } from 'angular';
+
+import { SETTINGS } from '@spinnaker/core';
+
+export const DOCKER_PIPELINE_STAGES_BAKE_BAKEEXECUTIONDETAILS_CONTROLLER =
+  'spinnaker.docker.pipeline.stage.bake.executionDetails.controller';
+export const name = DOCKER_PIPELINE_STAGES_BAKE_BAKEEXECUTIONDETAILS_CONTROLLER; // for backwards compatibility
+module(DOCKER_PIPELINE_STAGES_BAKE_BAKEEXECUTIONDETAILS_CONTROLLER, [UIROUTER_ANGULARJS]).controller(
+  'dockerBakeExecutionDetailsCtrl',
+  [
+    '$scope',
+    '$stateParams',
+    'executionDetailsSectionService',
+    '$interpolate',
+    function ($scope, $stateParams, executionDetailsSectionService, $interpolate) {
+      $scope.configSections = ['bakeConfig', 'taskStatus'];
+
+      const initialized = () => {
+        $scope.detailsSection = $stateParams.details;
+        $scope.provider = $scope.stage.context.cloudProviderType || 'docker';
+        $scope.bakeryDetailUrl = $interpolate(
+          $scope.roscoMode && SETTINGS.roscoDetailUrl ? SETTINGS.roscoDetailUrl : SETTINGS.bakeryDetailUrl,
+        );
+      };
+
+      const initialize = () => executionDetailsSectionService.synchronizeSection($scope.configSections, initialized);
+
+      initialize();
+
+      $scope.$on('$stateChangeSuccess', initialize);
+    },
+  ],
+);

package/src/pipeline/stages/bake/bakeExecutionDetails.html

@@ -0,0 +1,47 @@
+<div ng-controller="dockerBakeExecutionDetailsCtrl">
+  <execution-details-section-nav sections="configSections"></execution-details-section-nav>
+  <div class="step-section-details" ng-if="detailsSection === 'bakeConfig'">
+    <div class="row">
+      <div class="col-md-6">
+        <dl class="dl-narrow dl-horizontal">
+          <dt if-multiple-providers>Provider</dt>
+          <dd if-multiple-providers>Docker</dd>
+          <dt>Organization</dt>
+          <dd>{{stage.context.organization}}</dd>
+          <dt>Image Name</dt>
+          <dd>{{stage.context.ami_name}}</dd>
+          <dt>Image Tag</dt>
+          <dd>{{stage.context.extendedAttributes['docker_target_image_tag']}}</dd>
+          <dt>Image</dt>
+          <dd>{{stage.context.ami}}</dd>
+        </dl>
+      </div>
+      <div class="col-md-6">
+        <dl class="dl-narrow dl-horizontal">
+          <dt>Base OS</dt>
+          <dd>{{stage.context.baseOs}}</dd>
+          <dt>Region</dt>
+          <dd>{{stage.context.region}}</dd>
+          <dt>Package</dt>
+          <dd>{{stage.context.package}}</dd>
+          <dt>Label</dt>
+          <dd>{{stage.context.baseLabel}}</dd>
+        </dl>
+      </div>
+    </div>
+    <stage-failure-message stage="stage" message="stage.failureMessage"></stage-failure-message>
+
+    <div class="row" ng-if="stage.context.region && stage.context.status.resourceId">
+      <div class="col-md-12">
+        <div class="alert alert-{{stage.isFailed ? 'danger' : 'info'}}">
+          <a target="_blank" href="{{ bakeryDetailUrl(stage) }}"> View Bakery Details </a>
+        </div>
+      </div>
+    </div>
+  </div>
+  <div class="step-section-details" ng-if="detailsSection === 'taskStatus'">
+    <div class="row">
+      <execution-step-details item="stage"></execution-step-details>
+    </div>
+  </div>
+</div>

package/src/pipeline/stages/bake/bakeStage.html

@@ -0,0 +1,32 @@
+<div ng-controller="dockerBakeStageCtrl as bakeStageCtrl">
+  <stage-config-field label="Package" help-key="pipeline.config.bake.package">
+    <input type="text" class="form-control input-sm" ng-model="stage.package" />
+  </stage-config-field>
+  <stage-config-field label="Organization" help-key="pipeline.config.docker.bake.organization">
+    <input type="text" class="form-control input-sm" ng-model="stage.organization" />
+  </stage-config-field>
+  <stage-config-field label="Image Name" help-key="pipeline.config.docker.bake.targetImage">
+    <input type="text" class="form-control input-sm" ng-model="stage.ami_name" />
+  </stage-config-field>
+  <stage-config-field label="Image tag" help-key="pipeline.config.docker.bake.targetImageTag">
+    <input type="text" class="form-control input-sm" ng-model="stage.extendedAttributes['docker_target_image_tag']" />
+  </stage-config-field>
+  <stage-config-field label="Base OS">
+    <bake-stage-choose-os model="stage.baseOs" base-os-options="baseOsOptions"></bake-stage-choose-os>
+  </stage-config-field>
+
+  <stage-config-field label="Base Label">
+    <label class="radio-inline" ng-repeat="baseLabel in baseLabelOptions">
+      <input type="radio" ng-model="stage.baseLabel" ng-value="baseLabel" />
+      {{baseLabel}}
+    </label>
+  </stage-config-field>
+  <stage-config-field label="Rebake">
+    <div class="checkbox" style="margin-bottom: 0">
+      <label>
+        <input type="checkbox" ng-model="stage.rebake" />
+        Rebake image without regard to the status of any existing bake
+      </label>
+    </div>
+  </stage-config-field>
+</div>

package/src/pipeline/stages/bake/dockerBakeStage.js

@@ -0,0 +1,81 @@
+'use strict';
+
+import { module } from 'angular';
+import _ from 'lodash';
+
+import { AuthenticationService, BakeExecutionLabel, BakeryReader, Registry } from '@spinnaker/core';
+import { DOCKER_PIPELINE_STAGES_BAKE_BAKEEXECUTIONDETAILS_CONTROLLER } from './bakeExecutionDetails.controller';
+
+/*
+  This stage is just here so that we can experiment with baking Docker containers within pipelines.
+  Without this stage, programmatically-created pipelines with Docker bake stages would not render
+  execution details.
+ */
+export const DOCKER_PIPELINE_STAGES_BAKE_DOCKERBAKESTAGE = 'spinnaker.docker.pipeline.stage.bakeStage';
+export const name = DOCKER_PIPELINE_STAGES_BAKE_DOCKERBAKESTAGE; // for backwards compatibility
+module(DOCKER_PIPELINE_STAGES_BAKE_DOCKERBAKESTAGE, [DOCKER_PIPELINE_STAGES_BAKE_BAKEEXECUTIONDETAILS_CONTROLLER])
+  .config(function () {
+    Registry.pipeline.registerStage({
+      provides: 'bake',
+      cloudProvider: 'docker',
+      label: 'Bake',
+      description: 'Bakes an image',
+      templateUrl: require('./bakeStage.html'),
+      executionDetailsUrl: require('./bakeExecutionDetails.html'),
+      executionLabelComponent: BakeExecutionLabel,
+      extraLabelLines: (stage) => {
+        return stage.masterStage.context.allPreviouslyBaked || stage.masterStage.context.somePreviouslyBaked ? 1 : 0;
+      },
+      supportsCustomTimeout: true,
+      validators: [{ type: 'requiredField', fieldName: 'package' }],
+      restartable: true,
+    });
+  })
+  .controller('dockerBakeStageCtrl', [
+    '$scope',
+    '$q',
+    function ($scope, $q) {
+      const stage = $scope.stage;
+
+      stage.region = 'global';
+
+      if (!$scope.stage.user) {
+        $scope.stage.user = AuthenticationService.getAuthenticatedUser().name;
+      }
+
+      $scope.viewState = {
+        loading: true,
+      };
+
+      function initialize() {
+        $scope.viewState.providerSelected = true;
+        $q.all([BakeryReader.getBaseOsOptions('docker'), BakeryReader.getBaseLabelOptions()]).then(function ([
+          baseOsOptions,
+          baseLabelOptions,
+        ]) {
+          $scope.baseOsOptions = baseOsOptions.baseImages;
+          $scope.baseLabelOptions = baseLabelOptions;
+
+          if (!$scope.stage.baseOs && $scope.baseOsOptions && $scope.baseOsOptions.length) {
+            $scope.stage.baseOs = $scope.baseOsOptions[0].id;
+          }
+          if (!$scope.stage.baseLabel && $scope.baseLabelOptions && $scope.baseLabelOptions.length) {
+            $scope.stage.baseLabel = $scope.baseLabelOptions[0];
+          }
+          $scope.viewState.loading = false;
+        });
+      }
+
+      function deleteEmptyProperties() {
+        _.forOwn($scope.stage, function (val, key) {
+          if (val === '') {
+            delete $scope.stage[key];
+          }
+        });
+      }
+
+      $scope.$watch('stage', deleteEmptyProperties, true);
+
+      initialize();
+    },
+  ]);

package/src/pipeline/trigger/DockerTrigger.tsx

@@ -0,0 +1,44 @@
+import React from 'react';
+
+import type { IDockerTrigger, IExecutionTriggerStatusComponentProps } from '@spinnaker/core';
+import { Registry } from '@spinnaker/core';
+
+import { DockerTriggerConfig } from './DockerTriggerConfig';
+import { DockerTriggerTemplate } from './DockerTriggerTemplate';
+
+const DockerTriggerExecutionStatus = (props: IExecutionTriggerStatusComponentProps) => {
+  const trigger = props.trigger as IDockerTrigger;
+  return (
+    <li>
+      {trigger.repository}:{trigger.tag}
+    </li>
+  );
+};
+
+Registry.pipeline.registerTrigger({
+  label: 'Docker Registry',
+  description: 'Executes the pipeline on an image update',
+  key: 'docker',
+  component: DockerTriggerConfig,
+  manualExecutionComponent: DockerTriggerTemplate,
+  executionStatusComponent: DockerTriggerExecutionStatus,
+  executionTriggerLabel: () => 'Docker Registry',
+  validators: [
+    {
+      type: 'requiredField',
+      fieldName: 'account',
+      message: '<strong>Registry</strong> is a required field for Docker Registry triggers.',
+    },
+    {
+      type: 'requiredField',
+      fieldName: 'repository',
+      message: '<strong>Image</strong> is a required field for Docker Registry triggers.',
+    },
+    {
+      type: 'serviceAccountAccess',
+      preventSave: true,
+      message: `You do not have access to the service account configured in this pipeline's Docker Registry trigger.
+                You will not be able to save your edits to this pipeline.`,
+    },
+  ],
+});

package/src/pipeline/trigger/DockerTriggerConfig.tsx

@@ -0,0 +1,40 @@
+import type { FormikProps } from 'formik';
+import React from 'react';
+
+import type { IDockerTrigger } from '@spinnaker/core';
+
+import type { IDockerImageAndTagChanges } from '../../image';
+import { DockerImageAndTagSelector } from '../../image';
+
+export interface IDockerTriggerConfigProps {
+  formik: FormikProps<IDockerTrigger>;
+  triggerUpdated: (trigger: IDockerTrigger) => void;
+}
+
+export function DockerTriggerConfig(props: IDockerTriggerConfigProps) {
+  const { formik } = props;
+  const trigger = formik.values;
+
+  const dockerChanged = (changes: IDockerImageAndTagChanges) => {
+    // Trigger doesn't use imageId.
+    const { imageId, ...rest } = changes;
+    props.triggerUpdated(rest as IDockerTrigger);
+  };
+
+  return (
+    <div className="form-horizontal">
+      <DockerImageAndTagSelector
+        allowManualDefinition={false}
+        specifyTagByRegex={true}
+        account={trigger.account}
+        organization={trigger.organization}
+        registry={trigger.registry}
+        repository={trigger.repository}
+        tag={trigger.tag}
+        showRegistry={true}
+        onChange={dockerChanged}
+        showDigest={false}
+      />
+    </div>
+  );
+}