@kumologica/sdk 3.0.10 → 3.0.13

package/cli/commands/build-commands/kumohub.js

@@ -1,7 +1,49 @@
-exports.command = 'kumohub '
-exports.desc = 'Build kumohub artefacrs remote named <name> for repo at url <url>'
-exports.builder = {}
+exports.command = 'kumohub';
+exports.desc = `Builds kumohub binaries: 
+* generates kumohub artefacts
+* runs npm install
+* creates zip file
+
+Documentation: 
+  https://docs.kumologica.com/docs/references/cli/BuildKumohub.html`;
+
+exports.builder = {
+	"flow-file-name": {
+		describe: "The name of kumologica flow file.\n Auto search if not provided.\n ",
+		type: 'string',
+		alias: 'f',
+		nargs: 1
+	},
+	"project-directory": {
+		describe: "The root directory of project.\n Current working directory if not provided.\n",
+		type: 'string',
+		alias: 'd',
+		nargs: 1
+	},
+	"zip-file-name": {
+		describe: "The name of zip file to be created",
+		type: 'string',
+		default: 'lambda.zip',
+		alias: 'z',
+		nargs: 1
+	}
+}
+		
+function display(argv) {
+	console.log(`\nBuilding kumohub artefacts with following parameters: \n`);
+	console.log('project-directory: %s', argv["project-directory"]||'');
+	console.log('flow-file-name:    %s', argv["flow-file-name"]||'');
+  console.log('zip-file-name:     %s', argv["zip-file-name"]||'');
+}
 
 exports.handler = function (argv) {
-  console.log('adding remote %s at url %s', argv.name, argv.url)
+	display(argv);
+
+	try {
+		const { build } = require('@kumologica/builder');
+		build('kumohub', argv);
+	} catch (e) {
+		console.log(`${e.message}`);
+		process.exit(1);
+	}
 }

package/cli/commands/test-utils/TestSuiteController.js

@@ -5,6 +5,7 @@ const path = require('path');
 const chalk = require('chalk');
 const { error } = require('./util/output');
 const got = require('got');
+const { logError } = require('../utils');
 const log = console.log;
 
 
@@ -128,6 +129,7 @@ class TestReporter {
     this._testCases.push(testCase);
   }
 
