<script type="module">
import lambdaTdd from 'https://cdn.skypack.dev/lambda-tdd';
</script>
README
Test Framework for AWS Lambda
Testing Framework for AWS Lambda. Very useful for integration testing as you can examine how your lambda function executes for certain input and specific environment variables. Tries to model the cloud execution as closely as possible.
You can pass an array of test files to the execute() function or a regular expression pattern. By default tests are auto detected. If a pattern is passed in only matching tests are executed.
The example above allows for use of a --filter=REGEX parameter to only execute specific tests.
Note: If you are running e.g. npm t to run your tests you need to specify the filter option with quadruple dashes. Example:
Handler file containing the handler functions (specified in test).
cassetteFolder
Type: string
Default: __cassettes
Folder containing nock recordings.
envVarYml
Type: string
Default: env-vars.yml
Specify yaml file containing environment variables. To allow overwriting of existing environment variables prefix with ^. Otherwise an exception is thrown.
Environment variables set by default are AWS_REGION, AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY since these always get set by the AWS Lambda environment.
envVarYmlRecording
Type: string
Default: env-vars.recording.yml
Similar to envVarYml. Environment variables declared get applied on top of envVarYml iff this is a new test recording.
Great when secrets are needed to record tests, but they should not be committed (recommendation is to git ignore this file).
testFolder
Type: string
Default: ``
Folder containing test files.
flush
Type: array
Default: ["aws-sdk"]
List of dependencies that are required to be flushed before test run.
Useful if you need to re-initialize a module that automatically picks up
environment variables on initialization (e.g. aws-sdk).
The current project files are always flushed between test runs.
This can not be used for natively compiled modules.
stripHeaders
Type: boolean
Default: false
Remove rawHeaders from recordings automatically when recording.
modifiers
Type: object
Default: {}
Allows definition of custom test file modifiers for expect and event and for cassette recordings (pipe operator).
Default custom modifiers are: toBase64, toGzip and jsonStringify
reqHeaderOverwrite
Type: object
Default: {}
Used to define overwrite values for cassette reqheaders.
Test File Format
handler
Type: string Required
The handler inside the handler file, i.e. if handler.js contained
Contains environment variables that are set for this test. Existing environment variables can be overwritten.
timestamp
Type unix
Default: Unfrozen
Set unix timestamp that test executing will see. Time does not progress if this option is set.
seed
Type string
Default: undefined
Seed used for randomly generated bytes. This mocks crypto.randomBytes.
reseed
Type boolean
Default: false
By default every "random function" is seeded once per test run.
When set to true every function is re-seeded for every invocation.
Will greatly reduce "randomness" when set to true.
timeout
Type integer
Default: Mocha Default Timeout
Set custom timeout in ms for lambda execution. Handy e.g. when recording nock requests.
event
Type object
Default: undefined
Event object that is passed to lambda handler.
Custom actions can be applied by using the pipe character, e.g. { "body|JSON.stringify": {...} } could be used to make input more readable. For more examples see tests.
lambdaTimeout
Type integer
Default: 300000
Set initial lambda timeout in ms. Exposed in lambda function through context.getRemainingTimeInMillis().
The timeout is not enforced, but progresses as expected unless timestamp option is used.
success
Type boolean Required
True iff execution is expected to succeed, i.e. no error is passed into callback.
expect, expect(...)
Type array
Default: []
Handle evaluation of response or error (uses success flag). Can define target path, e.g. expect(some.path). Can also apply function with e.g. expect(body|JSON.parse).
More details on dynamic expect handling below.
response (DEPRECATED)
Type array
Default: []
Deprecated. Use "expect" instead.
Dynamic expect logic executed against the response string. More details on dynamic expect handling below.
error (DEPRECATED)
Type array
Default: []
Deprecated. Use "expect" instead.
Dynamic expect logic executed against the error string. More details on dynamic expect handling below.
body (DEPRECATED)
Type array
Default: []
Deprecated. Use "expect" instead.
Dynamic expect logic executed against the response.body string. More details on dynamic expect handling below.
logs, logs(...)
Type array
Default: []
Dynamic expect logic executed against the console output. You can use warn, info, error and log to access the different log level with e.g. logs([error]). More details on dynamic expect handling below.
nock
Type array
Default: []
Dynamic expect logic executed against the nock recording. More details on dynamic expect handling below.
Note that the nock recording must already exist for this check to evaluate correctly.
Important: If you are running into issues with replaying a cassette file you recorded previously, try editing the cassette and stripping information that might change. Also make sure cassette files never expose secret tokens or passwords!
stripHeaders
Type: boolean
Default: ?
Remove rawHeaders from recordings automatically when recording. Defaults depends on value set in runner options.
allowedUnmatchedRecordings
Type: array
Default: []
Can define the recordings that are allowed to be unmatched.
allowedOutOfOrderRecordings
Type: array
Default: []
Can define the recordings that are allowed to be out of order.
Dynamic Expect Logic
Uses Chai Assertion Library syntax written as json. Lets assume we have an output array [1, 2] we want to validate. We can write