Namespace Amazon.CDK.IntegTests
integ-tests
---AWS CDK v1 has reached End-of-Support on 2023-06-01.
This package is no longer being updated, and users should migrate to AWS CDK v2.
For more information on how to migrate, see the Migrating to AWS CDK v2 guide.
Overview
This library is meant to be used in combination with the integ-runner CLI to enable users to write and execute integration tests for AWS CDK Constructs.
An integration test should be defined as a CDK application, and there should be a 1:1 relationship between an integration test and a CDK application.
So for example, in order to create an integration test called my-function
we would need to create a file to contain our integration test application.
test/integ.my-function.ts
var app = new App();
var stack = new Stack();
new Function(stack, "MyFunction", new FunctionProps {
Runtime = Runtime.NODEJS_14_X,
Handler = "index.handler",
Code = Code.FromAsset(Join(__dirname, "lambda-handler"))
});
This is a self contained CDK application which we could deploy by running
cdk deploy --app 'node test/integ.my-function.js'
In order to turn this into an integration test, all that is needed is to
use the IntegTest
construct.
App app;
Stack stack;
new IntegTest(app, "Integ", new IntegTestProps { TestCases = new [] { stack } });
You will notice that the stack
is registered to the IntegTest
as a test case.
Each integration test can contain multiple test cases, which are just instances
of a stack. See the Usage section for more details.
Usage
IntegTest
Suppose you have a simple stack, that only encapsulates a Lambda function with a certain handler:
class StackUnderTestProps : StackProps
{
public Architecture? Architecture { get; set; }
}
class StackUnderTest : Stack
{
public StackUnderTest(Construct scope, string id, StackUnderTestProps props) : base(scope, id, props)
{
new Function(this, "Handler", new FunctionProps {
Runtime = Runtime.NODEJS_14_X,
Handler = "index.handler",
Code = Code.FromAsset(Join(__dirname, "lambda-handler")),
Architecture = props.Architecture
});
}
}
You may want to test this stack under different conditions. For example, we want
this stack to be deployed correctly, regardless of the architecture we choose
for the Lambda function. In particular, it should work for both ARM_64
and
X86_64
. So you can create an IntegTestCase
that exercises both scenarios:
class StackUnderTestProps : StackProps
{
public Architecture? Architecture { get; set; }
}
class StackUnderTest : Stack
{
public StackUnderTest(Construct scope, string id, StackUnderTestProps props) : base(scope, id, props)
{
new Function(this, "Handler", new FunctionProps {
Runtime = Runtime.NODEJS_14_X,
Handler = "index.handler",
Code = Code.FromAsset(Join(__dirname, "lambda-handler")),
Architecture = props.Architecture
});
}
}
// Beginning of the test suite
var app = new App();
new IntegTest(app, "DifferentArchitectures", new IntegTestProps {
TestCases = new [] {
new StackUnderTest(app, "Stack1", new StackUnderTestProps {
Architecture = Architecture.ARM_64
}),
new StackUnderTest(app, "Stack2", new StackUnderTestProps {
Architecture = Architecture.X86_64
}) }
});
This is all the instruction you need for the integration test runner to know which stacks to synthesize, deploy and destroy. But you may also need to customize the behavior of the runner by changing its parameters. For example:
var app = new App();
var stackUnderTest = new Stack(app, "StackUnderTest");
var stack = new Stack(app, "stack");
var testCase = new IntegTest(app, "CustomizedDeploymentWorkflow", new IntegTestProps {
TestCases = new [] { stackUnderTest },
DiffAssets = true,
StackUpdateWorkflow = true,
CdkCommandOptions = new CdkCommands {
Deploy = new DeployCommand {
Args = new DeployOptions {
RequireApproval = RequireApproval.NEVER,
Json = true
}
},
Destroy = new DestroyCommand {
Args = new DestroyOptions {
Force = true
}
}
}
});
IntegTestCaseStack
In the majority of cases an integration test will contain a single IntegTestCase
.
By default when you create an IntegTest
an IntegTestCase
is created for you
and all of your test cases are registered to this IntegTestCase
. The IntegTestCase
and IntegTestCaseStack
constructs are only needed when it is necessary to
defined different options for individual test cases.
For example, you might want to have one test case where diffAssets
is enabled.
App app;
Stack stackUnderTest;
var testCaseWithAssets = new IntegTestCaseStack(app, "TestCaseAssets", new IntegTestCaseStackProps {
DiffAssets = true
});
new IntegTest(app, "Integ", new IntegTestProps { TestCases = new [] { stackUnderTest, testCaseWithAssets } });
Assertions
This library also provides a utility to make assertions against the infrastructure that the integration test deploys.
There are two main scenarios in which assertions are created.
In this case you would create an integration test using the IntegTest
construct and then make assertions using the assert
property.
You should not utilize the assertion constructs directly, but should instead use the methods
on IntegTest.assert
.
App app;
Stack stack;
var integ = new IntegTest(app, "Integ", new IntegTestProps { TestCases = new [] { stack } });
integ.Assertions.AwsApiCall("S3", "getObject");
In this case you may be using assertions as part of a normal CDK deployment in order to make an assertion on the infrastructure before the deployment is considered successful. In this case you can utilize the assertions constructs directly.
Stack myAppStack;
new AwsApiCall(myAppStack, "GetObject", new AwsApiCallProps {
Service = "S3",
Api = "getObject"
});
DeployAssert
Assertions are created by using the DeployAssert
construct. This construct creates it's own Stack
separate from
any stacks that you create as part of your integration tests. This Stack
is treated differently from other stacks
by the integ-runner
tool. For example, this stack will not be diffed by the integ-runner
.
DeployAssert
also provides utilities to register your own assertions.
CustomResource myCustomResource;
Stack stack;
App app;
var integ = new IntegTest(app, "Integ", new IntegTestProps { TestCases = new [] { stack } });
integ.Assertions.Expect("CustomAssertion", ExpectedResult.ObjectLike(new Dictionary<string, object> { { "foo", "bar" } }), ActualResult.FromCustomResource(myCustomResource, "data"));
In the above example an assertion is created that will trigger a user defined CustomResource
and assert that the data
attribute is equal to { foo: 'bar' }
.
AwsApiCall
A common method to retrieve the "actual" results to compare with what is expected is to make an AWS API call to receive some data. This library does this by utilizing CloudFormation custom resources which means that CloudFormation will call out to a Lambda Function which will use the AWS JavaScript SDK to make the API call.
This can be done by using the class directory (in the case of a normal deployment):
Stack stack;
new AwsApiCall(stack, "MyAssertion", new AwsApiCallProps {
Service = "SQS",
Api = "receiveMessage",
Parameters = new Dictionary<string, string> {
{ "QueueUrl", "url" }
}
});
Or by using the awsApiCall
method on DeployAssert
(when writing integration tests):
App app;
Stack stack;
var integ = new IntegTest(app, "Integ", new IntegTestProps {
TestCases = new [] { stack }
});
integ.Assertions.AwsApiCall("SQS", "receiveMessage", new Dictionary<string, string> {
{ "QueueUrl", "url" }
});
EqualsAssertion
This library currently provides the ability to assert that two values are equal
to one another by utilizing the EqualsAssertion
class. This utilizes a Lambda
backed CustomResource
which in tern uses the Match utility from the
@aws-cdk/assertions library.
App app;
Stack stack;
Queue queue;
IFunction fn;
var integ = new IntegTest(app, "Integ", new IntegTestProps {
TestCases = new [] { stack }
});
integ.Assertions.InvokeFunction(new LambdaInvokeFunctionProps {
FunctionName = fn.FunctionName,
InvocationType = InvocationType.EVENT,
Payload = JSON.Stringify(new Dictionary<string, string> { { "status", "OK" } })
});
var message = integ.Assertions.AwsApiCall("SQS", "receiveMessage", new Dictionary<string, object> {
{ "QueueUrl", queue.QueueUrl },
{ "WaitTimeSeconds", 20 }
});
message.AssertAtPath("Messages.0.Body", ExpectedResult.ObjectLike(new Dictionary<string, object> {
{ "requestContext", new Dictionary<string, string> {
{ "condition", "Success" }
} },
{ "requestPayload", new Dictionary<string, string> {
{ "status", "OK" }
} },
{ "responseContext", new Dictionary<string, int> {
{ "statusCode", 200 }
} },
{ "responsePayload", "success" }
}));
Match
integ-tests
also provides a Match
utility similar to the @aws-cdk/assertions
module. Match
can be used to construct the ExpectedResult
.
AwsApiCall message;
message.Expect(ExpectedResult.ObjectLike(new Dictionary<string, object> {
{ "Messages", Match.ArrayWith(new [] { new Dictionary<string, IDictionary<string, IDictionary<string, object[]>>> {
{ "Body", new Struct {
Values = Match.ArrayWith(new [] { new Dictionary<string, int> { { "Asdf", 3 } } }),
Message = Match.StringLikeRegexp("message")
} }
} }) }
}));
Examples
Invoke a Lambda Function
In this example there is a Lambda Function that is invoked and we assert that the payload that is returned is equal to '200'.
IFunction lambdaFunction;
App app;
var stack = new Stack(app, "cdk-integ-lambda-bundling");
var integ = new IntegTest(app, "IntegTest", new IntegTestProps {
TestCases = new [] { stack }
});
var invoke = integ.Assertions.InvokeFunction(new LambdaInvokeFunctionProps {
FunctionName = lambdaFunction.FunctionName
});
invoke.Expect(ExpectedResult.ObjectLike(new Dictionary<string, object> {
{ "Payload", "200" }
}));
Make an AWS API Call
In this example there is a StepFunctions state machine that is executed and then we assert that the result of the execution is successful.
App app;
Stack stack;
IStateMachine sm;
var testCase = new IntegTest(app, "IntegTest", new IntegTestProps {
TestCases = new [] { stack }
});
// Start an execution
var start = testCase.Assertions.AwsApiCall("StepFunctions", "startExecution", new Dictionary<string, string> {
{ "stateMachineArn", sm.StateMachineArn }
});
// describe the results of the execution
var describe = testCase.Assertions.AwsApiCall("StepFunctions", "describeExecution", new Dictionary<string, string> {
{ "executionArn", start.GetAttString("executionArn") }
});
// assert the results
describe.Expect(ExpectedResult.ObjectLike(new Dictionary<string, object> {
{ "status", "SUCCEEDED" }
}));
Classes
ActualResult | (experimental) Represents the "actual" results to compare. |
AssertionRequest | (experimental) A request to make an assertion that the actual value matches the expected. |
AssertionResult | (experimental) The result of an Assertion wrapping the actual result data in another struct. |
AssertionResultData | (experimental) The result of an assertion. |
AssertionsProvider | (experimental) Represents an assertions provider. |
AssertionType | (experimental) The type of assertion to perform. |
AwsApiCall | (experimental) Construct that creates a custom resource that will perform a query using the AWS SDK. |
AwsApiCallOptions | (experimental) Options to perform an AWS JavaScript V2 API call. |
AwsApiCallProps | (experimental) Options for creating an SDKQuery provider. |
AwsApiCallRequest | (experimental) A AWS JavaScript SDK V2 request. |
AwsApiCallResult | (experimental) The result from a SdkQuery. |
EqualsAssertion | (experimental) Construct that creates a CustomResource to assert that two values are equal. |
EqualsAssertionProps | (experimental) Options for an EqualsAssertion. |
ExpectedResult | (experimental) Represents the "expected" results to compare. |
IntegTest | (experimental) A collection of test cases. |
IntegTestCase | (experimental) An integration test case. Allows the definition of test properties that apply to all stacks under this case. |
IntegTestCaseProps | (experimental) Properties of an integration test case. |
IntegTestCaseStack | (experimental) An integration test case stack. Allows the definition of test properties that should apply to this stack. |
IntegTestCaseStackProps | (experimental) Properties of an integration test case stack. |
IntegTestProps | (experimental) Integration test properties. |
InvocationType | (experimental) The type of invocation. |
LambdaInvokeFunction | (experimental) An AWS Lambda Invoke function API call. |
LambdaInvokeFunctionProps | (experimental) Options to pass to the Lambda invokeFunction API call. |
LogType | (experimental) Set to Tail to include the execution log in the response. |
Match | (experimental) Partial and special matching during assertions. |
Status | (experimental) The status of the assertion. |
Interfaces
IAssertionRequest | (experimental) A request to make an assertion that the actual value matches the expected. |
IAssertionResult | (experimental) The result of an Assertion wrapping the actual result data in another struct. |
IAssertionResultData | (experimental) The result of an assertion. |
IAwsApiCall | (experimental) Interface for creating a custom resource that will perform an API call using the AWS SDK. |
IAwsApiCallOptions | (experimental) Options to perform an AWS JavaScript V2 API call. |
IAwsApiCallProps | (experimental) Options for creating an SDKQuery provider. |
IAwsApiCallRequest | (experimental) A AWS JavaScript SDK V2 request. |
IAwsApiCallResult | (experimental) The result from a SdkQuery. |
IDeployAssert | (experimental) Interface that allows for registering a list of assertions that should be performed on a construct. |
IEqualsAssertionProps | (experimental) Options for an EqualsAssertion. |
IIntegTestCaseProps | (experimental) Properties of an integration test case. |
IIntegTestCaseStackProps | (experimental) Properties of an integration test case stack. |
IIntegTestProps | (experimental) Integration test properties. |
ILambdaInvokeFunctionProps | (experimental) Options to pass to the Lambda invokeFunction API call. |