3.0.4

.gitlab-ci.yml

@@ -1,59 +1,150 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone standard
+image: hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+  - .npmci_cache/
+  key: "$CI_BUILD_STAGE"
 
 stages:
+- security
 - test
 - release
-- trigger
+- metadata
-- pages
 
-testLEGACY:
+# ====================
-  stage: test
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
+  - npmci git mirror
   tags:
   - docker
+  - notpriv
+
+snyk:
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
+    - npmci command snyk test
+  tags:
+  - 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:
   stage: test
   script:
-    - npmci test lts
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - notpriv
     
 testSTABLE:
   stage: test
   script:
-    - npmci test stable
+  - npmci npm prepare
+  - npmci node install stable
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - notpriv
 
 release:
   stage: release
   script:
-    - npmci publish
+  - npmci node install stable
+  - npmci npm publish
   only:
   - tags
   tags:
   - 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/')
+    - docker run
+        --env SOURCE_CODE="$PWD"
+        --volume "$PWD":/code
+        --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
+  - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
   - npmci trigger
   only:
   - tags
   tags:
   - docker
+  - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmpage
+  image: hosttoday/ht-docker-node:npmci
-  stage: pages
+  stage: metadata
   script:
-    - npmci command npmpage --publish gitlab
+    - npmci command npm install -g typedoc typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+  tags:
+    - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
     - public
+  allow_failure: true

README.md

@@ -1,13 +1,16 @@
 # qenv
+
 easy promised environments
 
 ## Availabililty
