4.0.8

.gitignore

@@ -1,4 +1,20 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
-pages/
 public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -18,127 +18,104 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - 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
+    - lossless
-  - notpriv
+    - docker
-
+    - notpriv
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run build
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
-        --volume "$PWD:/code"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
-  artifacts:
-    reports:
-      sast: gl-sast-report.json
-  tags:
-  - docker
-  - priv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - priv
 
-testSTABLE:
+testBuild:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -146,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,46 +0,0 @@
-# qenv
-
-easy promised environments
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/qenv)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/qenv)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/qenv)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](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/qenv.svg)](https://www.npmjs.com/package/qenv)
-[![Dependency Status](https://david-dm.org/pushrocks/qenv.svg)](https://david-dm.org/pushrocks/qenv)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/qenv/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/qenv/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/qenv/badges/code.svg)](https://www.bithound.io/github/pushrocks/qenv)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
-
-## 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(');
-```
-
-> 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://push.rocks)

npmextra.json

@@ -2,5 +2,16 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "qenv",
+      "shortDescription": "easy promised environments",
+      "npmPackagename": "@pushrocks/qenv",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,10 +1,10 @@
 {
   "name": "@pushrocks/qenv",
-  "version": "4.0.0",
+  "version": "4.0.8",
   "private": false,
   "description": "easy promised environments",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
     "build": "(tsbuild)"
@@ -25,16 +25,28 @@
   },
   "homepage": "https://gitlab.com/pushrocks/qenv#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.24",
-    "@gitzone/tsrun": "^1.1.12",
+    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.13",
+    "@gitzone/tstest": "^1.0.33",
-    "@pushrocks/tapbundle": "^3.0.5",
+    "@pushrocks/tapbundle": "^3.2.1",
-    "@types/node": "^10.5.8",
+    "@types/node": "^14.0.12",
-    "tslint": "^5.12.0",
+    "tslint": "^6.1.2",
-    "tslint-config-prettier": "^1.17.0"
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^6.0.6",
+    "@pushrocks/smartfile": "^7.0.12",
-    "@pushrocks/smartlog": "^2.0.9"
+    "@pushrocks/smartlog": "^2.0.26"
-  }
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

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

@@ -7,11 +7,7 @@ process.env['key1'] = 'original';
 let testQenv: qenv.Qenv;
 
 tap.test('should create a new class', async () => {
-  testQenv = new qenv.Qenv(
+  testQenv = new qenv.Qenv(path.join(__dirname, 'assets'), path.join(__dirname, 'assets'), false);
-    path.join(__dirname, 'assets'),
-    path.join(__dirname, 'assets'),
-    false
-  );
   expect(testQenv).to.be.instanceof(qenv.Qenv);
 });
 
@@ -21,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
@@ -9,21 +8,14 @@ export class Qenv {
   public requiredEnvVars: string[] = [];
   public availableEnvVars: string[] = [];
   public missingEnvVars: string[] = [];
-  public keyValueObject: {[key: string]: any } = {};
+  public keyValueObject: { [key: string]: any } = {};
-  public logger: plugins.smartlog.Smartlog;
+  public logger = new plugins.smartlog.ConsoleLog();
 
   // filePaths
   public qenvFilePathAbsolute: string;
   public envFilePathAbsolute: string;
 
-  constructor(
+  constructor(qenvFileBasePathArg = process.cwd(), envFileBasePathArg, failOnMissing = true) {
-    qenvFileBasePathArg = process.cwd(),
-    envFileBasePathArg,
-    failOnMissing = true,
-    loggerArg: plugins.smartlog.Smartlog = plugins.smartlog.defaultLogger
-  ) {
-    this.logger = loggerArg;
-
     // lets make sure paths are absolute
     this.qenvFilePathAbsolute = plugins.path.join(
       plugins.path.resolve(qenvFileBasePathArg),
@@ -31,7 +23,7 @@ export class Qenv {
     );
     this.envFilePathAbsolute = plugins.path.join(
       plugins.path.resolve(envFileBasePathArg),
-      'env.yml'
+      'env.json'
     );
 
     this.getRequiredEnvVars();
@@ -46,8 +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 {
+        this.logger.log('warn', 'qenv is not set to fail on missing environment variables');
       }
     }
   }
@@ -62,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 {
+  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 +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;
+    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 +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]);
@@ -171,7 +178,7 @@ export class Qenv {
         this.keyValueObject[requiredEnvVar] = chosenVar;
       }
     }
-  }
+  };
 
   /**
    * gets missing env vars

ts/qenv.plugins.ts

@@ -1,16 +1,10 @@
 // native
 import * as path from 'path';
 
-export {
+export { path };
-  path
-}
 
 // @pushrocks scope
 import * as smartfile from '@pushrocks/smartfile';
 import * as smartlog from '@pushrocks/smartlog';
 
-export {
+export { smartfile, smartlog };
-  smartfile,
-  smartlog
-}
-