npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

glambda

1.3.2 • Public • Published

Build Status Code Climate Test Coverage Dependency Status

NPM

GLambda

AWS Gateway + Lambda Testing Module

A module for mocking and testing AWS API Gateway in conjunction with Lambda functions.

Introduction

Setup

Install the module:

npm install glambda --save-dev

To see a fully functional demo, see the /test directory. The index.js file is setup to run using the lambdas and the gateway.yml file. The tests run against this configuration as well.

After installing the npm module simply include it in a file where it will run and set any config options on init:

// Include the module
var glambda = require('glambda')
// Set options and init
glambda.init({
  lambdas: './lambdas',
  schema: './gateway.yml',
  port: 8181,
  apiPath: '/api',
  log: true,
  cors: {
    origin: '*',
    methods: 'GET,PUT,POST,DELETE,OPTIONS',
    headers: 'Content-Type, Authorization, Content-Length, X-Requested-With'
  }
})

The above shows a standard set of config options:

  • lambdas: Path to the directory containing lambdas
  • schema: Path to the API gateway YAML config
  • port: Port on which the HTTP server will run
  • apiPath: Any path (proceeding root) to include in HTTP requests mapping
  • log: Wether or not to log to console

Simply running the file created above will spin up the service, then accessing the endpoints via the corresponding lambda name will spawn the Lambda function and return its results.

Environment Variables

The system runs a configuration load process which uses the default values, overrides with any initialized (passed) config properties and (lastly) checks for environment variables following the convention GL_{PROPERTY}.

Note: CORS settings don't currently support environment variables

The Gateway YAML Configuration

The gateway.yml format was designed to closely match the AWS API Gateway. The structure is intended to appear similar to the Resource (left-hand) pane when editing an API in the web interface.

---
  /:
    /foo:
      GET:
          lambda: "foo"
          templates:
            application/json:
              method: "get"
      POST:
          lambda: "foo"
          templates:
            application/json:
              method: "post"
              body: "$input.json('$')"
      /foo/{fooId}:
        GET:
          lambda: "foo"
          templates:
            application/json:
              id: "$input.params('fooId')"
              method: "get"
        PUT:
          lambda: "foo"
          templates:
            application/json:
              id: "$input.params('fooId')"
              baz: "quz"
              body: "$input.json('$')"

It's simple to identify the core nodes of the tree, i.e. the paths of the requests and their associated methods. To explain, the following shows results of a number of requests made against the above configuration:

PATH METHOD BODY RESPONSE/EVENT
/ ANY N/A METHOD NOT ALLOWED
/foo GET N/A { method: 'get' }
/foo POST { fizz: 'buzz' } { method: 'post', body: { fizz: 'buzz' }
/foo/123 GET N/A { method: 'get', fooId: 123 }
/foo/123 PUT { baz: 'quz' } { method: 'put', fooId: 123, body: { baz: 'quz' } }

Logging

GLambda will output information from both the service and the Lambdas. An example of the Lambda-specific log output is below:

[2015-08-02 14:26:46] INFO: Lambda Processed (...)
        lambda: foo
        event: {"method":"get"}
        pid: 30945
        memory: { rss: 20062208, heapTotal: 9751808, heapUsed: 3989464 }
        time: 0.124

Notes

Gateway Templates

Currently Glambda only supports a single template which must be application/json. The plan is to expand on this, see Support Multiple Templates issue for more information.

Makefile and Scripts

A Makefile is included for managing build and install tasks. The commands are then referenced in the package.json scripts if that is the preferred task method:

  • all (default) will run all build tasks
  • start will run the main script
  • clean will remove the /node_modules directories
  • build will transpile ES2015 code in /src to /build
  • test will run all spec files in /test/src
  • cover will run code coverage on all tests
  • lint will lint all files in /src
  • doc will run ESDoc on all files in /src and output to /docs
  • report will run Plato static analysis on /build and output to /report
  • dev will run...
    • linting, then...
    • tests, then...
    • build/transpile, then...
    • the main script.
  • watch will run the dev task and rerun on change of /src files

Test Inidividual File

An individual spec can be run by specifying the FILE:

make test FILE=some.spec.js

The FILE is relative to the test/src/ directory.

Deploys

For deploying releases, the deploy TAG={VERSION} can be used where VERSION can be:

<newversion> | major | minor | patch | premajor

Both make {COMMAND} and npm run {COMMAND} work for any of the above commands.

License

Glambda is licensed under the MIT license. Please see LICENSE.txt for full details.

Credits

Glambda was designed and created at TechnologyAdvice.

install

npm i glambda

Downloadsweekly downloads

10

version

1.3.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability