3.3.0 (#194)

* feature: env file load
* build: 3.3.0

Author: CarlosCarmona

CHANGELOG.md

@@ -1,15 +1,27 @@
 # Runnerty ChangeLog
 
+<a name="3.3.0"></a>
+
+# [3.3.0](5/2/2022)
+
+### Features
+
+- **common:** by default the environment variables will be read from the `.env` file in the root directory if it exists or from the file specified by cli in env-file
+- **cli:** new option --env-file, for reading environment variables from the path of the specified file
+- **interpreter:** new @GENV and @ENV functions for reading environment variables
+
 <a name="3.2.7"></a>
 
 # [3.2.7](3/2/2022)
+
 ### Bug Fixes
 
 - **common:** fixed empty values comparison in process dependencies (depends_process)
 
 <a name="3.2.6"></a>
 
 # [3.2.6](31/12/2021)
+
 ### Features
 
 - **dependencies:** minor dependency updates

__tests__/end2end.spec.js

@@ -868,3 +868,27 @@ describe('TestDefaultsConfigIterableChain', () => {
     );
   });
 });
+
+describe('ENVFunction', () => {
+  const successOutput = `info: res CONFIG_vtest vtest`;
+  test('Execution End2End: ENVFunction', done => {
+    exec(
+      'env_test=vtest node',
+      [
+        'index.js',
+        '-c',
+        './__tests__/end2end/config.json',
+        '-p',
+        './__tests__/end2end/plan_env.json',
+        '-f',
+        'CHAIN_ONE',
+        '--end'
+      ],
+      3000,
+      res => {
+        expect(flatOutput(res)).toEqual(flatSuccessOutput(successOutput));
+        done();
+      }
+    );
+  });
+});

__tests__/end2end/config.json

@@ -50,7 +50,8 @@
   "global_values": [
     {
       "myparams": {
-        "sample": "sample_value"
+        "sample": "sample_value",
+        "env_test": "CONFIG_@ENV(env_test)"
       }
     }
   ]

__tests__/end2end/package.json

@@ -3,11 +3,11 @@
   "version": "0.0.1",
   "private": false,
   "dependencies": {
-    "@runnerty/executor-shell": "^3.1.4",
-    "@runnerty/executor-wait": "^3.0.7",
-    "@runnerty/executor-iterable": "^3.1.2",
-    "@runnerty/notifier-console": "^3.0.6",
-    "@runnerty/trigger-schedule": "^3.0.6",
-    "@runnerty/trigger-immediate": "^3.0.7"
+    "@runnerty/executor-shell": "^3.2.0",
+    "@runnerty/executor-wait": "^3.1.0",
+    "@runnerty/executor-iterable": "^3.2.0",
+    "@runnerty/notifier-console": "^3.1.0",
+    "@runnerty/trigger-schedule": "^3.1.0",
+    "@runnerty/trigger-immediate": "^3.1.0"
   }
 }

__tests__/end2end/plan_env.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://raw.githubusercontent.com/runnerty/schemas/master/schemas/3.2/plan.json",
+  "chains": [
+    {
+      "id": "CHAIN_ONE",
+      "name": "CHAIN_ONE",
+      "processes": [
+        {
+          "id": "PROCESS_ONE",
+          "name": "PROCESS_ONE",
+          "exec": {
+            "id": "shell_default",
+            "command": "echo 'res @GV(myparams_env_test) @GENV(env_test)'"
+          },
+          "notifications": {
+            "on_end": [
+              {
+                "id": "console_default",
+                "message": "@GV(PROCESS_EXEC_MSG_OUTPUT)"
+              }
+            ]
+          }
+        }
+      ]
+    }
+  ]
+}

lib/app.js

@@ -24,6 +24,9 @@ async function initCli() {
 
 async function main(cliCmd) {
   try {
+    const dotenvOptions = {};
+    if (cliCmd.envFile) dotenvOptions.path = cliCmd.envFile;
+    require('dotenv').config(dotenvOptions);
     if (!cliCmd.mustContinue) process.exit();
     await init(cliCmd.configFilePath, cliCmd.options);
     utils.forceInitChainExecution(cliCmd.options);

lib/cli.js

@@ -92,7 +92,10 @@ class Cli {
       .option(
         '-en, --exclude_namespace <namespace>',
         'Disable the chains of the indicated namespace. It is possible to set a list of comma separated items'
-      );
+      )
+      .option('--env-file <env_file_path>', 'Read in a file of environment variables', envFilePath => {
+        this.envFile = envFilePath;
+      });
 
     // init project:
     program

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "runnerty",
   "description": "Process orchestrator",
-  "version": "3.2.7",
+  "version": "3.3.0",
   "preferGlobal": true,
   "main": "index.js",
   "license": "MIT",
@@ -26,25 +26,26 @@
     "lint": "eslint '**/*.js' && prettier --check '**'"
   },
   "dependencies": {
-    "@runnerty/interpreter-core": "~3.0.3",
-    "@runnerty/trigger-server": "~3.0.8",
-    "ajv": "~8.8.2",
+    "@runnerty/interpreter-core": "~3.1.0",
+    "@runnerty/trigger-server": "~3.1.0",
+    "ajv": "~8.10.0",
     "axios": "~0.25.0",
     "better-ajv-errors": "~1.1.2",
     "body-parser": "~1.19.1",
     "boxen": "~5.1.2",
     "bytes": "~3.1.1",
     "chalk": "~4.1.2",
-    "colors": "^1.4.0",
-    "commander": "~8.3.0",
+    "colors": "1.4.0",
+    "commander": "~9.0.0",
     "cors": "~2.8.5",
     "cron-parser": "~4.2.1",
+    "dotenv": "^16.0.0",
     "express": "~4.17.2",
     "express-basic-auth": "~1.2.1",
     "express-jwt": "~6.1.0",
     "fs-extra": "~10.0.0",
     "glob-to-regexp": "~0.4.1",
-    "helmet": "~4.6.0",
+    "helmet": "~5.0.2",
     "json-stringify-safe": "~5.0.1",
     "jsonfile": "^6.1.0",
     "jsonwebtoken": "~8.5.1",
@@ -60,7 +61,7 @@
     "semver": "~7.3.5",
     "socket.io-client": "~4.4.1",
     "update-notifier": "~5.1.0",
-    "winston": "~3.4.0"
+    "winston": "~3.5.1"
   },
   "keywords": [
     "runnerty",
@@ -94,14 +95,14 @@
     "node": ">=14.0.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.16.7",
-    "@babel/eslint-parser": "^7.16.5",
-    "eslint": "^8.7.0",
+    "@babel/core": "^7.17.0",
+    "@babel/eslint-parser": "^7.17.0",
+    "eslint": "^8.8.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-jest": "^25.7.0",
+    "eslint-plugin-jest": "^26.0.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.4.7",
-    "jest-cli": "^27.4.7",
+    "jest": "^27.5.0",
+    "jest-cli": "^27.5.0",
     "prettier": "^2.5.1",
     "runnerty-tests-modules": "file:__tests__/end2end"
   },