AWS CDK测试初探：掌握Assertion测试模式

本系文将深入讲解AWS CDK（云开发工具包）中的Assertion测试方法。在本文的第一部分，我们将重点先容Template类的方法及其具体用法。
谁适合阅读这篇文章

如果你正考虑为基础设施代码添加测试，或者计划为CDK应用程序引入测试，那么这篇文章会为你提供一些有用的思绪。此外，如果你对Assertion测试的编写有浓重的兴趣，那么你也将在这里找到值得参考的示例和指导。
这篇文章不涉及的内容

我们不会在本文中讲解AWS CDK的基本使用步调，也不会深入探讨特定AWS资源的高级技能细节。本文的核心将集中在测试的具体实现上，帮助你更好地理解如何在CDK项目中应用Assertion测试。
运行环境

本文的内容已在以下环境中举行过测试和验证：

• Node.js 20.15.0
  
• TypeScript 5.5.2
  
• AWS CDK v2（2.150.0）
  

测试对象

1. import * as cdk from 'aws-cdk-lib';
2. import { Construct } from 'constructs';
3. import * as s3 from 'aws-cdk-lib/aws-s3';
5. export class CdkTestStudyStack extends cdk.Stack {
6.   constructor(scope: Construct, id: string, props?: cdk.StackProps) {
7.     super(scope, id, props);
9.     const Bucket = new s3.Bucket(this, 'CdkTestStudyBucket1', {
10.       bucketName: 'hogehoge',
11.       enforceSSL: true,
12.       objectLockEnabled: true,
13.       versioned: true,
14.     });
16.     new s3.Bucket(this, 'CdkTestStudyBucket2', {
17.       objectLockEnabled: true,
18.       removalPolicy: cdk.RemovalPolicy.RETAIN
19.     });
20.   
21.    
22.     new cdk.CfnOutput(this, 'S3BucketName', {
23.       value: Bucket.bucketName,
24.     });
25.   }
26. }

复制代码

检查资源的属性内容

当你想要验证某个资源的特定属性时，可以使用hasResourceProperties方法。通过该方法，你可以确认是否存在具有指定属性的资源，从而确保资源的配置符合预期。

1. test("验证存在启用了ObjectLock的S3桶", () => {
2.   template.hasResourceProperties("AWS::S3::Bucket", {
3.     BucketName: "hogehoge"
4.   });
5. });

复制代码

allResourcesProperties

allResourcesProperties方法用于确认指定的所有资源是否都具有特定的属性。当你想验证所有创建的S3桶是否都启用了Object Lock等属性时，这个方法将非常有用。

1. test("验证所有的S3存储桶都启用了ObjectLock", () => {
2.   template.allResourcesProperties("AWS::S3::Bucket", {
3.     ObjectLockEnabled: true,
4.   });
5. });

复制代码

检查资源属性以外的元素

当你想验证资源的其他元素（例如类型）时，可以使用hasResource方法。这个方法能够帮助你确认是否存在指定类型的资源。
如果你需要针对所有AWS资源举行测试，类似于hasResourceProperties的情况，可以使用allResources方法来实现。这样你可以确认项目中所有相干资源是否符合预期配置。

1. test("验证存在删除策略为Retain的S3存储桶", () => {
2.   template.hasResource("AWS::S3::Bucket", {
3.     DeletionPolicy: "Retain",
4.   });
5. });

复制代码

allResources

allResources方法用于验证是否存在指定类型的资源。当你需要测试所有的AWS资源时，类似于使用hasResourceProperties的情况，你可以使用allResources来确认所有相干资源是否符合预期配置。

1. test("验证所有的S3存储桶的删除策略都是Retain", () => {
2.   template.allResources("AWS::S3::Bucket", {
3.     DeletionPolicy: "Retain",
4.   });
5. });

复制代码

检查资源数量

当你想要验证某个特定类型的资源是否存在指定的数量时，可以使用resourceCountIs方法。该方法可以帮助你确认项目中是否存在预期数量的资源，以确保资源的数量配置符合要求。

