Skip to content
v2.275.0

Experimental

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

EqualsAssertion ​

Construct that creates a CustomResource to assert that two values are equal.

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';
import { aws_lambda as lambda } from 'aws-cdk-lib';

declare const actualResult: integ_tests_alpha.ActualResult;
declare const expectedResult: integ_tests_alpha.ExpectedResult;
const equalsAssertion = new integ_tests_alpha.EqualsAssertion(this, 'MyEqualsAssertion', {
  actual: actualResult,
  expected: expectedResult,

  // the properties below are optional
  failDeployment: false,
  providerLogLevel: lambda.ApplicationLogLevel.INFO,
});
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
from aws_cdk import aws_lambda as lambda_

# actual_result: integ_tests_alpha.ActualResult
# expected_result: integ_tests_alpha.ExpectedResult

equals_assertion = integ_tests_alpha.EqualsAssertion(self, "MyEqualsAssertion",
    actual=actual_result,
    expected=expected_result,

    # the properties below are optional
    fail_deployment=False,
    provider_log_level=lambda_.ApplicationLogLevel.INFO
)
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.*;
import software.amazon.awscdk.services.lambda.*;

ActualResult actualResult;
ExpectedResult expectedResult;

EqualsAssertion equalsAssertion = EqualsAssertion.Builder.create(this, "MyEqualsAssertion")
        .actual(actualResult)
        .expected(expectedResult)

        // the properties below are optional
        .failDeployment(false)
        .providerLogLevel(ApplicationLogLevel.INFO)
        .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;
using Amazon.CDK.AWS.Lambda;

ActualResult actualResult;
ExpectedResult expectedResult;

var equalsAssertion = new EqualsAssertion(this, "MyEqualsAssertion", new EqualsAssertionProps {
    Actual = actualResult,
    Expected = expectedResult,

    // the properties below are optional
    FailDeployment = false,
    ProviderLogLevel = ApplicationLogLevel.INFO
});
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"
import "github.com/aws/aws-cdk-go/awscdk"

var actualResult ActualResult
var expectedResult ExpectedResult

equalsAssertion := integ_tests_alpha.NewEqualsAssertion(this, jsii.String("MyEqualsAssertion"), &EqualsAssertionProps{
	Actual: actualResult,
	Expected: expectedResult,

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

Initializer ​

ts
new EqualsAssertion(scope: Construct, id: string, props: EqualsAssertionProps)
python
EqualsAssertion(scope: Construct, id: str, props: EqualsAssertionProps)
java
new EqualsAssertion(Construct scope, String id, EqualsAssertionProps props)
csharp
new EqualsAssertion(Construct scope, string id, EqualsAssertionProps props)
go
NewEqualsAssertion(Scope Construct, Id *string, Props EqualsAssertionProps)

Construct Props ​

The actual results to compare.
expectedExpectedResultexpectedExpectedResultexpectedExpectedResultExpectedExpectedResultExpectedExpectedResultrequired#
The expected result 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.

providerLogLeveloptionalApplicationLogLevelprovider_log_leveloptionalApplicationLogLevelproviderLogLeveloptionalApplicationLogLevelProviderLogLeveloptionalApplicationLogLevelProviderLogLeveloptionalApplicationLogLevel= ApplicationLogLevel.FATAL#
The log level of the provider lambda function.

Properties ​

nodeNodenodeNodenodeNodeNodeNodeNodeNode#
The tree node.
resultstringresultstrresultStringResultstringResult*string#
The result of the assertion.

Methods ​

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining