4.0.4

.gitignore

@@ -1,3 +1,22 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
-docs/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,35 +1,119 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+  - .npmci_cache/
+  key: "$CI_BUILD_STAGE"
 
 stages:
+- security
 - test
 - release
+- metadata
 
-testLEGACY:
-  stage: test
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test lts
+  - npmci git mirror
   tags:
-    - docker
+  - 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
+
+# ====================
+# 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
-    
-testSTABLE:
+  - docker
+  - notpriv
+
+testBuild:
   stage: test
   script:
-    - npmci test stable
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
+  - notpriv
 
 release:
   stage: release
   script:
-    - npmci publish
+  - npmci node install lts
+  - npmci npm publish
+  only:
+  - tags
+  tags:
+  - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+  - docker
+  - priv
+
+trigger:
+  stage: metadata
+  script:
+  - npmci trigger
+  only:
+  - tags
+  tags:
+  - docker
+  - notpriv
+
+pages:
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:18-dind
+  stage: metadata
+  script:
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - docker
+    - notpriv
   only:
     - tags
-  tags:
-    - docker
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public
+  allow_failure: true

README.md

@@ -1,19 +1,43 @@
-# qenv
-provides an easy way for promised environments
+# @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.
+- **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.
 
-```typescript
-import {Qenv} from "qenv";
+```javascript
+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(');
+```
 
-``` 
+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)

dist/index.d.ts

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

dist/qenv.plugins.d.ts

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

dist/qenv.plugins.js

@@ -1,8 +0,0 @@
-"use strict";
-require("typings-global");
-exports.beautylog = require("beautylog");
-exports.lodash = require("lodash");
-exports.path = require("path");
-exports.smartfile = require("smartfile");
-
-//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInFlbnYucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsUUFBTyxnQkFBZ0IsQ0FBQyxDQUFBO0FBQ1YsaUJBQVMsV0FBVyxXQUFXLENBQUMsQ0FBQztBQUNwQyxjQUFNLEdBQUcsT0FBTyxDQUFDLFFBQVEsQ0FBQyxDQUFDO0FBQ3hCLFlBQUksV0FBVyxNQUFNLENBQUMsQ0FBQztBQUN2QixpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDIiwiZmlsZSI6InFlbnYucGx1Z2lucy5qcyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBcInR5cGluZ3MtZ2xvYmFsXCI7XG5leHBvcnQgaW1wb3J0IGJlYXV0eWxvZyA9IHJlcXVpcmUoXCJiZWF1dHlsb2dcIik7XG5leHBvcnQgbGV0IGxvZGFzaCA9IHJlcXVpcmUoXCJsb2Rhc2hcIik7XG5leHBvcnQgaW1wb3J0IHBhdGggPSByZXF1aXJlKFwicGF0aFwiKTtcbmV4cG9ydCBpbXBvcnQgc21hcnRmaWxlID0gcmVxdWlyZShcInNtYXJ0ZmlsZVwiKTtcbiJdfQ==

npmextra.json

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

npmts.json

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

package.json

@@ -1,11 +1,13 @@
 {
-  "name": "qenv",
-  "version": "1.0.8",
-  "description": "promised environments",
+  "name": "@pushrocks/qenv",
+  "version": "4.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,15 +25,27 @@
   },
   "homepage": "https://gitlab.com/pushrocks/qenv#README",
   "devDependencies": {
-    "npmts-g": "^5.2.6",
-    "should": "^9.0.2",
-    "typings-test": "^1.0.1"
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.24",
+    "@pushrocks/tapbundle": "^3.0.13",
+    "@types/node": "^12.7.2",
+    "tslint": "^5.19.0",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "beautylog": "^5.0.12",
-    "lodash": "^4.13.1",
-    "q": "^1.4.1",
-    "smartfile": "^3.0.10",
-    "typings-global": "^1.0.3"
-  }
+    "@pushrocks/smartfile": "^7.0.4",
+    "@pushrocks/smartlog": "^2.0.19"
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "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/assets/qenv.yml

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