1. test("验证创建的S3存储桶数量为2", () => {
2.   template.resourceCountIs("AWS::S3::Bucket", 2);
3. });

复制代码

resourcePropertiesCountIs

resourcePropertiesCountIs方法用于验证具有指定属性的资源是否存在指定的数量。通过这个方法，你可以确保项目中具有某些特定属性的资源数量符合预期要求。这对于确保资源配置的一致性和正确性非常有用。

1. test("验证存在两个启用了ObjectLock的S3存储桶", () => {
2.   template.resourcePropertiesCountIs("AWS::S3::Bucket", {
3.     ObjectLockEnabled: true,
4.   }, 2);
5. });

复制代码

从模板中获取特定资源信息

如果你想从CloudFormation模板中提取与特定资源相干的信息，可以使用find〇〇系列方法。以findResources为例，它能够从模板的Resources部分中筛选出符合条件的特定资源类型。
举个例子，假如你需要输出与S3存储桶相干的部分，可以这样写：

1. const s3 = template.findResources("AWS::S3::Bucket", {});

复制代码

根据模板的差别部分，你可以灵活使用类似的find〇〇方法，获取你需要的资源信息。

1. {
2.   CdkTestStudyBucket13535E829: {
3.     Type: 'AWS::S3::Bucket',
4.     Properties: {
5.       BucketName: 'hogehoge',
6.       ObjectLockEnabled: true,
7.       VersioningConfiguration: [Object]
8.     },
9.     UpdateReplacePolicy: 'Retain',
10.     DeletionPolicy: 'Retain'
11.   },
12.   CdkTestStudyBucket2D584685D: {
13.     Type: 'AWS::S3::Bucket',
14.     Properties: { ObjectLockEnabled: true },
15.     UpdateReplacePolicy: 'Retain',
16.     DeletionPolicy: 'Retain'
17.   }
18. }

复制代码

如果只指定资源类型，模板中所有与该资源相干的部分都会被提取出来。为了更加正确地筛选资源，可以通过指定Properties来限定需要提取的特定资源。这样可以帮助你在大量资源中正确找到符合特定条件的资源配置。

1. const s3 = template.findResources("AWS::S3::Bucket", {
2.   Properties: {
3.     BucketName: "hogehoge",
4.   },
5. });

复制代码

1. {
2.   CdkTestStudyBucket13535E829: {
3.     Type: 'AWS::S3::Bucket',
4.     Properties: {
5.       BucketName: 'hogehoge',
6.       ObjectLockEnabled: true,
7.       VersioningConfiguration: [Object]
8.     },
9.     UpdateReplacePolicy: 'Retain',
10.     DeletionPolicy: 'Retain'
11.   }
12. }

复制代码

确认模板的某个部分是否包罗特定值

如果你想从CloudFormation模板中确认某个特定部分是否包罗特定的值，可以使用has〇〇系列方法。例如，使用hasOutputs可以确认模板的Outputs部分是否包罗符合条件的内容。
例如，如果你想检查S3 Bucket是否被包罗在Outputs部分中，可以这样写：

1. test("验证S3的BucketName是否被输出", () => {
2.   const s3 = template.findResources("AWS::S3::Bucket", {
3.     Properties: {
4.       BucketName: "hogehoge",
5.     },
6.   });
8.   template.hasOutput('S3BucketName', {
9.     Value: {
10.       Ref: Object.keys(s3)[0]
11.     }
12.   });
13. });

复制代码

你可以根据模板的差别部分使用相应的has〇〇方法，以便确认特定值是否存在。
总结

在本文中，我们先容了在Assertion测试中使用的Template类方法。像hasResourceProperties和resourceCountIs这样的方法使用频率较高，是编写Assertion测试时必须相识的关键方法。
下一篇文章中，我们将深入探讨创建更具体的Assertion测试时不可或缺的Match类方法。
参考

class Template · AWS CDK

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。