テスト構成 - AWS Cloud Development Kit (AWS CDK) v2

これはAWS CDK v2 開発者ガイドです。古いCDK v1は2022年6月1日にメンテナンスを開始し、今後は重大なバグ修正とセキュリティパッチのみが提供されます。新機能はCDK v2専用に開発されます。CDK v1 Support は、2023 年 6 月 1 日に完全に終了します。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

テスト構成

を使用するとAWS CDK、作成した他のコードと同様にインフラストラクチャをテストできます。AWS CDKアプリをテストする標準的なアプローチでは、AWS CDKのアサーションモジュールとJest for Python TypeScript JavaScript や Pytest for Python などの一般的なテストフレームワークを使用します。

AWS CDKアプリ用に作成できるテストには 2 つのカテゴリがあります。

  • きめ細かなアサーションは、「このリソースにはこの値を持つこのプロパティがあります」など、AWS CloudFormation生成されたテンプレートの特定の側面をテストします。これらのテストは回帰を検出できます。また、テスト駆動開発を使用して新しい機能を開発する場合にも役立ちます。(最初にテストを書いてから、正しい実装を書いて合格にすることができます。) きめ細かなアサーションは、最も頻繁に使用されるテストです。

  • スナップショットテストでは、AWS CloudFormation合成されたテンプレートを以前に保存されたベースラインテンプレートと照合してテストします。スナップショットテストでは、リファクタリングされたコードが元のコードとまったく同じように動作することを確認できるため、自由にリファクタリングできます。変更が意図的なものであれば、future テスト用に新しいベースラインを適用できます。ただし、CDK のアップグレードによって合成テンプレートが変更されることもあるため、スナップショットだけに頼って実装が正しいことを確認することはできません。

注記

このトピックの例として使用されている TypeScript、Python、および Java アプリの完全版は、で入手できます GitHub

開始方法

これらのテストの作成方法を説明するために、AWS Step FunctionsAWS Lambdaステートマシンと関数を含むスタックを作成します。Lambda 関数は Amazon SNS トピックに登録され、メッセージをステートマシンに転送するだけです。

まず、CDK Toolkit を使用して空の CDK アプリケーションプロジェクトを作成し、必要なライブラリをインストールします。使用する構成はすべてメインCDKパッケージに含まれています。これは、CDK Toolkitで作成されたプロジェクトのデフォルトの依存関係です。ただし、テストフレームワークをインストールする必要があります。

TypeScript
mkdir state-machine && cd state-machine cdk init --language=typescript npm install --save-dev jest @types/jest

テスト用の新しいディレクトリを作成します。

mkdir test

package.jsonプロジェクトを編集して NPM に Jest の実行方法を伝え、収集するファイルの種類を Jest に伝えます。必要な変更点は次のとおりです。

  • testscriptsセクションに新しいキーを追加

  • JestdevDependencies とそのタイプをセクションに追加

  • jestmoduleFileExtensions宣言付きの新しいトップレベルキーを追加

これらの変更点を次の概要に示します。package.json新しいテキストを指示された場所に配置します。「...」プレースホルダーは、変更してはならないファイルの既存の部分を示します。

{ ... "scripts": { ... "test": "jest" }, "devDependencies": { ... "@types/jest": "^24.0.18", "jest": "^24.9.0" }, "jest": { "moduleFileExtensions": ["js"] } }
JavaScript
mkdir state-machine && cd state-machine cdk init --language=javascript npm install --save-dev jest

テスト用の新しいディレクトリを作成します。

mkdir test

package.jsonプロジェクトを編集して NPM に Jest の実行方法を伝え、収集するファイルの種類を Jest に伝えます。必要な変更点は次のとおりです。

  • testscriptsセクションに新しいキーを追加

  • JestdevDependencies をセクションに追加

  • jestmoduleFileExtensions宣言付きの新しいトップレベルキーを追加

これらの変更点を次の概要に示します。package.json新しいテキストを指示された場所に配置します。「...」プレースホルダーは、変更してはならないファイルの既存の部分を示します。

{ ... "scripts": { ... "test": "jest" }, "devDependencies": { ... "jest": "^24.9.0" }, "jest": { "moduleFileExtensions": ["js"] } }
Python
mkdir state-machine && cd state-machine cdk init --language=python source .venv/bin/activate python -m pip install -r requirements.txt python -m pip install -r requirements-dev.txt
Java
mkdir state-machine && cd-state-machine cdk init --language=java

お好みの Java IDE でプロジェクトを開きます。(Eclipse では、「ファイル」>「インポート」>「既存の Maven プロジェクト」を使用してください。)

C#
mkdir state-machine && cd-state-machine cdk init --language=csharp

Visual Studiosrc\StateMachine.sln で開きます。

ソリューションエクスプローラーでソリューションを右クリックし、「追加」>「新規プロジェクト」 を選択します。MSTest C# を検索し、C# 用の MSTest テストプロジェクトを追加します。(TestProject1デフォルト名で問題ありません。)

