如何用Jest测试AWS CDK v1中的AppSync、GraphQL与Lambda

一、先解决断言失败的核心问题 #

toHaveResource/toHaveProperty断言失败，大概率是资源类型名称写错或者属性路径不匹配CDK合成后的CloudFormation模板结构。CDK v1中各资源的CFN类型是固定的，比如AppSync API对应AWS::AppSync::GraphQLApi，Lambda函数对应AWS::Lambda::Function，别搞混。

最快的排查方式：先执行cdk synth生成CFN模板，直接查看目标资源的实际结构，再对应调整断言逻辑。

二、AppSync资源测试用例 #

1. 测试API基础配置 #

test('AppSync API创建成功且认证模式正确', () => {
  const app = new cdk.App();
  const stack = new YourStack(app, 'TestStack');
  
  expect(stack).toHaveResource('AWS::AppSync::GraphQLApi', {
    AuthenticationType: 'API_KEY', // 替换成你的实际认证类型，比如AWS_IAM/AMAZON_COGNITO_USER_POOLS
    Name: 'YourApiName' // 替换成你的API名称
  });
});

2. 测试数据源与Resolver关联 #

test('AppSync Lambda数据源与Resolver关联正常', () => {
  const app = new cdk.App();
  const stack = new YourStack(app, 'TestStack');
  
  // 断言Lambda数据源存在
  expect(stack).toHaveResource('AWS::AppSync::DataSource', {
    Type: 'AWS_LAMBDA',
    Name: 'LambdaDataSource', // 你的数据源名称
    LambdaConfig: {
      LambdaFunctionArn: {
        'Fn::GetAtt': [
          'YourLambdaFunctionLogicalId', // 从cdk synth输出中找Lambda的逻辑ID
          'Arn'
        ]
      }
    }
  });
  
  // 断言Resolver关联正确字段与数据源
  expect(stack).toHaveResource('AWS::AppSync::Resolver', {
    FieldName: 'getPosts', // 你的Schema字段名
    TypeName: 'Query', // 对应类型：Query/Mutation
    DataSourceName: {
      'Fn::GetAtt': [
        'YourDataSourceLogicalId', // 数据源的逻辑ID
        'Name'
      ]
    }
  });
});

三、Lambda函数测试用例 #

1. 测试基础配置与Redshift访问权限 #

test('Lambda运行时配置正确且拥有Redshift访问权限', () => {
  const app = new cdk.App();
  const stack = new YourStack(app, 'TestStack');
  
  expect(stack).toHaveResource('AWS::Lambda::Function', {
    Runtime: 'nodejs16.x', // 替换成你的实际运行时
    Handler: 'index.handler',
    Role: {
      'Fn::GetAtt': [
        'YourLambdaRoleLogicalId', // Lambda角色的逻辑ID
        'Arn'
      ]
    }
  });
  
  // 验证Lambda角色的Redshift权限
  expect(stack).toHaveResource('AWS::IAM::Policy', {
    PolicyDocument: {
      Statement: expect.arrayContaining([
        {
          Action: [
            'redshift-data:ExecuteStatement',
            'redshift-data:GetStatementResult'
          ],
          Effect: 'Allow',
          Resource: '*' // 或者你的Redshift集群ARN
        }
      ])
    }
  });
});

四、GraphQL Schema内容验证 #

CDK中Schema一般通过文件或内联字符串定义，可通过读取本地文件对比合成后的模板内容：

import * as fs from 'fs';

test('AppSync Schema与本地文件一致', () => {
  const app = new cdk.App();
  const stack = new YourStack(app, 'TestStack');
  const localSchema = fs.readFileSync('./path/to/your/schema.graphql', 'utf8').trim();
  
  // 从CFN模板中提取Schema资源
  const cfnSchema = stack.node.findChild('YourSchemaLogicalId') as cdk.CfnResource;
  expect(cfnSchema.properties.Definition).toBe(localSchema);
});

五、通用调试技巧 #

1. 打印合成模板：在测试中加入console.log(JSON.stringify(stack.templateOptions, null, 2))，直接输出CFN结构，对比断言路径是否正确。
2. 模糊匹配动态属性：对于ARN、逻辑ID这类动态生成的内容，用expect.objectContaining()或expect.arrayContaining()做模糊匹配，避免严格断言失败。
3. 确认CDK包版本：CDK v1要使用@aws-cdk/assert包，不要混用v2的aws-cdk-lib/assertions，版本不兼容也会导致断言失效。

内容的提问来源于stack exchange，提问作者Zorro