@aws-cdk/integ-tests-alpha/lib/assertions/providers/lambda-handler/types.d.ts

CDK Integration Testing Constructs

export declare const ASSERT_RESOURCE_TYPE = "Custom::DeployAssert@AssertEquals";
export declare const SDK_RESOURCE_TYPE_PREFIX = "Custom::DeployAssert@SdkCall";
export declare const HTTP_RESOURCE_TYPE = "Custom::DeployAssert@HttpCall";
export interface HttpRequestParameters {
    /**
     * The url to fetch
     */
    readonly url: string;
    /**
     * Options for fetch
     */
    readonly fetchOptions?: FetchOptions;
}
/**
 * Request to the HttpCall resource
 */
export interface HttpRequest {
    /**
     * Parameters from the custom resource
     */
    readonly parameters: HttpRequestParameters;
    /**
     * Whether or not to flatten the response from the HTTP request
     *
     * Valid values are 'true' or 'false' as strings
     *
     * Typically when using an HttpRequest you will be passing it as the
     * `actual` value to an assertion provider so this would be set
     * to 'false' (you want the actual response).
     *
     * If you are using the HttpRequest to perform more of a query to return
     * a single value to use, then this should be set to 'true'.
     *
     * @default 'false'
     */
    readonly flattenResponse?: string;
}
/**
 * Options to pass to the JavaScript fetch api
 */
export interface FetchOptions {
    /**
     * Request body
     *
     * @default - no body
     */
    readonly body?: string;
    /**
     * Optional port
     *
     * @default default port for protocol
     */
    readonly port?: number;
    /**
     * HTTP method
     *
     * @default GET
     */
    readonly method?: string;
    /**
     * Optional request headers
     *
     * @default no headers
     */
    readonly headers?: {
        [key: string]: string;
    };
}
/**
 * Response from the HttpCall resource
 */
export interface HttpResponseWrapper {
    /**
     * The Response from the fetch request
     */
    readonly apiCallResponse: HttpResponse;
}
/**
 * Response from fetch
 */
export interface HttpResponse {
    /**
     * Indicates whether the response was successful
     *
     * status range 200-299
     */
    readonly ok?: boolean;
    /**
     * Status code of the response
     */
    readonly status?: number;
    /**
     * The status message corresponding to the status code
     */
    readonly statusText?: string;
    /**
     * The response, either as parsed JSON or a string literal.
     */
    readonly body?: any;
    /**
     * Headers associated with the response
     */
    readonly headers?: {
        [name: string]: any;
    };
}
/**
 * A AWS JavaScript SDK V2 request
 */
export interface AwsApiCallRequest {
    /**
     * The AWS service i.e. S3
     */
    readonly service: string;
    /**
     * The AWS api call to make i.e. getBucketLifecycle
     */
    readonly api: string;
    /**
     * Any parameters to pass to the api call
     *
     * @default - no parameters
     */
    readonly parameters?: any;
    /**
     * Whether or not to flatten the response from the api call
     *
     * Valid values are 'true' or 'false' as strings
     *
     * Typically when using an SdkRequest you will be passing it as the
     * `actual` value to an assertion provider so this would be set
     * to 'false' (you want the actual response).
     *
     * If you are using the SdkRequest to perform more of a query to return
     * a single value to use, then this should be set to 'true'. For example,
     * you could make a StepFunctions.startExecution api call and retrieve the
     * `executionArn` from the response.
     *
     * @default 'false'
     */
    readonly flattenResponse?: string;
    /**
     * Restrict the data returned by the API call to specific paths in
     * the API response. Use this to limit the data returned by the custom
     * resource if working with API calls that could potentially result in custom
     * response objects exceeding the hard limit of 4096 bytes.
     *
     * @default - return all data
     */
    readonly outputPaths?: string[];
}
/**
 * The result from a SdkQuery
 */
export interface AwsApiCallResult {
    /**
     * The full api response
     */
    readonly apiCallResponse: any;
}
/**
 * The type of assertion to perform
 */
export declare enum AssertionType {
    /**
     * Assert that two values are equal
     */
    EQUALS = "equals",
    /**
     * The keys and their values must be present in the target but the target
     * can be a superset.
     */
    OBJECT_LIKE = "objectLike",
    /**
     * Matches the specified pattern with the array
     * The set of elements must be in the same order as would be found
     */
    ARRAY_WITH = "arrayWith"
}
/**
 * A request to make an assertion that the
 * actual value matches the expected
 */
export interface AssertionRequest {
    /**
     * The expected value to assert
     */
    readonly expected: any;
    /**
     * The actual value received
     */
    readonly actual: any;
    /**
     * 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`.
     *
     * @default false
     */
    readonly failDeployment?: boolean;
}
/**
 * The result of an Assertion
 * wrapping the actual result data in another struct.
 * Needed to access the whole message via getAtt() on the custom resource.
 */
export interface AssertionResult {
    /**
     * The result of an assertion
     */
    readonly assertion: string;
    /**
     * Whether or not the assertion failed
     *
     * @default false
     */
    readonly failed?: boolean;
}
/**
 * The status of the assertion
 */
export declare enum Status {
    /**
     * The assertion passed
     */
    PASS = "pass",
    /**
     * The assertion failed
     */
    FAIL = "fail"
}
/**
 * The result of an assertion
 */
export interface AssertionResultData {
    /**
     * The status of the assertion, i.e.
     * pass or fail
     */
    readonly status: Status;
    /**
     * Any message returned with the assertion result
     * typically this will be the diff if there is any
     *
     * @default - none
     */
    readonly message?: string;
}