codebuild-step.test.ts

import { Template, Match } from '@aws-cdk/assertions';
import { Duration, Stack } from '@aws-cdk/core';
import * as cdkp from '../../lib';
import { PIPELINE_ENV, TestApp, ModernTestGitHubNpmPipeline, AppWithOutput } from '../testhelpers';

let app: TestApp;
let pipelineStack: Stack;

beforeEach(() => {
  app = new TestApp();
  pipelineStack = new Stack(app, 'PipelineStack', { env: PIPELINE_ENV });
});

afterEach(() => {
  app.cleanup();
});

test('additionalinputs creates the right commands', () => {
  // WHEN
  new cdkp.CodePipeline(pipelineStack, 'Pipeline', {
    synth: new cdkp.CodeBuildStep('Synth', {
      commands: ['/bin/true'],
      input: cdkp.CodePipelineSource.gitHub('test/test', 'main'),
      additionalInputs: {
        'some/deep/directory': cdkp.CodePipelineSource.gitHub('test2/test2', 'main'),
      },
    }),
  });

  // THEN
  Template.fromStack(pipelineStack).hasResourceProperties('AWS::CodeBuild::Project', {
    Source: {
      BuildSpec: Match.serializedJson(Match.objectLike({
        phases: {
          install: {
            commands: [
              '[ ! -d "some/deep/directory" ] || { echo \'additionalInputs: "some/deep/directory" must not exist yet. If you want to merge multiple artifacts, use a "cp" command.\'; exit 1; } && mkdir -p -- "some/deep" && ln -s -- "$CODEBUILD_SRC_DIR_test2_test2_Source" "some/deep/directory"',
            ],
          },
        },
      })),
    },
  });
});

test('CodeBuild projects have a description', () => {
  new cdkp.CodePipeline(pipelineStack, 'Pipeline', {
    synth: new cdkp.CodeBuildStep('Synth', {
      commands: ['/bin/true'],
      input: cdkp.CodePipelineSource.gitHub('test/test', 'main'),
    }),
  });

  // THEN
  Template.fromStack(pipelineStack).hasResourceProperties(
    'AWS::CodeBuild::Project',
    {
      Description: 'Pipeline step PipelineStack/Pipeline/Build/Synth',
    },
  );
});

test('long duration steps are supported', () => {
  // WHEN
  new cdkp.CodePipeline(pipelineStack, 'Pipeline', {
    synth: new cdkp.CodeBuildStep('Synth', {
      commands: ['/bin/true'],
      input: cdkp.CodePipelineSource.gitHub('test/test', 'main'),
      additionalInputs: {
        'some/deep/directory': cdkp.CodePipelineSource.gitHub('test2/test2', 'main'),
      },
      timeout: Duration.minutes(180),
    }),
  });

  // THEN
  Template.fromStack(pipelineStack).hasResourceProperties('AWS::CodeBuild::Project', {
    TimeoutInMinutes: 180,
  });
});

test('timeout can be configured as part of defaults', () => {
  // WHEN
  new cdkp.CodePipeline(pipelineStack, 'Pipeline', {
    synth: new cdkp.CodeBuildStep('Synth', {
      commands: ['/bin/true'],
      input: cdkp.CodePipelineSource.gitHub('test/test', 'main'),
      additionalInputs: {
        'some/deep/directory': cdkp.CodePipelineSource.gitHub('test2/test2', 'main'),
      },
    }),
    codeBuildDefaults: {
      timeout: Duration.minutes(180),
    },
  });

  // THEN
  Template.fromStack(pipelineStack).hasResourceProperties('AWS::CodeBuild::Project', {
    TimeoutInMinutes: 180,
  });
});

test('timeout from defaults can be overridden', () => {
  // WHEN
  new cdkp.CodePipeline(pipelineStack, 'Pipeline', {
    synth: new cdkp.CodeBuildStep('Synth', {
      commands: ['/bin/true'],
      input: cdkp.CodePipelineSource.gitHub('test/test', 'main'),
      additionalInputs: {
        'some/deep/directory': cdkp.CodePipelineSource.gitHub('test2/test2', 'main'),
      },
      timeout: Duration.minutes(888),
    }),
    codeBuildDefaults: {
      timeout: Duration.minutes(180),
    },
  });

  // THEN
  Template.fromStack(pipelineStack).hasResourceProperties('AWS::CodeBuild::Project', {
    TimeoutInMinutes: 888,
  });
});

test('envFromOutputs works even with very long stage and stack names', () => {
  const pipeline = new ModernTestGitHubNpmPipeline(pipelineStack, 'Cdk');

  const myApp = new AppWithOutput(app, 'Alpha'.repeat(20), {
    stackId: 'Stack'.repeat(20),
  });

  pipeline.addStage(myApp, {
    post: [
      new cdkp.ShellStep('Approve', {
        commands: ['/bin/true'],
        envFromCfnOutputs: {
          THE_OUTPUT: myApp.theOutput,
        },
      }),
    ],
  });

  // THEN - did not throw an error about identifier lengths
});

test('variable namespace is set in CodeBuildStep', () => {
  // WHEN
  const pipeline = new ModernTestGitHubNpmPipeline(pipelineStack, 'Cdk');
  const myApp = new AppWithOutput(app, 'VariableNamespaceApp');

  const step1 = new cdkp.CodeBuildStep('Synth', {
    commands: ['/bin/true'],
    input: cdkp.CodePipelineSource.gitHub('test/test', 'main'),
    variablesNamespace: 'CodeBuildStep-namespace',
  });
  const step2 = new cdkp.ShellStep('Approve', {
    commands: ['/bin/true'],
    variablesNamespace: 'ShellStep-namespace',
  });
  pipeline.addStage(myApp, {
    pre: [step1],
    post: [step2],
  });

  // THEN
  expect(step1.variable('test')).toEqual('#{CodeBuildStep-namespace.test}');
  expect(step2.variable('test')).toEqual('#{ShellStep-namespace.test}');
});