A grunt plugin to help develop AWS Lambda functions. 

tim-b

grunt-aws-lambda

 * https://github.com/Tim-B/grunt-aws-lambda

        // Before generating any new files, remove any previously-created files.

        // Configuration to be run (and then tested).

                    file_name: 'test/fixtures/index.js',

                    event: 'test/fixtures/event.json'

                    file_name: 'test/fixtures/custom_index.js',

                    event: 'test/fixtures/custom_event.json',

                    handler: 'myfunction'

                    file_name: 'test/fixtures/failing_index.js',

                    event: 'test/fixtures/event.json',

                    dist_folder: 'tmp/dist',

                    package_folder: 'test/fixtures/package_default'

                    package_folder: 'test/fixtures/package_custom'

                    package_folder: 'test/fixtures/package_custom',

                    include_files: ['custom.json']

    // Actually load this plugin's task(s).

    // These plugins provide necessary tasks.

    grunt.loadNpmTasks('grunt-contrib-jshint');

    grunt.loadNpmTasks('grunt-contrib-clean');

    grunt.loadNpmTasks('grunt-contrib-nodeunit');

    // Whenever the "test" task is run, first clean the "tmp" dir, then run this

    // plugin's task(s), then test the result.

    grunt.registerTask('test', ['clean', 'lambda_package', 'nodeunit']);

    // By default, lint and run all tests.

    grunt.registerTask('default', ['jshint', 'test']);

    "description": "A grunt plugin to help develop AWS Lambda functions.",

    "homepage": "https://github.com/Tim-B/grunt-aws-lambda",

        "url": "git://github.com/Tim-B/grunt-aws-lambda.git"

        "url": "https://github.com/Tim-B/grunt-aws-lambda/issues"

            "url": "https://github.com/Tim-B/grunt-aws-lambda/blob/master/LICENSE-MIT"

        "grunt-contrib-jshint": "^0.9.2",

        "grunt-contrib-nodeunit": "^0.3.3",

