# grunt-kopper-serverless

> A grunt utility for easily testing and deploying AWS lambda + AWS api gateway apis/apps

Latest version **0.0.6** (published 2016-07-15) · 0 weekly downloads

## Install

```sh
npm install grunt-kopper-serverless
pnpm add grunt-kopper-serverless
yarn add grunt-kopper-serverless
bun add grunt-kopper-serverless
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2016-07-15 |
| First published | 2016-07-10 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ben Connito |
| Maintainers | benconnito |
| Keywords | aws, lambda, api gateway, serverless, grunt |

## Links

- npm: https://www.npmjs.com/package/grunt-kopper-serverless
- Repository: https://github.com/benconnito/grunt-kopper-serverless
- Issues: https://github.com/benconnito/grunt-kopper-serverless/issues
- npm.io page: https://npm.io/package/grunt-kopper-serverless

## Dependencies (5)

- [grunt](https://npm.io/package/grunt.md) *
- [bluebird](https://npm.io/package/bluebird.md) *
- [underscore](https://npm.io/package/underscore.md) *
- [grunt-aws-lambda](https://npm.io/package/grunt-aws-lambda.md) *
- [grunt-contrib-nodeunit](https://npm.io/package/grunt-contrib-nodeunit.md) *

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2016-07-15
- 0.0.5 — 2016-07-14
- 0.0.4 — 2016-07-13
- 0.0.3 — 2016-07-13
- 0.0.2 — 2016-07-10

## README

# grunt-kopper-serverless
A grunt utility for easily testing and deploying AWS lambda + AWS api gateway apis/apps.

[![Build Status](https://travis-ci.org/benconnito/grunt-kopper-serverless.svg)](https://travis-ci.org/benconnito/grunt-kopper-serverless)
[![Coverage Status](https://coveralls.io/repos/github/benconnito/grunt-kopper-serverless/badge.svg?branch=master)](https://coveralls.io/github/benconnito/grunt-kopper-serverless?branch=master)
[![Dependency Status](https://david-dm.org/benconnito/grunt-kopper-serverless.svg)](https://david-dm.org/benconnito/grunt-kopper-serverless)
[![devDependency Status](https://david-dm.org/benconnito/grunt-kopper-serverless/dev-status.svg)](https://david-dm.org/benconnito/grunt-kopper-serverless#info=devDependencies)

##there is a library too!
Use https://github.com/benconnito/kopper-serverless for developing the lambda functions. It has some Error classes, success/fail wrappers, and an AWS config method.

##Getting Started
```
npm install grunt-kopper-serverless
```

##usage
Unlike most grunt plugins where you `grunt.loadNpmTask` this library is just some helper methods for auto setting up your config and adding some run, test, and deploy methods.

See the example [`Gruntfile.js`](examples/Gruntfile.js) for an example of what to write.

##test helpers

grunt-kopper-serverless uses nodeunit + grunt-contrib-nodeunit for tests. You will need to add a test for each lambda function that you create. place it in /test/api/LAMBDA_NAME/test.js

```
var Kopper = require('grunt-kopper-serverless');

exports.testMyFirstLambda = {
	testOK: function (test) {
		Kopper.Test.ok(__dirname + '/../../../examples/lambda', 'my-first-lambda', test, {
			isLocal: true,
			id: 'test'
		});
	},
	testFail: function(test){
		Kopper.Test.fail(__dirname + '/../../../examples/lambda', 'my-first-lambda', test, {
			isLocal: true,
			id: 'test'
		});
	},
	testWithContext: function (test) {
		Kopper.Test.test(__dirname + '/../../../examples/lambda', 'my-first-lambda', {
			isLocal: true,
			id: 'test'
		}, {
			succeed: function (response) {
				test.ok(response.message, 'there is a message');
				test.done();
			},
			fail: function (error) {
				test.ok(false, error.toString());
				test.done();
			}
		});
	}
};
```

##api definition

See [api.js](/examples/lambda/api.js) for an example api definition file.

##running a local api with apache and cgi-node

If you've set up an api definition. You can run a local version of it via apache and cgi-node.

cgi-node is located at [cgi](/cgi/cgi-node.min.cgi) or at https://github.com/UeiRicho/cgi-node

Copy this file into your lambdas folder directory along with [app.js](/cgi/app.js).

Replace REAPLACE-cgi-node.min.cgi file with cgi-node from /cgi folder in this repo. Then replace the NODE_EXECUTABLE_PATH and TEMP_PATH values.

Change `'api'` in app.js to to whatever file you named your api definition file. The router uses require() to include it.

Then set up your apache directory directive like this:

```
Options +ExecCGI
AddHandler cgi-script .cgi
		
AddHandler cgi-node .js
Action cgi-node /cgi-node.min.cgi

RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ app.js [QSA,L]
```

---
_Source: https://npm.io/package/grunt-kopper-serverless · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._