test/test.d.ts

@@ -1,2 +0,0 @@
-import "typings-test";
-import "should";

test/test.js

@@ -1,23 +0,0 @@
-"use strict";
-require("typings-test");
-var path = require("path");
-require("should");
-var index_1 = require("../dist/index");
-process.cwd = function () {
-    return path.join(__dirname, "./assets/");
-};
-process.env["key1"] = "original";
-var 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 () {
-        process.env.key1.should.equal("original");
-    });
-    it("key2 should be read from Yml", function () {
-        process.env.key2.should.equal("fromYml");
-    });
-});
-
-//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsSUFBWSxJQUFJLFdBQU0sTUFBTSxDQUFDLENBQUE7QUFDN0IsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUNoQixzQkFBbUIsZUFBZSxDQUFDLENBQUE7QUFFbkMsT0FBTyxDQUFDLEdBQUcsR0FBRztJQUNWLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBQyxXQUFXLENBQUMsQ0FBQztBQUM1QyxDQUFDLENBQUE7QUFFRCxPQUFPLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxHQUFHLFVBQVUsQ0FBQTtBQUVoQyxJQUFJLGNBQW1CLENBQUM7QUFDeEIsUUFBUSxDQUFDLFlBQVksRUFBQztJQUNsQixFQUFFLENBQUMsMkJBQTJCLEVBQUM7UUFDM0IsY0FBYyxHQUFHLElBQUksWUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxPQUFPLENBQUMsR0FBRyxFQUFFLEVBQUMsS0FBSyxDQUFDLENBQUM7SUFDakUsQ0FBQyxDQUFDLENBQUM7SUFDSCxFQUFFLENBQUMsK0RBQStELEVBQUM7UUFDL0QsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUM5QyxDQUFDLENBQUMsQ0FBQztJQUNILEVBQUUsQ0FBQyw4QkFBOEIsRUFBQztRQUM5QixPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQzdDLENBQUMsQ0FBQyxDQUFBO0FBRU4sQ0FBQyxDQUFDLENBQUMiLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBcInR5cGluZ3MtdGVzdFwiO1xuaW1wb3J0ICogYXMgcGF0aCBmcm9tIFwicGF0aFwiO1xuaW1wb3J0IFwic2hvdWxkXCI7XG5pbXBvcnQge1FlbnZ9IGZyb20gXCIuLi9kaXN0L2luZGV4XCI7XG5cbnByb2Nlc3MuY3dkID0gKCkgPT4ge1xuICAgIHJldHVybiBwYXRoLmpvaW4oX19kaXJuYW1lLFwiLi9hc3NldHMvXCIpO1xufVxuXG5wcm9jZXNzLmVudltcImtleTFcIl0gPSBcIm9yaWdpbmFsXCJcblxubGV0IHFlbnZUZXN0T2JqZWN0OlFlbnY7XG5kZXNjcmliZShcIlFlbnYgY2xhc3NcIixmdW5jdGlvbigpe1xuICAgIGl0KFwic2hvdWxkIGNyZWF0ZSBhIG5ldyBjbGFzc1wiLGZ1bmN0aW9uKCl7XG4gICAgICAgIHFlbnZUZXN0T2JqZWN0ID0gbmV3IFFlbnYocHJvY2Vzcy5jd2QoKSxwcm9jZXNzLmN3ZCgpLGZhbHNlKTtcbiAgICB9KTtcbiAgICBpdChcImtleTEgc2hvdWxkIGJlIG5vdCBiZSBvdmVyd3JpdHRlbiBzaW5jZSBpdCBpcyBhbHJlYWR5IHByZXNlbnRcIixmdW5jdGlvbigpe1xuICAgICAgICBwcm9jZXNzLmVudi5rZXkxLnNob3VsZC5lcXVhbChcIm9yaWdpbmFsXCIpO1xuICAgIH0pO1xuICAgIGl0KFwia2V5MiBzaG91bGQgYmUgcmVhZCBmcm9tIFltbFwiLGZ1bmN0aW9uKCl7XG4gICAgICAgIHByb2Nlc3MuZW52LmtleTIuc2hvdWxkLmVxdWFsKFwiZnJvbVltbFwiKTtcbiAgICB9KVxuXG59KTsiXX0=

