@contrail/cli 1.0.2 → 1.0.3

package/src/create-app/setup-template.ts

@@ -1,57 +1,38 @@
-
-import ncp from 'ncp';
-import path from 'path';
-import { promisify } from 'util';
-import execa from 'execa';
-const Listr = require('listr');
-import { projectInstall } from 'pkg-install';
-const copy = promisify(ncp);
-const TARGET_DIR = process.cwd();
-
-const currentFileUrl = import .meta.url;
-const TEMPLATE_DIR = path.resolve(new URL(currentFileUrl).pathname, '../../../templates/javascript').replace(/\\/g, '\\').replace(/(.):\\(.):/g, '');
-// console.log('TEMPLATE_DIR: ', TEMPLATE_DIR);
-// console.log('TARGET_DIR: ', TARGET_DIR);
-
-function copyTemplate(){
-  return copy(TEMPLATE_DIR, TARGET_DIR, {
-    clobber: false,
-  });
-}
-
-function npmInstall(){
-  async function initGit(options) {
-    const result = await execa('git', ['init'], {
-      cwd: options.targetDirectory,
-    });
-    if (result.failed) {
-      return Promise.reject(new Error('Failed to initialize git'));
-    }
-    return;
-   }
-}
-
-export async function setUpTemplate() {
-  try {
-    const tasks = new Listr([
-      {
-        title: 'Copy template files',
-        task: () => copyTemplate(),
-      },
-      {
-        title: 'Install dependencies',
-        task: () =>
-          projectInstall({
-            cwd: TARGET_DIR,
-          }),
-        // skip: () =>
-        //   !options.runInstall
-        //     ? 'Pass --install to automatically install dependencies'
-        //     : undefined,
-      },
-    ]);
-    await tasks.run();
-  } catch (e) {
-    console.log('Error copying template: ', e);
-  }
+
+import ncp from 'ncp';
+import path from 'path';
+import { promisify } from 'util';
+const Listr = require('listr');
+import { projectInstall } from 'pkg-install';
+const copy = promisify(ncp);
+
+const TARGET_DIR = process.cwd();
+const currentFileUrl = import .meta.url;
+
+function copyTemplate(templateDir){
+  return copy(templateDir, TARGET_DIR, {
+    clobber: false,
+  });
+}
+
+export async function setUpTemplate(options) {
+  const templateDir = path.resolve(new URL(currentFileUrl).pathname, `../../../templates/${options.template.toLocaleLowerCase()}`).replace(/\\/g, '\\').replace(/(.):\\(.):/g, '').replace(/%20/g, ' ');
+  try {
+    const tasks = new Listr([
+      {
+        title: 'Copy template files',
+        task: () => copyTemplate(templateDir),
+      },
+      {
+        title: 'Install dependencies',
+        task: () =>
+          projectInstall({
+            cwd: TARGET_DIR,
+          }),
+      },
+    ]);
+    await tasks.run();
+  } catch (e) {
+    throw new Error(`Error copying template: ${e}`);
+  }
 }

package/src/deploy-app/actions-deployer.ts

@@ -1,84 +1,109 @@
-import { Entities } from '@contrail/sdk';
-import chalk from 'chalk';
-import { App, AppDeclartion, AppActionDeclaration, EventWorkflowActionDefinition } from './interfaces';
-import fs from 'fs';
-
-export class ActionsDeployer {
-  async deployActions(appDeclaration: AppDeclartion, app: App) {
-
-    // FETCH ALL ACTIONS FROM THE API.
-    const existingActions = await this.getActionsForApp(app);
-    // UPSERT / DELETE BASED ON ACTION IDENTIFIER
-    console.log('%s \tDeploying actions.', chalk.yellow.bold('ACTION'));
-    for (const actionKey of Object.keys(appDeclaration.actions)) {
-      await this.deployAction(actionKey, appDeclaration.actions[actionKey], app, existingActions);
-    }
-  }
-
-  async getActionsForApp(app: App){
-    return await new Entities().get({ entityName: 'event-workflow-action-definition',
-                                      criteria: { ownerKey: `app:${app.id}`}});
-  }
-
-  async deployAction(actionKey: string,
-                     actionDeclaration: AppActionDeclaration,
-                     app: App,
-                     existingActions: Array<any>){
-    console.log(`%s \tDeploying action: ${actionKey}`, chalk.yellow.bold('ACTION'));
-    const identifier = this.getActionDeclarationIdentifier(actionKey, app);
-    const existingDefinition = existingActions.find(ad => ad.identifier === identifier);
-    if (!existingDefinition) {
-      await this.createNewActionDefinition(actionKey, actionDeclaration, app);
-    } else {
-      await this.updateActionDefinition(existingDefinition, actionDeclaration);
-    }
-  }
-  private async createNewActionDefinition(actionKey: string,
-                                          actionDeclaration: AppActionDeclaration,
-                                          app: App) {
-    const newObject: EventWorkflowActionDefinition = {
-      identifier: this.getActionDeclarationIdentifier(actionKey, app),
-      name: actionDeclaration.name,
-      ownerKey: `app:${app.id}`,
-      public: !app.private,
-    };
-    const functionString = await this.getFunction(actionDeclaration);
-    if (functionString) {
-      newObject.executeFunctionString = functionString;
-    }
-    const actionDefinition = await new Entities().create({
-      entityName: 'event-workflow-action-definition',
-      object: newObject });
-    console.log(`%s      Created new action defintion: ${actionKey}`, chalk.yellow.bold('APP'));
-    return actionDefinition;
-  }
-  private async updateActionDefinition(existingActionDefinition: EventWorkflowActionDefinition,
-                                       actionDeclaration: AppActionDeclaration) {
-    const updates: EventWorkflowActionDefinition  = {
-      name: actionDeclaration.name,
-    };
-    const functionString = await this.getFunction(actionDeclaration);
-    if (functionString) {
-      updates.executeFunctionString = functionString;
-    }
-    const actionDefinition = await new Entities().update({
-      entityName: 'event-workflow-action-definition',
-      id: existingActionDefinition.id,
-      object: updates });
-    console.log(`%s      Updated existingaction defintion: ${actionDefinition.identifier}`, chalk.yellow.bold('APP'));
-    return actionDefinition;
-  }
-  getActionDeclarationIdentifier(actionKey, app: App) {
-    return app.identifier + ':' + actionKey;
-  }
-
-  async getFunction(actionDeclaration: AppActionDeclaration): Promise<string> {
-    if (!actionDeclaration.handler) {
-      return;
-    }
-    const CURRENT_DIR = process.cwd();
-    const functionLocaiton = CURRENT_DIR + '\\' + actionDeclaration.handler;
-    const content = fs.readFileSync(functionLocaiton);
-    return content.toString();
-  }
-}
+import { Entities } from '@contrail/sdk';
+import chalk from 'chalk';
+import { App, AppDeclaration, AppActionDeclaration, EventWorkflowActionDefinition } from './interfaces';
+import { ConfigPropertiesParser } from './app-template-parsers';
+import fs from 'fs';
+
+export class ActionsDeployer {
+  async deployActions(appDeclaration: AppDeclaration, app: App) {
+
+    // FETCH ALL ACTIONS FROM THE API.
+    const existingActions = await this.getActionsForApp(app);
+
+    // UPSERT / DELETE BASED ON ACTION IDENTIFIER
+    console.log('%s \tDeploying actions.', chalk.yellow.bold('ACTION'));
+
+    for (const actionKey of Object.keys(appDeclaration.actions)) {
+      await this.deployAction(actionKey, appDeclaration.actions[actionKey], app, existingActions);
+    }
+  }
+
+  async getActionsForApp(app: App) {
+    return await new Entities().get({
+      entityName: 'event-workflow-action-definition',
+      criteria: { ownerKey: `app:${app.id}` },
+    });
+  }
+
+  async deployAction(actionKey: string, actionDeclaration: AppActionDeclaration, app: App, existingActions: Array<any>) {
+    console.log(`%s \tDeploying action: ${actionKey}`, chalk.yellow.bold('ACTION'));
+
+    const identifier = this.getActionDeclarationIdentifier(actionKey, app);
+    const existingDefinition = existingActions.find(ad => ad.identifier === identifier);
+
+    if (!existingDefinition) {
+      await this.createNewActionDefinition(actionKey, actionDeclaration, app);
+    } else {
+      await this.updateActionDefinition(existingDefinition, actionDeclaration);
+    }
+  }
+
+  private async createNewActionDefinition(actionKey: string, actionDeclaration: AppActionDeclaration, app: App) {
+    const newObject: EventWorkflowActionDefinition = {
+      identifier: this.getActionDeclarationIdentifier(actionKey, app),
+      name: actionDeclaration.name,
+      ownerKey: `app:${app.id}`,
+      public: app.public,  // TODO - an actions visibility is not tied to the visibility of the app
+      configProperties: ConfigPropertiesParser.getConfigProperties(actionDeclaration.actionConfiguration),
+    };
+
+    const functionString = await this.getFunction(actionDeclaration);
+    if (functionString) {
+      newObject.executeFunctionString = functionString;
+    }
+
+    const actionDefinition = await new Entities().create({
+      entityName: 'event-workflow-action-definition',
+      object: newObject,
+    });
+
+    console.log(`%s      Created new action definition: ${actionKey}`, chalk.yellow.bold('APP'));
+
+    return actionDefinition;
+  }
+
+  private async updateActionDefinition(existingActionDefinition: EventWorkflowActionDefinition,
+                                       actionDeclaration: AppActionDeclaration) {
+    const updates: EventWorkflowActionDefinition = {
+      name: actionDeclaration.name,
+      // public: actionDeclaration.public, // TODO - an actions visibility is allowed to change
+      configProperties: ConfigPropertiesParser.getConfigProperties(actionDeclaration.actionConfiguration),
+    };
+
+    const functionString = await this.getFunction(actionDeclaration);
+    if (functionString) {
+      updates.executeFunctionString = functionString;
+    }
+
+    const actionDefinition = await new Entities().update({
+      entityName: 'event-workflow-action-definition',
+      id: existingActionDefinition.id,
+      object: updates,
+    });
+
+    console.log(`%s      Updated existingaction defintion: ${actionDefinition.identifier}`, chalk.yellow.bold('APP'));
+
+    return actionDefinition;
+  }
+
+  getActionDeclarationIdentifier(actionKey, app: App) {
+    return app.identifier + ':' + actionKey;
+  }
+
+  async getFunction(actionDeclaration: AppActionDeclaration): Promise<string> {
+    if (!actionDeclaration.handler) {
+      return;
+    }
+
+    if (!actionDeclaration.handler.endsWith('.js')) {
+      throw new Error('Action handler must be a .js file.');
+    }
+    const CURRENT_DIR = process.cwd();
+    const isWin = process.platform === 'win32';
+    const separator = isWin ? '\\' : '/';
+
+    const functionLocaiton = CURRENT_DIR + separator + actionDeclaration.handler;
+    const content = fs.readFileSync(functionLocaiton);
+    return content.toString();
+  }
+}

package/src/deploy-app/app-deployer.ts

@@ -1,89 +1,86 @@
-import { Entities } from '@contrail/sdk';
-import chalk from 'chalk';
-import { config } from 'process';
-import { Auth } from '../auth/auth';
-import { ActionsDeployer } from './actions-deployer';
-import { App, AppDeclartion } from './interfaces';
-
-export class AppDeployer {
-  private app: App;
-  public async deploy(appDeclaration: AppDeclartion) {
-    let app = await this.getExistingApp(appDeclaration);
-    if (!app) {
-      app = await this.createNewApp(appDeclaration);
-    } else {
-      app = await this.updateExistingApp(appDeclaration, app);
-    }
-    this.app = app;
-    await new ActionsDeployer().deployActions(appDeclaration, this.app);
-  }
-
-  public async remove(appDeclaration: AppDeclartion) {
-    let app = await this.getExistingApp(appDeclaration);
-    if (app) {
-      app = await new Entities().delete({ entityName: 'app', id: app.id});
-      console.log(`%s      Deleted app: ${app.name}`, chalk.yellow.bold('APP'));
-    } else {
-      console.log(`%s      App not found. Can not remove`, chalk.red.bold('APP'));
-    }
-  }
-
-  public async getExistingApp(appDeclaration: AppDeclartion) {
-    const orgId = Auth.config.orgId;
-    const apps = await new Entities().get({ entityName: 'app', criteria: {
-      orgId,
-      private: (appDeclaration.visibility === 'private')},
-    });
-//    console.log('Existing: ', apps);
-    return apps.find(app => app.identifier === appDeclaration.appIdentifier);
-  }
-  public async updateExistingApp(appDeclaration: AppDeclartion, existingApp) {
-    const updates = {
-      name: appDeclaration.appName,
-      public: appDeclaration.visibility === 'public',
-      description: appDeclaration.appDescription,
-      publisher: appDeclaration.publisher,
-      thumbnail: appDeclaration.thumbnail,
-      eventWorkflowTriggerKeyMapping: 'NONE',
-      keywords: appDeclaration.keywords,
-      configProperties: this.getAppConfigProperties(appDeclaration),
-    };
-    const app = await new Entities().update({ entityName: 'app', id: existingApp.id, object: updates });
-    console.log(`%s      Updated app: ${app.name}`, chalk.yellow.bold('APP'));
-    return app;
-  }
-  private async createNewApp(appDeclaration: AppDeclartion) {
-    const newApp = {
-      identifier: appDeclaration.appIdentifier,
-      name: appDeclaration.appName,
-      public: appDeclaration.visibility === 'public',
-      description: appDeclaration.appDescription,
-      publisher: appDeclaration.publisher,
-      thumbnail: appDeclaration.thumbnail,
-      eventWorkflowTriggerKeyMapping: 'NONE',
-      keywords: appDeclaration.keywords,
-      configProperties: this.getAppConfigProperties(appDeclaration),
-    };
-    const app = await new Entities().create({ entityName: 'app', object: newApp });
-    console.log(`%s      Created new app: ${app.name}`, chalk.yellow.bold('APP'));
-    return app;
-
-  }
-  private getAppConfigProperties(appDeclaration: AppDeclartion){
-    const appConfiguration = [];
-    for (const configKey of Object.keys(appDeclaration.appConfiguration)) {
-      const declaration = appDeclaration.appConfiguration[configKey];
-      const config: any = {
-        label: declaration.label,
-        slug: configKey,
-        propertyType: declaration.propertyType,
-      };
-      if (declaration.options) {
-        config.options = declaration.options;
-      }
-      appConfiguration.push(config);
-    }
-    return appConfiguration;
-  }
-
-}
+import { Entities } from '@contrail/sdk';
+import chalk from 'chalk';
+import { Auth } from '../auth/auth';
+import { ActionsDeployer } from './actions-deployer';
+import { App, AppDeclaration } from './interfaces';
+import { TriggerKeyDefinitionParser, ConfigPropertiesParser } from './app-template-parsers';
+
+export class AppDeployer {
+  public async deploy(appDeclaration: AppDeclaration) {
+    let app = await this.getExistingApp(appDeclaration);
+    if (!app) {
+      app = await this.createNewApp(appDeclaration);
+    } else {
+      app = await this.updateExistingApp(appDeclaration, app);
+    }
+    await new ActionsDeployer().deployActions(appDeclaration, app);
+  }
+
+  public async getExistingApp(appDeclaration: AppDeclaration): Promise<App> {
+    const orgId = Auth.config.orgId;
+    const apps = [];
+
+    apps.push(...await new Entities().get({
+      entityName: 'app',
+      criteria: {
+        orgId,
+        private: true,
+      },
+    }));
+    apps.push(...await new Entities().get({
+      entityName: 'app',
+      criteria: {
+        orgId,
+        private: false,
+      },
+    }));
+
+    return apps.find(app => app.identifier === appDeclaration.appIdentifier);
+  }
+
+  private async createNewApp(appDeclaration: AppDeclaration) {
+    const newApp = {
+      identifier: appDeclaration.appIdentifier,
+      name: appDeclaration.appName,
+      public: appDeclaration.visibility === 'public',
+      description: appDeclaration.appDescription,
+      publisher: appDeclaration.publisher,
+      thumbnail: appDeclaration.thumbnail,
+      eventWorkflowTriggerKeyMapping: appDeclaration.eventWorkflowTriggerKeyMapping,
+      keywords: appDeclaration.keywords,
+      configProperties: ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration),
+      triggerKeyDefinitions: TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration),
+    };
+    const app = await new Entities().create({ entityName: 'app', object: newApp });
+    console.log(`%s      Created new app: ${app.name}`, chalk.yellow.bold('APP'));
+    return app;
+  }
+
+  public async updateExistingApp(appDeclaration: AppDeclaration, existingApp) {
+    const updates = {
+      name: appDeclaration.appName,
+      public: appDeclaration.visibility === 'public',
+      description: appDeclaration.appDescription,
+      publisher: appDeclaration.publisher,
+      thumbnail: appDeclaration.thumbnail,
+      eventWorkflowTriggerKeyMapping: appDeclaration.eventWorkflowTriggerKeyMapping,
+      keywords: appDeclaration.keywords,
+      configProperties: ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration),
+      triggerKeyDefinitions: TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration),
+    };
+    const app = await new Entities().update({ entityName: 'app', id: existingApp.id, object: updates });
+    console.log(`%s      Updated app: ${app.name}`, chalk.yellow.bold('APP'));
+    return app;
+  }
+
+  public async remove(appDeclaration: AppDeclaration) {
+    let app = await this.getExistingApp(appDeclaration);
+    if (app) {
+      app = await new Entities().delete({ entityName: 'app', id: app.id });
+      console.log(`%s      Deleted app: ${app.name}`, chalk.yellow.bold('APP'));
+    } else {
+      throw new Error('App not found.');
+    }
+  }
+
+}

