Compare commits

..

14 Commits

Author SHA1 Message Date
d76d1a263b 4.0.0 2019-01-15 23:54:29 +01:00
5f6f434998 BREAKING CHANGE(process.env): treat environment as immutable 2019-01-15 23:54:29 +01:00
8e7909e367 3.1.1 2019-01-14 22:42:25 +01:00
ff9302f745 fix(core): update 2019-01-14 22:42:24 +01:00
3577fa22e1 3.1.0 2019-01-14 01:54:05 +01:00
f5275adfbd feat(docker secret): docker secret.json can now also be named [anything].secret.json 2019-01-14 01:54:04 +01:00
31bf1b27a4 3.0.7 2019-01-13 22:33:19 +01:00
a77def5844 fix(core): update 2019-01-13 22:33:18 +01:00
2357699f3e 3.0.6 2019-01-13 22:04:20 +01:00
01f5784488 fix(core): update 2019-01-13 22:04:20 +01:00
80f35c39aa 3.0.5 2019-01-13 21:35:57 +01:00
87f55773bd fix(core): update 2019-01-13 21:35:57 +01:00
1a25341232 3.0.4 2019-01-13 18:25:09 +01:00
ccd41d86bf fix(core): update 2019-01-13 18:25:09 +01:00
4 changed files with 29 additions and 28 deletions

2
package-lock.json generated
View File

