aws-lambda-test-utils - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "aws-lambda-test-utils",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Test your AWS Lambda Functions for reals!",
   "main": "index.js",
   "scripts": {
-    "test": "tape"
+    "dev": "tape test/*.js",
+    "test": "istanbul cover ./node_modules/tape/bin/tape ./test/*.js",
+    "coverage": "istanbul cover ./node_modules/tape/bin/tape ./test/*.js && istanbul check-coverage --statements 100 --functions 100 --lines 100 --branches 100"
   },
@@ -26,3 +28,7 @@ "repository": {
   },
-  "homepage": "https://github.com/dwyl/aws-lambda-test-utils#readme"
+  "homepage": "https://github.com/dwyl/aws-lambda-test-utils#readme",
+  "devDependencies": {
+    "istanbul": "^0.4.2",
+    "tape": "^4.4.0"
+  }
 }

README.md

 # aws-lambda-test-utils
-Mock event and context objects without fluff.
+
+Testing your AWS Lambda Functions does not need to be difficult or complex.
+
+[![Build Status](https://travis-ci.org/dwyl/aws-lambda-test-utils.svg?branch=master)](https://travis-ci.org/dwyl/aws-lambda-test-utils)
+[![codecov.io](https://codecov.io/github/dwyl/aws-lambda-test-utils/coverage.svg?branch=master)](https://codecov.io/github/dwyl/aws-lambda-test-utils?branch=master)
+[![Dependency Status](https://david-dm.org/dwyl/aws-lambda-test-utils.svg)](https://david-dm.org/dwyl/aws-lambda-test-utils)
+[![devDependency Status](https://david-dm.org/dwyl/aws-lambda-test-utils/dev-status.svg)](https://david-dm.org/dwyl/aws-lambda-test-utils#info=devDependencies)
+
+[![NPM](https://nodei.co/npm-dl/aws-lambda-test-utils.png?months=3)](https://nodei.co/npm/aws-lambda-test-utils/)
+
+If you are *new* to Amazon WebServices Lambda
+(*or need a refresher*),
+please checkout our our  
+***Beginners Guide to AWS Lambda***:
+https://github.com/dwyl/learn-aws-lambda
+
+## Why?
+
+Testing your code is *essential* everywhere you need *reliability*.
+
+
+AWS Lambda has a **Testing _Console_** which is a *web-based*
+way of invoking your function(s) with a given input and
+monitoring the result. But this quite slow and *cannot be automated* (*yet*).
+
+## What?
+
+The simplest *possilbe* way we could think of for Testing
+our AWS Lambda functions.
+
+## *How*? (*Usage*)
+
+### *install* `aws-lambda-test-utils` from NPM
+
+```sh
+npm install aws-lambda-test-utils --save-dev
+```
+
+### Use in your Tests
+
+### Mock Context
+
+An example of using the `mockContextCreator` in an example test.
+
+```js
+'use strict';
+var test               = require('tape');
+var utils              = require('aws-lambda-test-utils')
+var mockContextCreator = utils.mockContextCreator;
+var index              = require('./index.js'); // lambda function
+
+var ctxOpts = {
+  functionName: 'LambdaTest',
+  functionVersion: '1',
+  invokedFunctionArn: 'arn:aws:lambda:eu-west-1:655240711487:function:LambdaTest:ci'
+};
+var testEvent = { key1: 'value1' };
+
+test('LambdaTest', function(t){
+  t.test("LambdaTest: returns value when given event with key1 property", function(st) {
+    function test(result){
+      st.equals(result, "value1")
+      st.end();
+    };
+    var context = mockContextCreator({}, test); // no options and test as the callback
+    index.handler(testEvent, context);
+  });
+  t.test("LambdaTest: returns value when given event with key1 property", function(st) {
+    function test(result){
+      st.equals(result, "value1")
+      st.end();
+    };
+    var context = mockContextCreator(ctxOpts, test); // context options specified and test as the callback
+    index.handler(testEvent, context);
+  });
+  t.end();
+});
+```
+
+### Mock Events
+
+This helper can be used to mock event objects created by AWS services like S3, SNS, or DynamoDB.
+
+The following example uses the `mockEventCreator` to create a mock DynamoDB event.
+
+
+```js
+/* index.js Lambda function  */
+  'use strict';
+
+  exports.handler = function(event, context) {
+      // receives am event from Dynamo DB
+      context.succeed(event.Records.length);
+  };
+```
+
+
+```js
+/* index.test.js  */
+'use strict';
+var test               = require('tape');
+var utils              = require('aws-lambda-test-utils')
+var mockContextCreator = utils.mockContextCreator;
+var mockEventCreator   = utils.mockEventCreator;
+var index              = require('./index.js'); // lambda function
+
+var ctxOpts = {
+  functionName: 'LambdaTest',
+  functionVersion: '1',
+  invokedFunctionArn: 'arn:aws:lambda:eu-west-1:655240711487:function:LambdaTest:ci'
+};
+
+var testEvent = mockEventCreator.createDynamoDBEvent();
+
+test('LambdaTest', function(t){
+  t.test("LambdaTest: returns value when given event with key1 property", function(st) {
+    function test(result){
+      st.equals(result, 1)
+      st.end();
+    };
+    var context = mockContextCreator(ctxOpts, test); // no options and test as the callback
+    index.handler(testEvent, context);
+  });
+});
+```
+
+## Documentation
+
+### Lambda Function `event` & `context`
+
+Every AWS Lambda function take two parameters `event` & `context`
+
+### `context`
+
+The 'context' object has the following form:
+
+```js
+{
+  //methods
+  success,
+  done,
+  fail,
+  getRemainingTimeInMillis,
+
+  //properties
+  functionName,
+  functionVersion,
+  invokedFunctionArn,
+  memoryLimitInMB,
+  awsRequestId,
+  logGroupName,
+  logStreamName,
+  identity: {
+    cognito_identity_id,
+    cognito_identity_pool_id
+  },
+  clientContext: {
+    client: {
+      installation_id,
+      app_title,
+      app_version_name,
+      app_version_code,
+      app_package_name,
+      Custom,
+    },
+    env: {
+      platform_version
+      platform,
+      make,
+      model,
+      locale,
+    }
+  }
+}
+```
+
+The properties of the context object can be specified in an options parameter to the `mockContextCreator` function.  
+
+## Background Reading
+
++
+
+## TODO
+
+* Add options to customise the event objects created by the `mockEventCreator`
+* Add stubs for AWS SDK methods

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

33484

increased by73.96%

Number of package files

9

increased by125%

Lines of code

275

increased byInfinity%

Number of lines in readme file

188

increased by6166.67%

Worsened metrics

Dev dependency count

2

increased byInfinity%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes