@kumologica/sdk 3.0.0

package/cli/commands/test-utils/fixtures/example3-flow.json

@@ -0,0 +1,148 @@
+[
+    {
+        "id": "main.flow",
+        "type": "tab",
+        "label": "main",
+        "disabled": false,
+        "info": ""
+    },
+    {
+        "id": "test.flow",
+        "type": "tab",
+        "label": "test",
+        "disabled": false,
+        "info": ""
+    },
+    {
+        "id": "eacbb9ef.69d5c8",
+        "type": "EventListener",
+        "z": "main.flow",
+        "name": "GET /hello",
+        "provider": "aws",
+        "eventSource": "api",
+        "dynamodbOperation": "",
+        "apiMethod": "get",
+        "apiUrl": "/",
+        "albMethod": "any",
+        "albUrl": "",
+        "bucketName": "",
+        "event": "s3:ObjectCreated:*",
+        "kapiUrl": "",
+        "kcronexpression": "",
+        "x": 120,
+        "y": 160,
+        "wires": [
+            [
+                "5eb3cd61.894f04"
+            ]
+        ],
+        "caname": "event-handler",
+        "category": "general"
+    },
+    {
+        "id": "5eb3cd61.894f04",
+        "type": "Logger",
+        "z": "main.flow",
+        "name": "Log",
+        "level": "INFO",
+        "message": "Request received",
+        "x": 262.5,
+        "y": 160,
+        "wires": [
+            [
+                "b5fc6ccd.17dd7"
+            ]
+        ],
+        "caname": "logger",
+        "category": "logging"
+    },
+    {
+        "id": "b5fc6ccd.17dd7",
+        "type": "EventListener-End",
+        "z": "main.flow",
+        "name": "Success",
+        "statusCode": "500",
+        "headers": {
+            "Content-Type": "application/json"
+        },
+        "payload": "{\"hello\": \"world\"}",
+        "x": 522.5,
+        "y": 160,
+        "wires": [],
+        "caname": "eventlistenerend",
+        "category": "general"
+    },
+    {
+        "id": "b970b7d2.5454c8",
+        "type": "Assertion",
+        "z": "test.flow",
+        "name": "check response",
+        "selector": "jsonBody",
+        "property": "hello",
+        "comparison": "equals",
+        "value": "world",
+        "x": 265,
+        "y": 160,
+        "wires": [
+            [
+                "e0721cc7.653eb"
+            ]
+        ],
+        "caname": "test-assertion",
+        "category": "testing"
+    },
+    {
+        "id": "e0721cc7.653eb",
+        "type": "TestCaseEnd",
+        "z": "test.flow",
+        "name": "TestCaseEnd",
+        "x": 425,
+        "y": 160,
+        "wires": [],
+        "caname": "test-case-end",
+        "category": "testing"
+    },
+    {
+        "id": "e8fb91dc.46c24",
+        "type": "HTTPTestCase",
+        "z": "test.flow",
+        "name": "HTTPTestCase",
+        "method": "GET",
+        "path": "/",
+        "headers": {
+            "Accept": "application/json"
+        },
+        "authtype": "none",
+        "secUser": "",
+        "secPassword": "",
+        "secToken": "",
+        "payload": "",
+        "x": 122.5,
+        "y": 160,
+        "wires": [
+            [
+                "b970b7d2.5454c8"
+            ]
+        ],
+        "caname": "http-test-case",
+        "category": "testing"
+    },
+    {
+        "id": "d974781.eca0588",
+        "type": "TestCase",
+        "z": "test.flow",
+        "name": "TestCase",
+        "selectedTargetNode": "eacbb9ef.69d5c8",
+        "payload": "{\n  \"path\": \"/settings\",\n  \"headers\": {\n    \"Accept\": \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8\",\n    \"Accept-Encoding\": \"gzip, deflate, lzma, sdch, br\",\n    \"Accept-Language\": \"en-US,en;q=0.8\",\n    \"CloudFront-Forwarded-Proto\": \"https\",\n    \"CloudFront-Is-Desktop-Viewer\": \"true\",\n    \"CloudFront-Is-Mobile-Viewer\": \"false\",\n    \"CloudFront-Is-SmartTV-Viewer\": \"false\",\n    \"CloudFront-Is-Tablet-Viewer\": \"false\",\n    \"CloudFront-Viewer-Country\": \"US\",\n    \"Host\": \"wt6mne2s9k.execute-api.us-west-2.amazonaws.com\",\n    \"Upgrade-Insecure-Requests\": \"1\",\n    \"User-Agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.82 Safari/537.36 OPR/39.0.2256.48\",\n    \"Via\": \"1.1 fb7cca60f0ecd82ce07790c9c5eef16c.cloudfront.net (CloudFront)\",\n    \"X-Amz-Cf-Id\": \"nBsWBOrSHMgnaROZJK1wGCZ9PcRcSpq_oSXZNQwQ10OTZL4cimZo3g==\",\n    \"X-Forwarded-For\": \"192.168.100.1, 192.168.1.1\",\n    \"X-Forwarded-Port\": \"443\",\n    \"X-Forwarded-Proto\": \"https\"\n  },\n  \"pathParameters\": {\n    \"proxy\": \"hello\"\n  },\n  \"requestContext\": {\n    \"accountId\": \"123456789012\",\n    \"resourceId\": \"us4z18\",\n    \"stage\": \"test\",\n    \"requestId\": \"41b45ea3-70b5-11e6-b7bd-69b5aaebc7d9\",\n    \"identity\": {\n      \"cognitoIdentityPoolId\": \"\",\n      \"accountId\": \"\",\n      \"cognitoIdentityId\": \"\",\n      \"caller\": \"\",\n      \"apiKey\": \"\",\n      \"sourceIp\": \"192.168.100.1\",\n      \"cognitoAuthenticationType\": \"\",\n      \"cognitoAuthenticationProvider\": \"\",\n      \"userArn\": \"\",\n      \"userAgent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.82 Safari/537.36 OPR/39.0.2256.48\",\n      \"user\": \"\"\n    },\n    \"resourcePath\": \"/{proxy+}\",\n    \"httpMethod\": \"GET\",\n    \"apiId\": \"wt6mne2s9k\"\n  },\n  \"resource\": \"/{proxy+}\",\n  \"httpMethod\": \"GET\",\n  \"queryStringParameters\": {\n    \"name\": \"me\"\n  },\n  \"stageVariables\": {\n    \"stageVarName\": \"stageVarValue\"\n  }\n}",
+        "initialLoad": "false",
+        "x": 122.5,
+        "y": 60,
+        "wires": [
+            [
+                "b970b7d2.5454c8"
+            ]
+        ],
+        "caname": "test-case",
+        "category": "testing"
+    }
+]

package/cli/commands/test-utils/fixtures/package.json

@@ -0,0 +1,6 @@
+{
+    "name": "cloudaction-project",
+    "description": "A CloudAction Project",
+    "version": "0.0.1",
+    "private": true
+}

package/cli/commands/test-utils/fixtures/s3-event.js

@@ -0,0 +1,43 @@
+const MOCK_S3_EVENT = {
+  Records: [
+    {
+      eventVersion: '2.1',
+      eventSource: 'aws:s3',
+      awsRegion: 'us-east-2',
+      eventTime: '2019-09-03T19:37:27.192Z',
+      eventName: 'ObjectCreated:Put',
+      userIdentity: {
+        principalId: 'AWS:AIDAINPONIXQXHT3IKHL2'
+      },
+      requestParameters: {
+        sourceIPAddress: '205.255.255.255'
+      },
+      responseElements: {
+        'x-amz-request-id': 'D82B88E5F771F645',
+        'x-amz-id-2':
+          'vlR7PnpV2Ce81l0PRw6jlUpck7Jo5ZsQjryTjKlc5aLWGVHPZLj5NeC6qMa0emYBDXOo6QBU0Wo='
+      },
+      s3: {
+        s3SchemaVersion: '1.0',
+        configurationId: '828aa6fc-f7b5-4305-8584-487c791949c1',
+        bucket: {
+          name: 'lambda-artifacts-deafc19498e3f2df',
+          ownerIdentity: {
+            principalId: 'A3I5XTEXAMAI3E'
+          },
+          arn: 'arn:aws:s3:::lambda-artifacts-deafc19498e3f2df'
+        },
+        object: {
+          key: 'b21b84d653bb07b05b1e6b33684dc11b',
+          size: 1305107,
+          eTag: 'b21b84d653bb07b05b1e6b33684dc11b',
+          sequencer: '0C0F6F405D6ED209E1'
+        }
+      }
+    }
+  ]
+};
+
+module.exports = {
+  MOCK_S3_EVENT
+};

package/cli/commands/test-utils/util/output.js

@@ -0,0 +1,14 @@
+const chalk = require('chalk');
+
+function error(message) {
+  return chalk.red(message);
+}
+
+function bold(message) {
+  return chalk.bold(message);
+}
+
+module.exports = {
+  error,
+  bold
+};

package/cli/commands/test-utils/util/updates/index.js

@@ -0,0 +1,17 @@
+const updateNotifier = require('update-notifier');
+const chalk = require('chalk');
+const pkg = require('./pkg');
+
+module.exports = () => {
+  const { update } = updateNotifier({ pkg });
+
+  if (!update) {
+    return;
+  }
+
+  console.log(
+    `${chalk.white.bold.bgRed(
+      'UPDATE AVAILABLE'
+    )} The latest version of Kumologica CLI is ${chalk.bold(update.latest)}`
+  );
+};

package/cli/commands/test-utils/util/updates/pkg.js

@@ -0,0 +1,13 @@
+/* eslint-disable import/no-unresolved */
+
+const path = require('path');
+const pkg = require('../../../package.json');
+
+try {
+  const distDir = path.dirname(process.execPath);
+  pkg._npmPkg = require(path.join(distDir, '../../package.json'));
+} catch (err) {
+  pkg._npmPkg = null;
+}
+
+module.exports = pkg;

package/cli/commands/test-utils/util/updates/templates/default-settings.js

@@ -0,0 +1,209 @@
+/**
+ * Copyright JS Foundation and other contributors, http://js.foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ **/
+
+// The `https` setting requires the `fs` module. Uncomment the following
+// to make it available:
+//var fs = require("fs");
+
+module.exports = {
+  // the tcp port that the kumologica-core web server is listening on
+  uiPort: process.env.PORT || 1880,
+  awsRegion: 'ap-southeast-2',
+  // awsS3Bucket: 'jteso-experiment',
+  awsS3Appname: 'funcname123',
+  // storageModule: require('./cloud-red/extra/storage-s3'),
+  // By default, the kumologica-core UI accepts connections on all IPv4 interfaces.
+  // The following property can be used to listen on a specific interface. For
+  // example, the following would only allow connections from the local machine.
+  //uiHost: "127.0.0.1",
+
+  // Retry time in milliseconds for MQTT connections
+  mqttReconnectTime: 15000,
+
+  // Retry time in milliseconds for Serial port connections
+  serialReconnectTime: 15000,
+
+  // Retry time in milliseconds for TCP socket connections
+  //socketReconnectTime: 10000,
+
+  // Timeout in milliseconds for TCP server socket connections
+  //  defaults to no timeout
+  //socketTimeout: 120000,
+
+  // Timeout in milliseconds for HTTP request connections
+  //  defaults to 120 seconds
+  //httpRequestTimeout: 120000,
+
+  // The maximum length, in characters, of any message sent to the debug sidebar tab
+  debugMaxLength: 1000,
+
+  // Colourise the console output of the debug node
+  //debugUseColors: true,
+
+  // To enabled pretty-printing of the flow within the flow file, set the following
+  //  property to true:
+  //flowFilePretty: true,
+
+  // By default, credentials are encrypted in storage using a generated key. To
+  // specify your own secret, set the following property.
+  // If you want to disable encryption of credentials, set this property to false.
+  // Note: once you set this property, do not change it - doing so will prevent
+  // kumologica-core from being able to decrypt your existing credentials and they will be
+  // lost.
+  credentialSecret: process.env.NODE_RED_SECRET || 'a-secret-key',
+
+  // By default, all user data is stored in location . To
+  // use a different location, the following property can be used
+  // TODO: Documentation needs update - default is now the directory where the editor has been opened
+  //userDir: '/home/nol/.kumologica-core/',
+
+  // kumologica-core scans the `nodes` directory in the install directory to find nodes.
+  // The following property can be used to specify an additional directory to scan.
+  //nodesDir: '/home/nol/.kumologica-core/nodes',
+
+  // By default, the kumologica-core UI is available at http://localhost:1880/
+  // The following property can be used to specifiy a different root path.
+  // If set to false, this is disabled.
+  //httpAdminRoot: '/admin',
+
+  // Some nodes, such as HTTP In, can be used to listen for incoming http requests.
+  // By default, these are served relative to '/'. The following property
+  // can be used to specifiy a different root path. If set to false, this is
+  // disabled.
+  //httpNodeRoot: '/red-nodes',
+
+  // The following property can be used in place of 'httpAdminRoot' and 'httpNodeRoot',
+  // to apply the same root to both parts.
+  //httpRoot: '/red',
+
+  // When httpAdminRoot is used to move the UI to a different root path, the
+  // following property can be used to identify a directory of static content
+  // that should be served at http://localhost:1880/.
+  //httpStatic: '/home/nol/kumologica-core-static/',
+
+  // The maximum size of HTTP request that will be accepted by the runtime api.
+  // Default: 5mb
+  //apiMaxLength: '5mb',
+
+  // If you installed the optional kumologica-core-dashboard you can set it's path
+  // relative to httpRoot
+  //ui: { path: "ui" },
+
+  // Securing kumologica-core
+  // -----------------
+  // To password protect the kumologica-core editor and admin API, the following
+  // property can be used. See http://nodered.org/docs/security.html for details.
+  //adminAuth: {
+  //    type: "credentials",
+  //    users: [{
+  //        username: "admin",
+  //        password: "$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN.",
+  //        permissions: "*"
+  //    }]
+  //},
+
+  // To password protect the node-defined HTTP endpoints (httpNodeRoot), or
+  // the static content (httpStatic), the following properties can be used.
+  // The pass field is a bcrypt hash of the password.
+  // See http://nodered.org/docs/security.html#generating-the-password-hash
+  //httpNodeAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."},
+  //httpStaticAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."},
+
+  // The following property can be used to enable HTTPS
+  // See http://nodejs.org/api/https.html#https_https_createserver_options_requestlistener
+  // for details on its contents.
+  // See the comment at the top of this file on how to load the `fs` module used by
+  // this setting.
+  //
+  //https: {
+  //    key: fs.readFileSync('privatekey.pem'),
+  //    cert: fs.readFileSync('certificate.pem')
+  //},
+
+  // The following property can be used to cause insecure HTTP connections to
+  // be redirected to HTTPS.
+  //requireHttps: true
+
+  // The following property can be used to disable the editor. The admin API
+  // is not affected by this option. To disable both the editor and the admin
+  // API, use either the httpRoot or httpAdminRoot properties
+  //disableEditor: false,
+
+  // The following property can be used to configure cross-origin resource sharing
+  // in the HTTP nodes.
+  // See https://github.com/troygoode/node-cors#configuration-options for
+  // details on its contents. The following is a basic permissive set of options:
+  //httpNodeCors: {
+  //    origin: "*",
+  //    methods: "GET,PUT,POST,DELETE"
+  //},
+
+  // If you need to set an http proxy please set an environment variable
+  // called http_proxy (or HTTP_PROXY) outside of kumologica-core in the operating system.
+  // For example - http_proxy=http://myproxy.com:8080
+  // (Setting it here will have no effect)
+  // You may also specify no_proxy (or NO_PROXY) to supply a comma separated
+  // list of domains to not proxy, eg - no_proxy=.acme.co,.acme.co.uk
+
+  // The following property can be used to add a custom middleware function
+  // in front of all http in nodes. This allows custom authentication to be
+  // applied to all http in nodes, or any other sort of common request processing.
+  //httpNodeMiddleware: function(req,res,next) {
+  //    // Handle/reject the request, or pass it on to the http in node by calling next();
+  //    // Optionally skip our rawBodyParser by setting this to true;
+  //    //req.skipRawBodyParser = true;
+  //    next();
+  //},
+
+  // Anything in this hash is globally available to all functions.
+  // It is accessed as context.global.
+  // eg:
+  //    functionGlobalContext: { os:require('os') }
+  // can be accessed in a function block as:
+  //    context.global.os
+
+  functionGlobalContext: {
+    // os:require('os'),
+    // octalbonescript:require('octalbonescript'),
+    // jfive:require("johnny-five"),
+    // j5board:require("johnny-five").Board({repl:false})
+  },
+
+  // The following property can be used to order the categories in the editor
+  // palette. If a node's category is not in the list, the category will get
+  // added to the end of the palette.
+  // If not set, the following default order is used:
+  //paletteCategories: ['subflows', 'input', 'output', 'function', 'social', 'mobile', 'storage', 'analysis', 'advanced'],
+
+  // Configure the logging output
+  logging: {
+    // Only console logging is currently supported
+    console: {
+      // Level of logging to be recorded. Options are:
+      // fatal - only those errors which make the application unusable should be recorded
+      // error - record errors which are deemed fatal for a particular request + fatal errors
+      // warn - record problems which are non fatal + errors + fatal errors
+      // info - record information about the general running of the application + warn + error + fatal errors
+      // debug - record information which is more verbose than info + info + warn + error + fatal errors
+      // trace - record very detailed logging + debug + info + warn + error + fatal errors
+      level: 'info',
+      // Whether or not to include metric events in the log output
+      metrics: false,
+      // Whether or not to include audit events in the log output
+      audit: false
+    }
+  }
+};

package/cli/commands/test.js

@@ -0,0 +1,66 @@
+exports.command = 'test';
+exports.desc = `Run test suite`;
+
+exports.builder = {
+	"flow-file-name": {
+		describe: "The name of kumologica flow file.\n Auto search if not provided.",
+		type: 'string',
+		alias: 'f',
+		nargs: 1
+	}
+}
+        
+const chalk = require('chalk');
+const log = console.log;
+const APP_SERVER_PORT = 1990;
+const { AppServer } = require('@kumologica/runtime');
+const { TestSuiteController } = require('./test-utils/TestSuiteController');
+const path = require('path');
+const { codegen } = require('@kumologica/builder');
+		
+async function runTest(flowFilePath) {
+    log(`Starting runtime on port ${APP_SERVER_PORT}...`);
+  
+    let appServer = new AppServer({
+      projectDir: process.cwd(),
+      flowFilePath: flowFilePath,
+      port: APP_SERVER_PORT,
+      serverMode: AppServer.mode.HEADLESS_DEFAULT_EXPRESS,
+      logLevel: AppServer.logLevel.ERROR,
+      editorApi: undefined,
+      startupEmitter: undefined
+    });
+
+    try {
+      await appServer.start();
+      log(`FlowFile to be tested: ${chalk.bold(flowFilePath)}`);
+      let testSuiteController = new TestSuiteController(appServer);
+      await testSuiteController.runTestSuite(); // no need to wait for response
+      process.exit(0);
+    } catch (err) {
+      log(
+        chalk.red(
+          `Unexpected error occurred while starting server due to <${err.message}>`
+        )
+      );
+      process.exit(1);
+    }
+  }
+  
+function display(argv) {
+	console.log(`\nRunning test suite with following parameters: \n`);
+	console.log('flow-file-name: %s', argv["flow-file-name"]||'');
+}
+
+exports.handler = function (argv) {
+	display(argv);
+    let projectDir = process.cwd();
+    let projectFlowName = argv["flow-file-name"] || codegen.findFlowFile(projectDir);
+
+	try {
+		runTest(path.join(projectDir, projectFlowName));
+	} catch (e) {
+		console.log(`${e.message}`);
+		process.exit(1);
+	}
+}

package/cli/commands/utils.js

@@ -0,0 +1,14 @@
+const chalk = require('chalk');
+
+function logError(message) {
+    console.log(chalk.red(message));
+}
+
+function logNotice(message) {
+    console.log(chalk.yellow(message));
+}
+
+module.exports = {
+    logError,
+    logNotice
+}