-[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/qenv)
+
-[![git](https://push.rocks/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/qenv)
+[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/qenv)
-[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/qenv)
+[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/qenv)
-[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/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)
@@ -19,22 +22,25 @@ easy promised environments
 [![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.
+- **qenv.yml** - specifies which ENV vars are required.
-* **env.yml** - specifies all env vars that are not already set in the current environment.
+- **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";
+import { Qenv } from 'qenv';
-
-myQenv = new Qenv("path/to/dir/where/qenv.yml/is/","path/to/dir/where/env.yml/is(");
 
+const myQenv = new Qenv('path/to/dir/where/qenv.yml/is/', 'path/to/dir/where/env.yml/is(');
 ```
 
-[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)
+> 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)

dist/index.d.ts

@@ -1,11 +0,0 @@
-export interface IKeyValueObject {
-    key: string;
-    value: string;
-}
-export declare class Qenv {
-    requiredEnvVars: string[];
-    availableEnvVars: string[];
-    missingEnvVars: string[];
-    keyValueObjectArray: IKeyValueObject[];
-    constructor(basePathArg: string, envYmlPathArg: any, failOnMissing?: boolean);
-}

dist/index.js

@@ -1,69 +0,0 @@
-"use strict";
-const plugins = require("./qenv.plugins");
-;
-class Qenv {
-    constructor(basePathArg = process.cwd(), envYmlPathArg, failOnMissing = true) {
-        this.requiredEnvVars = [];
-        this.availableEnvVars = [];
-        this.missingEnvVars = [];
-        this.keyValueObjectArray = [];
-        getRequiredEnvVars(basePathArg, this.requiredEnvVars);
-        getAvailableEnvVars(this.requiredEnvVars, envYmlPathArg, this.availableEnvVars, this.keyValueObjectArray);
-        this.missingEnvVars = getMissingEnvVars(this.requiredEnvVars, this.availableEnvVars);
-        // handle missing variables
-        if (this.missingEnvVars.length > 0) {
-            console.info('Required Env Vars are:');
-            console.log(this.requiredEnvVars);
-            console.error('However some Env variables could not be resolved:');
-            console.log(this.missingEnvVars);
-            if (failOnMissing) {
-                console.error('Exiting!');
-                process.exit(1);
-            }
-        }
-    }
-    ;
-}
-exports.Qenv = Qenv;
-;
-let getRequiredEnvVars = (pathArg, requiredEnvVarsArray) => {
-    let qenvFilePath = plugins.path.join(pathArg, 'qenv.yml');
-    let qenvFile = plugins.smartfile.fs.toObjectSync(qenvFilePath);
-    for (let keyArg in qenvFile.vars) {
-        requiredEnvVarsArray.push(qenvFile.vars[keyArg]);
-    }
-    ;
-};
-let getAvailableEnvVars = (requiredEnvVarsArg, envYmlPathArg, availableEnvVarsArray, keyValueObjectArrayArg) => {
-    envYmlPathArg = plugins.path.join(envYmlPathArg, 'env.yml');
-    let envYml;
-    try {
-        envYml = plugins.smartfile.fs.toObjectSync(envYmlPathArg);
-    }
-    catch (err) {
-        console.log("env file couldn't be found at " + envYmlPathArg);
-        envYml = {};
-    }
-    for (let requiredEnvVar of requiredEnvVarsArg) {
-        if (process.env[requiredEnvVar]) {
-            availableEnvVarsArray.push(requiredEnvVar);
-            keyValueObjectArrayArg.push({
-                key: requiredEnvVar,
-                value: process.env[requiredEnvVar]
-            });
-        }
-        else if (envYml.hasOwnProperty(requiredEnvVar)) {
-            process.env[requiredEnvVar] = envYml[requiredEnvVar];
-            availableEnvVarsArray.push(requiredEnvVar);
-            keyValueObjectArrayArg.push({
-                key: requiredEnvVar,
-                value: process.env[requiredEnvVar]
-            });
-        }
-    }
-    ;
-};
-let getMissingEnvVars = (requiredEnvVarsArray, availableEnvVarsArray) => {
-    return plugins.lodash.difference(requiredEnvVarsArray, availableEnvVarsArray);
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMENBQXlDO0FBS3hDLENBQUM7QUFFRjtJQUtJLFlBQVksV0FBVyxHQUFHLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxhQUFhLEVBQUMsYUFBYSxHQUFHLElBQUk7UUFKMUUsb0JBQWUsR0FBYSxFQUFFLENBQUE7UUFDOUIscUJBQWdCLEdBQVksRUFBRSxDQUFBO1FBQzlCLG1CQUFjLEdBQVksRUFBRSxDQUFBO1FBQzVCLHdCQUFtQixHQUFxQixFQUFFLENBQUE7UUFFdEMsa0JBQWtCLENBQUMsV0FBVyxFQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQTtRQUNwRCxtQkFBbUIsQ0FBQyxJQUFJLENBQUMsZUFBZSxFQUFDLGFBQWEsRUFBQyxJQUFJLENBQUMsZ0JBQWdCLEVBQUMsSUFBSSxDQUFDLG1CQUFtQixDQUFDLENBQUE7UUFDdEcsSUFBSSxDQUFDLGNBQWMsR0FBRyxpQkFBaUIsQ0FBQyxJQUFJLENBQUMsZUFBZSxFQUFDLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFBO1FBRW5GLDJCQUEyQjtRQUMzQixFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQSxDQUFDO1lBQ2hDLE9BQU8sQ0FBQyxJQUFJLENBQUMsd0JBQXdCLENBQUMsQ0FBQTtZQUN0QyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQTtZQUNqQyxPQUFPLENBQUMsS0FBSyxDQUFDLG1EQUFtRCxDQUFDLENBQUE7WUFDbEUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUE7WUFDaEMsRUFBRSxDQUFDLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQztnQkFDaEIsT0FBTyxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtnQkFDekIsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQTtZQUNuQixDQUFDO1FBQ0wsQ0FBQztJQUNMLENBQUM7SUFBQSxDQUFDO0NBQ0w7QUF0QkQsb0JBc0JDO0FBQUEsQ0FBQztBQUVGLElBQUksa0JBQWtCLEdBQUcsQ0FBQyxPQUFlLEVBQUUsb0JBQThCO0lBQ3JFLElBQUksWUFBWSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBQyxVQUFVLENBQUMsQ0FBQTtJQUN4RCxJQUFJLFFBQVEsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxZQUFZLENBQUMsWUFBWSxDQUFDLENBQUE7SUFDOUQsR0FBRyxDQUFDLENBQUMsSUFBSSxNQUFNLElBQUksUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDL0Isb0JBQW9CLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQTtJQUNwRCxDQUFDO0lBQUEsQ0FBQztBQUNOLENBQUMsQ0FBQTtBQUlELElBQUksbUJBQW1CLEdBQUcsQ0FBQyxrQkFBNEIsRUFBQyxhQUFxQixFQUFDLHFCQUErQixFQUFDLHNCQUF5QztJQUNuSixhQUFhLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsYUFBYSxFQUFDLFNBQVMsQ0FBQyxDQUFBO0lBQzFELElBQUksTUFBTSxDQUFBO0lBQ1YsSUFBSSxDQUFDO1FBQ0QsTUFBTSxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxhQUFhLENBQUMsQ0FBQTtJQUM3RCxDQUFDO0lBQUMsS0FBSyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztRQUNYLE9BQU8sQ0FBQyxHQUFHLENBQUMsZ0NBQWdDLEdBQUcsYUFBYSxDQUFDLENBQUE7UUFDN0QsTUFBTSxHQUFHLEVBQUUsQ0FBQTtJQUNmLENBQUM7SUFDRCxHQUFHLENBQUMsQ0FBQyxJQUFJLGNBQWMsSUFBSSxrQkFBa0IsQ0FBQyxDQUFBLENBQUM7UUFDM0MsRUFBRSxDQUFDLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFBLENBQUM7WUFDN0IscUJBQXFCLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxDQUFBO1lBQzFDLHNCQUFzQixDQUFDLElBQUksQ0FBQztnQkFDeEIsR0FBRyxFQUFFLGNBQWM7Z0JBQ25CLEtBQUssRUFBRSxPQUFPLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQzthQUNyQyxDQUFDLENBQUE7UUFDTixDQUFDO1FBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxjQUFjLENBQUMsY0FBYyxDQUFDLENBQUMsQ0FBQSxDQUFDO1lBQzlDLE9BQU8sQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLEdBQUcsTUFBTSxDQUFDLGNBQWMsQ0FBQyxDQUFBO1lBQ3BELHFCQUFxQixDQUFDLElBQUksQ0FBQyxjQUFjLENBQUMsQ0FBQTtZQUMxQyxzQkFBc0IsQ0FBQyxJQUFJLENBQUM7Z0JBQ3hCLEdBQUcsRUFBRSxjQUFjO2dCQUNuQixLQUFLLEVBQUUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxjQUFjLENBQUM7YUFDckMsQ0FBQyxDQUFBO1FBQ04sQ0FBQztJQUNMLENBQUM7SUFBQSxDQUFDO0FBQ04sQ0FBQyxDQUFBO0FBRUQsSUFBSSxpQkFBaUIsR0FBRyxDQUFDLG9CQUE4QixFQUFDLHFCQUErQjtJQUNuRixNQUFNLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsb0JBQW9CLEVBQUMscUJBQXFCLENBQUMsQ0FBQTtBQUNoRixDQUFDLENBQUEifQ==

dist/qenv.plugins.d.ts

@@ -1,4 +0,0 @@
-import 'typings-global';
-export declare let lodash: any;
-export import path = require('path');
-export import smartfile = require('smartfile');

dist/qenv.plugins.js

@@ -1,6 +0,0 @@
-"use strict";
-require("typings-global");
-exports.lodash = require('lodash');
-exports.path = require("path");
-exports.smartfile = require("smartfile");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicWVudi5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvcWVudi5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSwwQkFBd0I7QUFDYixRQUFBLE1BQU0sR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7QUFDdEMsK0JBQXFDO0FBQ3JDLHlDQUE4QyJ9

npmextra.json

@@ -0,0 +1,6 @@
+{
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  }
+}

npmts.json

@@ -1,3 +0,0 @@
-{
-    "mode":"default"
-}

package.json

@@ -1,11 +1,13 @@
 {
-  "name": "qenv",
+  "name": "@pushrocks/qenv",
-  "version": "1.1.2",
+  "version": "3.0.4",
+  "private": false,
   "description": "easy promised environments",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -23,14 +25,16 @@
   },
   "homepage": "https://gitlab.com/pushrocks/qenv#README",
   "devDependencies": {
-    "npmts-g": "^6.0.0",
+    "@gitzone/tsbuild": "^2.0.22",
-    "smartchai": "^1.0.1",
+    "@gitzone/tsrun": "^1.1.12",
-    "typings-test": "^1.0.3"
+    "@gitzone/tstest": "^1.0.13",
+    "@pushrocks/tapbundle": "^3.0.5",
+    "@types/node": "^10.5.8",
+    "tslint": "^5.12.0",
+    "tslint-config-prettier": "^1.17.0"
   },
   "dependencies": {
-    "lodash": "^4.17.4",
+    "@pushrocks/smartfile": "^6.0.6",
-    "q": "^1.4.1",
+    "@pushrocks/smartlog": "^2.0.9"
-    "smartfile": "^4.1.3",
-    "typings-global": "^1.0.14"
   }
 }

test/assets/qenv.yml

@@ -1,4 +1,4 @@
-vars:
+required:
   - key1
   - key2
   - key3

test/test.d.ts

@@ -1 +0,0 @@
-import 'typings-test';

test/test.js

@@ -1,26 +0,0 @@
-"use strict";
-require("typings-test");
-const path = require("path");
-const smartchai_1 = require("smartchai");
-const index_1 = require("../dist/index");
-process.cwd = () => {
-    return path.join(__dirname, './assets/');
-};
-process.env['key1'] = 'original';
-let qenvTestObject;
-describe('Qenv class', function () {
-    it('should create a new class', function () {
-        qenvTestObject = new index_1.Qenv(process.cwd(), process.cwd(), false);
-    });
-    it('key1 should be not be overwritten since it is already present', function () {
-        smartchai_1.expect(process.env.key1).to.equal('original');
-    });
-    it('key2 should be read from Yml', function () {
-        smartchai_1.expect(process.env.key2).to.equal('fromYml');
-    });
-    it('keyValueObjectArray should hold all retrieved values', function () {
-        smartchai_1.expect(qenvTestObject.keyValueObjectArray[0].value).to.equal('original');
-        smartchai_1.expect(qenvTestObject.keyValueObjectArray[1].value).to.equal('fromYml');
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUNyQiw2QkFBNEI7QUFDNUIseUNBQWtDO0FBQ2xDLHlDQUFrQztBQUVsQyxPQUFPLENBQUMsR0FBRyxHQUFHO0lBQ1YsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFDLFdBQVcsQ0FBQyxDQUFBO0FBQzNDLENBQUMsQ0FBQTtBQUVELE9BQU8sQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLEdBQUcsVUFBVSxDQUFBO0FBRWhDLElBQUksY0FBbUIsQ0FBQTtBQUN2QixRQUFRLENBQUMsWUFBWSxFQUFDO0lBQ2xCLEVBQUUsQ0FBQywyQkFBMkIsRUFBQztRQUMzQixjQUFjLEdBQUcsSUFBSSxZQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxLQUFLLENBQUMsQ0FBQTtJQUNoRSxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQywrREFBK0QsRUFBQztRQUMvRCxrQkFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtJQUNqRCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyw4QkFBOEIsRUFBQztRQUM5QixrQkFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQTtJQUNoRCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyxzREFBc0QsRUFBQztRQUN0RCxrQkFBTSxDQUFDLGNBQWMsQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxFQUFFLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxDQUFBO1FBQ3hFLGtCQUFNLENBQUMsY0FBYyxDQUFDLG1CQUFtQixDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDLENBQUE7SUFDM0UsQ0FBQyxDQUFDLENBQUE7QUFFTixDQUFDLENBQUMsQ0FBQSJ9

test/test.ts

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

ts/index.ts

@@ -1,71 +1 @@
-import * as plugins from "./qenv.plugins"
+export * from './qenv.classes.qenv';
-
-export interface IKeyValueObject {
-    key: string,
-    value: string
-};
-
-export class Qenv {
-    requiredEnvVars: string[] = []
-    availableEnvVars:string[] = []
-    missingEnvVars:string[] = []
-    keyValueObjectArray:IKeyValueObject[] = []
-    constructor(basePathArg = process.cwd(),envYmlPathArg,failOnMissing = true){
-        getRequiredEnvVars(basePathArg,this.requiredEnvVars)
-        getAvailableEnvVars(this.requiredEnvVars,envYmlPathArg,this.availableEnvVars,this.keyValueObjectArray)
-        this.missingEnvVars = getMissingEnvVars(this.requiredEnvVars,this.availableEnvVars)
-
-        // handle missing variables
-        if (this.missingEnvVars.length > 0){
-            console.info('Required Env Vars are:')
-            console.log(this.requiredEnvVars)
-            console.error('However some Env variables could not be resolved:')
-            console.log(this.missingEnvVars)
-            if (failOnMissing) {
-                console.error('Exiting!')
-                process.exit(1)
-            }
-        }
-    };
-};
-
-let getRequiredEnvVars = (pathArg: string, requiredEnvVarsArray: string[]) => {
-    let qenvFilePath = plugins.path.join(pathArg,'qenv.yml')
-    let qenvFile = plugins.smartfile.fs.toObjectSync(qenvFilePath)
-    for (let keyArg in qenvFile.vars) {
-        requiredEnvVarsArray.push(qenvFile.vars[keyArg])
-    };
-}
-
-
-
-let getAvailableEnvVars = (requiredEnvVarsArg: string[],envYmlPathArg: string,availableEnvVarsArray: string[],keyValueObjectArrayArg: IKeyValueObject[]) => {
-    envYmlPathArg = plugins.path.join(envYmlPathArg,'env.yml')
-    let envYml
-    try {
-        envYml = plugins.smartfile.fs.toObjectSync(envYmlPathArg)
-    } catch (err) {
-        console.log("env file couldn't be found at " + envYmlPathArg)
-        envYml = {}
-    }
-    for (let requiredEnvVar of requiredEnvVarsArg){
-        if (process.env[requiredEnvVar]){
-            availableEnvVarsArray.push(requiredEnvVar)
-            keyValueObjectArrayArg.push({
-                key: requiredEnvVar,
-                value: process.env[requiredEnvVar]
-            })
-        } else if (envYml.hasOwnProperty(requiredEnvVar)){
-            process.env[requiredEnvVar] = envYml[requiredEnvVar]
-            availableEnvVarsArray.push(requiredEnvVar)
-            keyValueObjectArrayArg.push({
-                key: requiredEnvVar,
-                value: process.env[requiredEnvVar]
-            })
-        }
-    };
-}
-
-let getMissingEnvVars = (requiredEnvVarsArray: string[],availableEnvVarsArray: string[]) => {
-    return plugins.lodash.difference(requiredEnvVarsArray,availableEnvVarsArray)
-}

ts/qenv.classes.qenv.ts

@@ -0,0 +1,189 @@
+import * as plugins from './qenv.plugins';
+
+export interface IKeyValueObject {
+  key: string;
+  value: string;
+}
+
+/**
+ * class Qenv
+ * allows to make assertions about the environments while being more flexibel in how to meet them
+ */
+export class Qenv {
+  public requiredEnvVars: string[] = [];
+  public availableEnvVars: string[] = [];
+  public missingEnvVars: string[] = [];
+  public keyValueObjectArray: IKeyValueObject[] = [];
+  public logger: plugins.smartlog.Smartlog;
+
+  // filePaths
+  public qenvFilePathAbsolute: string;
+  public envFilePathAbsolute: string;
+
+  constructor(
+    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),
+      'qenv.yml'
+    );
+    this.envFilePathAbsolute = plugins.path.join(
+      plugins.path.resolve(envFileBasePathArg),
+      'env.yml'
+    );
+
+    this.getRequiredEnvVars();
+    this.getAvailableEnvVars();
+
+    this.missingEnvVars = this.getMissingEnvVars();
+
+    // handle missing variables
+    if (this.missingEnvVars.length > 0) {
+      console.info('Required Env Vars are:');
+      console.log(this.requiredEnvVars);
+      console.error('However some Env variables could not be resolved:');
+      console.log(this.missingEnvVars);
+      if (failOnMissing) {
+        console.error('Exiting!');
+        process.exit(1);
+      }
+    }
+  }
+
+  /**
+   * 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];
+  }
+
+  /**
+   * tries to get any env var even if it is not required
+   * @param requiredEnvVar
+   */
+  public getEnvVarOnDemand(requiredEnvVar: string): string {
+    // lets determine the actual env yml
+    let envYml;
+    try {
+      envYml = plugins.smartfile.fs.toObjectSync(this.envFilePathAbsolute);
+    } catch (err) {
+      console.log("env file couldn't be found at " + this.envFilePathAbsolute);
+      envYml = {};
+    }
+    let envVar: string;
+    let envFileVar: string;
+    let dockerSecret: string;
+    let dockerSecretJson: string;
+
+    // env var check
+    if (process.env[requiredEnvVar]) {
+      this.availableEnvVars.push(requiredEnvVar);
+      envVar = process.env[requiredEnvVar];
+    }
+
+    // env file check
+    if (envYml.hasOwnProperty(requiredEnvVar)) {
+      envFileVar = envYml[requiredEnvVar];
+      this.availableEnvVars.push(requiredEnvVar);
+    }
+
+    // docker secret check
+    if (
+      plugins.smartfile.fs.isDirectory('/run') &&
+      plugins.smartfile.fs.isDirectory('/run/secrets') &&
+      plugins.smartfile.fs.fileExistsSync(`/run/secrets/${requiredEnvVar}`)
+    ) {
+      dockerSecret = plugins.smartfile.fs.toStringSync(`/run/secrets/${requiredEnvVar}`);
+    }
+
+    // docker secret.json
+    if (
+      plugins.smartfile.fs.isDirectory('/run') &&
+      plugins.smartfile.fs.isDirectory('/run/secrets') &&
+      plugins.smartfile.fs.fileExistsSync(`/run/secrets/secret.json`)
+    ) {
+      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++;
+      }
+    });
+    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
+   */
+  private getRequiredEnvVars = () => {
+    let qenvFile: any = {};
+    if (plugins.smartfile.fs.fileExistsSync(this.qenvFilePathAbsolute)) {
+      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!`);
+    } else {
+      for (const keyArg of Object.keys(qenvFile.required)) {
+        this.requiredEnvVars.push(qenvFile.required[keyArg]);
+      }
+    }
+  };
+
+  /**
+   * gets the available env vars
+   */
+  private getAvailableEnvVars = () => {
+    for (const requiredEnvVar of this.requiredEnvVars) {
+      const chosenVar = this.getEnvVarOnDemand(requiredEnvVar);
+      if (chosenVar) {
+        this.availableEnvVars.push(requiredEnvVar);
+        process.env[requiredEnvVar] = chosenVar;
+        this.keyValueObjectArray.push({
+          key: requiredEnvVar,
+          value: chosenVar
+        });
+      }
+    }
+  };
+
+  /**
+   * gets missing env vars
+   */
+  private getMissingEnvVars = (): string[] => {
+    const missingEnvVars: string[] = [];
+    for (const envVar of this.requiredEnvVars) {
+      if (!this.availableEnvVars.includes(envVar)) {
+        missingEnvVars.push(envVar);
+      }
+    }
+    return missingEnvVars;
+  };
+}

ts/qenv.plugins.ts

@@ -1,4 +1,16 @@
-import 'typings-global';
+// native
-export let lodash = require('lodash');
+import * as path from 'path';
-export import path = require('path');
+
-export import smartfile = require('smartfile')
+export {
+  path
+}
+
+// @pushrocks scope
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartlog from '@pushrocks/smartlog';
+
+export {
+  smartfile,
+  smartlog
+}
+

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "extends": ["tslint:latest", "tslint-config-prettier"],
+  "rules": {
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
 }