aws-lambda-testing

class to test the lambda functions

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00Mar 8, 2019Jan 31, 2017Minified + gzip package size for aws-lambda-testing in KB

Readme

aws-lambda-testing

Module to test the aws-lambda functions

Build Status

Inline docs

aws-lambda-testing for JavaScript, support to timeout and memory usage.

Installing

$ npm install aws-lambda-testing

Getting starter


let AwsTest = require( 'aws-lambda-testing' )
let awsTest = new AwsTest() // you can pass a handler.
let handler = function (params, ctx, cb) {
  //the handler receive the params, ctx and cb
  assert(params.test === 'test')
  ctx.done(null, 'test') // the ctx object has the method done, fail and success
}
awsTest.setHandler(handler)
.exec({test: 'test'},function (error, res) { // The exec function can receive the params and callback
  // to use in the hadler to test
  assert(!error)
  assert(res === 'test')
})

awsTest.setHandler(handler)
.exec({test: 'testing the promise'}) // if you do not pass a callback return a promise
.then(function (res) {
  assert(res === 'testing the promise')
})
.catch(errorHandler) // every error is catched and the promise is rejected
})

Class aws-lambda-testing

Class aws-lambda-testing method

assumeRole(arnRole)-> Promise.resolve(res)

set the AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_SESSION_TOKEN environment vars.

aws-lambda-testing([handler, params, cb, ctx])

To instance the aws-lambda-testing you can pass the handler to test, the params and callback to be used when the handler is execed and the context to be used to exec it.

Instance aws-lambda-testing

aws-lambda-testing.exec([params,callback]) => self || promise

This method exec the handler and return a promise, this promise is resolve with the return valur of callback passed to this function and rejected with every error catched or values passed to ctx.fail or ctx.done. If you do not pass a callback return a promise. If process is over timeout or memory usage limit a error is return in callback or promise.

Event pre config

There event preconfig to use, if params is a string and equal to:

[ '$CloudFormationCreateRequest',
  '$SESEmailReceiving',
  '$ScheduledEvent',
  '$CloudWatchLogs',
  '$SNS',
  '$DynamoDBUpdate',
  '$CognitoSyncTrigger',
  '$KinesisStreams',
  '$S3Put',
  '$S3Delete',
  '$Lex',
  '$GatewayProxyRequest',
  '$GatewayProxyResponse',
  '$CloudFront',
  '$Config',
  '$IoTButton',
  '$KinesisFirehose' ]

aws-lambda-testing.setHandler(handler) => self

This method setted the handler to be tested and return itself instance.

aws-lambda-testing.setParams(params) => self

This method setted the params to be passed to the handler and return itself instance.

aws-lambda-testing.setCallback(callback) => self

This method setted the callback to be passed to the handler and return itself instance.

aws-lambda-testing.setCtx(ctx) => self

This method setted the context to be passed like thisArg to the handler and return itself instance.

aws-lambda-testing.setTimeout(timeout) => self

This method setted the timeout, if the timeout in exec is broken a error is throw and passed to callback or promise if is not managed.

aws-lambda-testing.getMemoryUsage() => Number (MB unit)

get the memory usage by last process.

aws-lambda-testing.setMemoryUsageLimit(Number limit (MB unit)) => self

set the memory usage limit, if any exec routine is over this limit a error is returned in callback or promise.

aws-lambda-testing.getMemoryUsageLimit() => Number (MB unit)

get the memory limit, default is infinity

aws-lambda-testing.memoryUsageIsOverLimit() => Boolean

get if memory usage limit is over.

Ctx object

The ctx object has the method done, success and fail. If the error or error like passed to done or fail method is not controlled by the callback is passed to reject method.

Testing

Running the tests

npm test

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code. For any bugs report please contact to me via e-mail: jesus.edelcereceres@gmail.com.

Licence

The MIT License (MIT)

Copyright (c) 2015 JECD.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.