Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucasconstantino/now-we-test
Test your Now deployed Node.js lambdas locally
https://github.com/lucasconstantino/now-we-test
lambda local now serve testing
Last synced: 2 months ago
JSON representation
Test your Now deployed Node.js lambdas locally
- Host: GitHub
- URL: https://github.com/lucasconstantino/now-we-test
- Owner: lucasconstantino
- License: mit
- Created: 2018-12-24T19:26:37.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-04-16T16:52:38.000Z (almost 6 years ago)
- Last Synced: 2024-10-30T07:42:50.145Z (3 months ago)
- Topics: lambda, local, now, serve, testing
- Language: JavaScript
- Size: 297 KB
- Stars: 50
- Watchers: 3
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Now we test
[](https://travis-ci.org/lucasconstantino/now-we-test)
[](https://codecov.io/github/lucasconstantino/now-we-test)
[](https://oclif.io)
[](https://www.npmjs.com/package/now-we-test)
Temporary lib to help test [Now.sh](https://zeit.co/now) lambdas written in Node.js. It was created with the purpose to eventually be deprecated when [`now dev` command](https://github.com/zeit/now-cli/issues/1681) is released.
## Purpose
Help unit test and locally serve lambdas written to deploy using Now.
## Installation
`yarn add now-we-test --dev`
## Usage
### For unit tests
In your unit tests, you can use the `simulator` helper to simulate a lambda execution environment without needing a running server:
```js
import { simulator } from 'now-we-test'
import func from '../your-lambda-implementation'
const app = simulator(func)
describe('func', () => {
it('should do something', async () => {
const result = await app.get('/')
expect(result.text).toBe('[the value returned by the lambda]')
})
})
```
Signature:
```
simulator(
fn: Function,
[builder="@now/node"]: String
)
```
Alternatively to the default `@now/node` building evironment, you can also simulate a [`now-micro`](https://github.com/lucasconstantino/now-micro) passing it as second parameter.
> The result of the invokation of `simulator` helper is a [SuperTest](https://github.com/visionmedia/supertest) instance, so please refer to that documentation for details on possible assertions and usage.
### For locally serving lambdas
_Now we test_ provides a simple CLI to serve your lambdas locally - useful for testing integration with other tools.
> Keep in mind there is only so much it can do in terms of simulation, so you should never completelly trust what works locally would necessarily work on Now.sh environment.
#### Commands
- [`now-we-test serve`](#now-we-test-serve)
- [`now-we-test help [COMMAND]`](#now-we-test-help-command)
##### `now-we-test serve`
Serves the lambdas locally
```
USAGE
$ now-we-test serve [PATH]
ARGUMENTS
PATH [default: .] The path to the directory where now.json stands
OPTIONS
-f, --format=format [default: combined] logger format (morgan compliant)
-p, --port=port [default: 3000] port to use
```
_See code: [lib/commands/serve.js](https://github.com/lucasconstantino/now-we-test/blob/v0.0.0/src/commands/serve.js)_
> Only `@now/node`, `@now/static`, and `now-micro` builders are available so far.
##### `now-we-test help [COMMAND]`
display help for a now-we-test command
```
USAGE
$ now-we-test help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.4/src/commands/help.ts)_