push.rocks/qenv
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(core): update

Browse Source
This commit is contained in:
Philipp Kunz 2019-01-13 00:00:32 +01:00
parent 0cfbdf2c9e
commit 33a91c6ae7
1 changed files with 81 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

123
ts/qenv.classes.qenv.ts
View File

@ -5,6 +5,10 @@ export interface IKeyValueObject {
value: string; value: string;
} }
/**
* class Qenv
* allows to make assertions about the environments while being more flexibel in how to meet them
*/
export class Qenv { export class Qenv {
public requiredEnvVars: string[] = []; public requiredEnvVars: string[] = [];
public availableEnvVars: string[] = []; public availableEnvVars: string[] = [];
@ -25,8 +29,14 @@ export class Qenv {
this.logger = loggerArg; this.logger = loggerArg;
// lets make sure paths are absolute // lets make sure paths are absolute
this.qenvFilePathAbsolute = plugins.path.join(plugins.path.resolve(qenvFileBasePathArg), 'qenv.yml'); this.qenvFilePathAbsolute = plugins.path.join(
this.envFilePathAbsolute = plugins.path.join(plugins.path.resolve(envFileBasePathArg), 'env.yml'); plugins.path.resolve(qenvFileBasePathArg),
'qenv.yml'
);
this.envFilePathAbsolute = plugins.path.join(
plugins.path.resolve(envFileBasePathArg),
'env.yml'
);
this.getRequiredEnvVars(); this.getRequiredEnvVars();
this.getAvailableEnvVars(); this.getAvailableEnvVars();
@ -46,10 +56,18 @@ export class Qenv {
} }
} }
public getEnvVar(envVarName): string { /**
* only gets an environment variable if it is required within a read qenv.yml file
* @param envVarName
*/
public getEnvVarRequired(envVarName): string {
return process.env[envVarName]; return process.env[envVarName];
} }
/**
* tries to get any env var even if it is not required
* @param requiredEnvVar
*/
public getEnvVarOnDemand(requiredEnvVar: string): string { public getEnvVarOnDemand(requiredEnvVar: string): string {
// lets determine the actual env yml // lets determine the actual env yml
let envYml; let envYml;
@ -60,52 +78,74 @@ export class Qenv {
envYml = {}; envYml = {};
} }
let envVar: string; let envVar: string;
let envFileVar: string; let envFileVar: string;
let dockerSecret: string; let dockerSecret: string;
let dockerSecretJson: string;
// env var check // env var check
if (process.env[requiredEnvVar]) { if (process.env[requiredEnvVar]) {
this.availableEnvVars.push(requiredEnvVar); this.availableEnvVars.push(requiredEnvVar);
envVar = process.env[requiredEnvVar]; envVar = process.env[requiredEnvVar];
} }
// env file check // env file check
if (envYml.hasOwnProperty(requiredEnvVar)) { if (envYml.hasOwnProperty(requiredEnvVar)) {
envFileVar = envYml[requiredEnvVar]; envFileVar = envYml[requiredEnvVar];
this.availableEnvVars.push(requiredEnvVar); this.availableEnvVars.push(requiredEnvVar);
} }
if (
plugins.smartfile.fs.isDirectory('/run') &&
plugins.smartfile.fs.isDirectory('/run/secrets') &&
plugins.smartfile.fs.fileExists(`/run/secrets/${requiredEnvVar}`)
) {
dockerSecret = plugins.smartfile.fs.toStringSync(`/run/secrets/${requiredEnvVar}`);
}
if ((envVar && envFileVar) || (envVar && dockerSecret) || (envFileVar && dockerSecret)) { // docker secret check
this.logger.log( if (
'warn', plugins.smartfile.fs.isDirectory('/run') &&
`found multiple candidates for ${requiredEnvVar} Choosing in the order of envVar, envFileVar, dockerSecret` plugins.smartfile.fs.isDirectory('/run/secrets') &&
); plugins.smartfile.fs.fileExists(`/run/secrets/${requiredEnvVar}`)
} ) {
dockerSecret = plugins.smartfile.fs.toStringSync(`/run/secrets/${requiredEnvVar}`);
}
let chosenVar: string = null; // docker secret.json
if (envVar) { if (
chosenVar = envVar; plugins.smartfile.fs.isDirectory('/run') &&
} else if (envFileVar) { plugins.smartfile.fs.isDirectory('/run/secrets') &&
chosenVar = envFileVar; plugins.smartfile.fs.fileExists(`/run/secrets/secret.json`)
} else if (dockerSecret) { ) {
chosenVar = dockerSecret; const secretObject = plugins.smartfile.fs.toObjectSync('/run/secrets/secret.json');
dockerSecret = secretObject[requiredEnvVar];
}
// warn if there is more than one candidate
let candidatesCounter = 0;
[envVar, envFileVar, dockerSecret, dockerSecretJson].forEach(candidate => {
if (candidate) {
candidatesCounter++;
} }
return chosenVar; });
if (candidatesCounter > 1) {
this.logger.log(
'warn',
`found multiple candidates for ${requiredEnvVar} Choosing in the order of envVar, envFileVar, dockerSecret, dockerSecretJson`
);
}
let chosenVar: string = null;
if (envVar) {
chosenVar = envVar;
} else if (envFileVar) {
chosenVar = envFileVar;
} else if (dockerSecret) {
chosenVar = dockerSecret;
} else if (dockerSecretJson) {
chosenVar = dockerSecretJson;
}
return chosenVar;
} }
/** /**
* gets the required env values * gets the required env values
*/ */
private getRequiredEnvVars = () => { private getRequiredEnvVars = () => {
let qenvFile: any = {}; let qenvFile: any = {};
if(plugins.smartfile.fs.fileExistsSync(this.qenvFilePathAbsolute)) { if (plugins.smartfile.fs.fileExistsSync(this.qenvFilePathAbsolute)) {
qenvFile = plugins.smartfile.fs.toObjectSync(this.qenvFilePathAbsolute); qenvFile = plugins.smartfile.fs.toObjectSync(this.qenvFilePathAbsolute);
} }
if (!qenvFile || !qenvFile.required || !Array.isArray(qenvFile.required)) { if (!qenvFile || !qenvFile.required || !Array.isArray(qenvFile.required)) {
@ -115,13 +155,12 @@ export class Qenv {
this.requiredEnvVars.push(qenvFile.required[keyArg]); this.requiredEnvVars.push(qenvFile.required[keyArg]);
} }
} }
} };
/** /**
* gets the available env vars * gets the available env vars
*/ */
private getAvailableEnvVars = () => { private getAvailableEnvVars = () => {
for (const requiredEnvVar of this.requiredEnvVars) { for (const requiredEnvVar of this.requiredEnvVars) {
const chosenVar = this.getEnvVarOnDemand(requiredEnvVar); const chosenVar = this.getEnvVarOnDemand(requiredEnvVar);
if (chosenVar) { if (chosenVar) {
@ -133,7 +172,7 @@ export class Qenv {
}); });
} }
} }
} };
/** /**
* gets missing env vars * gets missing env vars
@ -146,5 +185,5 @@ export class Qenv {
} }
} }
return missingEnvVars; return missingEnvVars;
} };
} }