Skip to content

Commit f99c97b

Browse files
jraedejraede
committed
Add support for injecting environment variables
jshint/jsbeautify cleanup Only append environment/version to function name if they are provided (no longer defaults) Rebase on upstream/master
1 parent 6e752df commit f99c97b

File tree

7 files changed

+338
-120
lines changed

7 files changed

+338
-120
lines changed

‎.jsbeautifyrc

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"break_chained_methods": false,
3+
"e4x": false,
4+
"eval_code": false,
5+
"indent_char": " ",
6+
"indent_level": 0,
7+
"indent_size": 2,
8+
"indent_with_tabs": false,
9+
"jslint_happy": true,
10+
"keep_array_indentation": false,
11+
"keep_function_indentation": false,
12+
"max_preserve_newlines": 2,
13+
"preserve_newlines": true,
14+
"space_before_conditional": true,
15+
"space_in_paren": false,
16+
"unescape_strings": false,
17+
"wrap_line_length": 120,
18+
"space_after_anon_function":true
19+
}

‎.jshintrc

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
{
2+
3+
"maxerr" : 50, // {int} Maximum error before stopping
4+
5+
// Enforcing
6+
"bitwise" : true, // true: Prohibit bitwise operators (&, |, ^, etc.)
7+
"camelcase" : false, // false: Identifiers do not need to be in camelCase. We would like to enforce this except for when interacting with our api objects which use snakeCase properties.
8+
"curly" : false, // false: Do not require {} for every new block or scope
9+
"eqeqeq" : true, // true: Require triple equals (===) for comparison
10+
"forin" : true, // true: Require filtering for..in loops with obj.hasOwnProperty()
11+
"immed" : false, // true: Require immediate invocations to be wrapped in parens e.g. `(function () { } ());`
12+
"indent" : 2, // {int} Number of spaces to use for indentation
13+
"latedef" : false, // true: Require variables/functions to be defined before being used
14+
"newcap" : false, // true: Require capitalization of all constructor functions e.g. `new F()`
15+
"noarg" : true, // true: Prohibit use of `arguments.caller` and `arguments.callee`
16+
"noempty" : true, // true: Prohibit use of empty blocks
17+
"nonew" : false, // true: Prohibit use of constructors for side-effects (without assignment)
18+
"plusplus" : false, // true: Prohibit use of `++` & `--`
19+
"quotmark" : false, // Quotation mark consistency:
20+
// false : do nothing (default)
21+
// true : ensure whatever is used is consistent
22+
// "single" : require single quotes
23+
// "double" : require double quotes
24+
"undef" : true, // true: Require all non-global variables to be declared (prevents global leaks)
25+
"unused" : true, // true: Require all defined variables be used
26+
"strict" : false, // false: Do not require all functions to be run in ES5 Strict Mode
27+
"trailing" : true, // true: Prohibit trailing whitespaces
28+
"maxparams" : false, // {int} Max number of formal params allowed per function
29+
"maxdepth" : false, // {int} Max depth of nested blocks (within functions)
30+
"maxstatements" : false, // {int} Max number statements per function
31+
"maxcomplexity" : false, // {int} Max cyclomatic complexity per function
32+
"maxlen" : 120, // {int} Max number of characters per line
33+
34+
// Relaxing
35+
"asi" : false, // true: Tolerate Automatic Semicolon Insertion (no semicolons)
36+
"boss" : false, // true: Tolerate assignments where comparisons would be expected
37+
"debug" : false, // true: Allow debugger statements e.g. browser breakpoints.
38+
"eqnull" : false, // true: Tolerate use of `== null`
39+
"es5" : false, // true: Allow ES5 syntax (ex: getters and setters)
40+
"esnext" : false, // true: Allow ES.next (ES6) syntax (ex: `const`)
41+
"moz" : false, // true: Allow Mozilla specific syntax (extends and overrides esnext features)
42+
// (ex: `for each`, multiple try/catch, function expression…)
43+
"evil" : false, // true: Tolerate use of `eval` and `new Function()`
44+
"expr" : true, // true: Tolerate `ExpressionStatement` as Programs
45+
"funcscope" : false, // true: Tolerate defining variables inside control statements"
46+
"globalstrict" : true, // true: Allow global "use strict" (also enables 'strict')
47+
"iterator" : false, // true: Tolerate using the `__iterator__` property
48+
"lastsemic" : false, // true: Tolerate omitting a semicolon for the last statement of a 1-line block
49+
"laxbreak" : false, // true: Tolerate possibly unsafe line breakings
50+
"laxcomma" : false, // true: Tolerate comma-first style coding
51+
"loopfunc" : false, // true: Tolerate functions being defined in loops
52+
"multistr" : false, // true: Tolerate multi-line strings
53+
"proto" : false, // true: Tolerate using the `__proto__` property
54+
"scripturl" : false, // true: Tolerate script-targeted URLs
55+
"smarttabs" : false, // true: Tolerate mixed tabs/spaces when used for alignment
56+
"shadow" : false, // true: Allows re-define variables later in code e.g. `var x=1; x=2;`
57+
"sub" : false, // true: Tolerate using `[]` notation when it can still be expressed in dot notation
58+
"supernew" : false, // true: Tolerate `new function () { ... };` and `new Object;`
59+
"validthis" : false, // true: Tolerate using this in a non-constructor function
60+
61+
// Environments
62+
"browser" : false, // Web Browser (window, document, etc)
63+
"couch" : false, // CouchDB
64+
"devel" : false, // Development/debugging (alert, confirm, etc)
65+
"dojo" : false, // Dojo Toolkit
66+
"jquery" : false, // jQuery
67+
"mootools" : false, // MooTools
68+
"node" : true, // Node.js
69+
"nonstandard" : false, // Widely adopted globals (escape, unescape, etc)
70+
"prototypejs" : false, // Prototype and Scriptaculous
71+
"rhino" : false, // Rhino
72+
"worker" : false, // Web Workers
73+
"wsh" : false, // Windows Scripting Host
74+
"yui" : false, // Yahoo User Interface
75+
76+
"ignore": [{"dir":"./node_modules"}],
77+
78+
79+
// Custom globals, from http://docs.meteor.com, in the order they appear there
80+
"globals" : {
81+
// Jasmine
82+
"expect": false,
83+
"beforeEach": false,
84+
"afterEach":false,
85+
"beforeAll": false,
86+
"afterAll": false,
87+
"it": false,
88+
"describe": false,
89+
"spyOn": false
90+
}
91+
92+
93+
}

