Skip to content

Add (optional) --profile options for run command#379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nodanaonlyzuul wants to merge 4 commits into from
Closed

Add (optional) --profile options for run command #379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
59de786
Factor out auth related logic
nodanaonlyzuul Sep 11, 2017
e410b9d
Merge remote-tracking branch 'upstream/master' into ss/add-optional-p…
nodanaonlyzuul Sep 28, 2017
dd1b00a
replace 'undefined' with eplanatory text in README
nodanaonlyzuul Sep 28, 2017
97767b1
Backwards compatible syntax for Node 4
nodanaonlyzuul Sep 28, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,20 +102,23 @@ Runs your Amazon Lambda index.js file locally. Passes `event.json` data to the A
```
$ node-lambda run --help

Usage: run|execute [options]
Usage: run|execute [options]

Run your Amazon Lambda application locally
Run your Amazon Lambda application locally


Options:
-h, --help output usage information
-H, --handler [index.handler] Lambda Handler {index.handler}
-j, --eventFile [event.json] Event JSON File
-u, --runtime [nodejs6.10] Lambda Runtime
-t, --timeout [3] Lambda Timeout
-f, --configFile [] Path to file holding secret environment variables (e.g. "deploy.env")
-x, --contextFile [context.json] Context JSON File
-M, --enableRunMultipleEvents [true] Enable run multiple events

-a, --accessKey [your_key] AWS Access Key
-s, --secretKey [your_secret] AWS Secret Key
-P, --profile [] AWS Profile
-H, --handler [index.handler] Lambda Handler {index.handler}
-j, --eventFile [event.json] Event JSON File
-u, --runtime [nodejs6.10] Lambda Runtime
-t, --timeout [3] Lambda Timeout
-f, --configFile [] Path to file holding secret environment variables (e.g. "deploy.env")
-x, --contextFile [context.json] Context JSON File
-M, --enableRunMultipleEvents [true] Enable run multiple events
-h, --help output usage information
```

#### package
Expand Down
3 changes: 3 additions & 0 deletions bin/node-lambda
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -120,6 +120,9 @@ program
.command('run')
.alias('execute')
.description('Run your Amazon Lambda application locally')
.option('-a, --accessKey [' + AWS_ACCESS_KEY_ID + ']', 'AWS Access Key', AWS_ACCESS_KEY_ID)
.option('-s, --secretKey [' + AWS_SECRET_ACCESS_KEY + ']', 'AWS Secret Key', AWS_SECRET_ACCESS_KEY)
.option('-P, --profile [' + AWS_PROFILE + ']', 'AWS Profile', AWS_PROFILE)

@DeviaVirDeviaVirOct 5, 2017

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes no sense here, run is local only... perhaps you can explain the usecase a bit better?

@nodanaonlyzuulnodanaonlyzuulOct 5, 2017

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @DeviaVir...good question...for sure the event.js is run against the handler locally.

But what happens inside the handler often interacts with AWS services (it may publish to kinesis or upload to S3, etc)- and being able to pass credentials and profile in a familiar way (e.g. --profile) sounds like the right the thing to do.

That's a pretty common use for the lambdas we're deploying.
Let me know if that answers your question.

@DeviaVirDeviaVirOct 5, 2017

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What stops you from using

AWS_PROFILE=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=

environment variables?

The part I'm unsure about here, is that for a handler, you'd just expect it to be agnostic to what it runs. If we start passing these vars, the handler is not agnostic anymore.

@nodanaonlyzuulnodanaonlyzuulOct 12, 2017•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @DeviaVir - good question, sorry for the late reply.

Agnosticism of handlers

Hmmmm - like I said in my prior comment - our handlers are rarely an island unto themselves.
They mostly do something aws-y as a result...like publishing to kinesis or uploading to S3.

Using AWS_PROFILE, AWS_ACCESS_KEY_ID, and AWS_SECRET_ACCESS_KEY

When you talk about adding those three env vars - you're talking about adding them to .env right?

node-lambda favors having one AWS account across deployments. There's a lot of parallel flexibility between deploy and run now (e.g: --runtime, --timeout, --configFile) and I feel that adding --profile adds to that flexibility.

Without the --profile flag/param, developers have to juggle the .env files depending on which account's services they want the handler to interact with. At least in our team, that juggling has been too easy to mess up. Being able to control it with --profile would be more wieldy than juggling .envs.

.option('-H, --handler [' + AWS_HANDLER + ']', 'Lambda Handler {index.handler}', AWS_HANDLER)
.option('-j, --eventFile [' + EVENT_FILE + ']', 'Event JSON File', EVENT_FILE)
.option('-u, --runtime [' + AWS_RUNTIME + ']', 'Lambda Runtime', AWS_RUNTIME)
Expand Down
42 changes: 26 additions & 16 deletions lib/main.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@ class Lambda {
this._setRunTimeEnvironmentVars(program)
}

this._loadAWSCredentials(program)

const handler = require(path.join(process.cwd(), filename))[handlername]
const event = require(path.join(process.cwd(), program.eventFile))
const context = require(path.join(process.cwd(), program.contextFile))
Expand DownExpand Up@@ -754,21 +756,6 @@ so you can easily test run multiple events.
console.log('=> Uploading zip file to AWS Lambda ' + region + ' with parameters:')
console.log(params)

const awsSecurity = { region: region }

if (program.profile) {
aws.config.credentials = new aws.SharedIniFileCredentials({
profile: program.profile
})
} else {
awsSecurity.accessKeyId = program.accessKey
awsSecurity.secretAccessKey = program.secretKey
}

if (program.sessionToken) {
awsSecurity.sessionToken = program.sessionToken
}

if (program.deployTimeout) {
aws.config.httpOptions.timeout = parseInt(program.deployTimeout)
}
Expand All@@ -777,7 +764,7 @@ so you can easily test run multiple events.
aws.config.httpOptions.agent = proxy(program.proxy)
}

aws.config.update(awsSecurity)
aws.config.update(this._loadAWSCredentials(program, {region: region}))

const lambda = new aws.Lambda({ apiVersion: '2015-03-31' })
const scheduleEvents = new ScheduleEvents(aws)
Expand DownExpand Up@@ -875,6 +862,29 @@ so you can easily test run multiple events.
console.log(err)
})
}

_loadAWSCredentials (program, options) {
if (typeof options !== 'object' || !options.region) {
options = {region: null}
}

const awsSecurity = { region: options.region }

if (program.profile) {
aws.config.credentials = new aws.SharedIniFileCredentials({

@abetomoabetomoOct 5, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that there is a sense of unity if you make it to awsSecurity.credentials = new aws.SharedIniFileCredentials(...) , what do you think?

profile: program.profile
})
} else {
awsSecurity.accessKeyId = program.accessKey
awsSecurity.secretAccessKey = program.secretKey
}

if (program.sessionToken) {
awsSecurity.sessionToken = program.sessionToken
}

return awsSecurity
}
}

module.exports = new Lambda()