4.0.7

.gitlab-ci.yml

@@ -38,23 +38,23 @@ snyk:
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
   - npmci npm prepare
-  - npmci node install lts
+  - npmci node install stable
   - npmci npm install
   - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
-  - notpriv
+  - priv
 
 testBuild:
   stage: test
   script:
   - npmci npm prepare
-  - npmci node install lts
+  - npmci node install stable
   - npmci npm install
   - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
@@ -65,7 +65,7 @@ testBuild:
 release:
   stage: release
   script:
-  - npmci node install lts
+  - npmci node install stable
   - npmci npm publish
   only:
   - tags
@@ -100,7 +100,7 @@ trigger:
 pages:
   image: hosttoday/ht-docker-dbase:npmci
   services:
-   - docker:18-dind
+   - docker:stable-dind
   stage: metadata
   script:
     - npmci command npm install -g @gitzone/tsdoc

README.md

@@ -38,6 +38,6 @@ const myQenv = new Qenv('path/to/dir/where/qenv.yml/is/', 'path/to/dir/where/env
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/qenv",
-  "version": "4.0.1",
+  "version": "4.0.7",
   "private": false,
   "description": "easy promised environments",
   "main": "dist/index.js",
@@ -25,17 +25,17 @@
   },
   "homepage": "https://gitlab.com/pushrocks/qenv#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsbuild": "^2.1.24",
-    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.24",
+    "@gitzone/tstest": "^1.0.33",
-    "@pushrocks/tapbundle": "^3.0.11",
+    "@pushrocks/tapbundle": "^3.2.1",
-    "@types/node": "^12.6.9",
+    "@types/node": "^14.0.12",
-    "tslint": "^5.18.0",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^7.0.4",
+    "@pushrocks/smartfile": "^7.0.12",
-    "@pushrocks/smartlog": "^2.0.19"
+    "@pushrocks/smartlog": "^2.0.26"
   },
   "files": [
     "ts/*",

test/assets/env.json

@@ -0,0 +1,4 @@
+{
+  "key1": "fromJson",
+  "key2" :"fromJson"
+}

test/assets/env.yml

@@ -1,2 +0,0 @@
-key1: fromYml
-key2: fromYml

test/test.ts

@@ -17,13 +17,13 @@ tap.test('key1 should be not be overwritten since it is already present', async
 });
 
 tap.test('key2 should be read from Yml', async () => {
-  expect(testQenv.getEnvVarRequired('key2')).to.equal('fromYml');
+  expect(testQenv.getEnvVarRequired('key2')).to.equal('fromJson');
-  expect(testQenv.getEnvVarOnDemand('key2')).to.equal('fromYml');
+  expect(testQenv.getEnvVarOnDemand('key2')).to.equal('fromJson');
 });
 
 tap.test('keyValueObjectArray should hold all retrieved values', async () => {
   expect(testQenv.keyValueObject.key1).to.equal('original');
-  expect(testQenv.keyValueObject.key2).to.equal('fromYml');
+  expect(testQenv.keyValueObject.key2).to.equal('fromJson');
 });
 
 tap.start();

ts/qenv.classes.qenv.ts

@@ -1,5 +1,4 @@
 import * as plugins from './qenv.plugins';
-plugins.smartlog.defaultLogger.enableConsole();
 
 /**
  * class Qenv
@@ -10,7 +9,7 @@ export class Qenv {
   public availableEnvVars: string[] = [];
   public missingEnvVars: string[] = [];
   public keyValueObject: { [key: string]: any } = {};
-  public logger: plugins.smartlog.Smartlog;
+  public logger = new plugins.smartlog.ConsoleLog();
 
   // filePaths
   public qenvFilePathAbsolute: string;
@@ -19,10 +18,8 @@ export class Qenv {
   constructor(
     qenvFileBasePathArg = process.cwd(),
     envFileBasePathArg,
-    failOnMissing = true,
+    failOnMissing = true
-    loggerArg: plugins.smartlog.Smartlog = plugins.smartlog.defaultLogger
   ) {
-    this.logger = loggerArg;
 
     // lets make sure paths are absolute
     this.qenvFilePathAbsolute = plugins.path.join(
@@ -31,7 +28,7 @@ export class Qenv {
     );
     this.envFilePathAbsolute = plugins.path.join(
       plugins.path.resolve(envFileBasePathArg),
-      'env.yml'
+      'env.json'
     );
 
     this.getRequiredEnvVars();
@@ -46,8 +43,10 @@ export class Qenv {
       console.error('However some Env variables could not be resolved:');
       console.log(this.missingEnvVars);
       if (failOnMissing) {
-        console.error('Exiting!');
+        this.logger.log('error', 'Exiting!');
         process.exit(1);
+      } else {
+        this.logger.log('warn', 'qenv is not set to fail on missing environment variables');
       }
     }
   }
@@ -62,40 +61,39 @@ export class Qenv {
 
   /**
    * tries to get any env var even if it is not required
-   * @param requiredEnvVar
+   * @param wantedEnvVar
    */