‎README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ node-lambda deploy
3535

3636
#### setup
3737

38-
Initializes the `event.json` and `.env` files. `event.json` is where you mock your event. `.env.` is where you place your deployment configuration.
38+
Initializes the `event.json`, `.env` files, and `deploy.env` files. `event.json` is where you mock your event. `.env.` is where you place your deployment configuration. `deploy.env` has the same format as `.env`, but is used for holding any environment/config variables that you need to be deployed with your code to Lambda but you don't want in version control (e.g. DB connection info).
3939

4040
```
4141
$ node-lambda setup --help
@@ -47,10 +47,10 @@ $ node-lambda setup --help
4747
-h, --help output usage information
4848
```
4949

50-
After running setup, it's a good idea to gitignore the generated `event.json` and `.env` file.
50+
After running setup, it's a good idea to gitignore the generated `event.json` and `.env` files.
5151

5252
```
53-
echo ".env\nevent.json" >> .gitignore
53+
echo ".env\ndeploy.env\nevent.json" >> .gitignore
5454
```
5555

5656
#### run
@@ -80,7 +80,7 @@ $ node-lambda deploy --help
8080
Options:
8181
8282
-h, --help output usage information
83-
-e, --environment [staging] Choose environment {development, stating, production}
83+
-e, --environment [staging] Choose environment {development, staging, production}
8484
-a, --accessKey [your_key] AWS Access Key
8585
-s, --secretKey [your_secret] AWS Secret Key
8686
-r, --region [us-east-1] AWS Region(s)
@@ -93,8 +93,12 @@ $ node-lambda deploy --help
9393
-t, --timeout [3] Lambda Timeout
9494
-d, --description [missing] Lambda Description
9595
-u, --runtime [nodejs] Lambda Runtime
96+
-f, --configFile [] Path to file holding secret environment variables (e.g. "deploy.env")`
9697
```
9798

