software.amazon.awscdk.integtests

Interface IDeployAssert

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IDeployAssert.Jsii$Default

All Known Implementing Classes:

IDeployAssert.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:58.394Z")
 @Stability(value=Experimental)
public interface IDeployAssert
extends software.amazon.jsii.JsiiSerializable

(experimental) Interface that allows for registering a list of assertions that should be performed on a construct.

This is only necessary when writing integration tests.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IDeployAssert.Jsii$Default Internal default implementation for IDeployAssert.
static class	IDeployAssert.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
IAwsApiCall	awsApiCall(String service, String api) (experimental) Query AWS using JavaScript SDK V2 API calls.
IAwsApiCall	awsApiCall(String service, String api, Object parameters) (experimental) Query AWS using JavaScript SDK V2 API calls.
void	expect(String id, ExpectedResult expected, ActualResult actual) (experimental) Assert that the ExpectedResult is equal to the ActualResult.
IAwsApiCall	invokeFunction(LambdaInvokeFunctionProps props) (experimental) Invoke a lambda function and return the response which can be asserted.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

awsApiCall

@Stability(value=Experimental)
 @NotNull
IAwsApiCall awsApiCall(@NotNull
                                                                String service,
                                                                @NotNull
                                                                String api,
                                                                @Nullable
                                                                Object parameters)

(experimental) Query AWS using JavaScript SDK V2 API calls.

This can be used to either trigger an action or to return a result that can then be asserted against an expected value

Example:

 App app;
 IntegTest integ;
 integ.assertions.awsApiCall("SQS", "sendMessage", Map.of(
         "QueueUrl", "url",
         "MessageBody", "hello"));
 IAwsApiCall message = integ.assertions.awsApiCall("SQS", "receiveMessage", Map.of(
         "QueueUrl", "url"));
 message.expect(ExpectedResult.objectLike(Map.of(
         "Messages", List.of(Map.of("Body", "hello")))));
 

Parameters:

service - This parameter is required.

api - This parameter is required.

parameters -

awsApiCall

@Stability(value=Experimental)
 @NotNull
IAwsApiCall awsApiCall(@NotNull
                                                                String service,
                                                                @NotNull
                                                                String api)

(experimental) Query AWS using JavaScript SDK V2 API calls.

This can be used to either trigger an action or to return a result that can then be asserted against an expected value

Example:

 App app;
 IntegTest integ;
 integ.assertions.awsApiCall("SQS", "sendMessage", Map.of(
         "QueueUrl", "url",
         "MessageBody", "hello"));
 IAwsApiCall message = integ.assertions.awsApiCall("SQS", "receiveMessage", Map.of(
         "QueueUrl", "url"));
 message.expect(ExpectedResult.objectLike(Map.of(
         "Messages", List.of(Map.of("Body", "hello")))));
 

Parameters:

service - This parameter is required.

api - This parameter is required.

expect

@Stability(value=Experimental)
void expect(@NotNull
                                           String id,
                                           @NotNull
                                           ExpectedResult expected,
                                           @NotNull
                                           ActualResult actual)

(experimental) Assert that the ExpectedResult is equal to the ActualResult.

Example:

 IntegTest integ;
 AwsApiCall apiCall;
 integ.assertions.expect("invoke", ExpectedResult.objectLike(Map.of("Payload", "OK")), ActualResult.fromAwsApiCall(apiCall, "Body"));
 

Parameters:

id - This parameter is required.

expected - This parameter is required.

actual - This parameter is required.

invokeFunction

@Stability(value=Experimental)
 @NotNull
IAwsApiCall invokeFunction(@NotNull
                                                                    LambdaInvokeFunctionProps props)

(experimental) Invoke a lambda function and return the response which can be asserted.

Example:

 App app;
 IntegTest integ;
 IAwsApiCall invoke = integ.assertions.invokeFunction(LambdaInvokeFunctionProps.builder()
         .functionName("my-function")
         .build());
 invoke.expect(ExpectedResult.objectLike(Map.of(
         "Payload", "200")));
 

Parameters:

props - This parameter is required.