+  
   findTestCase(testCaseId){
     let tcfound = this._testCases.filter(tc => tc._testCaseId === testCaseId);
     if (tcfound.length === 0) {
@@ -139,7 +141,7 @@ class TestReporter {
   }
 
   printTestCaseHeader(description, target) {
-    let prettyName = `${description} > ${target}`;
+    let prettyName = `${description}`; // mvp: only full flow being targeted > ${target} 
     const sep = '=';
     let underline = sep.repeat(prettyName.length);
     let headerLine = `- ${prettyName}\n  ${underline}`;
@@ -307,12 +309,26 @@ class TestSuiteController {
     return flowFileJson.filter((node) => node.type === 'TestCase' || node.type === 'HTTPTestCase');
   }
 
-  async runTestSuite() {
+  async runTestSuite(testcase) {
     const flowFileAbsPath = path.join(
       this._appServer.settings.userDir,
       this._appServer.settings.flowFile
     );
     let testCases = this.findTestCasesFromFlow(flowFileAbsPath);
+    if (!testCases || (testCases && testCases.length === 0)) {
+      logError(`No testcases found on flow file: ${flowFileAbsPath}`);
+      process.exit(1);
+    }
+
+    // If defined, filter the testcase that you want to test
+    if (testcase) {
+      testCases = testCases.filter(tc => tc.name.toLowerCase() === testcase.toLowerCase());
+      if (testCases && testCases.length === 0){
+        logError(`TestCase: "${testcase}" cannot be found`);
+        process.exit(1);
+      }
+      
+    }
 
     // === Starting the testSuite ===
     this._appServer.events.emit('runtime-event', {

package/cli/commands/test.js

@@ -1,4 +1,5 @@
 const chalk = require('chalk');
+const { Select } = require('enquirer');
 const fs = require('fs');
 const { logError } = require('./utils');
 const path = require('path');
@@ -10,7 +11,7 @@ const { codegen } = require('@kumologica/builder');
 const log = console.log;
 const APP_SERVER_PORT = 1990;
 		
-async function runTest(flowFilePath) {
+async function runTest(flowFilePath, testcase, iterative) {
     log(`\n> Starting runtime on port ${APP_SERVER_PORT}...`);
   
     let appServer = new AppServer({
@@ -27,8 +28,34 @@ async function runTest(flowFilePath) {
       await appServer.start();
       log(`> FlowFile to be tested: ${chalk.bold(path.resolve(flowFilePath))} \n`);
       let testSuiteController = new TestSuiteController(appServer);
-      const errors = await testSuiteController.runTestSuite(); // no need to wait for response
+      let testcasesAvailable = testSuiteController.findTestCasesFromFlow(flowFilePath).map(tc => {
+        return tc.name;
+      })
+      testcasesAvailable.push('Run all TestCases...');
+      // Iterative ?
+        // Check if iterative testing has been selected
+      if (iterative) {
+        const prompt = new Select({
+          name: 'testcase',
+          message: 'What testcase do you want to run?',
+          choices: testcasesAvailable
+        });
+        await prompt.run()
+          .then(tc => {
+            if (tc === 'Run all TestCases...'){
+              testcase = null;
+            }else {
+              testcase = tc;
+            }
+          })
+          .catch(err => {
+            logError(`Error found while running tests on iterative mode due to: `, err.message);
+            process.exit(1);
+          });
+      }
+
       
+      const errors = await testSuiteController.runTestSuite(testcase); // no need to wait for response
       process.exit(errors > 0);
     } catch (err) {
       log(
@@ -53,15 +80,24 @@ function isDirectory(dir) {
 
 exports.command = 'test [project_directory]';
 exports.desc = `Run test suite`;
-
 exports.builder = (yargs) => {
   yargs.positional(`project_directory`, {
       type: 'string',
       describe: 'Path to a valid kumologica project directory or flow file. (Optional)'
   })
+  yargs.option(`testcase`, {
+    describe: "Testcase name to run",
+    type: 'string',
+    alias: 't',
+    nargs: 1
+    });
+    yargs.option(`iterative`, {
+      describe: "Manually select the testcase to run from all available testcases",
+      type: 'boolean',
+      alias: 'i'
+      });
 }
-
-exports.handler = ({ project_directory }) => {
+exports.handler = ({ project_directory, testcase, iterative }) => {
   let projectDirOrFile = project_directory || process.cwd();
   let projectFlowPath = projectDirOrFile;
 
@@ -82,7 +118,7 @@ exports.handler = ({ project_directory }) => {
   }
 
 	try {
-		runTest(projectFlowPath);
+		runTest(projectFlowPath, testcase, iterative);
 	} catch (e) {
 		logError(e.message);
 		process.exit(1);

package/package.json

@@ -3,7 +3,7 @@
   "productName": "Kumologica Designer",
   "copyright": "Copyright 2020 Kumologica Pty Ltd, All Rights Reserved.",
   "author": "Kumologica Pty Ltd <contact@kumologica.com>",
-  "version": "3.0.10",
+  "version": "3.0.13",
   "description": "Kumologica Designer, harnessing Serverless for your cloud integration needs",
   "main": "src/app/main.js",
   "files": [
@@ -64,60 +64,62 @@
   },
   "license": "Proprietary",
   "dependencies": {
-    "@kumologica/builder": "3.0.10",
-    "@kumologica/runtime": "3.0.10",
-    "@kumologica/devkit": "3.0.10",
-    "adm-zip": "^0.4.13",
-    "ajv": "^8.10.0",
-    "aws-sdk": "^2.513.0",
+    "@electron/remote": "^2.0.8",
+    "@kumologica/builder": "3.0.13",
+    "@kumologica/devkit": "3.0.13",
+    "@kumologica/runtime": "3.0.13",
+    "adm-zip": "0.4.13",
+    "ajv": "8.10.0",
+    "aws-sdk": "2.513.0",
     "basic-auth": "2.0.1",
     "bcryptjs": "2.4.3",
-    "body-parser": "^1.19.0",
-    "chalk": "^2.4.2",
-    "child_process": "^1.0.2",
+    "body-parser": "1.19.0",
+    "chalk": "2.4.2",
+    "child_process": "1.0.2",
     "clone": "2.1.2",
     "cookie-parser": "1.4.4",
     "cors": "^2.8.5",
     "dagre": "^0.8.5",
     "debounce": "^1.2.0",
-    "electron": "11.0.1",
+    "electron": "19.0.0",
     "electron-updater": "4.3.9",
     "enquirer": "^2.3.1",
     "express": "4.17.3",
     "express-session": "1.16.2",
-    "extract-json-from-string": "^1.0.1",
+    "extract-json-from-string": "1.0.1",
     "fs-extra": "8.1.0",
-    "glob": "^7.1.6",
+    "glob": "7.1.6",
     "got": "11.8.2",
     "hash-sum": "2.0.0",
-    "http-shutdown": "^1.2.1",
+    "http-shutdown": "1.2.1",
     "iconv-lite": "0.5.0",
     "ini": "^2.0.0",
-    "js-yaml": "^3.13.1",
-    "jsonata": "^1.7.0",
-    "jsonpath": "^1.0.2",
+    "js-yaml": "3.13.1",
+    "jsonata": "1.7.0",
+    "jsonpath": "1.0.2",
     "memorystore": "1.6.1",
     "mime": "2.4.4",
     "minimist": "^1.2.3",
     "multer": "1.4.1",
     "mustache": "3.0.1",
     "oauth2orize": "1.11.0",
-    "os": "^0.1.1",
+    "os": "0.1.1",
     "passport": "0.4.0",
     "passport-http-bearer": "1.0.1",
     "passport-oauth2-client-password": "0.1.2",
-    "request": "^2.88.0",
-    "rimraf": "^3.0.0",
-    "shell-path": "^2.1.0",
-    "simplemde": "^1.11.2",
-    "smoketail": "^0.2.2",
-    "socket.io": "^2.3.0",
-    "util": "^0.12.1",
+    "request": "2.88.0",
+    "rimraf": "3.0.0",
+    "shell-path": "2.1.0",
+    "simplemde": "1.11.2",
+    "smoketail": "0.2.2",
+    "socket.io": "2.3.0",
+    "tcp-port-used": "1.0.2",
+    "util": "0.12.1",
     "when": "3.7.8",
-    "ws": "^7.1.1",
-    "xterm": "^4.1.0",
-    "xterm-addon-fit": "^0.2.1",
-    "yargs": "^17.3.1"
+    "ws": "7.1.1",
+    "xterm": "4.1.0",
+    "xterm-addon-fit": "0.2.1",
+    "yargs": "17.3.1"
   },
   "devDependencies": {
     "@types/node": "^12.6.8",

package/src/app/lib/stores/settings-cloud-store.js

@@ -1,30 +1,33 @@
 // properties: ~/.kumologica/credentials
 
-const defaultContent = `// This file contains all your sensitive credential information
-// about your cloud connections used by Kumologica Designer.
-// For more information visit  https://docs.kumologica.com/settings
-//
-// Azure with terraform:
-// using a Service Principal with a Client Secret follow:
-// https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/guides/service_principal_client_secret
-
-// Examples:
-//
-// [kumohub.default]
-// username = your-username
-// password = your-password
-// subscription = kumohub-subscription-id
-
-// [aws.development]
-// profile = your-defined-aws-profile
-
-// 
-// [azure.default]
-// subscription_id = 00000000-0000-0000-0000-000000000000
-// client_id = 00000000-0000-0000-0000-000000000000
-// client_secret = 0000000000000000000000000000000
-// tenant_id = 00000000-0000-0000-0000-000000000000
-//
+const defaultContent = `; This file contains all your sensitive credential information
+; about your cloud connections used by Kumologica Designer.
+; For more information visit  https://docs.kumologica.com/settings
+;
+; Examples:
+
+; =============== Kumohub Details =======================
+; Follow the format for this section as: "kumohub.<alias>"
+; =======================================================
+; [kumohub.default]
+; username = your-username
+; password = your-password
+; subscription = kumohub-subscription-id
+
+; ============= AWS Cloud Details =======================
+; Follow the format for this section as: "aws.<alias>"
+; =======================================================
+; [aws.development]
+; profile = your-defined-aws-profile
+
+; ============= Azure Cloud Details =====================
+; Follow the format for this section as: "azure.<alias>"
+; =======================================================
+; [azure.default]
+; subscription_id = 00000000-0000-0000-0000-000000000000
+; client_id = 00000000-0000-0000-0000-000000000000
+; client_secret = 0000000000000000000000000000000
+; tenant_id = 00000000-0000-0000-0000-000000000000
 `
 
 const os = require('os');

package/src/app/lib/stores/settings-network-store.js

@@ -94,7 +94,6 @@ class NetworkConfigStore {
 
     getProxyDetails() {
         let config = this.parseConfigFile();
-        console.log('[settings-network-store] config=', config);
 
         // Make sure the section is present
         if (!config.proxy){

package/src/app/lib/stores/test-config-store.js

@@ -1,26 +1,159 @@
-// properties
-const defaultKeys = {
-    test: {}
-  };
+const {
+  getVariablesByConfigAndSection,
+  getSectionsByText
+} = require('./util/iniParser');
+
+const NO_ENVIRONMENT = "__no_environment__";
+
+const KEYS = {
+  ROOT_KEY: "test",
+  ENVIRONMENTS: "environments",
+  TESTCASE_OLD: "test",
+  PROPERTIES_OLD: "properties",
+  TESTCASE: "testcase",
+  ENVIRONMENT: "environment"
+}
+
+const DEFAULT_ENVIRONMENTS = [
+  "; ===========================================================",
+  "; Environment variables must be defined under one section",
+  "; You can define as many sections as you need.",
+  "; (Remove the semicolons to uncomment the lines)",
+  "; ===========================================================",
+  "",
+  "; Example:",
+  "",
+  "; [development] ",
+  "; KUMOLOGICA_LOGLEVEL=DEBUG",
+  "; VAR_1=VALUE_1",
+  "",
+  "; [test]",
+  "; KUMOLOGICA_LOGLEVEL=ERROR",
+  "; VAR_1=VALUE_1",
+]
   
-  const Store = require('./store');
-  
-  class TestConfigStore extends Store {
-  
-    constructor(defaults) {
-      super({ ...defaults, configName: '.kumologica/test-config', defaults: {}});
+const Store = require('./store');
+
+class TestConfigStore extends Store {
+
+  constructor(defaults) {
+    super({ ...defaults, configName: '.kumologica/test-config', defaults: {}});
+  }
+
+  getConfigFileFullPath() {
+    return this.path;
+  }
+
+  getTestConfig() {
+    let config = super.get(KEYS.ROOT_KEY);
+
+    // Decorate with default environments if not persisted
+    config = this.convertToLatestVersion(config);
+   
+    // check whether is first time, i.e. config is empty
+    if (!config) {
+      config = {};
+      config[KEYS.TESTCASE] = "__runAll";
+      config[KEYS.ENVIRONMENT] = NO_ENVIRONMENT;
+      config[KEYS.ENVIRONMENTS] = DEFAULT_ENVIRONMENTS;
+      super.set(KEYS.ROOT_KEY, config);
     }
-  
-    getTestConfig() {
-      return super.get('test');
+
+    return config;
+  }
+
+  convertToLatestVersion(config) {
+    let newConfig = config;
+    if (newConfig){
+      if (newConfig.hasOwnProperty(KEYS.TESTCASE_OLD)){
+        // replace: "config.test" -> "config.testcase"
+        newConfig[KEYS.TESTCASE] = newConfig[KEYS.TESTCASE_OLD]; 
+        delete newConfig[KEYS.TESTCASE_OLD];
+        // select "config.environment" = no_environment
+        newConfig[KEYS.ENVIRONMENT] = NO_ENVIRONMENT;
+        // append the old properties to the new environment
+        newConfig[KEYS.ENVIRONMENTS] = DEFAULT_ENVIRONMENTS;
+        if (newConfig.hasOwnProperty(KEYS.PROPERTIES_OLD)){
+          let props = newConfig[KEYS.PROPERTIES_OLD];
+          newConfig[KEYS.ENVIRONMENTS].push('[old-properties]');
+          for (const [key, value] of Object.entries(props)) {
+            newConfig[KEYS.ENVIRONMENTS].push(`${key}=${value}`);
+          }
+          delete newConfig[KEYS.PROPERTIES_OLD];
+          // persist the new model
+          super.set(KEYS.ROOT_KEY, newConfig);
+        }
+      }
     }
-  
-    setTestConfig(value) {
-      super.set('test', value);
+    return newConfig;
+  }
+
+  saveTestValuesIntoConfig(value) {
+    let config = this.getTestConfig();
+    config[KEYS.ENVIRONMENT] = this.listEnvironments().includes(value[KEYS.ENVIRONMENT])?value[KEYS.ENVIRONMENT]: NO_ENVIRONMENT;
+    config[KEYS.TESTCASE] = value[KEYS.TESTCASE];
+    super.set(KEYS.ROOT_KEY, config);
+  }
+
+  saveEnvironmentSectionIntoConfig(text) {
+    let config = this.getTestConfig();
+    config[KEYS.ENVIRONMENTS] = this.convertTextIntoArray(text);
+    super.set(KEYS.ROOT_KEY, config);
+    // If selected environment is not longer available, lets default it to no_environment
+    if (!this.listEnvironments().includes(config[KEYS.ENVIRONMENT])) {
+      config[KEYS.ENVIRONMENTS] = this.convertTextIntoArray(text);
+      config[KEYS.ENVIRONMENT] = NO_ENVIRONMENT;
+      super.set(KEYS.ROOT_KEY, config);
     }
   }
   
-  module.exports = {
-    TestConfigStore
-  };
+  getEnvironmentSectionFromConfig() {
+    return this.convertArrayIntoText(this.getTestConfig()[KEYS.ENVIRONMENTS]);
+  }
+
+  getLatestSelectedEnvironment() {
+    let config = this.getTestConfig();
+    return (config.hasOwnProperty(KEYS.ENVIRONMENT))? config[KEYS.ENVIRONMENT]: NO_ENVIRONMENT;
+  }
+
+  getLatestSelectedTestCase() {
+    let config = this.getTestConfig();
+    if (config){
+      if (config.hasOwnProperty(KEYS.TESTCASE)) {
+        return config[KEYS.TESTCASE];
+      } else if (config.hasOwnProperty(KEYS.TESTCASE_OLD)) {
+        return config[KEYS.TESTCASE_OLD];
+      } else {
+        return null;
+      }
+    }
+   
+  }
+
+  listEnvironments() {
+    let enviromentAsText = this.convertArrayIntoText(this.getTestConfig()[KEYS.ENVIRONMENTS])
+    return getSectionsByText(enviromentAsText);
+  }
+
+  listVariablesByEnvironment(section) {
+    let environmentSelected = section;
+    if (!environmentSelected) {
+      environmentSelected = this.getLatestSelectedEnvironment();
+    }
+    let aEnvironments = this.getTestConfig()[KEYS.ENVIRONMENTS];
+    return getVariablesByConfigAndSection(this.convertArrayIntoText(aEnvironments), environmentSelected);
+  }
+
+  convertTextIntoArray(text){
+    let lines = text.split(/\r\n|\n/);
+    return lines.map(l => l.trim());
+  }
+  convertArrayIntoText(lines) {
+    return lines.join('\r\n');
+  }
+}
+
+module.exports = {
+  TestConfigStore
+};
   

package/src/app/lib/stores/util/iniParser.js

@@ -0,0 +1,46 @@
+const ini = require('ini');
+
+function parseStringToConfig(text) {
+    let config = ini.parse(text);
+    return config;
+}
+
+function getSectionsByText(text) {
+    let config = parseStringToConfig(text);
+    let keys = [];
+    if (config) {
+        keys = Object.keys(config);
+        keys= keys.filter(section => isValidSection(section, config))
+    }
+    return keys;
+}
+function getVariablesByConfigAndSection(environmentsAsText, section){
+    let oEnvironments = parseStringToConfig(environmentsAsText);
+    let variables = [];
+
+    if (oEnvironments){
+        if (oEnvironments[section]){
+            for (const [key, value] of Object.entries(oEnvironments[section])) {
+                variables.push({ key, value })
+            }
+        }
+    }
+    
+   
+    return variables;
+}
+
+function isValidSection(section, config) {
+    return (
+            section !== '__no_environment__' && 
+            !section.trim().startsWith('//') &&
+            !section.trim().startsWith('#') && 
+            typeof config[section] == 'object' && Object.entries(config[section]).length > 0
+    ); 
+}
+
+module.exports = {
+    parseStringToConfig,
+    getSectionsByText,
+    getVariablesByConfigAndSection
+}

package/src/app/lib/stores/util/iniParser.spec.js

@@ -0,0 +1,72 @@
+
+const chai = require('chai');
+const { 
+    parseStringToConfig,
+    getSectionsByText,
+    getVariablesByConfigAndSection } = require('./iniParser');
+
+let assert = chai.assert;
+
+const ENVIRONMENTS_WITH_COMMENTS = `
+// comment
+; hola amigos
+; this is comments
+[dev]
+url=http://dev.good.url.com
+private=false
+[test]
+url=http://test.good.url.com
+private=true
+`;
+const ENVIRONMENTS_WITHOUT_SECTIONS = ``; 
+
+const ENVIRONMENTS_WRONG_FORMAT = `
+// comment
+; hola amigos
+; this is comments
+[dev]
+url
+private = false
+USER == test123
+password=asdfa salutation=hello
+`;
+
+const ENVIRONMENTS_MISSING_SECTION = `
+// comment
+; hola amigos
+; this is comments
+;;[dev]
+url = true
+
+[test]
+url = hola
+
+`;
+
+describe('parse correctly a environment section', () => {
+    it('happy path', () => {
+        let config = parseStringToConfig(ENVIRONMENTS_WITH_COMMENTS)
+        let sections = getSectionsByText(ENVIRONMENTS_WITH_COMMENTS);
+        assert.equal(sections.length, 2);
+
+        let vars = getVariablesByConfigAndSection(config, sections[0]);
+        assert.equal(vars.length, 2);        
+    });
+    it('No sections available', () => {
+        let sections = getSectionsByText(ENVIRONMENTS_WITHOUT_SECTIONS);
+        assert.equal(sections.length, 0);
+    });
+    it('Variables not correct', () => {
+        let config = parseStringToConfig(ENVIRONMENTS_WRONG_FORMAT)
+        let sections = getSectionsByText(ENVIRONMENTS_WRONG_FORMAT);
+        let vars = getVariablesByConfigAndSection(config, sections[0]);
+        assert.equal(vars.length, 4); 
+    })
+    it('Detecting missing sections', () => {
+        let sections = getSectionsByText(ENVIRONMENTS_MISSING_SECTION);
+        console.log(sections);
+        //let vars = getVariablesByConfigAndSection(config, sections[0]);
+        //assert.equal(vars.length, 4); 
+    })
+    
+  });