@flit/cdk-pipeline 1.0.9 → 1.0.11

package/src/stack-segment.ts

@@ -0,0 +1,195 @@
+import { Stack } from "aws-cdk-lib";
+import {
+  BuildEnvironmentVariable,
+  BuildSpec,
+  ComputeType,
+  LinuxBuildImage,
+  Project,
+} from "aws-cdk-lib/aws-codebuild";
+import { IAction } from "aws-cdk-lib/aws-codepipeline";
+import {
+  CloudFormationCreateReplaceChangeSetAction,
+  CloudFormationExecuteChangeSetAction,
+  CodeBuildAction,
+  ManualApprovalAction,
+} from "aws-cdk-lib/aws-codepipeline-actions";
+import * as path from "path";
+
+import { PublishAssetsAction } from "./publish-assets-action";
+import { Artifact } from "./artifact";
+import { Segment, SegmentConstructed } from "./segment";
+import { Pipeline } from "./pipeline";
+
+export interface StackSegmentProps {
+  /**
+   * The stack to be deployed in this segment.
+   */
+  readonly stack: Stack;
+  /**
+   * The input arfifact for the build stage.
+   */
+  readonly input: Artifact | Artifact[];
+  /**
+   * The command(s) to build the stack.
+   * @example "cdk synth StackName --strict --exclusively"
+   */
+  readonly command: string | string[];
+  /**
+   * The environmental variables for the build stage.
+   */
+  readonly environmentVariables?: { [key: string]: BuildEnvironmentVariable };
+  /**
+   * The name of the stack to deploy the changes to.
+   * @deafult The name of the given stack.
+   */
+  readonly stackName?: string;
+  /**
+   * The AWS account this Action is supposed to operate in.
+   */
+  readonly account?: string;
+  /**
+   * The AWS region the given Action resides in.
+   */
+  readonly region?: string;
+  /**
+   * The artifact to hold the stack deployment output file.
+   * @default no output artifact
+   */
+  readonly output?: Artifact;
+  /**
+   * Does this stage require manual approval of the change set?
+   * @default false
+   */
+  readonly manualApproval?: Boolean;
+}
+
+/**
+ * @category Segments
+ */
+export class StackSegment extends Segment {
+  readonly props: StackSegmentProps;
+
+  constructor(props: StackSegmentProps) {
+    super(props);
+    this.props = props;
+  }
+
+  construct(scope: Pipeline): SegmentConstructed {
+    return new StackSegmentConstructed(
+      scope,
+      `Deploy${this.props.stack.stackName}`,
+      {
+        ...this.props,
+        input: this.inputs[0],
+        extraInputs: this.inputs.slice(1),
+      }
+    );
+  }
+}
+
+export interface StackSegmentConstructedProps {
+  readonly stack: Stack;
+  readonly command: string | string[];
+  readonly environmentVariables?: { [key: string]: BuildEnvironmentVariable };
+  readonly stackName?: string;
+  readonly account?: string;
+  readonly region?: string;
+  readonly input: Artifact;
+  readonly extraInputs?: Artifact[];
+  readonly output?: Artifact;
+  readonly manualApproval?: Boolean;
+}
+
+export class StackSegmentConstructed extends SegmentConstructed {
+  readonly name: string;
+  readonly actions: IAction[];
+
+  constructor(
+    scope: Pipeline,
+    id: string,
+    props: StackSegmentConstructedProps
+  ) {
+    super(scope, id);
+
+    this.name = props.stack.stackName;
+
+    const buildArtifact = new Artifact();
+
+    this.actions = [
+      new CodeBuildAction({
+        actionName: "Build",
+        runOrder: 1,
+        input: props.input,
+        extraInputs: props.extraInputs,
+        outputs: [buildArtifact],
+        environmentVariables: props.environmentVariables,
+        project: new Project(this, "UpdateCodeBuild", {
+          environment: {
+            computeType: ComputeType.MEDIUM,
+            buildImage: LinuxBuildImage.AMAZON_LINUX_2_4,
+            privileged: true,
+          },
+          buildSpec: BuildSpec.fromObject({
+            version: "0.2",
+            phases: {
+              install: {
+                "runtime-versions": {
+                  docker: 20,
+                  nodejs: 18,
+                },
+                commands: ["npm ci"],
+              },
+              build: {
+                commands: props.command,
+              },
+            },
+            artifacts: {
+              files: [path.join(scope.buildDir, "**/*")],
+            },
+            cache: {
+              paths: ["/root/.npm/**/*"],
+            },
+          }),
+        }),
+      }),
+      new PublishAssetsAction(this, "PublishAssets", {
+        actionName: "PublishAssets",
+        runOrder: 2,
+        input: buildArtifact,
+        manifestPath: scope.buildDir,
+      }),
+      new CloudFormationCreateReplaceChangeSetAction({
+        actionName: "PrepareChanges",
+        runOrder: 3,
+        stackName: props.stackName ? props.stackName : props.stack.stackName,
+        account: props.account,
+        region: props.region,
+        changeSetName: `${props.stack.stackName}Changes`,
+        adminPermissions: true,
+        templatePath: buildArtifact.atPath(
+          path.join(scope.buildDir, props.stack.templateFile)
+        ),
+      }),
+      ...(props.manualApproval
+        ? [
+            new ManualApprovalAction({
+              actionName: "ApproveChanges",
+              runOrder: 4,
+            }),
+          ]
+        : []),
+      new CloudFormationExecuteChangeSetAction({
+        actionName: "ExecuteChanges",
+        runOrder: props.manualApproval ? 5 : 4,
+        stackName: props.stackName ? props.stackName : props.stack.stackName,
+        account: props.account,
+        region: props.region,
+        changeSetName: `${props.stack.stackName}Changes`,
+        output: props.output,
+        outputFileName: props.output
+          ? `${props.stack.stackName}Output.json`
+          : undefined,
+      }),
+    ];
+  }
+}