test/test.ts

@@ -1,24 +1,29 @@
-import "typings-test";
-import * as path from "path";
-import "should";
-import {Qenv} from "../dist/index";
+import * as path from 'path';
+import { tap, expect } from '@pushrocks/tapbundle';
+import * as qenv from '../ts/index';
 
-process.cwd = () => {
-    return path.join(__dirname,"./assets/");
-}
+process.env['key1'] = 'original';
 
-process.env["key1"] = "original"
+let testQenv: qenv.Qenv;
 
-let qenvTestObject:Qenv;
-describe("Qenv class",function(){
-    it("should create a new class",function(){
-        qenvTestObject = new Qenv(process.cwd(),process.cwd(),false);
-    });
-    it("key1 should be not be overwritten since it is already present",function(){
-        process.env.key1.should.equal("original");
-    });
-    it("key2 should be read from Yml",function(){
-        process.env.key2.should.equal("fromYml");
-    })
+tap.test('should create a new class', async () => {
+  testQenv = new qenv.Qenv(path.join(__dirname, 'assets'), path.join(__dirname, 'assets'), false);
+  expect(testQenv).to.be.instanceof(qenv.Qenv);
+});
 
-});
+tap.test('key1 should be not be overwritten since it is already present', async () => {
+  expect(testQenv.getEnvVarRequired('key1')).to.equal('original');
+  expect(testQenv.getEnvVarOnDemand('key1')).to.equal('original');
+});
+
+tap.test('key2 should be read from Yml', async () => {
+  expect(testQenv.getEnvVarRequired('key2')).to.equal('fromJson');
+  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('fromJson');
+});
+
+tap.start();

ts/index.ts

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

ts/qenv.classes.qenv.ts

@@ -0,0 +1,190 @@
+import * as plugins from './qenv.plugins';
+plugins.smartlog.defaultLogger.enableConsole();
+
+/**
+ * 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 keyValueObject: { [key: string]: any } = {};
+  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.json'
+    );
+
+    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) {
+        this.logger.log('error', 'Exiting!');
+        process.exit(1);
+      } else {
+        this.logger.log('warn', 'qenv is not set to fail on missing environment variables');
+      }
+    }
+  }
+
+  /**
+   * only gets an environment variable if it is required within a read qenv.yml file
+   * @param envVarName
+   */
+  public getEnvVarRequired(envVarName): string {
+    return this.keyValueObject[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) {
+      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')
+    ) {
+      const availableSecrets = plugins.smartfile.fs.listAllItemsSync('/run/secrets');
+      for (const secret of availableSecrets) {
+        if (secret.includes('secret.json') && !dockerSecret) {
+          const secretObject = plugins.smartfile.fs.toObjectSync(`/run/secrets/${secret}`);
+          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) {
+      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;
+    }
+    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', `qenv (promised environment): ./env.yml 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);
+        this.keyValueObject[requiredEnvVar] = 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,5 +1,10 @@
-import "typings-global";
-export import beautylog = require("beautylog");
-export let lodash = require("lodash");
-export import path = require("path");
-export import smartfile = require("smartfile");
+// native
+import * as path from 'path';
+
+export { path };
+
+// @pushrocks scope
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartlog from '@pushrocks/smartlog';
+
+export { smartfile, smartlog };

tslint.json

@@ -0,0 +1,17 @@
+{
+  "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"
+}