TestProject1右クリックして「追加」>「プロジェクト参照」を選択し、StateMachineプロジェクトを参照として追加します。

スタック例

このトピックでテストするスタックは次のとおりです。前に説明したように、これには Lambda 関数と Step Functions ステートマシンが含まれており、1 つ以上の Amazon SNS トピックを受け入れます。Lambda 関数は Amazon SNS トピックに登録され、ステートマシンに転送されます。

アプリをテスト可能にするために特別なことをする必要はありません。実際、この CDK スタックは、このガイドの他のサンプルスタックと大きな違いはありません。

TypeScript

次のコードを記述しますlib/state-machine-stack.ts

import * as cdk from "aws-cdk-lib"; import * as sns from "aws-cdk-lib/aws-sns"; import * as sns_subscriptions from "aws-cdk-lib/aws-sns-subscriptions"; import * as lambda from "aws-cdk-lib/aws-lambda"; import * as sfn from "aws-cdk-lib/aws-stepfunctions"; import { Construct } from "constructs"; export interface ProcessorStackProps extends cdk.StackProps { readonly topics: sns.Topic[]; } export class ProcessorStack extends cdk.Stack { constructor(scope: Construct, id: string, props: ProcessorStackProps) { super(scope, id, props); // In the future this state machine will do some work... const stateMachine = new sfn.StateMachine(this, "StateMachine", { definition: new sfn.Pass(this, "StartState"), }); // This Lambda function starts the state machine. const func = new lambda.Function(this, "LambdaFunction", { runtime: lambda.Runtime.NODEJS_14_X, handler: "handler", code: lambda.Code.fromAsset("./start-state-machine"), environment: { STATE_MACHINE_ARN: stateMachine.stateMachineArn, }, }); stateMachine.grantStartExecution(func); const subscription = new sns_subscriptions.LambdaSubscription(func); for (const topic of props.topics) { topic.addSubscription(subscription); } } }
JavaScript

次のコードを記述しますlib/state-machine-stack.js

const cdk = require("aws-cdk-lib"); const sns = require("aws-cdk-lib/aws-sns"); const sns_subscriptions = require("aws-cdk-lib/aws-sns-subscriptions"); const lambda = require("aws-cdk-lib/aws-lambda"); const sfn = require("aws-cdk-lib/aws-stepfunctions"); class ProcessorStack extends cdk.Stack { constructor(scope, id, props) { super(scope, id, props); // In the future this state machine will do some work... const stateMachine = new sfn.StateMachine(this, "StateMachine", { definition: new sfn.Pass(this, "StartState"), }); // This Lambda function starts the state machine. const func = new lambda.Function(this, "LambdaFunction", { runtime: lambda.Runtime.NODEJS_14_X, handler: "handler", code: lambda.Code.fromAsset("./start-state-machine"), environment: { STATE_MACHINE_ARN: stateMachine.stateMachineArn, }, }); stateMachine.grantStartExecution(func); const subscription = new sns_subscriptions.LambdaSubscription(func); for (const topic of props.topics) { topic.addSubscription(subscription); } } } module.exports = { ProcessorStack }
Python

次のコードを記述しますstate_machine/state_machine_stack.py

from typing import List import aws_cdk.aws_lambda as lambda_ import aws_cdk.aws_sns as sns import aws_cdk.aws_sns_subscriptions as sns_subscriptions import aws_cdk.aws_stepfunctions as sfn import aws_cdk as cdk class ProcessorStack(cdk.Stack): def __init__( self, scope: cdk.Construct, construct_id: str, *, topics: List[sns.Topic], **kwargs ) -> None: super().__init__(scope, construct_id, **kwargs) # In the future this state machine will do some work... state_machine = sfn.StateMachine( self, "StateMachine", definition=sfn.Pass(self, "StartState") ) # This Lambda function starts the state machine. func = lambda_.Function( self, "LambdaFunction", runtime=lambda_.Runtime.NODEJS_14_X, handler="handler", code=lambda_.Code.from_asset("./start-state-machine"), environment={ "STATE_MACHINE_ARN": state_machine.state_machine_arn, }, ) state_machine.grant_start_execution(func) subscription = sns_subscriptions.LambdaSubscription(func) for topic in topics: topic.add_subscription(subscription)
Java
package software.amazon.samples.awscdkassertionssamples; import software.constructs.Construct; import software.amazon.awscdk.Stack; import software.amazon.awscdk.StackProps; import software.amazon.awscdk.services.lambda.Code; import software.amazon.awscdk.services.lambda.Function; import software.amazon.awscdk.services.lambda.Runtime; import software.amazon.awscdk.services.sns.ITopicSubscription; import software.amazon.awscdk.services.sns.Topic; import software.amazon.awscdk.services.sns.subscriptions.LambdaSubscription; import software.amazon.awscdk.services.stepfunctions.Pass; import software.amazon.awscdk.services.stepfunctions.StateMachine; import java.util.Collections; import java.util.List; public class ProcessorStack extends Stack { public ProcessorStack(final Construct scope, final String id, final List<Topic> topics) { this(scope, id, null, topics); } public ProcessorStack(final Construct scope, final String id, final StackProps props, final List<Topic> topics) { super(scope, id, props); // In the future this state machine will do some work... final StateMachine stateMachine = StateMachine.Builder.create(this, "StateMachine") .definition(new Pass(this, "StartState")) .build(); // This Lambda function starts the state machine. final Function func = Function.Builder.create(this, "LambdaFunction") .runtime(Runtime.NODEJS_14_X) .handler("handler") .code(Code.fromAsset("./start-state-machine")) .environment(Collections.singletonMap("STATE_MACHINE_ARN", stateMachine.getStateMachineArn())) .build(); stateMachine.grantStartExecution(func); final ITopicSubscription subscription = new LambdaSubscription(func); for (final Topic topic : topics) { topic.addSubscription(subscription); } } }
C#
using Amazon.CDK; using Amazon.CDK.AWS.Lambda; using Amazon.CDK.AWS.StepFunctions; using Amazon.CDK.AWS.SNS; using Amazon.CDK.AWS.SNS.Subscriptions; using Constructs; using System.Collections.Generic; namespace AwsCdkAssertionSamples { public class StateMachineStackProps : StackProps { public Topic[] Topics; } public class StateMachineStack : Stack { internal StateMachineStack(Construct scope, string id, StateMachineStackProps props = null) : base(scope, id, props) { // In the future this state machine will do some work... var stateMachine = new StateMachine(this, "StateMachine", new StateMachineProps { Definition = new Pass(this, "StartState") }); // This Lambda function starts the state machine. var func = new Function(this, "LambdaFunction", new FunctionProps { Runtime = Runtime.NODEJS_14_X, Handler = "handler", Code = Code.FromAsset("./start-state-machine"), Environment = new Dictionary<string, string> { { "STATE_MACHINE_ARN", stateMachine.StateMachineArn } } }); stateMachine.GrantStartExecution(func); foreach (Topic topic in props?.Topics ?? new Topic[0]) { var subscription = new LambdaSubscription(func); } } } }

実際にスタックをインスタンス化しないように、アプリのメインエントリポイントを変更します。誤ってデプロイしたくありません。テストでは、テスト用のアプリとスタックのインスタンスを作成します。これは、テスト駆動型開発と組み合わせる場合に便利な方法です。デプロイを有効にする前に、スタックがすべてのテストに合格することを確認してください。

TypeScript

Eclipse bin/state-machine.ts:

#!/usr/bin/env node import * as cdk from "aws-cdk-lib"; const app = new cdk.App(); // Stacks are intentionally not created here -- this application isn't meant to // be deployed.
JavaScript

Eclipse bin/state-machine.js:

#!/usr/bin/env node const cdk = require("aws-cdk-lib"); const app = new cdk.App(); // Stacks are intentionally not created here -- this application isn't meant to // be deployed.
Python

Eclipse app.py:

#!/usr/bin/env python3 import os import aws_cdk as cdk app = cdk.App() # Stacks are intentionally not created here -- this application isn't meant to # be deployed. app.synth()
Java
package software.amazon.samples.awscdkassertionssamples; import software.amazon.awscdk.App; public class SampleApp { public static void main(final String[] args) { App app = new App(); // Stacks are intentionally not created here -- this application isn't meant to be deployed. app.synth(); } }
C#
using Amazon.CDK; namespace AwsCdkAssertionSamples { sealed class Program { public static void Main(string[] args) { var app = new App(); // Stacks are intentionally not created here -- this application isn't meant to be deployed. app.Synth(); } } }

Lambda 関数

このサンプルスタックには、ステートマシンを起動する Lambda 関数が含まれています。CDK が Lambda 関数リソースの作成の一部としてバンドルしてデプロイできるように、この関数のソースコードを提供する必要があります。

  • start-state-machineフォルダをアプリケーションのメインディレクトリで作成します。

  • このフォルダで少なくとも 1 つのファイルを作成します。たとえば、次のコードをに保存できますstart-state-machines/index.js

    exports.handler = async function (event, context) { return 'hello world'; };

    ただし、スタックを実際にデプロイすることはないため、どのファイルでも機能します。

テストを実行する

参考までに、AWS CDKアプリでテストを実行するために使用するコマンドを以下に示します。これらは、同じテストフレームワークを使用するどのプロジェクトでもテストを実行するために使用するのと同じコマンドです。ビルドステップが必要な言語の場合は、テストがコンパイルされたことを確認するためにビルドステップを含めてください。

TypeScript
tsc && npm test
JavaScript
npm test
Python
python -m pytest
Java
mvn compile && mvn test
C#

ソリューションを構築してテストを見つけ (F6)、テストを実行します ([テスト] > [すべてのテストを実行])。実行するテストを選択するには、テストエクスプローラー (テスト > テストエクスプローラー) を開きます。

または:

dotnet test src

きめ細かなアサーション

きめ細かなアサーションを使用してスタックをテストする最初のステップは、AWS CloudFormation生成されたテンプレートに対してアサーションを作成するため、スタックを合成することです。

ProcessorStackステートマシンに転送するには、Amazon SNS トピックを渡す必要があります。そこで、このテストでは、トピックを格納するスタックを別に作成します。

通常、CDK アプリケーションを作成する場合、Stackスタックのコンストラクターで Amazon SNS トピックをサブクラス化してインスタンス化できます。このテストでは、Stack直接インスタンス化し、Topicこのスタックをのスコープとして渡し、スタックにアタッチします。これは機能的には同等で、冗長性も低いです。また、テストでのみ使用されるスタックを、デプロイする予定のスタックと「見た目が異なる」ようにするのにも役立ちます。

TypeScript
import { Capture, Match, Template } from "aws-cdk-lib/assertions"; import * as cdk from "aws-cdk-lib"; import * as sns from "aws-cdk-lib/aws-sns"; import { ProcessorStack } from "../lib/processor-stack"; describe("ProcessorStack", () => { test("synthesizes the way we expect", () => { const app = new cdk.App(); // Since the ProcessorStack consumes resources from a separate stack // (cross-stack references), we create a stack for our SNS topics to live // in here. These topics can then be passed to the ProcessorStack later, // creating a cross-stack reference. const topicsStack = new cdk.Stack(app, "TopicsStack"); // Create the topic the stack we're testing will reference. const topics = [new sns.Topic(topicsStack, "Topic1", {})]; // Create the ProcessorStack. const processorStack = new ProcessorStack(app, "ProcessorStack", { topics: topics, // Cross-stack reference }); // Prepare the stack for assertions. const template = Template.fromStack(processorStack); }
JavaScript
const { Capture, Match, Template } = require("aws-cdk-lib/assertions"); const cdk = require("aws-cdk-lib"); const sns = require("aws-cdk-lib/aws-sns"); const { ProcessorStack } = require("../lib/processor-stack"); describe("ProcessorStack", () => { test("synthesizes the way we expect", () => { const app = new cdk.App(); // Since the ProcessorStack consumes resources from a separate stack // (cross-stack references), we create a stack for our SNS topics to live // in here. These topics can then be passed to the ProcessorStack later, // creating a cross-stack reference. const topicsStack = new cdk.Stack(app, "TopicsStack"); // Create the topic the stack we're testing will reference. const topics = [new sns.Topic(topicsStack, "Topic1", {})]; // Create the ProcessorStack. const processorStack = new ProcessorStack(app, "ProcessorStack", { topics: topics, // Cross-stack reference }); // Prepare the stack for assertions. const template = Template.fromStack(processorStack);
Python
from aws_cdk import aws_sns as sns import aws_cdk as cdk from aws_cdk.assertions import Template from app.processor_stack import ProcessorStack def test_synthesizes_properly(): app = cdk.App() # Since the ProcessorStack consumes resources from a separate stack # (cross-stack references), we create a stack for our SNS topics to live # in here. These topics can then be passed to the ProcessorStack later, # creating a cross-stack reference. topics_stack = cdk.Stack(app, "TopicsStack") # Create the topic the stack we're testing will reference. topics = [sns.Topic(topics_stack, "Topic1")] # Create the ProcessorStack. processor_stack = ProcessorStack( app, "ProcessorStack", topics=topics # Cross-stack reference ) # Prepare the stack for assertions. template = Template.from_stack(processor_stack)
Java
package software.amazon.samples.awscdkassertionssamples; import org.junit.jupiter.api.Test; import software.amazon.awscdk.assertions.Capture; import software.amazon.awscdk.assertions.Match; import software.amazon.awscdk.assertions.Template; import software.amazon.awscdk.App; import software.amazon.awscdk.Stack; import software.amazon.awscdk.services.sns.Topic; import java.util.*; import static org.assertj.core.api.Assertions.assertThat; public class ProcessorStackTest { @Test public void testSynthesizesProperly() { final App app = new App(); // Since the ProcessorStack consumes resources from a separate stack (cross-stack references), we create a stack // for our SNS topics to live in here. These topics can then be passed to the ProcessorStack later, creating a // cross-stack reference. final Stack topicsStack = new Stack(app, "TopicsStack"); // Create the topic the stack we're testing will reference. final List<Topic> topics = Collections.singletonList(Topic.Builder.create(topicsStack, "Topic1").build()); // Create the ProcessorStack. final ProcessorStack processorStack = new ProcessorStack( app, "ProcessorStack", topics // Cross-stack reference ); // Prepare the stack for assertions. final Template template = Template.fromStack(processorStack)
C#
using Microsoft.VisualStudio.TestTools.UnitTesting; using Amazon.CDK; using Amazon.CDK.AWS.SNS; using Amazon.CDK.Assertions; using AwsCdkAssertionSamples; using ObjectDict = System.Collections.Generic.Dictionary<string, object>; using StringDict = System.Collections.Generic.Dictionary<string, string>; namespace TestProject1 { [TestClass] public class ProcessorStackTest { [TestMethod] public void TestMethod1() { var app = new App(); // Since the ProcessorStack consumes resources from a separate stack (cross-stack references), we create a stack // for our SNS topics to live in here. These topics can then be passed to the ProcessorStack later, creating a // cross-stack reference. var topicsStack = new Stack(app, "TopicsStack"); // Create the topic the stack we're testing will reference. var topics = new Topic[] { new Topic(topicsStack, "Topic1") }; // Create the ProcessorStack. var processorStack = new StateMachineStack(app, "ProcessorStack", new StateMachineStackProps { Topics = topics }); // Prepare the stack for assertions. var template = Template.FromStack(processorStack); // test will go here } } }

これで、Lambda 関数と Amazon SNS サブスクリプションが作成されたことを確認できます。

TypeScript
// Assert it creates the function with the correct properties... template.hasResourceProperties("AWS::Lambda::Function", { Handler: "handler", Runtime: "nodejs14.x", }); // Creates the subscription... template.resourceCountIs("AWS::SNS::Subscription", 1);
JavaScript
// Assert it creates the function with the correct properties... template.hasResourceProperties("AWS::Lambda::Function", { Handler: "handler", Runtime: "nodejs14.x", }); // Creates the subscription... template.resourceCountIs("AWS::SNS::Subscription", 1);
Python
# Assert that we have created the function with the correct properties template.has_resource_properties( "AWS::Lambda::Function", { "Handler": "handler", "Runtime": "nodejs14.x", }, ) # Assert that we have created a subscription template.resource_count_is("AWS::SNS::Subscription", 1)
Java
// Assert it creates the function with the correct properties... template.hasResourceProperties("AWS::Lambda::Function", Map.of( "Handler", "handler", "Runtime", "nodejs14.x" )); // Creates the subscription... template.resourceCountIs("AWS::SNS::Subscription", 1);
C#
// Prepare the stack for assertions. var template = Template.FromStack(processorStack); // Assert it creates the function with the correct properties... template.HasResourceProperties("AWS::Lambda::Function", new StringDict { { "Handler", "handler"}, { "Runtime", "nodejs14x" } }); // Creates the subscription... template.ResourceCountIs("AWS::SNS::Subscription", 1);

今回の Lambda 関数テストでは、関数リソースの 2 つの特定のプロパティには特定の値があることが確認されています。デフォルトでは、hasResourceProperties CloudFormation メソッドは合成テンプレートで指定されたリソースのプロパティを部分一致させます。このテストでは、提供されたプロパティが存在し、指定された値を持っていることが必要ですが、リソースにはテストされていない他のプロパティを含めることもできます。

Amazon SNS アサーションでは、合成されたテンプレートにはサブスクリプションが含まれているが、サブスクリプション自体については何も含まれていないと断言しています。このアサーションは、主にリソース数をアサートする方法を説明するために含めました。Templateこのクラスには、 CloudFormation テンプレートの、、Mappingおよびセクションに対してアサーションを記述するためのResourcesOutputs、より具体的なメソッドが用意されています。

マッチャー

のデフォルトの部分一致動作は、hasResourcePropertiesMatchクラスのマッチャーを使用して変更できます

マッチャーは lenient (Match.anyValue) から strict (Match.objectEquals) までさまざまです。それらをネストして、リソースプロパティのさまざまな部分にさまざまなマッチング方法を適用できます。たとえば、Match.objectEqualsMatch.anyValueとを組み合わせて使用すると、変更される可能性のあるプロパティに特定の値を設定しなくても、ステートマシンの IAM ロールをより詳細にテストできます。

TypeScript
// Fully assert on the state machine's IAM role with matchers. template.hasResourceProperties( "AWS::IAM::Role", Match.objectEquals({ AssumeRolePolicyDocument: { Version: "2012-10-17", Statement: [ { Action: "sts:AssumeRole", Effect: "Allow", Principal: { Service: { "Fn::Join": [ "", ["states.", Match.anyValue(), ".amazonaws.com"], ], }, }, }, ], }, }) );
JavaScript
// Fully assert on the state machine's IAM role with matchers. template.hasResourceProperties( "AWS::IAM::Role", Match.objectEquals({ AssumeRolePolicyDocument: { Version: "2012-10-17", Statement: [ { Action: "sts:AssumeRole", Effect: "Allow", Principal: { Service: { "Fn::Join": [ "", ["states.", Match.anyValue(), ".amazonaws.com"], ], }, }, }, ], }, }) );
Python
from aws_cdk.assertions import Match # Fully assert on the state machine's IAM role with matchers. template.has_resource_properties( "AWS::IAM::Role", Match.object_equals( { "AssumeRolePolicyDocument": { "Version": "2012-10-17", "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "Service": { "Fn::Join": [ "", [ "states.", Match.any_value(), ".amazonaws.com", ], ], }, }, }, ], }, } ), )
Java
// Fully assert on the state machine's IAM role with matchers. template.hasResourceProperties("AWS::IAM::Role", Match.objectEquals( Collections.singletonMap("AssumeRolePolicyDocument", Map.of( "Version", "2012-10-17", "Statement", Collections.singletonList(Map.of( "Action", "sts:AssumeRole", "Effect", "Allow", "Principal", Collections.singletonMap( "Service", Collections.singletonMap( "Fn::Join", Arrays.asList( "", Arrays.asList("states.", Match.anyValue(), ".amazonaws.com") ) ) ) )) )) ));
C#
// Fully assert on the state machine's IAM role with matchers. template.HasResource("AWS::IAM::Role", Match.ObjectEquals(new ObjectDict { { "AssumeRolePolicyDocument", new ObjectDict { { "Version", "2012-10-17" }, { "Action", "sts:AssumeRole" }, { "Principal", new ObjectDict { { "Version", "2012-10-17" }, { "Statement", new object[] { new ObjectDict { { "Action", "sts:AssumeRole" }, { "Effect", "Allow" }, { "Principal", new ObjectDict { { "Service", new ObjectDict { { "", new object[] { "states", Match.AnyValue(), ".amazonaws.com" } } } } } } } } } } } } } }));

CloudFormation 多くのリソースには、文字列として表されるシリアル化された JSON オブジェクトが含まれています。Match.serializedJson()マッチャーを使用して、この JSON 内のプロパティを照合できます。

たとえば、Step Functions ステートマシンは JSON ベースの Amazon ステート言語の文字列を使用して定義されますMatch.serializedJson()最初の状態が唯一のステップであることを確認するのに使用します。繰り返しになりますが、ネストされたマッチャーを使用して、オブジェクトのさまざまな部分にさまざまな種類のマッチングを適用します。

TypeScript
// Assert on the state machine's definition with the Match.serializedJson() // matcher. template.hasResourceProperties("AWS::StepFunctions::StateMachine", { DefinitionString: Match.serializedJson( // Match.objectEquals() is used implicitly, but we use it explicitly // here for extra clarity. Match.objectEquals({ StartAt: "StartState", States: { StartState: { Type: "Pass", End: true, // Make sure this state doesn't provide a next state -- we can't // provide both Next and set End to true. Next: Match.absent(), }, }, }) ), });
JavaScript
// Assert on the state machine's definition with the Match.serializedJson() // matcher. template.hasResourceProperties("AWS::StepFunctions::StateMachine", { DefinitionString: Match.serializedJson( // Match.objectEquals() is used implicitly, but we use it explicitly // here for extra clarity. Match.objectEquals({ StartAt: "StartState", States: { StartState: { Type: "Pass", End: true, // Make sure this state doesn't provide a next state -- we can't // provide both Next and set End to true. Next: Match.absent(), }, }, }) ), });
Python
# Assert on the state machine's definition with the serialized_json matcher. template.has_resource_properties( "AWS::StepFunctions::StateMachine", { "DefinitionString": Match.serialized_json( # Match.object_equals() is the default, but specify it here for clarity Match.object_equals( { "StartAt": "StartState", "States": { "StartState": { "Type": "Pass", "End": True, # Make sure this state doesn't provide a next state -- # we can't provide both Next and set End to true. "Next": Match.absent(), }, }, } ) ), }, )
Java
// Assert on the state machine's definition with the Match.serializedJson() matcher. template.hasResourceProperties("AWS::StepFunctions::StateMachine", Collections.singletonMap( "DefinitionString", Match.serializedJson( // Match.objectEquals() is used implicitly, but we use it explicitly here for extra clarity. Match.objectEquals(Map.of( "StartAt", "StartState", "States", Collections.singletonMap( "StartState", Map.of( "Type", "Pass", "End", true, // Make sure this state doesn't provide a next state -- we can't provide // both Next and set End to true. "Next", Match.absent() ) ) )) ) ));
C#
// Assert on the state machine's definition with the Match.serializedJson() matcher template.HasResourceProperties("AWS::StepFunctions::StateMachine", new ObjectDict { { "DefinitionString", Match.SerializedJson( // Match.objectEquals() is used implicitly, but we use it explicitly here for extra clarity. Match.ObjectEquals(new ObjectDict { { "StartAt", "StartState" }, { "States", new ObjectDict { { "StartState", new ObjectDict { { "Type", "Pass" }, { "End", "True" }, // Make sure this state doesn't provide a next state -- we can't provide // both Next and set End to true. { "Next", Match.Absent() } }} }} }) )}});

キャプチャ

プロパティの正確な値を事前に知らなくても、プロパティが特定の形式に従っているか、別のプロパティと同じ値であることを確認するためにプロパティをテストしておくと便利なことがよくあります。assertionsこのモジュールは、Captureこのクラスの機能を備えています。

Captureの値の代わりにインスタンスを指定するとhasResourcePropertiesCaptureその値はオブジェクトに保持されます。実際にキャプチャされた値は、、asなどのオブジェクトのメソッドを使用して取得できasNumber()asString()asObject、テストの対象となります。Captureマッチャーと一緒に使用して、シリアル化された JSON プロパティを含むリソースのプロパティ内でキャプチャする値の正確な位置を指定します。

次の例では、ステートマシンの開始ステートの名前が「」で始まることを確認するテストを行っていますStart。また、この状態がマシンの状態リストに含まれているかどうかもテストします。

TypeScript
// Capture some data from the state machine's definition. const startAtCapture = new Capture(); const statesCapture = new Capture(); template.hasResourceProperties("AWS::StepFunctions::StateMachine", { DefinitionString: Match.serializedJson( Match.objectLike({ StartAt: startAtCapture, States: statesCapture, }) ), }); // Assert that the start state starts with "Start". expect(startAtCapture.asString()).toEqual(expect.stringMatching(/^Start/)); // Assert that the start state actually exists in the states object of the // state machine definition. expect(statesCapture.asObject()).toHaveProperty(startAtCapture.asString());
JavaScript
// Capture some data from the state machine's definition. const startAtCapture = new Capture(); const statesCapture = new Capture(); template.hasResourceProperties("AWS::StepFunctions::StateMachine", { DefinitionString: Match.serializedJson( Match.objectLike({ StartAt: startAtCapture, States: statesCapture, }) ), }); // Assert that the start state starts with "Start". expect(startAtCapture.asString()).toEqual(expect.stringMatching(/^Start/)); // Assert that the start state actually exists in the states object of the // state machine definition. expect(statesCapture.asObject()).toHaveProperty(startAtCapture.asString());
Python
import re from aws_cdk.assertions import Capture # ... # Capture some data from the state machine's definition. start_at_capture = Capture() states_capture = Capture() template.has_resource_properties( "AWS::StepFunctions::StateMachine", { "DefinitionString": Match.serialized_json( Match.object_like( { "StartAt": start_at_capture, "States": states_capture, } ) ), }, ) # Assert that the start state starts with "Start". assert re.match("^Start", start_at_capture.as_string()) # Assert that the start state actually exists in the states object of the # state machine definition. assert start_at_capture.as_string() in states_capture.as_object()
Java
// Capture some data from the state machine's definition. final Capture startAtCapture = new Capture(); final Capture statesCapture = new Capture(); template.hasResourceProperties("AWS::StepFunctions::StateMachine", Collections.singletonMap( "DefinitionString", Match.serializedJson( Match.objectLike(Map.of( "StartAt", startAtCapture, "States", statesCapture )) ) )); // Assert that the start state starts with "Start". assertThat(startAtCapture.asString()).matches("^Start.+"); // Assert that the start state actually exists in the states object of the state machine definition. assertThat(statesCapture.asObject()).containsKey(startAtCapture.asString());
C#
// Capture some data from the state machine's definition. var startAtCapture = new Capture(); var statesCapture = new Capture(); template.HasResourceProperties("AWS::StepFunctions::StateMachine", new ObjectDict { { "DefinitionString", Match.SerializedJson( new ObjectDict { { "StartAt", startAtCapture }, { "States", statesCapture } } )} }); Assert.IsTrue(startAtCapture.ToString().StartsWith("Start")); Assert.IsTrue(statesCapture.AsObject().ContainsKey(startAtCapture.ToString()));

スナップショットテスト

スナップショットテストでは、 CloudFormation合成されたテンプレート全体を以前に保存されたマスターと比較します。きめ細かなアサーションとは異なり、スナップショットテストは回帰の検出には役立ちません。これは、スナップショットテストはテンプレート全体に適用され、コードの変更以外にも合成結果に小さな(または not-so-small)違いが生じる可能性があるためです。

たとえば、CDK 構成を更新して新しいベストプラクティスを組み込むと、合成されたリソースやその構成が変更される可能性があります。または、CDK Toolkit を更新して追加のメタデータを報告することもできます。コンテキスト値を変更すると、合成テンプレートにも影響する可能性があります。

ただし、スナップショットテストは、合成されたテンプレートに影響を与える可能性のある他のすべての要因を一定に保つ限り、リファクタリングに非常に役立ちます。行った変更によってテンプレートが意図せず変更されたかどうかは、すぐにわかります。変更が意図的なものである場合は、新しいマスターを受け入れて続行してください。

たとえば、DeadLetterQueue次のような構造体があるとします。

TypeScript
export class DeadLetterQueue extends sqs.Queue { public readonly messagesInQueueAlarm: cloudwatch.IAlarm; constructor(scope: Construct, id: string) { super(scope, id); // Add the alarm this.messagesInQueueAlarm = new cloudwatch.Alarm(this, 'Alarm', { alarmDescription: 'There are messages in the Dead Letter Queue', evaluationPeriods: 1, threshold: 1, metric: this.metricApproximateNumberOfMessagesVisible(), }); } }
JavaScript
class DeadLetterQueue extends sqs.Queue { constructor(scope, id) { super(scope, id); // Add the alarm this.messagesInQueueAlarm = new cloudwatch.Alarm(this, 'Alarm', { alarmDescription: 'There are messages in the Dead Letter Queue', evaluationPeriods: 1, threshold: 1, metric: this.metricApproximateNumberOfMessagesVisible(), }); } } module.exports = { DeadLetterQueue }
Python
class DeadLetterQueue(sqs.Queue): def __init__(self, scope: Construct, id: str): super().__init__(scope, id) self.messages_in_queue_alarm = cloudwatch.Alarm( self, "Alarm", alarm_description="There are messages in the Dead Letter Queue.", evaluation_periods=1, threshold=1, metric=self.metric_approximate_number_of_messages_visible(), )
Java
public class DeadLetterQueue extends Queue { private final IAlarm messagesInQueueAlarm; public DeadLetterQueue(@NotNull Construct scope, @NotNull String id) { super(scope, id); this.messagesInQueueAlarm = Alarm.Builder.create(this, "Alarm") .alarmDescription("There are messages in the Dead Letter Queue.") .evaluationPeriods(1) .threshold(1) .metric(this.metricApproximateNumberOfMessagesVisible()) .build(); } public IAlarm getMessagesInQueueAlarm() { return messagesInQueueAlarm; } }
C#
namespace AwsCdkAssertionSamples { public class DeadLetterQueue : Queue { public IAlarm messagesInQueueAlarm; public DeadLetterQueue(Construct scope, string id) : base(scope, id) { messagesInQueueAlarm = new Alarm(this, "Alarm", new AlarmProps { AlarmDescription = "There are messages in the Dead Letter Queue.", EvaluationPeriods = 1, Threshold = 1, Metric = this.MetricApproximateNumberOfMessagesVisible() }); } } }

次のようにテストできます。

TypeScript
import { Match, Template } from "@aws-cdk/assertions"; import * as cdk from "@aws-cdk/core"; import { DeadLetterQueue } from "../lib/dead-letter-queue"; describe("DeadLetterQueue", () => { test("matches the snapshot", () => { const stack = new cdk.Stack(); new DeadLetterQueue(stack, "DeadLetterQueue"); const template = Template.fromStack(stack); expect(template.toJSON()).toMatchSnapshot(); }); });
JavaScript
const { Match, Template } = require("@aws-cdk/assertions"); const cdk = require("@aws-cdk/core"); const { DeadLetterQueue } = require("../lib/dead-letter-queue"); describe("DeadLetterQueue", () => { test("matches the snapshot", () => { const stack = new cdk.Stack(); new DeadLetterQueue(stack, "DeadLetterQueue"); const template = Template.fromStack(stack); expect(template.toJSON()).toMatchSnapshot(); }); });
Python
from aws_cdk import core as cdk from aws_cdk.assertions import Match, Template from app.dead_letter_queue import DeadLetterQueue def snapshot_test(): stack = cdk.Stack() DeadLetterQueue(stack, "DeadLetterQueue") template = Template.from_stack(stack) assert template.to_json() == snapshot
Java
package software.amazon.samples.awscdkassertionssamples; import org.junit.jupiter.api.Test; import au.com.origin.snapshots.Expect; import software.amazon.awscdk.assertions.Match; import software.amazon.awscdk.assertions.Template; import software.amazon.awscdk.core.Stack; import java.util.Collections; import java.util.Map; public class DeadLetterQueueTest { @Test public void snapshotTest() { final Stack stack = new Stack(); new DeadLetterQueue(stack, "DeadLetterQueue"); final Template template = Template.fromStack(stack); expect.toMatchSnapshot(template.toJSON()); } }
C#
using Microsoft.VisualStudio.TestTools.UnitTesting; using Amazon.CDK; using Amazon.CDK.Assertions; using AwsCdkAssertionSamples; using ObjectDict = System.Collections.Generic.Dictionary<string, object>; using StringDict = System.Collections.Generic.Dictionary<string, string>; namespace TestProject1 { [TestClass] public class ProcessorStackTest [TestClass] public class DeadLetterQueueTest { [TestMethod] public void SnapshotTest() { var stack = new Stack(); new DeadLetterQueue(stack, "DeadLetterQueue"); var template = Template.FromStack(stack); return Verifier.Verify(template.ToJSON()); } } }

テストのヒント

テストはテストするコードと同じ期間有効であり、同じ頻度で読み取られたり変更されたりすることを覚えておいてください。したがって、少し時間を取って、それらをどのように書くのが最善かを考えることは有益です。

設定行や一般的なアサーションをコピーして貼り付けないでください。代わりに、このロジックをフィクスチャまたはヘルパー関数にリファクタリングしてください。各テストが実際にテストする内容を反映した適切な名前を使用してください。

1回のテストであまり多くのことをしようとしないでください。テストでは、1 つの動作を 1 つだけテストするのが望ましいです。誤ってこの動作を中断した場合、失敗するテストは 1 つだけで、テストの名前から何が失敗したかがわかります。ただし、これはより理想的です。複数の動作をテストするテストを必然的に(または不注意に)作成することもあります。すでに説明した理由により、スナップショットテストは特にこの問題が発生しやすいため、慎重に使用してください。