Skip to content
v2.277.0

Experimental

@aws-cdk/integ-tests-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AssertionRequest Struct ​

A request to make an assertion that the actual value matches the expected.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as integ_tests_alpha from '@aws-cdk/integ-tests-alpha';

declare const actual: any;
declare const expected: any;
const assertionRequest: integ_tests_alpha.AssertionRequest = {
  actual: actual,
  expected: expected,

  // the properties below are optional
  failDeployment: false,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.integ_tests_alpha as integ_tests_alpha

# actual: Any
# expected: Any

assertion_request = integ_tests_alpha.AssertionRequest(
    actual=actual,
    expected=expected,

    # the properties below are optional
    fail_deployment=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.integtests.alpha.*;

Object actual;
Object expected;

AssertionRequest assertionRequest = AssertionRequest.builder()
        .actual(actual)
        .expected(expected)

        // the properties below are optional
        .failDeployment(false)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.IntegTests.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.IntegTests.Alpha;

var actual;
var expected;

var assertionRequest = new AssertionRequest {
    Actual = actual,
    Expected = expected,

    // the properties below are optional
    FailDeployment = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import integ_tests_alpha "github.com/aws/aws-cdk-go/awscdkintegtestsalpha"

var actual interface{}
var expected interface{}

assertionRequest := &AssertionRequest{
	Actual: actual,
	Expected: expected,

	// the properties below are optional
	FailDeployment: jsii.Boolean(false),
}

Properties ​

actualanyactualAnyactualObjectActualobjectActualinterface{} required #
The actual value received.
expectedanyexpectedAnyexpectedObjectExpectedobjectExpectedinterface{} required #
The expected value to assert.
failDeploymentoptionalbooleanfail_deploymentoptionalboolfailDeploymentoptionalBooleanFailDeploymentoptionalboolFailDeploymentoptional*bool = false #
Set this to true if a failed assertion should result in a CloudFormation deployment failure.

This is only necessary if assertions are being executed outside of integ-runner.