test - Extension Development for CloudFormation
DescriptionSynopsisOptionsExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

test

Description

Performs contract tests on the handlers of an extension type.

Synopsis

$ cfn test 
    [--endpoint <value>] 
    [--function-name <value>]
    [--region <value>]
    [--role-arn <value>]
    [-- -k <value>]
    [-- --tb=<value>]
    [--enforce-timeout <value>]

Options

--endpoint <value>

The endpoint at which the type can be invoked. Alternately, you can also specify an actual Lambda endpoint and function name in your Amazon Web Services account.

Default: http://127.0.0.1.3001

--function-name <value>

The logical Lambda function name in the Amazon SAM template. Alternately, you can also specify an actual Lambda endpoint and function name in your Amazon Web Services account.

Default: TestEntrypoint

--region <value>

The region to use for temporary credentials.

Default: us-east-1

--role-arn <value>

The Amazon Resource Name (ARN) of the IAM execution role for the contract tests to assume and use when performing operations.

If you don't specify an execution role, the contract tests use the environment credentials or the credentials specified in the Boto 3 credentials chain.

-- -k <value>

Runs a single unit test. For more information, see Using -k expr to select tests based on their name from the pytest documentation.

-- --tb=<value>

Default: auto

The following are valid values for the traceback. For more information, see Modifying Python traceback printing from the pytest documentation.

  • auto – long tracebacks for the first and last entry, but short tracebacks for all other entries.

  • long – exhaustive and informative traceback formatting.

  • short – shorter traceback format.

  • line – only one line per failure.

  • native – standard library formatting.

  • no – no traceback.

--enforce-timeout <value>

Sets the read and list timeout to 60 seconds and the create, update, and delete handler timeouts to 120 seconds.

Examples

The following command performs contract tests on the handlers of the extension type.

$ cfn test

The following command runs one contract test at a time.

$ cfn test -- -k test-name

The following command increases the timeout time when running contract tests.

$ cfn test --enforce-timeout 60

The following command combines the contract test and timeout time.

$ cfn test --enforce-timeout 60 -- -k test-name

The following command starts a Lambda service and uses the test command to perform contract tests.

$ sam local start-lambda
$ cfn test -v --enforce-timeout 90