@ -1,6 +1,6 @@
{ {
"name": "@pushrocks/qenv", "name": "@pushrocks/qenv",
"version": "3.0.3", "version": "4.0.0",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
"dependencies": { "dependencies": {

View File

@ -1,6 +1,6 @@
{ {
"name": "@pushrocks/qenv", "name": "@pushrocks/qenv",
"version": "3.0.3", "version": "4.0.0",
"private": false, "private": false,
"description": "easy promised environments", "description": "easy promised environments",
"main": "dist/index.js", "main": "dist/index.js",

View File

@ -4,28 +4,30 @@ import * as qenv from '../ts/index';
process.env['key1'] = 'original'; process.env['key1'] = 'original';
let qenvTestObject: qenv.Qenv; let testQenv: qenv.Qenv;
tap.test('should create a new class', async () => { tap.test('should create a new class', async () => {
qenvTestObject = new qenv.Qenv( testQenv = new qenv.Qenv(
path.join(__dirname, 'assets'), path.join(__dirname, 'assets'),
path.join(__dirname, 'assets'), path.join(__dirname, 'assets'),
false false
); );
expect(qenvTestObject).to.be.instanceof(qenv.Qenv); expect(testQenv).to.be.instanceof(qenv.Qenv);
}); });
tap.test('key1 should be not be overwritten since it is already present', async () => { tap.test('key1 should be not be overwritten since it is already present', async () => {
expect(process.env.key1).to.equal('original'); expect(testQenv.getEnvVarRequired('key1')).to.equal('original');
expect(testQenv.getEnvVarOnDemand('key1')).to.equal('original');
}); });
tap.test('key2 should be read from Yml', async () => { tap.test('key2 should be read from Yml', async () => {
expect(process.env.key2).to.equal('fromYml'); expect(testQenv.getEnvVarRequired('key2')).to.equal('fromYml');
expect(testQenv.getEnvVarOnDemand('key2')).to.equal('fromYml');
}); });
tap.test('keyValueObjectArray should hold all retrieved values', async () => { tap.test('keyValueObjectArray should hold all retrieved values', async () => {
expect(qenvTestObject.keyValueObjectArray[0].value).to.equal('original'); expect(testQenv.keyValueObject.key1).to.equal('original');
expect(qenvTestObject.keyValueObjectArray[1].value).to.equal('fromYml'); expect(testQenv.keyValueObject.key2).to.equal('fromYml');
}); });
tap.start(); tap.start();

View File

@ -1,9 +1,5 @@
import * as plugins from './qenv.plugins'; import * as plugins from './qenv.plugins';
plugins.smartlog.defaultLogger.enableConsole();
export interface IKeyValueObject {
key: string;
value: string;
}
/** /**
* class Qenv * class Qenv
@ -13,7 +9,7 @@ export class Qenv {
public requiredEnvVars: string[] = []; public requiredEnvVars: string[] = [];
public availableEnvVars: string[] = []; public availableEnvVars: string[] = [];
public missingEnvVars: string[] = []; public missingEnvVars: string[] = [];
public keyValueObjectArray: IKeyValueObject[] = []; public keyValueObject: {[key: string]: any } = {};
public logger: plugins.smartlog.Smartlog; public logger: plugins.smartlog.Smartlog;
// filePaths // filePaths
@ -61,7 +57,7 @@ export class Qenv {
* @param envVarName * @param envVarName
*/ */
public getEnvVarRequired(envVarName): string { public getEnvVarRequired(envVarName): string {
return process.env[envVarName]; return this.keyValueObject[envVarName];
} }
/** /**
@ -74,7 +70,6 @@ export class Qenv {
try { try {
envYml = plugins.smartfile.fs.toObjectSync(this.envFilePathAbsolute); envYml = plugins.smartfile.fs.toObjectSync(this.envFilePathAbsolute);
} catch (err) { } catch (err) {
console.log("env file couldn't be found at " + this.envFilePathAbsolute);
envYml = {}; envYml = {};
} }
let envVar: string; let envVar: string;
@ -98,7 +93,7 @@ export class Qenv {
if ( if (
plugins.smartfile.fs.isDirectory('/run') && plugins.smartfile.fs.isDirectory('/run') &&
plugins.smartfile.fs.isDirectory('/run/secrets') && plugins.smartfile.fs.isDirectory('/run/secrets') &&
plugins.smartfile.fs.fileExists(`/run/secrets/${requiredEnvVar}`) plugins.smartfile.fs.fileExistsSync(`/run/secrets/${requiredEnvVar}`)
) { ) {
dockerSecret = plugins.smartfile.fs.toStringSync(`/run/secrets/${requiredEnvVar}`); dockerSecret = plugins.smartfile.fs.toStringSync(`/run/secrets/${requiredEnvVar}`);
} }
@ -106,11 +101,15 @@ export class Qenv {
// docker secret.json // docker secret.json
if ( if (
plugins.smartfile.fs.isDirectory('/run') && plugins.smartfile.fs.isDirectory('/run') &&
plugins.smartfile.fs.isDirectory('/run/secrets') && plugins.smartfile.fs.isDirectory('/run/secrets')
plugins.smartfile.fs.fileExists(`/run/secrets/secret.json`)
) { ) {
const secretObject = plugins.smartfile.fs.toObjectSync('/run/secrets/secret.json'); const availableSecrets = plugins.smartfile.fs.listAllItemsSync('/run/secrets');
dockerSecret = secretObject[requiredEnvVar]; for (const secret of availableSecrets) {
if (secret.includes('secret.json') && !dockerSecret) {
const secretObject = plugins.smartfile.fs.toObjectSync(`/run/secrets/${secret}`);
dockerSecret = secretObject[requiredEnvVar];
}
}
} }
// warn if there is more than one candidate // warn if there is more than one candidate
@ -129,12 +128,16 @@ export class Qenv {
let chosenVar: string = null; let chosenVar: string = null;
if (envVar) { if (envVar) {
this.logger.log('ok', `found ${requiredEnvVar} as environment variable`);
chosenVar = envVar; chosenVar = envVar;
} else if (envFileVar) { } else if (envFileVar) {
this.logger.log('ok', `found ${requiredEnvVar} as env.yml variable`);
chosenVar = envFileVar; chosenVar = envFileVar;
} else if (dockerSecret) { } else if (dockerSecret) {
this.logger.log('ok', `found ${requiredEnvVar} as docker secret`);
chosenVar = dockerSecret; chosenVar = dockerSecret;
} else if (dockerSecretJson) { } else if (dockerSecretJson) {
this.logger.log('ok', `found ${requiredEnvVar} as docker secret.json`);
chosenVar = dockerSecretJson; chosenVar = dockerSecretJson;
} }
return chosenVar; return chosenVar;
@ -165,14 +168,10 @@ export class Qenv {
const chosenVar = this.getEnvVarOnDemand(requiredEnvVar); const chosenVar = this.getEnvVarOnDemand(requiredEnvVar);
if (chosenVar) { if (chosenVar) {
this.availableEnvVars.push(requiredEnvVar); this.availableEnvVars.push(requiredEnvVar);
process.env[requiredEnvVar] = chosenVar; this.keyValueObject[requiredEnvVar] = chosenVar;
this.keyValueObjectArray.push({
key: requiredEnvVar,
value: chosenVar
});
} }
} }
}; }
/** /**
* gets missing env vars * gets missing env vars