Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/activescott/serverless-http-invoker
Locally invoke Serverless functions via their HTTP event as specified in Serverless.yml for testing purposes.
https://github.com/activescott/serverless-http-invoker
aws-lambda mocha nodejs serverless serverless-architectures serverless-framework serverless-functions
Last synced: 3 months ago
JSON representation
Locally invoke Serverless functions via their HTTP event as specified in Serverless.yml for testing purposes.
- Host: GitHub
- URL: https://github.com/activescott/serverless-http-invoker
- Owner: activescott
- License: mit
- Created: 2017-07-23T05:54:41.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T21:30:45.000Z (10 months ago)
- Last Synced: 2024-04-15T08:09:47.439Z (9 months ago)
- Topics: aws-lambda, mocha, nodejs, serverless, serverless-architectures, serverless-framework, serverless-functions
- Language: JavaScript
- Size: 2.39 MB
- Stars: 29
- Watchers: 5
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/serverless-http-invoker)
[](https://www.npmjs.com/package/serverless-http-invoker)
[](https://github.com/activescott/serverless-http-invoker/actions)
[](https://coveralls.io/github/activescott/serverless-http-invoker)
[](https://github.com/activescott/serverless-http-invoker/blob/main/LICENSE)
[](https://github.com/activescott/serverless-http-invoker)
# serverless-http-invoker
Locally invoke [Serverless](https://github.com/serverless/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](#usage--quick-start)
- [Prerequisites / Usage Requirements](#prerequisites--usage-requirements)
- [Install](#install)
- [Features](#features)
- [Contributing 🤝](#contributing-🤝)
- [Show your support](#show-your-support)
- [Release Process (Deploying to NPM)](#release-process-deploying-to-npm)
- [License 📝](#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](examples/basic/basic.spec.js).
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](examples/comprehensive/comprehensive.spec.js).
## Prerequisites / Usage Requirements
Requires Node.js latest, LTS, and v10 ([tested](https://travis-ci.org/activescott/serverless-http-invoker)).
If you need Node.js v6.x - v9.x support you can use [[email protected]](https://www.npmjs.com/package/serverless-http-invoker/v/0.8.6).
Requires Serverless Framework v1.x.
If you are new to the Serverless Framework, check out the [Serverless Framework Getting Started Guide](https://serverless.com/framework/docs/getting-started/).
## Install
npm (`npm install serverless-http-invoker --save-dev`) or yarn (`yarn add serverless-http-invoker --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](.github/CONTRIBUTING.md).
## Show your support
Give a ⭐️ if this project helped you!
## Release Process (Deploying to NPM)
We use [semantic-release](https://github.com/semantic-release/semantic-release) to consistently release [semver](https://semver.org/)-compatible versions. This project deploys to multiple [npm distribution tags](https://docs.npmjs.com/cli/dist-tag). Each of the below branches correspond to the following npm distribution tags:
| branch | npm distribution tag |
| ------ | -------------------- |
| main | latest |
| beta | beta |
To trigger a release use a Conventional Commit following [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) on one of the above branches.
## License 📝
Copyright © 2017 [Scott Willeke](https://github.com/activescott).
This project is [MIT](https://github.com/activescott/serverless-http-invoker/blob/main/LICENSE) licensed.