@kumologica/sdk 3.0.1 → 3.0.4

package/cli/commands/doc-commands/html.js

@@ -2,25 +2,23 @@ exports.command = 'html';
 exports.desc = `Generates html documentation of kumologica flow.`;
 
 exports.builder = {			
-	"documentation-directory": {
-        describe: "The directory where documentation will be created.",
-        demandOption: "The documentation directory is required.",
-		type: 'string',
+	"project-directory": {
+        describe: "\nThe root directory of kumologica project. Current working directory used if not provided.",
+        type: 'string',
 		alias: 'd',
 		nargs: 1
 	},
-	"kumologica-project-directory": {
-        describe: "The directory where kumologica project to be created",
-        demandOption: "The kumologica project directory is required.",
-		type: 'string',
-		alias: 'k',
+	"flow-file-name": {
+        describe: "\nThe name of kumologica flow file to be created, must end with .json extension. Auto search if not provided.",
+        type: 'string',
+		alias: 'f',
 		nargs: 1
 	},
-	"kumologica-flow-file-name": {
-        describe: "The name of kumologica flow file to be created, must end with .json extension",
-        demandOption: "The kumologica flow file name is required.",
-		type: 'string',
-		alias: 'f',
+	"documentation-directory": {
+        describe: "\nThe directory where documentation will be created.",
+        type: 'string',
+		alias: 'c',
+		default: 'docs',
 		nargs: 1
 	}
 }
@@ -28,20 +26,20 @@ exports.builder = {
 function validate(argv) {
 	const chalk = require('chalk');
 
-	if (!argv["kumologica-flow-file-name"].endsWith('.json')) {
-		console.log(`${chalk.redBright("Validation Error: kumologica-flow-file-name must end with .json extension.")}`);
+	if (argv["flow-file-name"] && !argv["flow-file-name"].endsWith('.json')) {
+		console.log(`${chalk.redBright("Validation Error: flow-file-name must end with .json extension.")}`);
 		process.exit(1);
 	}
 }
 function display(argv) {
 	console.log('Parameters:');
-	console.log('  documentation-directory:    %s', argv["documentation-directory"]||'');
-	console.log('  kumologica-project-directory:  %s', argv["kumologica-project-directory"]||'');
-	console.log('  kumologica-flow-file-name:     %s', argv["kumologica-flow-file-name"]||'');
+	console.log('  documentation-directory:  %s', argv["documentation-directory"]||'');
+	console.log('  project-directory:        %s', argv["project-directory"]||'');
+	console.log('  flow-file-name:           %s', argv["flow-file-name"]||'');
 }
 
 exports.handler = async function (argv) {
-	console.log('\nGenerating documentation\n');
+	console.log('\nGenerating html documentation\n');
 	display(argv);
 	validate(argv);
 
@@ -49,8 +47,9 @@ exports.handler = async function (argv) {
 
 	try {
 		const { doc } = require('@kumologica/builder');
-		doc("html", argv);
-		console.log(chalk.greenBright('Documentation generated succesfully.'));
+		const docsDirectory = doc("html", argv);
+		console.log(chalk.greenBright('Documentation generated successfully:'));
+		console.log(chalk.greenBright(docsDirectory));
 	
 		process.exit(0);
 	} catch (e) {

package/cli/commands/doc.js

@@ -1,4 +1,4 @@
-exports.command = 'doc'
+exports.command = 'doc <format>'
 exports.desc = 'Generate documentation for kumologica flow'
 exports.builder = function (yargs) {
   return yargs.commandDir('doc-commands')

package/cli/commands/export-commands/cloudformation.js

@@ -3,139 +3,148 @@ const { boolean } = require('yargs');
 exports.command = 'cloudformation';
 exports.desc = `Build aws cloud formation script. \n Parameters are equivalent of command: "aws lambda create-function"`;
 
-exports.builder = {			
+exports.builder = {		
+		
+	"project-directory": {
+		describe: "\nThe location of kumologica project.\n Current working directory if not provided.",
+		type: 'string',
+		alias: 'd',
+		nargs: 1
+	},
 	"flow-file-name": {
-		describe: "The name of kumologica flow file.\n Auto search if not provided.",
+		describe: "\nThe name of kumologica flow file.\n Auto search if not provided.",
 		type: 'string',
 		alias: 'f',
 		nargs: 1
 	},
 	"lambda-name": {
-		describe: "The name of lambda function,\n default to flow name",
+		describe: "\nThe name of lambda function,\n default to flow name",
 		type: 'string',
 		alias: 'l',
 		nargs: 1
 	},
 	"zip-file-name": {
-		describe: "The name of zip file of built lambda",
+		describe: "\nThe name of zip file of built lambda. The zip file may not exists until 'aws cloudformation package' command is called." ,
 		demandOption: "The name of zip file is required.",
 		type: 'string',
 		alias: 'z',
 		nargs: 1
 	},
 	"role-name": {
-		describe: "The name of lambda role, default to {lambda-name}-role",
+		describe: "\nThe name of lambda role, default to {lambda-name}-role",
 		type: 'string',
 		alias: 'o',
 		nargs: 1
 	},
     "bucket-name": {
-		describe: "The name of bucket where zipped lambda is loaded from",
+		describe: "\nThe name of bucket where zipped lambda is loaded from",
 		demandOption: "The name of s3 bucket is required.",
 		type: 'string',
 		alias: 'b',
 		nargs: 1
 	},
 	timeout: {
-		describe: "The time in seconds flow lambda is allowed to run, default: 3, max: 900",
+		describe: "\nThe time in seconds lambda is allowed to run, max: 900",
 		type: 'number',
+		default: 10,
 		alias: 't',
 		nargs: 1
 	},
 	"memory-size": {
-		describe: "The amount of memory allocated to function, default 128 (MB), must be multiple of 64 (MB)",
+		describe: "\nThe amount of memory allocated to function, default 128 (MB), must be multiple of 64 (MB), max 4096 (MB)",
 		type: 'number',
+		default: 128,
 		alias: 'm',
 		nargs: 1
 	},
 	description: {
-		describe: "The description of a function",
+		describe: "\nThe description of a function",
 		type: 'string',
-		alias: 'd',
 		nargs: 1
 	},
 	environment: {
-		describe: `Environment variables, JSON Syntax: '{"Variables": {"string": "string" ...}'}`,
+		describe: `\nEnvironment variables, JSON Syntax: '{"Variables": {"string": "string" ...}'}`,
 		type: 'string',
 		alias: 'e',
 		nargs: 1
 	},
 	tags: {
-		describe: `Tags, JSON Syntax: '{"string": "string" ...}'`,
+		describe: `\nTags, JSON Syntax: '{"name": "value" ...}'`,
 		type: 'string',
 		alias: 'g',
 		nargs: 1
 	},
 	"tracing-config": {
-		describe: `X-Ray config, JSON Syntax: '{"Mode": "Active"|"PassThrough"}' `,
+		describe: `\nX-Ray config, JSON Syntax: '{"Mode": "Active"|"PassThrough"}' `,
 		type: 'string',
 		alias: 'x',
 		nargs: 1
 	},
 	"kms-key-arn": {
-		describe: "The ARN of KMS key to encrypt env variables",
+		describe: "\nThe ARN of KMS key to encrypt env variables",
 		type: 'string',
 		alias: 'k',
 		nargs: 1
 	},
 	"vpc-config": {
-		describe: `The list of security groups and subnets of VPC, JSON syntax: '{ "SubnetIds": ["string", ...],"SecurityGroupIds": ["string", ...]}'`,
+		describe: `\nThe list of security groups and subnets of VPC, JSON syntax: '{ "SubnetIds": ["string", ...],"SecurityGroupIds": ["string", ...]}'`,
 		type: 'string',
 		alias: 'v',
 		nargs: 1
 	},
 	architectures: {
-		describe: "The instruction set architecture that the function supports, a string array with one of x86_64, arm64. The default value is [x86_64]",
+		describe: "\nThe instruction set architecture that the function supports, a string array with one of x86_64, arm64. Default value: [x86_64].",
 		type: 'string',
 		nargs: 1
 	},
 	runtime: {
-		describe: "The runtime, only nodejs runtimes allowed: nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|...",
+		describe: "\nThe runtime, only nodejs runtimes allowed: nodejs12.x | nodejs14.x | nodejs16.x | ...",
 		type: 'string',
+		default: 'nodejs14.x',
 		alias: 'r',
 		nargs: 1
 	},
 	"dead-letter-config": {
-		describe: `The arn of the dead letter queue or topic JSON Syntax: '{"TargetArn": "string"}'`,
+		describe: `\nThe arn of the dead letter queue or topic JSON Syntax: '{"TargetArn": "string"}'`,
 		type: 'string',
 		alias: 'q',
 		nargs: 1
 	},
 	"file-system-configs": {
-		describe: `AWS EFS config details, JSON Syntax: '[{"Arn": "string","LocalMountPath": "string"} ...]'`,
+		describe: `\nAWS EFS config details, JSON Syntax: '[{"Arn": "string","LocalMountPath": "string"} ...]'`,
 		type: 'string',
 		nargs: 1
 	},
 	"log-retention-days": {
-		describe: 'Number of days logs to be retained',
+		describe: '\nNumber of days logs to be retained',
 		type: 'number',
 		nargs: 1
 	},
 	"role-arn": {
-		describe: `The ARM of IAM role to assign to lambda, otherwise this command will generate role. \n Important!\n This parameter should only be used if this command is not able to generate sufficient role based on flow details.`,
+		describe: `\nThe arn of IAM role to assign to lambda, otherwise this command will generate role. \n Important!\n This parameter should only be used if this command is not able to generate sufficient role based on flow details.`,
 		type: 'string',
 		nargs: 1
 	},
 	"policy": {
-		describe: `Additional iam policy to add to the role. It must be valid aws policy format, for example: '{"Effect": "Allow", "Resource": ["*"],"Action": ["sns:Publish"]}'. if policy is invalid, cloudformation stack will fail. The value can be single policy statement or array of statements if required. This parameter is ignored if role-arn is provided.`,
+		describe: `\nAdditional iam policy to add to the role. It must be in valid aws policy format, for example: '{"Effect": "Allow", "Resource": ["*"],"Action": ["sns:Publish"]}'. if policy is invalid, cloudformation stack will fail. The value can be single policy statement or array of statements if required. This parameter is ignored if role-arn is provided.`,
 		type: 'string',
 		nargs: 1
 	},
 	"strict-mode": {
-		describe: 'Fails script creation if insufficient resource definition is provided (string values or environment reference). If false, then resource will be substituted with "*" if missing.',
-		type: boolean,
+		describe: '\nFails script creation if insufficient resource definition is provided (string values or environment reference). If false, then resource will be substituted with "*" if missing.',
+		type: 'boolean',
 		nargs: 1,
 		default: true
 	},
 	triggers: {
-		describe: `Array of lambda triggers, JSON Syntax: '[{"api": {"apiId": "..",..}]'}
+		describe: `\nArray of lambda triggers, JSON Syntax: '[{"api": {"apiId": "..",..}]'}
 
 		Supported triggers:
 
 Cloudwatch Event:\n-----------------
 			* schedule - cron expression (minutes hours days-of-month month days-of-week year) or fixed rate expression, required.\n See more: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html
 			* name - the name of event, optional, default value: Event+timestamp if not provided
-			* nodeId - the id of event listener node that should handle event. Optional
+			* reference - the reference property set for event listener node that should handle event. Optional
 
 Examples:
 1. Creates event trigger using cron expression that runs at 10am UTC every day:\n
@@ -144,8 +153,8 @@ Examples:
 2. Creates event trigger using rate expression that runs every minute:\n
 			{"event": {"expression": "rate(1 minute)"}}\n
 
-3. Creates event trigger using rate expression that runs every minute for event listener id "53bdf34.df2dfa42":\n
-			{"event": {"expression": "rate(1 minute)", "nodeId": "53bdf34.df2dfa42"}}\n
+3. Creates event trigger using rate expression that runs every minute for event listener with reference "cleanup":\n
+			{"event": {"expression": "rate(1 minute)", "reference": "cleanup"}}\n
 
 SQS:\n----
 			* queueArn - the ARN of sqs queue, required

package/cli/commands/export-commands/utils/validator.js

@@ -29,9 +29,9 @@ const triggersSchema = {
 						"title": "Event name", 
 						"type": "string"
 					},
-					"nodeId": {
-						"$id": "#root/items/event/nodeId", 
-						"title": "Event Listener node id", 
+					"reference": {
+						"$id": "#root/items/event/reference", 
+						"title": "Event Listener reference", 
 						"type": "string"
 					}
 				}

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

@@ -323,13 +323,17 @@ class TestSuiteController {
     // === Iterate over all the testCases ===
     await this.runTestCases(testCases);
     await this.waitForResults();
-    
+    const errorsNum = this._testReporter.getFailedTestCases().length;
+
     // === End the testSuite
     this._appServer.events.emit('runtime-event', {
       id: runtimeEvents.TEST_TESTSUITE_END,
       payload: {},
     });
+
+    return errorsNum;
   }
+
   async runTestCases(testCases) {
     remainingTestCases = testCases.length;
     const port = this._appServer._server.address().port;

package/cli/commands/test.js

@@ -27,8 +27,9 @@ async function runTest(flowFilePath) {
       await appServer.start();
       log(`> FlowFile to be tested: ${chalk.bold(path.resolve(flowFilePath))} \n`);
       let testSuiteController = new TestSuiteController(appServer);
-      await testSuiteController.runTestSuite(); // no need to wait for response
-      process.exit(0);
+      const errors = await testSuiteController.runTestSuite(); // no need to wait for response
+      
+      process.exit(errors > 0);
     } catch (err) {
       log(
         chalk.red(
@@ -50,18 +51,18 @@ function isDirectory(dir) {
  
 }
 
-exports.command = 'test [project_dir]';
+exports.command = 'test [project_directory]';
 exports.desc = `Run test suite`;
 
 exports.builder = (yargs) => {
-  yargs.positional(`project_dir`, {
+  yargs.positional(`project_directory`, {
       type: 'string',
       describe: 'Path to a valid kumologica project directory or flow file. (Optional)'
   })
 }
 
-exports.handler = ({ project_dir }) => {
-  let projectDirOrFile = project_dir || process.cwd();
+exports.handler = ({ project_directory }) => {
+  let projectDirOrFile = project_directory || process.cwd();
   let projectFlowPath = projectDirOrFile;
 
   let isDir = isDirectory(projectDirOrFile);
@@ -76,14 +77,14 @@ exports.handler = ({ project_dir }) => {
   } else if (isDir === false){
     // do nothing as it was assumed to be a file
   } else {
-    logError(`Directory does not exist: ${project_dir}`);
+    logError(`Directory does not exist: ${project_directory}`);
     process.exit(1);
   }
 
 	try {
 		runTest(projectFlowPath);
 	} catch (e) {
-		console.log(`${e.message}`);
+		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.1",
+  "version": "3.0.4",
   "description": "Kumologica Designer, harnessing Serverless for your cloud integration needs",
   "main": "src/app/main.js",
   "files": [
@@ -64,9 +64,9 @@
   },
   "license": "Proprietary",
   "dependencies": {
-    "@kumologica/builder": "3.0.1",
-    "@kumologica/runtime": "3.0.1",
-    "@kumologica/devkit": "3.0.1",
+    "@kumologica/builder": "3.0.4",
+    "@kumologica/runtime": "3.0.4",
+    "@kumologica/devkit": "3.0.4",
     "adm-zip": "^0.4.13",
     "ajv": "^8.10.0",
     "aws-sdk": "^2.513.0",