4.0.8

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,60 +18,66 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
-snyk:
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - priv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci command npm run build
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install lts
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -81,33 +87,35 @@ codequality:
   allow_failure: true
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:18-dind
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -115,5 +123,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,43 +0,0 @@
-# @pushrocks/qenv
-easy promised environments
-
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/qenv)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/qenv)
-* [github.com (source mirror)](https://github.com/pushrocks/qenv)
-* [docs (typedoc)](https://pushrocks.gitlab.io/qenv/)
-
-## Status for master
-[![build status](https://gitlab.com/pushrocks/qenv/badges/master/build.svg)](https://gitlab.com/pushrocks/qenv/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/qenv/badges/master/coverage.svg)](https://gitlab.com/pushrocks/qenv/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/qenv.svg)](https://www.npmjs.com/package/@pushrocks/qenv)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/qenv/badge.svg)](https://snyk.io/test/npm/@pushrocks/qenv)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
-
-## Usage
-
-Use TypeScript for best in class instellisense.
-
-qenv works with two files:
-
-- **qenv.yml** - specifies which ENV vars are required.
-- **env.yml** - specifies all env vars that are not already set in the current environment.
-
-Now obviously you can set build specific env vars in many CI environments.
-So there we do not need an **env.yml** since all ENV vars are in place
-However when on another machine you can have a env.yml that will be added to the environment by qenv.
-
-```javascript
-import { Qenv } from 'qenv';
-
-const myQenv = new Qenv('path/to/dir/where/qenv.yml/is/', 'path/to/dir/where/env.yml/is(');
-```
-
-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)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -4,6 +4,7 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,10 +1,10 @@
 {
   "name": "@pushrocks/qenv",
-  "version": "4.0.3",
+  "version": "4.0.8",
   "private": false,
   "description": "easy promised environments",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
     "build": "(tsbuild)"
@@ -25,25 +25,26 @@
   },
   "homepage": "https://gitlab.com/pushrocks/qenv#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.11",
-    "@types/node": "^12.6.9",
-    "tslint": "^5.18.0",
+    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tstest": "^1.0.33",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^14.0.12",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^7.0.4",
-    "@pushrocks/smartlog": "^2.0.19"
+    "@pushrocks/smartfile": "^7.0.12",
+    "@pushrocks/smartlog": "^2.0.26"
   },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "dist_ts_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

ts/qenv.classes.qenv.ts

@@ -1,5 +1,4 @@
 import * as plugins from './qenv.plugins';
-plugins.smartlog.defaultLogger.enableConsole();
 
 /**
  * class Qenv
@@ -10,20 +9,13 @@ 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;
   public envFilePathAbsolute: string;
 
-  constructor(
-    qenvFileBasePathArg = process.cwd(),
-    envFileBasePathArg,
-    failOnMissing = true,
-    loggerArg: plugins.smartlog.Smartlog = plugins.smartlog.defaultLogger
-  ) {
-    this.logger = loggerArg;
-
+  constructor(qenvFileBasePathArg = process.cwd(), envFileBasePathArg, failOnMissing = true) {
     // lets make sure paths are absolute
     this.qenvFilePathAbsolute = plugins.path.join(
       plugins.path.resolve(qenvFileBasePathArg),
@@ -46,10 +38,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 {
-        console.log('qenv is not set to fail on missing environment variables');
+        this.logger.log('warn', 'qenv is not set to fail on missing environment variables');
       }
     }
   }
@@ -64,40 +56,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 {
-    // lets determine the actual env yml
-    let envYml;
-    try {
-      envYml = plugins.smartfile.fs.toObjectSync(this.envFilePathAbsolute);
-    } catch (err) {
-      envYml = {};
-    }
-    let envVar: string;
-    let envFileVar: string;
-    let dockerSecret: string;
+  public getEnvVarOnDemand(wantedEnvVar: string): string {
+    let envVarFromEnvironmentVariable: string;
+    let envVarFromEnvJsonFile: string;
+    let envVarFromDockerSecret: string;
     let dockerSecretJson: string;
 
     // env var check
-    if (process.env[requiredEnvVar]) {
-      this.availableEnvVars.push(requiredEnvVar);
-      envVar = process.env[requiredEnvVar];
+    if (process.env[wantedEnvVar]) {
+      this.availableEnvVars.push(wantedEnvVar);
+      envVarFromEnvironmentVariable = process.env[wantedEnvVar];
     }
 
     // env file check
-    if (envYml.hasOwnProperty(requiredEnvVar)) {
-      envFileVar = envYml[requiredEnvVar];
-      this.availableEnvVars.push(requiredEnvVar);
+    // lets determine the actual env yml
+    let envJsonFileAsObject;
+    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
@@ -107,42 +98,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;
-    [envVar, envFileVar, dockerSecret, dockerSecretJson].forEach(candidate => {
+    const availableCcandidates: any[] = [];
+    [
+      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;
-    if (envVar) {
-      this.logger.log('ok', `found ${requiredEnvVar} as environment variable`);
-      chosenVar = envVar;
-    } else if (envFileVar) {
-      this.logger.log('ok', `found ${requiredEnvVar} as env.json variable`);
-      chosenVar = envFileVar;
-    } else if (dockerSecret) {
-      this.logger.log('ok', `found ${requiredEnvVar} as docker secret`);
-      chosenVar = dockerSecret;
-    } else if (dockerSecretJson) {
-      this.logger.log('ok', `found ${requiredEnvVar} as docker secret.json`);
-      chosenVar = dockerSecretJson;
+    switch (true) {
+      case !!envVarFromEnvironmentVariable:
+        this.logger.log('ok', `found ${wantedEnvVar} as environment variable`);
+        return envVarFromEnvironmentVariable;
+      case !!envVarFromEnvJsonFile:
+        this.logger.log('ok', `found ${wantedEnvVar} as env.json variable`);
+        return envVarFromEnvJsonFile;
+      case !!envVarFromDockerSecret:
+        this.logger.log('ok', `found ${wantedEnvVar} as docker secret`);
+        return envVarFromDockerSecret;
+      case !!dockerSecretJson:
+        this.logger.log('ok', `found ${wantedEnvVar} as docker secret.json`);
+        return dockerSecretJson;
+      default:
+        this.logger.log(
+          'warn',
+          `could not find the wanted environment variable ${wantedEnvVar} anywhere`
+        );
+        return;
     }
-    return chosenVar;
   }
 
   /**
@@ -154,7 +156,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]);