serverless-http-invoker

Locally invoke Serverless functions via their HTTP event as specified in Serverless.yml.

It makes it easy to test not only your handler logic, but also ensures that you have your http events setup properly in serverless.yml without deploying.

• Usage / Quick Start
• Prerequisites / Usage Requirements
• Install
• Features
• Contributing 🤝
• Show your support
• Release Process (Deploying to NPM)
• License 📝

Usage / Quick Start

Use it in tests of Serverless functions to test your HTTP endpoints along with the handler code. For example, you can write the following to test a Serverless function:

it('should invoke simple path', function () {
  let response = invoker.invoke('GET api/hello')
  return expect(response).to.eventually.have.property('statusCode', 200)
})

The test above is a test of a Serverless function defined in a Serverless.yml as follows:

functions:
  hello:
    handler: handler.hello
    events:
      - http:
          path: api/hello
          method: get

Some of the more common use cases are demonstrated in the basic tests at the basic test cases. An exhaustive list of what is supported in Some of the more common use cases are demonstrated in the basic tests at the comprehensive test cases.

Prerequisites / Usage Requirements

Requires Node.js latest, LTS, and v10 (tested).

If you need Node.js v6.x - v9.x support you can use serverless-http-invoker@0.8.6.

Requires Serverless Framework v1.x. If you are new to the Serverless Framework, check out the Serverless Framework Getting Started Guide.

Install

yarn (yarn add serverless-http-invoker --dev) or npm (npm install serverless-http-invoker --save-dev)

Features

• Simple to reference your handler
• Tests the serverless route is configured in serverless.yml as well as your handler code
• Test Framework agnostic (mocha, jest, etc.)

Contributing 🤝

This is a community project. We invite your participation through issues and pull requests! You can peruse the contributing guidelines.

Show your support

Give a ⭐️ if this project helped you!

Release Process (Deploying to NPM)

To deploy a pre-release version to NPM, tag a commit in master branch with a semver-compatible git tag and postfixed with an NPM distribution tag of next. For example:

git tag 1.0.1-next

To deploy a production version to NPM, tag a commit in master branch with a semver-compatible git tag WITHOUT a NPM distribution tag. For example:

git tag 1.0.1

In this case, since no NPM distribution tag is provided the latest tag will be used making it a normal production release.

NOTE: To get the tag to GitHub push it with git push --tags.

NOTE: If you want to move the git tag that was already pushed to the remote (GitHub) to a different commit you must delete it on the remote like git push --delete origin 0.8.7-next and then push it with git push --tags. Or do the abbreviated from by force-pushing it like git push --tags -f.

License 📝

Copyright © 2017 scott@willeke.com.

This project is MIT licensed.