package/src/deploy-app/app-template-parsers.ts

@@ -0,0 +1,43 @@
+import { AppDeclaration, TriggerKeyDefinition, ConfigPropertyElements } from './interfaces';
+
+export class TriggerKeyDefinitionParser {
+  public static buildTriggersArray(appDeclaration: AppDeclaration): Array<TriggerKeyDefinition> {
+    const triggers: Array<TriggerKeyDefinition> = [];
+
+    for (const triggerName of Object.keys(appDeclaration.triggers)) {
+      const triggerDeclaration = appDeclaration.triggers[triggerName];
+
+      const triggerDefinition = {
+        triggerKey: triggerDeclaration.external ? `${appDeclaration.appIdentifier}:${triggerDeclaration.key}` : triggerDeclaration.key,
+        name: triggerDeclaration.name,
+        external: triggerDeclaration.external,
+        description: triggerDeclaration.description,
+      };
+      if (!triggerDefinition.triggerKey || !triggerDefinition.name) {
+        throw new Error('Illegal trigger declaration: must have key and name');
+      }
+      triggers.push(triggerDefinition);
+
+    }
+    return triggers;
+  }
+}
+
+export class ConfigPropertiesParser {
+  public static getConfigProperties(configPropertyElements: ConfigPropertyElements) {
+    const appConfiguration = [];
+    for (const configKey of Object.keys(configPropertyElements)) {
+      const declaration = configPropertyElements[configKey];
+      const config: any = {
+        label: declaration.label,
+        slug: configKey,
+        propertyType: declaration.propertyType, // TODO should support options
+      };
+      if (declaration.options) {
+        config.options = declaration.options;
+      }
+      appConfiguration.push(config);
+    }
+    return appConfiguration;
+  }
+}

