@aws-cdk-testing/cli-integ/tests/cli-integ-tests/cdk-cdk-synth-add-the-metadata-properties-expected-by-sam.integtest.ts

Integration tests for the AWS CDK CLI

import { integTest, withSamIntegrationFixture } from '../../lib';

jest.setTimeout(2 * 60 * 60_000); // Includes the time to acquire locks, worst-case single-threaded runtime

integTest(
  'CDK synth add the metadata properties expected by sam',
  withSamIntegrationFixture(async (fixture) => {
    // Synth first
    await fixture.cdkSynth();

    const template = fixture.template('TestStack');

    const expectedResources = [
      {
        // Python Layer Version
        id: 'PythonLayerVersion39495CEF',
        cdkId: 'PythonLayerVersion',
        isBundled: true,
        property: 'Content',
      },
      {
        // Layer Version
        id: 'LayerVersion3878DA3A',
        cdkId: 'LayerVersion',
        isBundled: false,
        property: 'Content',
      },
      {
        // Bundled layer version
        id: 'BundledLayerVersionPythonRuntime6BADBD6E',
        cdkId: 'BundledLayerVersionPythonRuntime',
        isBundled: true,
        property: 'Content',
      },
      {
        // Python Function
        id: 'PythonFunction0BCF77FD',
        cdkId: 'PythonFunction',
        isBundled: true,
        property: 'Code',
      },
      {
        // Log Retention Function
        id: 'LogRetentionaae0aa3c5b4d4f87b02d85b201efdd8aFD4BFC8A',
        cdkId: 'LogRetentionaae0aa3c5b4d4f87b02d85b201efdd8a',
        isBundled: false,
        property: 'Code',
      },
      {
        // Function
        id: 'FunctionPythonRuntime28CBDA05',
        cdkId: 'FunctionPythonRuntime',
        isBundled: false,
        property: 'Code',
      },
      {
        // Bundled Function
        id: 'BundledFunctionPythonRuntime4D9A0918',
        cdkId: 'BundledFunctionPythonRuntime',
        isBundled: true,
        property: 'Code',
      },
      {
        // NodeJs Function
        id: 'NodejsFunction09C1F20F',
        cdkId: 'NodejsFunction',
        isBundled: true,
        property: 'Code',
      },
      {
        // Go Function
        id: 'GoFunctionCA95FBAA',
        cdkId: 'GoFunction',
        isBundled: true,
        property: 'Code',
      },
      {
        // Docker Image Function
        id: 'DockerImageFunction28B773E6',
        cdkId: 'DockerImageFunction',
        dockerFilePath: 'Dockerfile',
        property: 'Code.ImageUri',
      },
      {
        // Spec Rest Api
        id: 'SpecRestAPI7D4B3A34',
        cdkId: 'SpecRestAPI',
        property: 'BodyS3Location',
      },
    ];

    for (const resource of expectedResources) {
      fixture.output.write(`validate assets metadata for resource ${resource}`);
      expect(resource.id in template.Resources).toBeTruthy();
      expect(template.Resources[resource.id]).toEqual(
        expect.objectContaining({
          Metadata: {
            'aws:cdk:path': `${fixture.fullStackName('TestStack')}/${resource.cdkId}/Resource`,
            'aws:asset:path': expect.stringMatching(/asset\.[0-9a-zA-Z]{64}/),
            'aws:asset:is-bundled': resource.isBundled,
            'aws:asset:dockerfile-path': resource.dockerFilePath,
            'aws:asset:property': resource.property,
          },
        }),
      );
    }

    // Nested Stack
    fixture.output.write('validate assets metadata for nested stack resource');
    expect('NestedStackNestedStackNestedStackNestedStackResourceB70834FD' in template.Resources).toBeTruthy();
    expect(template.Resources.NestedStackNestedStackNestedStackNestedStackResourceB70834FD).toEqual(
      expect.objectContaining({
        Metadata: {
          'aws:cdk:path': `${fixture.fullStackName(
            'TestStack',
          )}/NestedStack.NestedStack/NestedStack.NestedStackResource`,
          'aws:asset:path': expect.stringMatching(
            `${fixture.stackNamePrefix.replace(/-/, '')}TestStackNestedStack[0-9A-Z]{8}\.nested\.template\.json`,
          ),
          'aws:asset:property': 'TemplateURL',
        },
      }),
    );
  }),
);