Merge pull request #27 from erezrokah/chai_support

chai support

Author: erezrokah

README.md

@@ -1,9 +1,9 @@
-# jest-e2e-serverless
+# AWS Testing Library
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![CircleCI](https://circleci.com/gh/erezrokah/jest-e2e-serverless.svg?style=svg)](https://circleci.com/gh/erezrokah/jest-e2e-serverless)
+[![CircleCI](https://circleci.com/gh/erezrokah/aws-testing-library.svg?style=svg)](https://circleci.com/gh/erezrokah/aws-testing-library)
 
-> Note: This library is still at POC level, if you're missing any capability please open an issue :)
+> Note: If you're missing any capability please open an issue/feature request :)
 
 ## Prerequisites
 
@@ -20,250 +20,36 @@ If you plan to use the [deploy](#deploy) utility function please install and con
 Install with [yarn](https://github.com/yarnpkg/yarn)
 
 ```bash
-yarn add jest-e2e-serverless --dev
+yarn add aws-testing-library --dev
 ```
 
 or [npm](https://www.npmjs.com/)
 
 ```bash
-npm install jest-e2e-serverless --save-dev
+npm install aws-testing-library --save-dev
 ```
 
-### Setup
+## Setup
 
-The simplest setup is to use jest's `setupTestFrameworkScriptFile` config.
+- [Chai](src/chai/README.md)
+- [Jest](src/jest/README.md)
 
-Make sure your `package.json` includes the following:
-
-```json
-// package.json
-"jest": {
-  "setupTestFrameworkScriptFile": "./node_modules/jest-e2e-serverless/lib/index.js",
-},
-```
-
-#### Usage with TypeScript
-
-When using `jest-e2e-serverless` with [TypeScript](http://typescriptlang.org/) and [ts-jest](https://github.com/kulshekhar/ts-jest), you'll need to add a `setupFrameworks.ts` file to your app that explicitly imports `jest-e2e-serverless`, and point the `setupTestFrameworkScriptFile` field in your `package.json` file towards it:
-
-```typescript
-// src/setupFrameworks.ts
-import 'jest-e2e-serverless';
-```
-
-```json
-// package.json
-"jest": {
- "setupTestFrameworkScriptFile": "./src/setupFrameworks.ts",
-},
-```
-
-### Assertions
-
-> Notes
->
-> - The matchers use `aws-sdk` under the hood, thus they are all asynchronous and require using `async/await`
-
-- [toHaveItem()](#tohaveitem)
-- [toHaveObject()](#tohaveobject)
-- [toHaveLog()](#tohavelog)
-- [toBeAtState()](#tobeatstate)
-- [toHaveState()](#tohavestate)
-- [toReturnResponse()](#toreturnresponse)
-- [toHaveRecord()](#tohaverecord)
-- [toHaveMessage()](#tohavemessage)
-
-#### `toHaveItem()`
-
-Asserts existence/equality of a DynamoDb item
-
-```js
-expect.assertions(1); // makes sure the assertion was called
-await expect({
-  region: 'us-east-1',
-  table: 'dynamo-db-table',
-  timeout: 0 /* optional (defaults to 2500) */,
-  pollEvery: 0 /* optional (defaults to 500) */,
-}).toHaveItem(
-  {
-    id: 'itemId',
-  } /* dynamoDb key object (https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#getItem-property) */,
-  {
-    id: 'itemId',
-    createdAt: new Date().getTime(),
-    text: 'some content',
-  } /* optional, if exists will check equality in addition to existence */,
-  true /* optional, strict mode comparison, defaults to true */,
-);
-```
-
-[See complete example](https://github.com/erezrokah/serverless-monorepo-app/blob/master/services/db-service/e2e/db.test.ts)
-
-#### `toHaveObject()`
-
-Asserts existence/equality of a S3 object
-
-```js
-expect.assertions(1); // makes sure the assertion was called
-await expect({
-  region: 'us-east-1',
-  bucket: 's3-bucket',
-  timeout: 0 /* optional (defaults to 2500) */,
-  pollEvery: 0 /* optional (defaults to 500) */,
-}).toHaveObject(
-  'someFileInTheBucket' /* a string representing the object key in the bucket */,
-  Buffer.from(
-    'a buffer of the file content',
-  ) /* optional, if exists will check equality in addition to existence */,
-);
-```
-
-[See complete example](https://github.com/erezrokah/serverless-monorepo-app/blob/master/services/file-service/e2e/handler.test.ts)
-
-#### `toHaveLog()`
-
-Asserts log message of a lambda function
-
-```js
-expect.assertions(1); // makes sure the assertion was called
-await expect({
-  region: 'us-east-1',
-  function: 'functionName',
-  timeout: 0 /* optional (defaults to 2500) */,
-  pollEvery: 0 /* optional (defaults to 500) */,
-}).toHaveLog(
-  'some message written to log by the lambda' /* a pattern to match against log messages */,
-);
-```
-
-[See complete example](https://github.com/erezrokah/hello-retail/blob/master/e2eTests/src/sendUserLogin.test.ts)
-
-#### `toBeAtState()`
-
-Asserts a state machine current state
-
-```js
-expect.assertions(1); // makes sure the assertion was called
-await expect({
-  pollEvery: 5000 /* optional (defaults to 500) */,
-  region: 'us-east-1',
-  stateMachineArn: 'stateMachineArn',
-  timeout: 30 * 1000 /* optional (defaults to 2500) */,
-}).toBeAtState('ExpectedState');
-```
-
-[See complete example](https://github.com/erezrokah/hello-retail/blob/master/e2eTests/src/newProduct.test.ts#L73)
-
-#### `toHaveState()`
-
-Asserts that a state machine has been at a state
-
-```js
-expect.assertions(1); // makes sure the assertion was called
-await expect({
-  pollEvery: 5000 /* optional (defaults to 500) */,
-  region: 'us-east-1',
-  stateMachineArn: 'stateMachineArn',
-  timeout: 30 * 1000 /* optional (defaults to 2500) */,
-}).toHaveState('ExpectedState');
-```
-
-[See complete example](https://github.com/erezrokah/hello-retail/blob/master/e2eTests/src/stateMachine.test.ts#L97)
-
-#### `toReturnResponse()`
-
-Asserts that an api returns a specific response
-
-```js
-expect.assertions(1); // makes sure the assertion was called
-await expect({
-  url: 'https://api-id.execute-api.us-east-1.amazonaws.com/dev/api/private',
-  method: 'POST',
-  params: { urlParam: 'value' } /* optional URL parameters */,
-  data: { bodyParam: 'value' } /* optional body parameters */,
-  headers: { Authorization: 'Bearer token_value' } /* optional headers */,
-}).toReturnResponse({
-  data: {
-    message: 'Unauthorized',
-  },
-  statusCode: 401,
-});
-```
-
-[See complete example](https://github.com/erezrokah/serverless-monorepo-app/blob/master/services/api-service/e2e/privateEndpoint.test.ts#L8)
-
-#### `toHaveRecord()`
-
-Asserts existence/equality of a Kinesis record
-
-```js
-expect.assertions(1); // makes sure the assertion was called
-await expect({
-  region: 'us-east-1',
-  stream: 'kinesis-stream',
-  timeout: 0 /* optional (defaults to 10000) */,
-  pollEvery: 0 /* optional (defaults to 500) */,
-}).toHaveRecord(
-  item => item.id === 'someId' /* predicate to match with the stream data */,
-);
-```
-
-[See complete example](https://github.com/erezrokah/serverless-monorepo-app/blob/master/services/kinesis-service/e2e/handler.test.ts)
-
-#### `toHaveMessage()`
-
-Asserts existence/equality of a message in an SQS queue
-
-```js
-const {
-  subscribeToTopic,
-  unsubscribeFromTopic,
-} = require('jest-e2e-serverless/lib/utils/sqs');
-
-let [subscriptionArn, queueUrl] = ['', ''];
-try {
-  // create an SQS queue and subscribe to SNS topic
-  ({ subscriptionArn, queueUrl } = await subscribeToTopic(region, topicArn));
-
-  // run some code that will publish a message to the SNS topic
-  someCodeThatResultsInPublishingAMessage();
-
-  expect.assertions(1); // makes sure the assertion was called
-  await expect({
-    region,
-    queueUrl,
-    timeout: 10000 /* optional (defaults to 2500) */,
-    pollEvery: 2500 /* optional (defaults to 500) */,
-  }).toHaveMessage(
-    /* predicate to match with the messages in the queue */
-    message =>
-      message.Subject === 'Some Subject' && message.Message === 'Some Message',
-  );
-} finally {
-  // unsubscribe from SNS topic and delete SQS queue
-  await unsubscribeFromTopic(region, subscriptionArn, queueUrl);
-}
-```
-
-[See complete example](https://github.com/erezrokah/serverless-monitoring-app/blob/master/services/monitoring-service/e2e/checkEndpointStepFunction.test.ts)
-
-### Utils
+## Utils
 
 - [invoke()](#invoke)
 - [clearAllItems()](#clearallitems)
 - [writeItems()](#writeitems)
 - [clearAllObjects()](#clearallobjects)
 - [deleteAllLogs()](#deletealllogs)
 - [stopRunningExecutions()](#stoprunningexecutions)
-- [getResponse()](#getresponse)
 - [deploy()](#deploy)
 
-#### `invoke()`
+### `invoke()`
 
 Invokes a lambda function
 
 ```typescript
-const { invoke } = require('jest-e2e-serverless/lib/utils/lambda');
+const { invoke } = require('aws-testing-library/lib/utils/lambda');
 
 const result = await invoke(
   'us-east-1',
@@ -274,34 +60,34 @@ const result = await invoke(
 );
 ```
 
-#### `clearAllItems()`
+### `clearAllItems()`
 
 Clear all items in a DynamoDb table
 
 ```typescript
-const { clearAllItems } = require('jest-e2e-serverless/lib/utils/dynamoDb');
+const { clearAllItems } = require('aws-testing-library/lib/utils/dynamoDb');
 
 await clearAllItems('us-east-1', 'dynamo-db-table');
 ```
 
-#### `writeItems()`
+### `writeItems()`
 
 Write items to a DynamoDb table
 
 ```typescript
-const { writeItems } = require('jest-e2e-serverless/lib/utils/dynamoDb');
+const { writeItems } = require('aws-testing-library/lib/utils/dynamoDb');
 
 const items = require('./seed.json');
 
 await writeItems('us-east-1', 'dynamo-db-table', items);
 ```
 
-#### `clearAllObjects()`
+### `clearAllObjects()`
 
 Clear all objects in a s3 bucket
 
 ```typescript
-const { clearAllObjects } = require('jest-e2e-serverless/lib/utils/s3');
+const { clearAllObjects } = require('aws-testing-library/lib/utils/s3');
 
 await clearAllObjects(
   'us-east-1',
@@ -310,50 +96,34 @@ await clearAllObjects(
 );
 ```
 
-#### `deleteAllLogs()`
+### `deleteAllLogs()`
 
 Clear all log streams for a lambda function
 
 ```typescript
-const { deleteAllLogs } = require('jest-e2e-serverless/lib/utils/cloudwatch');
+const { deleteAllLogs } = require('aws-testing-library/lib/utils/cloudwatch');
 
 await deleteAllLogs('us-east-1', 'lambda-function-name');
 ```
 
-#### `stopRunningExecutions()`
+### `stopRunningExecutions()`
 
 Stop all running executions for a state machine
 
 ```typescript
 const {
   stopRunningExecutions,
-} = require('jest-e2e-serverless/lib/utils/stepFunctions');
+} = require('aws-testing-library/lib/utils/stepFunctions');
 
 await stopRunningExecutions('us-east-1', 'state-machine-arn');
 ```
 
-#### `getResponse()`
-
-Send a request to an api and get a response
-
-```typescript
-const { getResponse } = require('jest-e2e-serverless/lib/utils/api');
-
-const result = await getResponse(
-  url: 'https://api-id.execute-api.us-east-1.amazonaws.com/dev/api/private',
-  method: 'POST',
-  params: { urlParam: 'value' } /* optional URL parameters */,
-  data: { bodyParam: 'value' } /* optional body parameters */,
-  headers: { Authorization: 'Bearer token_value' } /* optional headers */,
-);
-```
-
-#### `deploy()`
+### `deploy()`
 
 Deploys the current service using [Serverless framework](https://serverless.com/)
 
 ```typescript
-const { deploy } = require('jest-e2e-serverless/lib/utils/serverless');
+const { deploy } = require('aws-testing-library/lib/utils/serverless');
 
 await deploy('dev' /* optional - deployment stage */);
 ```