@lifeomic/test-tool-localstack
v5.2.1
Published
[![npm](https://img.shields.io/npm/v/@lifeomic/test-tool-localstack.svg)](https://www.npmjs.com/package/@lifeomic/test-tool-localstack) [![Build Status](https://github.com/lifeomic/test-tools/actions/workflows/release.yaml/badge.svg)](https://github.com/l
Downloads
505
Readme
@lifeomic/test-tool-localstack
Localstack docker setup and run tools.
startLocalstackDocker
Starts up a localstack docker instance with specified services.
LocalstackConnectionOptions
| Option (default) | Description |
|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| versionTag = 0.14 | Which version of localstack to use, must be >= 0.12.20. Not allowed to be latest. |
| nameTag = '' | Which of the three variants to use, light
or full
, with nothing specified defaulting to the localstack/localstack
default which is light |
| services | A list of SERVICES to start. Comma-separated list of AWS CLI service names or shorthands to start up. |
| envVariables | Other environment variables to start the localstack instance with |
| localstackPort = 4566 | Tell Localstack which port to use. Should probably use different ones when running on CI systems |
Returns a LocalstackConnection
type.
interface LocalstackConnection extends awsUtils.ConnectionAndConfig {
getOutput: () => string;
clearOutput: () => void;
cleanup: () => Promise<void>;
}
Hooks
Test framework convenience method.
import { localstackHooks } from '@lifeomic/test-tool-localstack'
const hooks = localstackHooks();
let
beforeAll(async () => {
})