Skip to content
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.

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

#5945: Invoke local docker to pass env vars to lambda container #5988

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 25 additions & 4 deletions lib/plugins/aws/invokeLocal/index.js
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -103,6 +103,12 @@ class AwsInvokeLocal {
}); });
} }


getConfiguredEnvVars() {
const providerEnvVars = this.serverless.service.provider.environment || {};
const functionEnvVars = this.options.functionObj.environment || {};
return _.merge(providerEnvVars, functionEnvVars);
}

loadEnvVars() { loadEnvVars() {
const lambdaName = this.options.functionObj.name; const lambdaName = this.options.functionObj.name;
const memorySize = Number(this.options.functionObj.memorySize) const memorySize = Number(this.options.functionObj.memorySize)
Expand Down Expand Up @@ -130,10 +136,9 @@ class AwsInvokeLocal {
lambdaDefaultEnvVars.AWS_PROFILE = profileOverride; lambdaDefaultEnvVars.AWS_PROFILE = profileOverride;
} }


const providerEnvVars = this.serverless.service.provider.environment || {}; const configuredEnvVars = this.getConfiguredEnvVars();
const functionEnvVars = this.options.functionObj.environment || {};


_.merge(process.env, lambdaDefaultEnvVars, providerEnvVars, functionEnvVars); _.merge(process.env, lambdaDefaultEnvVars, configuredEnvVars);


return BbPromise.resolve(); return BbPromise.resolve();
} }
Expand Down Expand Up @@ -315,6 +320,16 @@ class AwsInvokeLocal {
this.serverless.config.servicePath, '.serverless', 'invokeLocal', 'artifact')); this.serverless.config.servicePath, '.serverless', 'invokeLocal', 'artifact'));
} }


getEnvVarsFromOptions() {
const envVarsFromOptions = {};
// Get the env vars from command line options in the form of --env KEY=value
_.concat(this.options.env || [])
.forEach(itm => {
const splitItm = _.split(itm, '=');
envVarsFromOptions[splitItm[0]] = splitItm.slice(1, splitItm.length).join('=') || '';
});
return envVarsFromOptions;
}


invokeLocalDocker() { invokeLocalDocker() {
const handler = this.options.functionObj.handler; const handler = this.options.functionObj.handler;
Expand All @@ -329,10 +344,16 @@ class AwsInvokeLocal {
.then((results) => new BbPromise((resolve, reject) => { .then((results) => new BbPromise((resolve, reject) => {
const imageName = results[2]; const imageName = results[2];
const artifactPath = results[3]; const artifactPath = results[3];
const configuredEnvVars = this.getConfiguredEnvVars();
const envVarsFromOptions = this.getEnvVarsFromOptions();
const envVars = _.merge(configuredEnvVars, envVarsFromOptions);
const envVarsDockerArgs = _.flatMap(envVars,
(value, key) => ['--env', `${key}=${value}`]
);
const dockerArgsFromOptions = this.getDockerArgsFromOptions(); const dockerArgsFromOptions = this.getDockerArgsFromOptions();
const dockerArgs = _.concat([ const dockerArgs = _.concat([
'run', '--rm', '-v', `${artifactPath}:/var/task`, 'run', '--rm', '-v', `${artifactPath}:/var/task`,
], dockerArgsFromOptions, [ ], envVarsDockerArgs, dockerArgsFromOptions, [
imageName, handler, JSON.stringify(this.options.data), imageName, handler, JSON.stringify(this.options.data),
]); ]);
const docker = spawn('docker', dockerArgs); const docker = spawn('docker', dockerArgs);
Expand Down
55 changes: 55 additions & 0 deletions lib/plugins/aws/invokeLocal/index.test.js
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -1153,6 +1153,9 @@ describe('AwsInvokeLocal', () => {
serverless.setProvider('aws', new AwsProvider(serverless, options)); serverless.setProvider('aws', new AwsProvider(serverless, options));
awsInvokeLocalMocked = new AwsInvokeLocalMocked(serverless, options); awsInvokeLocalMocked = new AwsInvokeLocalMocked(serverless, options);


serverless.service.provider.environment = {
providerVar: 'providerValue',
};
awsInvokeLocalMocked.options = { awsInvokeLocalMocked.options = {
stage: 'dev', stage: 'dev',
function: 'first', function: 'first',
Expand All @@ -1161,8 +1164,12 @@ describe('AwsInvokeLocal', () => {
name: 'hello', name: 'hello',
timeout: 4, timeout: 4,
runtime: 'nodejs8.10', runtime: 'nodejs8.10',
environment: {
functionVar: 'functionValue',
},
}, },
data: {}, data: {},
env: 'commandLineEnvVar=commandLineEnvVarValue',
'docker-arg': '-p 9292:9292', 'docker-arg': '-p 9292:9292',
}; };


Expand Down Expand Up @@ -1199,6 +1206,12 @@ describe('AwsInvokeLocal', () => {
'--rm', '--rm',
'-v', '-v',
'servicePath:/var/task', 'servicePath:/var/task',
'--env',
'providerVar=providerValue',
'--env',
'functionVar=functionValue',
'--env',
'commandLineEnvVar=commandLineEnvVarValue',
'-p', '-p',
'9292:9292', '9292:9292',
'sls-docker', 'sls-docker',
Expand All @@ -1209,6 +1222,48 @@ describe('AwsInvokeLocal', () => {
); );
}); });


describe('#getEnvVarsFromOptions', () => {
it('returns empty object when env option is not set', () => {
delete awsInvokeLocal.options.env;

const envVarsFromOptions = awsInvokeLocal.getEnvVarsFromOptions();

expect(envVarsFromOptions).to.be.eql({});
});

it('returns empty object when env option empty', () => {
awsInvokeLocal.options.env = '';

const envVarsFromOptions = awsInvokeLocal.getEnvVarsFromOptions();

expect(envVarsFromOptions).to.be.eql({});
});

it('returns key value for option separated by =', () => {
awsInvokeLocal.options.env = 'SOME_ENV_VAR=some-value';

const envVarsFromOptions = awsInvokeLocal.getEnvVarsFromOptions();

expect(envVarsFromOptions).to.be.eql({ SOME_ENV_VAR: 'some-value' });
});

it('returns key with empty value for option without =', () => {
awsInvokeLocal.options.env = 'SOME_ENV_VAR';

const envVarsFromOptions = awsInvokeLocal.getEnvVarsFromOptions();

expect(envVarsFromOptions).to.be.eql({ SOME_ENV_VAR: '' });
});

it('returns key with single value for option multiple =s', () => {
awsInvokeLocal.options.env = 'SOME_ENV_VAR=value1=value2';

const envVarsFromOptions = awsInvokeLocal.getEnvVarsFromOptions();

expect(envVarsFromOptions).to.be.eql({ SOME_ENV_VAR: 'value1=value2' });
});
});

describe('#getDockerArgsFromOptions', () => { describe('#getDockerArgsFromOptions', () => {
it('returns empty list when docker-arg option is absent', () => { it('returns empty list when docker-arg option is absent', () => {
delete awsInvokeLocal.options['docker-arg']; delete awsInvokeLocal.options['docker-arg'];
Expand Down