99+
## Custom Environment Variables
100+
AWS Lambda doesn't let you set environment variables for your function, but in many cases you will need to configure your function with secure values that you don't want to check into version control. Use the sample `deploy.env` file to set environment variables that will be prepended to your compiled Lambda function before it gets uploaded to S3. For example, a DB connection string or encryption key.
101+
98102
## Other AWS Lambda Tools Projects
99103

100104
+ [lambdaws](https://github.com/mentum/lambdaws)

‎bin/node-lambda

+39-35
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ var packageJson = require(process.cwd() + '/package.json');
77

88
dotenv.load();
99

10-
var AWS_ENVIRONMENT = process.env.AWS_ENVIRONMENT || 'development';
10+
var AWS_ENVIRONMENT = process.env.AWS_ENVIRONMENT || '';
11+
var CONFIG_FILE = process.env.CONFIG_FILE || '';
1112
var AWS_ACCESS_KEY_ID = process.env.AWS_ACCESS_KEY_ID || 'missing';
1213
var AWS_SECRET_ACCESS_KEY = process.env.AWS_SECRET_ACCESS_KEY || 'missing';
1314
var AWS_REGION = process.env.AWS_REGION || 'us-east-1,us-west-2,eu-west-1';
@@ -19,44 +20,47 @@ var AWS_MEMORY_SIZE = process.env.AWS_MEMORY_SIZE || 128;
1920
var AWS_TIMEOUT = process.env.AWS_TIMEOUT || 60;
2021
var AWS_DESCRIPTION = process.env.AWS_DESCRIPTION || '';
2122
var AWS_RUNTIME = process.env.AWS_RUNTIME || 'nodejs';
22-
var AWS_FUNCTION_VERSION = process.env.AWS_FUNCTION_VERSION || packageJson.version;
23+
var AWS_FUNCTION_VERSION = process.env.AWS_FUNCTION_VERSION || '';
2324

2425
program
25-
.version( lambda.version )
26-
.command( 'deploy' )
27-
.description( 'Deploy your application to Amazon Lambda' )
28-
.option( '-e, --environment [' + AWS_ENVIRONMENT + ']', 'Choose environment {development, stating, production}', AWS_ENVIRONMENT )
29-
.option( '-a, --accessKey [' + AWS_ACCESS_KEY_ID + ']', 'AWS Access Key', AWS_ACCESS_KEY_ID )
30-
.option( '-s, --secretKey [' + AWS_SECRET_ACCESS_KEY + ']', 'AWS Secret Key', AWS_SECRET_ACCESS_KEY )
31-
.option( '-r, --region [' + AWS_REGION + ']', 'AWS Region', AWS_REGION )
32-
.option( '-n, --functionName [' + AWS_FUNCTION_NAME + ']', 'Lambda FunctionName', AWS_FUNCTION_NAME )
33-
.option( '-h, --handler [' + AWS_HANDLER + ']', 'Lambda Handler {index.handler}', AWS_HANDLER )
34-
.option( '-c, --mode [' + AWS_MODE + ']', 'Lambda Mode', AWS_MODE )
35-
.option( '-o, --role [' + AWS_ROLE + ']', 'Amazon Role ARN', AWS_ROLE )
36-
.option( '-m, --memorySize [' + AWS_MEMORY_SIZE + ']', 'Lambda Memory Size', AWS_MEMORY_SIZE )
37-
.option( '-t, --timeout [' + AWS_TIMEOUT + ']', 'Lambda Timeout', AWS_TIMEOUT )
38-
.option( '-d, --description [' + AWS_DESCRIPTION + ']', 'Lambda Description', AWS_DESCRIPTION )
39-
.option( '-u, --runtime [' + AWS_RUNTIME + ']', 'Lambda Runtime', AWS_RUNTIME )
40-
.option( '-v, --version [' + AWS_FUNCTION_VERSION + ']', 'Lambda Function Version', AWS_FUNCTION_VERSION )
41-
.action( function( prg ) {
42-
lambda.deploy( prg );
43-
} );
26+
.version(lambda.version)
27+
.command('deploy')
28+
.description('Deploy your application to Amazon Lambda')
29+
.option('-e, --environment [' + AWS_ENVIRONMENT + ']', 'Choose environment {dev, staging, production}',
30+
AWS_ENVIRONMENT)
31+
.option('-a, --accessKey [' + AWS_ACCESS_KEY_ID + ']', 'AWS Access Key', AWS_ACCESS_KEY_ID)
32+
.option('-s, --secretKey [' + AWS_SECRET_ACCESS_KEY + ']', 'AWS Secret Key', AWS_SECRET_ACCESS_KEY)
33+
.option('-r, --region [' + AWS_REGION + ']', 'AWS Region', AWS_REGION)
34+
.option('-n, --functionName [' + AWS_FUNCTION_NAME + ']', 'Lambda FunctionName', AWS_FUNCTION_NAME)
35+
.option('-h, --handler [' + AWS_HANDLER + ']', 'Lambda Handler {index.handler}', AWS_HANDLER)
36+
.option('-m, --mode [' + AWS_MODE + ']', 'Lambda Mode', AWS_MODE)
37+
.option('-o, --role [' + AWS_ROLE + ']', 'Amazon Role ARN', AWS_ROLE)
38+
.option('-m, --memorySize [' + AWS_MEMORY_SIZE + ']', 'Lambda Memory Size', AWS_MEMORY_SIZE)
39+
.option('-t, --timeout [' + AWS_TIMEOUT + ']', 'Lambda Timeout', AWS_TIMEOUT)
40+
.option('-d, --description [' + AWS_DESCRIPTION + ']', 'Lambda Description', AWS_DESCRIPTION)
41+
.option('-u, --runtime [' + AWS_RUNTIME + ']', 'Lambda Runtime', AWS_RUNTIME)
42+
.option('-v, --version [' + AWS_FUNCTION_VERSION + ']', 'Lambda Function Version', AWS_FUNCTION_VERSION)
43+
.option('-f, --configFile [' + CONFIG_FILE + ']',
44+
'Path to file holding secret environment variables (e.g. "deploy.env")', CONFIG_FILE)
45+
.action(function (prg) {
46+
lambda.deploy(prg);
47+
});
4448

4549
program
46-
.version( lambda.version )
47-
.command( 'run' )
48-
.description( 'Run your Amazon Lambda application locally' )
49-
.option( '-h, --handler [' + AWS_HANDLER + ']', 'Lambda Handler {index.handler}', AWS_HANDLER )
50-
.action( function( prg ) {
51-
lambda.run( prg );
52-
} );
50+
.version(lambda.version)
51+
.command('run')
52+
.description('Run your Amazon Lambda application locally')
53+
.option('-h, --handler [' + AWS_HANDLER + ']', 'Lambda Handler {index.handler}', AWS_HANDLER)
54+
.action(function (prg) {
55+
lambda.run(prg);
56+
});
5357

5458
program
55-
.version( lambda.version )
56-
.command( 'setup' )
57-
.description( 'Sets up the .env file.' )
58-
.action( function( prg ) {
59-
lambda.setup( );
60-
} )
59+
.version(lambda.version)
60+
.command('setup')
61+
.description('Sets up the .env file.')
62+
.action(function () {
63+
lambda.setup();
64+
});
6165

62-
program.parse( process.argv );
66+
program.parse(process.argv);

‎lib/deploy.env.example

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
SECRET_VARIABLE=mysecretval

0 commit comments

Comments
 (0)