-  public getEnvVarOnDemand(requiredEnvVar: string): string {
+  public getEnvVarOnDemand(wantedEnvVar: string): string {
-    // lets determine the actual env yml
+    let envVarFromEnvironmentVariable: string;
-    let envYml;
+    let envVarFromEnvJsonFile: string;
-    try {
+    let envVarFromDockerSecret: string;
-      envYml = plugins.smartfile.fs.toObjectSync(this.envFilePathAbsolute);
-    } catch (err) {
-      envYml = {};
-    }
-    let envVar: string;
-    let envFileVar: string;
-    let dockerSecret: string;
     let dockerSecretJson: string;
 
     // env var check
-    if (process.env[requiredEnvVar]) {
+    if (process.env[wantedEnvVar]) {
-      this.availableEnvVars.push(requiredEnvVar);
+      this.availableEnvVars.push(wantedEnvVar);
-      envVar = process.env[requiredEnvVar];
+      envVarFromEnvironmentVariable = process.env[wantedEnvVar];
     }
 
     // env file check
-    if (envYml.hasOwnProperty(requiredEnvVar)) {
+    // lets determine the actual env yml
-      envFileVar = envYml[requiredEnvVar];
+    let envJsonFileAsObject;
-      this.availableEnvVars.push(requiredEnvVar);
+    try {
+      envJsonFileAsObject = plugins.smartfile.fs.toObjectSync(this.envFilePathAbsolute);
+    } catch (err) {
+      envJsonFileAsObject = {};
+    }
+    if (envJsonFileAsObject.hasOwnProperty(wantedEnvVar)) {
+      envVarFromEnvJsonFile = envJsonFileAsObject[wantedEnvVar];
     }
 
     // docker secret check
     if (
       plugins.smartfile.fs.isDirectory('/run') &&
       plugins.smartfile.fs.isDirectory('/run/secrets') &&
-      plugins.smartfile.fs.fileExistsSync(`/run/secrets/${requiredEnvVar}`)
+      plugins.smartfile.fs.fileExistsSync(`/run/secrets/${wantedEnvVar}`)
     ) {
-      dockerSecret = plugins.smartfile.fs.toStringSync(`/run/secrets/${requiredEnvVar}`);
+      envVarFromDockerSecret = plugins.smartfile.fs.toStringSync(`/run/secrets/${wantedEnvVar}`);
     }
 
     // docker secret.json
@@ -105,42 +103,53 @@ export class Qenv {
     ) {
       const availableSecrets = plugins.smartfile.fs.listAllItemsSync('/run/secrets');
       for (const secret of availableSecrets) {
-        if (secret.includes('secret.json') && !dockerSecret) {
+        if (secret.includes('secret.json') && !envVarFromDockerSecret) {
           const secretObject = plugins.smartfile.fs.toObjectSync(`/run/secrets/${secret}`);
-          dockerSecret = secretObject[requiredEnvVar];
+          envVarFromDockerSecret = secretObject[wantedEnvVar];
         }
       }
     }
 
     // warn if there is more than one candidate
-    let candidatesCounter = 0;
+    const availableCcandidates: any[] = [];
-    [envVar, envFileVar, dockerSecret, dockerSecretJson].forEach(candidate => {
+    [
+      envVarFromEnvironmentVariable,
+      envVarFromEnvJsonFile,
+      envVarFromDockerSecret,
+      dockerSecretJson
+    ].forEach(candidate => {
       if (candidate) {
-        candidatesCounter++;
+        availableCcandidates.push(candidate);
       }
     });
-    if (candidatesCounter > 1) {
+    if (availableCcandidates.length > 1) {
       this.logger.log(
         'warn',
-        `found multiple candidates for ${requiredEnvVar} Choosing in the order of envVar, envFileVar, dockerSecret, dockerSecretJson`
+        `found multiple candidates for ${wantedEnvVar} Choosing in the order of envVar, envFileVar, dockerSecret, dockerSecretJson`
       );
+      console.log(availableCcandidates);
     }
 
-    let chosenVar: string = null;
+    switch (true) {
-    if (envVar) {
+      case !!envVarFromEnvironmentVariable:
-      this.logger.log('ok', `found ${requiredEnvVar} as environment variable`);
+        this.logger.log('ok', `found ${wantedEnvVar} as environment variable`);
-      chosenVar = envVar;
+        return envVarFromEnvironmentVariable;
-    } else if (envFileVar) {
+      case !!envVarFromEnvJsonFile:
-      this.logger.log('ok', `found ${requiredEnvVar} as env.yml variable`);
+        this.logger.log('ok', `found ${wantedEnvVar} as env.json variable`);
-      chosenVar = envFileVar;
+        return envVarFromEnvJsonFile;
-    } else if (dockerSecret) {
+      case !!envVarFromDockerSecret:
-      this.logger.log('ok', `found ${requiredEnvVar} as docker secret`);
+        this.logger.log('ok', `found ${wantedEnvVar} as docker secret`);
-      chosenVar = dockerSecret;
+        return envVarFromDockerSecret;
-    } else if (dockerSecretJson) {
+      case !!dockerSecretJson:
-      this.logger.log('ok', `found ${requiredEnvVar} as docker secret.json`);
+        this.logger.log('ok', `found ${wantedEnvVar} as docker secret.json`);
-      chosenVar = dockerSecretJson;
+        return dockerSecretJson;
+      default:
+        this.logger.log(
+          'warn',
+          `could not find the wanted environment variable ${wantedEnvVar} anywhere`
+        );
+        return;
     }
-    return chosenVar;
   }
 
   /**
@@ -152,7 +161,10 @@ export class Qenv {
       qenvFile = plugins.smartfile.fs.toObjectSync(this.qenvFilePathAbsolute);
     }
     if (!qenvFile || !qenvFile.required || !Array.isArray(qenvFile.required)) {
-      this.logger.log('warn', `env File does not contain a 'required' Array!`);
+      this.logger.log(
+        'warn',
+        `qenv (promised environment): ./qenv.yml File does not contain a 'required' Array! This might be ok though.`
+      );
     } else {
       for (const keyArg of Object.keys(qenvFile.required)) {
         this.requiredEnvVars.push(qenvFile.required[keyArg]);