> A grunt plugin to assist in developing functions for [AWS Lambda](http://aws.amazon.com/lambda/).

[![Build Status](https://travis-ci.org/Tim-B/grunt-aws-lambda.svg)](https://travis-ci.org/Tim-B/grunt-aws-lambda)

* Managing npm dependencies which are required by your function

* Packaging required dependencies with your function in a Lambda compatible zip

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

This will save you from packaging previous packages in future ones.

For example your `.npmignore` might look something like this:

### Include your dependencies in bundledDependencies

npm packages which should be bundled with your lambda function must be included in the `bundledDependencies` of your

## Specify AWS credentials in ~/.aws/credentials

This will save you from accidentally committing AWS credentials.

* lambda_invoke - Wrapper to run and test lambda functions locally and view output.

* lambda_package - Packages function along with any npm dependencies in a zip format suitable for lambda.

* lambda_deploy - Uploads the zip package to lambda.

lambda_invoke and lambda_package can be used independently, lambda_deploy will invoke lambda_package before uploading

In your project's Gruntfile, add a section named `lambda_invoke` to the data object passed into `grunt.initConfig()`.

                // Task-specific options go here.

List of files to explicitly include in the package, even if they would be ignored by NPM

Whether or not to timestamp the packages, if set to true the current date/time will be included in the zip name, if false

 then the package name will be constant and consist of just the package name and version.

The path to your npm package, must contain the package.json file.

The folder where the complete zip files should be saved relative to the Gruntfile.

In this example, the default options are used therefore if we have the following in our `Gruntfile.js`:

    "description": "An Example Lamda Function",

Then we run `grunt lambda_package`, we should see a new zip file in a new folder called `dist` called something like:

`my-lambda-function_0-0-1_2014-10-30-18-29-4.zip`

If you unzip that and look inside you should see something like:

Given that by default the dist folder is inside your function folder you can easily end up bundling previous packages

 inside subsequent packages therefore it is **strongly advised that you add dist to your .npmignore**.

In your project's Gruntfile, add a section named `lambda_deploy` to the data object passed into `grunt.initConfig()`.

            arn: 'arn:aws:lambda:us-east-1:123456781234:function:my-function'

* Adding `include_files` option to package - [pull request by dhleong](https://github.com/Tim-B/grunt-aws-lambda/pull/19)

    // Please see the Grunt documentation for more information regarding task

    // creation: http://gruntjs.com/creating-tasks

    grunt.registerMultiTask('lambda_package', 'Creates a package to be uploaded to lambda', function () {

        var pkg = grunt.file.readJSON(path.resolve(options.package_folder + '/package.json'));

            time_string =  time_components.join('-');

        var file_version = pkg.version.replace(/\./g, '-');

        var archive_name = pkg.name + '_' + file_version + '_' + time_string;

        npm.load([], function (err, npm) {

            npm.config.set('loglevel', 'silent');

            var install_location = dir.path;

            var zip_path = install_location + '/' + archive_name + '.zip';

            npm.commands.install(install_location, options.package_folder, function () {

                var output = fs.createWriteStream(zip_path);

                var zipArchive = archive('zip');

                 * Monkey patch to ensure permissions are always 777

                 * Prevents issues on Windows for directories that don't have execute permissions

                 * See https://github.com/Tim-B/grunt-aws-lambda/issues/6

                var old_normalizeEntryData = zipArchive._normalizeEntryData;

                zipArchive._normalizeEntryData = function(data, stats) {

                    // 0777 file permission

                    return old_normalizeEntryData.apply(zipArchive, [data, stats]);

                        cwd: install_location + '/node_modules/' + pkg.name

                if (options.include_files.length) {

                            src: options.include_files,

                            expand: true,

                            cwd: options.package_folder

                output.on('close', function () {

                    mkdirp('./' + options.dist_folder, function (err) {

                        var dist_path = './' + options.dist_folder + '/' + archive_name + '.zip';

                        var dist_zip = fs.createWriteStream(dist_path);

                        fs.createReadStream(zip_path).pipe(dist_zip);

                        dist_zip.on('close', function () {

                            rimraf(install_location, function () {

                                grunt.config.set('lambda_deploy.' + task.target + '.package', dist_path);

                                grunt.log.writeln('Created package at ' + dist_path);

                                done(true);

 ======== A Handy Little Nodeunit Reference ========

 test.notEqual(actual, expected, [message])

 test.deepEqual(actual, expected, [message])

 test.notDeepEqual(actual, expected, [message])

 test.strictEqual(actual, expected, [message])

 test.notStrictEqual(actual, expected, [message])

 test.doesNotThrow(block, [error], [message])

    return grunt.util.normalizelf(grunt.file.read(filepath));

        glob("my-lambda-function_0-0-1_*.zip", {cwd: 'tmp/dist'}, function (er, files) {

            test.equals(1, files.length);

            var zip = new AdmZip('tmp/dist/' + files[0]);

            var zipEntries = zip.getEntries();

            test.equals(3, zipEntries.length);

            zipEntries.forEach(function (item) {

                if (required.indexOf(item.entryName) !== -1) {

                    test.ok(true, "Found " + item.entryName);

        var zip = new AdmZip("tmp/dist/another-lambda-function_0-0-1_latest.zip");

        var zipEntries = zip.getEntries();

            'node_modules/jquery/package.json'

        zipEntries.forEach(function (item) {

            if (required.indexOf(item.entryName) !== -1) {

                test.ok(true, "Found " + item.entryName);

		{
		"name": "grunt-aws-lambda",
		"description": "A grunt plugin to help develop AWS Lambda functions.",
		"version": "0.7.0",
		"version": "0.8.0",
		"homepage": "https://github.com/Tim-B/grunt-aws-lambda",
		@@ -6,0 +6,0 @@ "author": {

		@@ -194,2 +194,8 @@ # grunt-aws-lambda

		##### options.include_files
		Type: `Array`
		Default value: `[]`

		List of files to explicitly include in the package, even if they would be ignored by NPM

		##### options.include_time
		@@ -492,1 +498,5 @@ Type: `Boolean`

		### 0.8.0
		* Adding `include_files` option to package - [pull request by dhleong](https://github.com/Tim-B/grunt-aws-lambda/pull/19)

		@@ -31,3 +31,4 @@ /*
		'include_time': true,
		'package_folder': './'
		'package_folder': './',
		'include_files': []
		});
		@@ -95,2 +96,13 @@

		if (options.include_files.length) {
		zipArchive.bulk([
		{
		src: options.include_files,
		dot: true,
		expand: true,
		cwd: options.package_folder
		}
		]);
		}

		zipArchive.finalize();
		@@ -97,0 +109,0 @@

		@@ -62,3 +62,3 @@ 'use strict';
		custom_options: function (test) {
		test.expect(5);
		test.expect(6);
		var zip = new AdmZip("tmp/dist/another-lambda-function_0-0-1_latest.zip");
		@@ -68,2 +68,3 @@ var zipEntries = zip.getEntries();
		var required = [
		'custom.json',
		'index.js',
		@@ -84,2 +85,3 @@ 'package.json',
		}

		};

		@@ -65,3 +65,4 @@ /*
		include_time: false,
		package_folder: 'test/fixtures/package_custom'
		package_folder: 'test/fixtures/package_custom',
		include_files: ['custom.json']
		}
		@@ -68,0 +69,0 @@ }

Improved metrics