Compare commits
16 Commits
Author | SHA1 | Date | |
---|---|---|---|
35e71ccf00 | |||
11a2cf83ee | |||
d7a0541d81 | |||
c03e17d522 | |||
b9d1080829 | |||
a84a257e4b | |||
2fa659a22a | |||
bdc99cc3a6 | |||
2956278369 | |||
c61ef2eeba | |||
41c97c4c05 | |||
8870f9adf2 | |||
dfb400ba5c | |||
38609031d9 | |||
1d4808ed4a | |||
612f8307b8 |
18
README.md
18
README.md
@ -2,6 +2,18 @@
|
|||||||
provides an easy way for promised environments
|
provides an easy way for promised environments
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
qenv looks for an qenv.yml that defines needed env vars. qenv dirst checks if they are already specified.
|
qenv works with two files:
|
||||||
If not, qenv by default looks for a .nogit/env.yml file.
|
|
||||||
If any env var is not specified, qenv throws an error and exits.
|
* **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";
|
||||||
|
|
||||||
|
myQenv = new Qenv("path/to/dir/where/qenv.yml/is/","path/to/dir/where/env.yml/is(");
|
||||||
|
|
||||||
|
```
|
11
dist/index.d.ts
vendored
11
dist/index.d.ts
vendored
@ -0,0 +1,11 @@
|
|||||||
|
export interface keyValueObject {
|
||||||
|
key: string;
|
||||||
|
value: string;
|
||||||
|
}
|
||||||
|
export declare class Qenv {
|
||||||
|
requiredEnvVars: string[];
|
||||||
|
availableEnvVars: string[];
|
||||||
|
missingEnvVars: string[];
|
||||||
|
keyValueObjectArray: keyValueObject[];
|
||||||
|
constructor(basePathArg: string, envYmlPathArg: any, failOnMissing?: boolean);
|
||||||
|
}
|
||||||
|
72
dist/index.js
vendored
72
dist/index.js
vendored
@ -1,3 +1,69 @@
|
|||||||
|
"use strict";
|
||||||
|
const plugins = require("./qenv.plugins");
|
||||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsImZpbGUiOiJpbmRleC5qcyIsInNvdXJjZXNDb250ZW50IjpbXX0=
|
;
|
||||||
|
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) {
|
||||||
|
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);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
;
|
||||||
|
}
|
||||||
|
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) {
|
||||||
|
plugins.beautylog.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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0sZ0JBQWdCLENBQUMsQ0FBQTtBQUt6QyxDQUFDO0FBRUY7SUFLSSxZQUFZLFdBQVcsR0FBRyxPQUFPLENBQUMsR0FBRyxFQUFFLEVBQUMsYUFBYSxFQUFDLGFBQWEsR0FBRyxJQUFJO1FBSjFFLG9CQUFlLEdBQVksRUFBRSxDQUFDO1FBQzlCLHFCQUFnQixHQUFZLEVBQUUsQ0FBQztRQUMvQixtQkFBYyxHQUFZLEVBQUUsQ0FBQztRQUM3Qix3QkFBbUIsR0FBb0IsRUFBRSxDQUFDO1FBRXRDLGtCQUFrQixDQUFDLFdBQVcsRUFBQyxJQUFJLENBQUMsZUFBZSxDQUFDLENBQUM7UUFDckQsbUJBQW1CLENBQUMsSUFBSSxDQUFDLGVBQWUsRUFBQyxhQUFhLEVBQUMsSUFBSSxDQUFDLGdCQUFnQixFQUFDLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDO1FBQ3ZHLElBQUksQ0FBQyxjQUFjLEdBQUcsaUJBQWlCLENBQUMsSUFBSSxDQUFDLGVBQWUsRUFBQyxJQUFJLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztRQUVwRiwwQkFBMEI7UUFDMUIsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxDQUFDLENBQUEsQ0FBQztZQUNoQyxPQUFPLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyx3QkFBd0IsQ0FBQyxDQUFBO1lBQ2hELE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxDQUFDO1lBQ2xDLE9BQU8sQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLG1EQUFtRCxDQUFDLENBQUM7WUFDN0UsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUM7WUFDakMsRUFBRSxDQUFBLENBQUMsYUFBYSxDQUFDLENBQUEsQ0FBQztnQkFDZCxPQUFPLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtnQkFDbkMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNwQixDQUFDO1FBQ0wsQ0FBQztJQUNMLENBQUM7O0FBQ0wsQ0FBQztBQXRCWSxZQUFJLE9Bc0JoQixDQUFBO0FBQUEsQ0FBQztBQUVGLElBQUksa0JBQWtCLEdBQUcsQ0FBQyxPQUFjLEVBQUUsb0JBQTZCO0lBQ25FLElBQUksWUFBWSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBQyxVQUFVLENBQUMsQ0FBQztJQUN6RCxJQUFJLFFBQVEsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxZQUFZLENBQUMsWUFBWSxDQUFDLENBQUM7SUFDL0QsR0FBRyxDQUFBLENBQUMsSUFBSSxNQUFNLElBQUksUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFBLENBQUM7UUFDN0Isb0JBQW9CLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQztJQUNyRCxDQUFDO0lBQUEsQ0FBQztBQUNOLENBQUMsQ0FBQTtBQUlELElBQUksbUJBQW1CLEdBQUcsQ0FBQyxrQkFBMkIsRUFBQyxhQUFvQixFQUFDLHFCQUE4QixFQUFDLHNCQUF1QztJQUM5SSxhQUFhLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsYUFBYSxFQUFDLFNBQVMsQ0FBQyxDQUFBO0lBQzFELElBQUksTUFBTSxDQUFDO0lBQ1gsSUFBSSxDQUFDO1FBQ0QsTUFBTSxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUM5RCxDQUNBO0lBQUEsS0FBSyxDQUFBLENBQUMsR0FBRyxDQUFDLENBQUEsQ0FBQztRQUNQLE9BQU8sQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLGdDQUFnQyxHQUFHLGFBQWEsQ0FBQyxDQUFBO1FBQ3ZFLE1BQU0sR0FBRyxFQUFFLENBQUM7SUFDaEIsQ0FBQztJQUNELEdBQUcsQ0FBQSxDQUFDLElBQUksY0FBYyxJQUFJLGtCQUFrQixDQUFDLENBQUEsQ0FBQztRQUMxQyxFQUFFLENBQUEsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQyxDQUFDLENBQUEsQ0FBQztZQUM1QixxQkFBcUIsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUM7WUFDM0Msc0JBQXNCLENBQUMsSUFBSSxDQUFDO2dCQUN4QixHQUFHLEVBQUUsY0FBYztnQkFDbkIsS0FBSyxFQUFFLE9BQU8sQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDO2FBQ3JDLENBQUMsQ0FBQztRQUNQLENBQUM7UUFBQyxJQUFJLENBQUMsRUFBRSxDQUFBLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFBLENBQUM7WUFDN0MsT0FBTyxDQUFDLEdBQUcsQ0FBQyxjQUFjLENBQUMsR0FBRyxNQUFNLENBQUMsY0FBYyxDQUFDLENBQUM7WUFDckQscUJBQXFCLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxDQUFDO1lBQzNDLHNCQUFzQixDQUFDLElBQUksQ0FBQztnQkFDeEIsR0FBRyxFQUFFLGNBQWM7Z0JBQ25CLEtBQUssRUFBRSxPQUFPLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQzthQUNyQyxDQUFDLENBQUM7UUFDUCxDQUFDO0lBQ0wsQ0FBQztJQUFBLENBQUM7QUFDTixDQUFDLENBQUM7QUFFRixJQUFJLGlCQUFpQixHQUFHLENBQUMsb0JBQTZCLEVBQUMscUJBQThCO0lBQ2pGLE1BQU0sQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxvQkFBb0IsRUFBQyxxQkFBcUIsQ0FBQyxDQUFDO0FBQ2pGLENBQUMsQ0FBQyJ9
|
2
dist/qenv.plugins.d.ts
vendored
2
dist/qenv.plugins.d.ts
vendored
@ -1,3 +1,5 @@
|
|||||||
import "typings-global";
|
import "typings-global";
|
||||||
export import beautylog = require("beautylog");
|
export import beautylog = require("beautylog");
|
||||||
|
export declare let lodash: any;
|
||||||
|
export import path = require("path");
|
||||||
export import smartfile = require("smartfile");
|
export import smartfile = require("smartfile");
|
||||||
|
5
dist/qenv.plugins.js
vendored
5
dist/qenv.plugins.js
vendored
@ -1,6 +1,7 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
require("typings-global");
|
require("typings-global");
|
||||||
exports.beautylog = require("beautylog");
|
exports.beautylog = require("beautylog");
|
||||||
|
exports.lodash = require("lodash");
|
||||||
|
exports.path = require("path");
|
||||||
exports.smartfile = require("smartfile");
|
exports.smartfile = require("smartfile");
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicWVudi5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvcWVudi5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFDVixpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDO0FBQ3BDLGNBQU0sR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7QUFDeEIsWUFBSSxXQUFXLE1BQU0sQ0FBQyxDQUFDO0FBQ3ZCLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUMifQ==
|
||||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInFlbnYucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsUUFBTyxnQkFBZ0IsQ0FBQyxDQUFBO0FBQ1YsaUJBQVMsV0FBVyxXQUFXLENBQUMsQ0FBQztBQUNqQyxpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDIiwiZmlsZSI6InFlbnYucGx1Z2lucy5qcyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBcInR5cGluZ3MtZ2xvYmFsXCI7XG5leHBvcnQgaW1wb3J0IGJlYXV0eWxvZyA9IHJlcXVpcmUoXCJiZWF1dHlsb2dcIik7XG5leHBvcnQgaW1wb3J0IHNtYXJ0ZmlsZSA9IHJlcXVpcmUoXCJzbWFydGZpbGVcIik7XG4iXX0=
|
|
14
package.json
14
package.json
@ -1,8 +1,9 @@
|
|||||||
{
|
{
|
||||||
"name": "qenv",
|
"name": "qenv",
|
||||||
"version": "1.0.2",
|
"version": "1.1.0",
|
||||||
"description": "promised environments",
|
"description": "promised environments",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
|
"typings": "dist/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(npmts)"
|
"test": "(npmts)"
|
||||||
},
|
},
|
||||||
@ -22,14 +23,15 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/qenv#README",
|
"homepage": "https://gitlab.com/pushrocks/qenv#README",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"npmts-g": "^5.2.6",
|
"npmts-g": "^5.2.8",
|
||||||
"should": "^9.0.2",
|
"should": "^10.0.0",
|
||||||
"typings-test": "^1.0.1"
|
"typings-test": "^1.0.1"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"beautylog": "^5.0.12",
|
"beautylog": "^5.0.20",
|
||||||
|
"lodash": "^4.14.1",
|
||||||
"q": "^1.4.1",
|
"q": "^1.4.1",
|
||||||
"smartfile": "^3.0.10",
|
"smartfile": "^4.0.13",
|
||||||
"typings-global": "^1.0.3"
|
"typings-global": "^1.0.6"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
2
test/assets/env.yml
Normal file
2
test/assets/env.yml
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
key1: fromYml
|
||||||
|
key2: fromYml
|
4
test/assets/qenv.yml
Normal file
4
test/assets/qenv.yml
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
vars:
|
||||||
|
- key1
|
||||||
|
- key2
|
||||||
|
- key3
|
2
test/test.d.ts
vendored
Normal file
2
test/test.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
import "typings-test";
|
||||||
|
import "should";
|
26
test/test.js
Normal file
26
test/test.js
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
"use strict";
|
||||||
|
require("typings-test");
|
||||||
|
const path = require("path");
|
||||||
|
require("should");
|
||||||
|
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 () {
|
||||||
|
process.env.key1.should.equal("original");
|
||||||
|
});
|
||||||
|
it("key2 should be read from Yml", function () {
|
||||||
|
process.env.key2.should.equal("fromYml");
|
||||||
|
});
|
||||||
|
it("keyValueObjectArray should hold all retrieved values", function () {
|
||||||
|
qenvTestObject.keyValueObjectArray[0].value.should.equal("original");
|
||||||
|
qenvTestObject.keyValueObjectArray[1].value.should.equal("fromYml");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsTUFBWSxJQUFJLFdBQU0sTUFBTSxDQUFDLENBQUE7QUFDN0IsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUNoQix3QkFBbUIsZUFBZSxDQUFDLENBQUE7QUFFbkMsT0FBTyxDQUFDLEdBQUcsR0FBRztJQUNWLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBQyxXQUFXLENBQUMsQ0FBQztBQUM1QyxDQUFDLENBQUE7QUFFRCxPQUFPLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxHQUFHLFVBQVUsQ0FBQTtBQUVoQyxJQUFJLGNBQW1CLENBQUM7QUFDeEIsUUFBUSxDQUFDLFlBQVksRUFBQztJQUNsQixFQUFFLENBQUMsMkJBQTJCLEVBQUM7UUFDM0IsY0FBYyxHQUFHLElBQUksWUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxPQUFPLENBQUMsR0FBRyxFQUFFLEVBQUMsS0FBSyxDQUFDLENBQUM7SUFDakUsQ0FBQyxDQUFDLENBQUM7SUFDSCxFQUFFLENBQUMsK0RBQStELEVBQUM7UUFDL0QsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUM5QyxDQUFDLENBQUMsQ0FBQztJQUNILEVBQUUsQ0FBQyw4QkFBOEIsRUFBQztRQUM5QixPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQzdDLENBQUMsQ0FBQyxDQUFDO0lBQ0gsRUFBRSxDQUFDLHNEQUFzRCxFQUFDO1FBQ3RELGNBQWMsQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUNyRSxjQUFjLENBQUMsbUJBQW1CLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDLENBQUM7SUFDeEUsQ0FBQyxDQUFDLENBQUE7QUFFTixDQUFDLENBQUMsQ0FBQyJ9
|
28
test/test.ts
Normal file
28
test/test.ts
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
import "typings-test";
|
||||||
|
import * as path from "path";
|
||||||
|
import "should";
|
||||||
|
import {Qenv} from "../dist/index";
|
||||||
|
|
||||||
|
process.cwd = () => {
|
||||||
|
return path.join(__dirname,"./assets/");
|
||||||
|
}
|
||||||
|
|
||||||
|
process.env["key1"] = "original"
|
||||||
|
|
||||||
|
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");
|
||||||
|
});
|
||||||
|
it("keyValueObjectArray should hold all retrieved values",function(){
|
||||||
|
qenvTestObject.keyValueObjectArray[0].value.should.equal("original");
|
||||||
|
qenvTestObject.keyValueObjectArray[1].value.should.equal("fromYml");
|
||||||
|
})
|
||||||
|
|
||||||
|
});
|
82
ts/index.ts
82
ts/index.ts
@ -1,34 +1,72 @@
|
|||||||
import * as plugins from "./qenv.plugins";
|
import * as plugins from "./qenv.plugins";
|
||||||
|
|
||||||
export class qenv {
|
export interface keyValueObject {
|
||||||
envVarsRequired:string[];
|
key: string,
|
||||||
envVarsAvailable:string[];
|
value: string
|
||||||
envVarsMissing:string[];
|
|
||||||
constructor(basePathArg = "./qenv.yml",envYmlPathArg){
|
|
||||||
this.envVarsRequired = getEnvVarsRequired(basePathArg);
|
|
||||||
this.envVarsAvailable;
|
|
||||||
}
|
|
||||||
};
|
};
|
||||||
|
|
||||||
let getEnvVarsRequired = (pathArg:string):string[] => {
|
export class Qenv {
|
||||||
let result:string[] = [];
|
requiredEnvVars:string[] = [];
|
||||||
|
availableEnvVars:string[] = [];
|
||||||
|
missingEnvVars:string[] = [];
|
||||||
|
keyValueObjectArray:keyValueObject[] = [];
|
||||||
|
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){
|
||||||
|
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, requiredEnvVarsArray:string[]) => {
|
||||||
let qenvFilePath = plugins.path.join(pathArg,"qenv.yml");
|
let qenvFilePath = plugins.path.join(pathArg,"qenv.yml");
|
||||||
let qenvFile = plugins.smartfile.local.toObjectSync(qenvFilePath);
|
let qenvFile = plugins.smartfile.fs.toObjectSync(qenvFilePath);
|
||||||
for(let keyArg in qenvFile.vars){
|
for(let keyArg in qenvFile.vars){
|
||||||
result.push(qenvFile.vars[keyArg]);
|
requiredEnvVarsArray.push(qenvFile.vars[keyArg]);
|
||||||
}
|
};
|
||||||
return result;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
let getEnvVarsAvailable = (requiredEnvVarsArg:string[]):string[] => {
|
|
||||||
let result = [];
|
|
||||||
for(let keyArg in requiredEnvVarsArg){
|
|
||||||
let envVar = requiredEnvVarsArg[keyArg];
|
|
||||||
if(process.env[envVar]){
|
|
||||||
result.push(envVar);
|
|
||||||
} else {
|
|
||||||
|
|
||||||
|
|
||||||
|
let getAvailableEnvVars = (requiredEnvVarsArg:string[],envYmlPathArg:string,availableEnvVarsArray:string[],keyValueObjectArrayArg:keyValueObject[]) => {
|
||||||
|
envYmlPathArg = plugins.path.join(envYmlPathArg,"env.yml")
|
||||||
|
let envYml;
|
||||||
|
try {
|
||||||
|
envYml = plugins.smartfile.fs.toObjectSync(envYmlPathArg);
|
||||||
}
|
}
|
||||||
|
catch(err){
|
||||||
|
plugins.beautylog.log("env file couldn't be found at " + envYmlPathArg)
|
||||||
|
envYml = {};
|
||||||
}
|
}
|
||||||
return result;
|
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);
|
||||||
|
};
|
@ -1,4 +1,5 @@
|
|||||||
import "typings-global";
|
import "typings-global";
|
||||||
export import beautylog = require("beautylog");
|
export import beautylog = require("beautylog");
|
||||||
|
export let lodash = require("lodash");
|
||||||
export import path = require("path");
|
export import path = require("path");
|
||||||
export import smartfile = require("smartfile");
|
export import smartfile = require("smartfile");
|
||||||
|
Reference in New Issue
Block a user