package/src/deploy-app/deploy.ts

@@ -1,34 +1,65 @@
-import chalk from 'chalk';
-import fs from 'fs';
-import { authUser } from '../auth/login';
-import { AppDeployer } from './app-deployer';
-import { AppDeclartion } from './interfaces';
-const yaml = require('js-yaml');
-
-function loadAppConfig(){
-  const TARGET_DIR = process.cwd();
-  try {
-    const doc = yaml.load(fs.readFileSync(TARGET_DIR + '/app.yml', 'utf8'));
-    console.log(doc);
-    return doc;
-  } catch (e) {
-    console.log('ERROR PARSING YAML: ', e);
-  }
-}
-
-export async function deployApp(args) {
-  const appDeclaration: AppDeclartion = loadAppConfig();
-
-  console.log(`%s Deploying application. ${appDeclaration.appIdentifier}`, chalk.blue.bold('START'));
-  const user = await authUser();
-  await new AppDeployer().deploy(appDeclaration);
-  console.log('%s Deployment complete.', chalk.green.bold('COMPLETE'));
-}
-
-export async function removeApp(args) {
-  const appDeclaration: AppDeclartion = loadAppConfig();
-  console.log(`%s Removing application. ${appDeclaration.appIdentifier}`, chalk.blue.bold('START'));
-  await authUser();
-  await new AppDeployer().remove(appDeclaration);
-  console.log('%s Removing complete.', chalk.green.bold('COMPLETE'));
+import chalk from 'chalk';
+import fs from 'fs';
+import { authUser } from '../auth/login';
+import { AppDeployer } from './app-deployer';
+import { AppDeclaration } from './interfaces';
+const yaml = require('js-yaml');
+
+function loadAppConfig(){
+  const TARGET_DIR = process.cwd();
+  try {
+    const doc = yaml.load(fs.readFileSync(TARGET_DIR + '/app.yml', 'utf8'));
+    console.log(doc);
+    return doc;
+  } catch (e) {
+    throw new Error(`ERROR PARSING YAML: ${e}`);
+  }
+}
+
+export async function deployApp(args) {
+  let appDeclaration: AppDeclaration;
+  try {
+    appDeclaration = loadAppConfig();
+  }
+  catch (e) {
+    console.log(`%s Application Deployment Failed. ${e}`, chalk.red.bold('FAIL'));
+    return;
+  }
+
+  console.log(`%s Deploying Application. ${appDeclaration.appIdentifier}`, chalk.blue.bold('START'));
+
+  try {
+    await authUser();
+    await new AppDeployer().deploy(appDeclaration);
+  }
+  catch (e) {
+    console.log(`%s Application Deployment Failed. ${e}`, chalk.red.bold('FAIL'));
+    return;
+  }
+
+  console.log('%s Deployment Complete.', chalk.green.bold('COMPLETE'));
+}
+
+export async function removeApp(args) {
+  let appDeclaration: AppDeclaration;
+  try {
+    appDeclaration = loadAppConfig();
+  }
+  catch (e) {
+    console.log(`%s Application Removal Failed. ${e}`, chalk.red.bold('FAIL'));
+    return;
+  }
+
+  console.log(`%s Removing Application. ${appDeclaration.appIdentifier}`, chalk.blue.bold('START'));
+
+  try {
+    await authUser();
+    await new AppDeployer().remove(appDeclaration);
+  }
+  catch (e) {
+    console.log(`%s Application Removal Failed. ${e}`, chalk.red.bold('FAIL'));
+    return;
+  }
+
+  console.log('%s Application Removal Complete.', chalk.green.bold('COMPLETE'));
 }