@contrail/cli 1.0.71 → 2.0.1

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

@@ -1,140 +0,0 @@
-import { Entities } from '@contrail/sdk';
-import chalk from 'chalk';
-import { App, AppDeclaration, AppActionDeclaration, EventWorkflowActionDefinition } from '../../interfaces';
-import { ConfigPropertiesParser } from './app-template-parsers';
-import { getSeparatorByPlatform } from '../../common';
-
-import fs from 'fs';
-
-export async function getActionsForApp(app: App) {
-  return await new Entities().get({
-    entityName: 'event-workflow-action-definition',
-    criteria: { ownerKey: `app:${app.id}` },
-  });
-}
-
-export function getActionDeclarationIdentifier(actionKey, app: App) {
-  return app.identifier + ':' + actionKey;
-}
-
-export async function deleteAction(actionId): Promise<any> {
-  return await new Entities().delete({ entityName: 'event-workflow-action-definition', id: actionId });
-}
-
-export class ActionsDeployer {
-
-  async deployActions(appDeclaration: AppDeclaration, app: App) {
-
-    // FETCH ALL ACTIONS FROM THE API.
-    const existingActions = await getActionsForApp(app);
-
-    // UPSERT / DELETE BASED ON ACTION IDENTIFIER
-    console.log('%s \tDeploying actions.', chalk.yellow.bold('ACTION'));
-    let appActionIdentifiers = [];
-    if (appDeclaration.actions) {
-      const localActionKeys = Object.keys(appDeclaration.actions);
-      appActionIdentifiers = localActionKeys.map(x => getActionDeclarationIdentifier(x, app));
-      if (localActionKeys?.length > 0) {
-        for (const actionKey of localActionKeys) {
-          await this.deployAction(actionKey, appDeclaration.actions[actionKey], app, existingActions);
-        }
-      }
-    }
-    const toDelete = existingActions.filter(x => !appActionIdentifiers.includes(x.identifier));
-    for (const action of toDelete) {
-      console.log(`%s \tDeleting action: ${action.identifier}`, chalk.yellow.bold('ACTION'));
-      await deleteAction(action.id);
-    }
-  }
-
-  async deployAction(actionKey: string, actionDeclaration: AppActionDeclaration, app: App, existingActions: Array<any>) {
-    console.log(`%s \tDeploying action: ${actionKey}`, chalk.yellow.bold('ACTION'));
-
-    const identifier = 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, app);
-    }
-  }
-
-  private async createNewActionDefinition(actionKey: string, actionDeclaration: AppActionDeclaration, app: App) {
-    let configProperties;
-    if (actionDeclaration?.actionConfiguration) {
-      configProperties = ConfigPropertiesParser.getConfigProperties(actionDeclaration.actionConfiguration);
-    }
-    const newObject: EventWorkflowActionDefinition = {
-      identifier: getActionDeclarationIdentifier(actionKey, app),
-      name: actionDeclaration.name,
-      ownerKey: `app:${app.id}`,
-      public: 'public' in actionDeclaration ? actionDeclaration.public : app.public,
-      configProperties,
-      async: actionDeclaration.async,
-    };
-
-    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, app: App) {
-
-    let configProperties;
-    if (actionDeclaration?.actionConfiguration) {
-      configProperties = ConfigPropertiesParser.getConfigProperties(actionDeclaration.actionConfiguration);
-    }
-    else if (!actionDeclaration?.actionConfiguration && existingActionDefinition.configProperties) {
-      configProperties = null;
-    }
-
-    const updates: EventWorkflowActionDefinition = {
-      name: actionDeclaration.name,
-      public: 'public' in actionDeclaration ? actionDeclaration.public : app.public,
-      configProperties,
-      async: actionDeclaration.async,
-    };
-
-    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 existing action definition: ${actionDefinition.identifier}`, chalk.yellow.bold('APP'));
-
-    return actionDefinition;
-  }
-
-  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 separator = getSeparatorByPlatform();
-
-    const functionLocation = CURRENT_DIR + separator + actionDeclaration.handler;
-    const content = fs.readFileSync(functionLocation);
-    return content.toString();
-  }
-}

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

@@ -1,105 +0,0 @@
-import { Entities } from '@contrail/sdk';
-import chalk from 'chalk';
-import { Auth } from '../../auth/auth';
-import { ActionsDeployer, getActionsForApp, deleteAction } from './actions-deployer';
-import { App, AppDeclaration } from '../../interfaces';
-import { TriggerKeyDefinitionParser, ConfigPropertiesParser } from './app-template-parsers';
-import { WorkflowTemplateDefinitionDeployer } from '../../workflow-template-definitions/workflow-template-definition-deployer';
-import { getAllAvailableApps } from '../../api/apps';
-
-export class AppDeployer {
-  public async deploy(appDeclaration: AppDeclaration) {
-    let app = await this.getExistingApp(appDeclaration);
-    if (!app) {
-      console.log('%s      Creating new app.', chalk.yellow.bold('APP'));
-      app = await this.createNewApp(appDeclaration);
-    } else {
-      console.log('%s      Updating existing app.', chalk.yellow.bold('APP'));
-      app = await this.updateExistingApp(appDeclaration, app);
-    }
-    await new ActionsDeployer().deployActions(appDeclaration, app);
-    await new WorkflowTemplateDefinitionDeployer().deployWorkflowTemplateDefinitions(appDeclaration, app);
-  }
-
-  public async getExistingApp(appDeclaration: AppDeclaration): Promise<App> {
-    const orgId = Auth.config.orgId;
-    const apps = await getAllAvailableApps({orgId});
-    return apps.find(app => app.identifier === appDeclaration.appIdentifier);
-  }
-
-  private async createNewApp(appDeclaration: AppDeclaration) {
-
-    let configProperties;
-    if (appDeclaration?.appConfiguration) {
-      configProperties = ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration);
-    }
-
-    let triggerKeyDefinitions;
-    if (appDeclaration?.triggers) {
-      triggerKeyDefinitions = TriggerKeyDefinitionParser.buildTriggersArray(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,
-      triggerKeyDefinitions,
-      dockerImageRef: appDeclaration.dockerImageRef,
-    };
-    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) {
-
-    let configProperties;
-    if (appDeclaration?.appConfiguration) {
-      configProperties = ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration);
-    }
-
-    let triggerKeyDefinitions;
-    if (appDeclaration?.triggers) {
-      triggerKeyDefinitions = TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration);
-    }
-
-    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,
-      triggerKeyDefinitions,
-      dockerImageRef: appDeclaration.dockerImageRef,
-    };
-    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) {
-      const actions = await getActionsForApp(app);
-      for(const action of actions)
-      {
-        console.log(`%s      Deleting action: ${action.identifier}`, chalk.yellow.bold('APP'));
-        await deleteAction(action.id);
-      }
-      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/apps/deploy-app/app-template-parsers.ts

@@ -1,44 +0,0 @@
-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
-        dynamic: declaration?.dynamic || false,
-      };
-      if (declaration.options) {
-        config.options = declaration.options;
-      }
-      appConfiguration.push(config);
-    }
-    return appConfiguration;
-  }
-}

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

@@ -1,66 +0,0 @@
-import chalk from 'chalk';
-import fs from 'fs';
-import { authUser } from '../../auth/login';
-import { AppDeployer } from './app-deployer';
-import { AppDeclaration } from '../../interfaces';
-import { getSeparatorByPlatform } from '../../common';
-const yaml = require('js-yaml');
-
-function loadAppConfig(){
-  const TARGET_DIR = process.cwd();
-  try {
-    const separator = getSeparatorByPlatform();
-    const doc = yaml.load(fs.readFileSync(TARGET_DIR + separator + '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'));
-}

package/src/apps/install-app/app-installer.ts

@@ -1,126 +0,0 @@
-import inquirer from 'inquirer';
-import chalk from 'chalk';
-import { Entities } from '@contrail/sdk';
-import { authUser } from '../../auth/login';
-import { deleteAppOrg, getAvailableApps, getInstalledApps, getWorkflowTemplateDefinitionsForApp, installAppToOrg } from '../../api/apps';
-import { App } from '../../interfaces';
-import { WorkflowTemplateDefinitionDeployer } from '../../workflow-template-definitions/workflow-template-definition-deployer';
-
-async function getConfigProperties(app) {
-  const config = {};
-  for (const key of Object.keys(app.configProperties)) {
-    const slug = app.configProperties[key]['slug'];
-    const name = app.configProperties[key]['label'];
-    const type = app.configProperties[key]['propertyType'];
-    const questions = [];
-    questions.push({
-      type: 'input',
-      name: 'configAnswer',
-      message: `[App config] ${name} (${type}):`,
-    });
-    const answers = await inquirer.prompt(questions);
-    config[slug] = answers.configAnswer;
-  }
-  return config;
-}
-export async function uninstallApp() {
-  await authUser();
-  const installedApps = await getInstalledApps();
-  const answers = await inquirer.prompt([{
-    type: 'list',
-    name: 'appIdentifier',
-    message: 'Which app would you like to uninstall?',
-    choices: installedApps.map(x => x.app.identifier)
-  }]);
-  const appToDelete = installedApps.find(x => x.app.identifier === answers.appIdentifier);
-  console.log('%s Uninstalling app', chalk.green.bold('APP INSTALLATION'));
-  await deleteAppOrg(appToDelete.id);
-  // eslint-disable-next-line no-constant-condition
-  while (true) {
-    await delay(1000);
-    try {
-      const appStillDeleting = await new Entities().get({ entityName: 'app-org', id: appToDelete.id });
-      if (!appStillDeleting) {
-        break;
-      }
-      process.stdout.write('.');
-    } catch (e) {
-      console.log('Error is:', e);
-      break;
-    }
-  }
-  console.log('%s App Uninstalled', chalk.green.bold('APP INSTALLATION'));
-}
-
-export async function installApp() {
-  await authUser();
-  const apps: App[] = await getAvailableApps();
-  if (!apps.length) {
-    throw new Error('No apps are available to install...');
-  }
-  const installedApps = await getInstalledApps();
-  const installedAppsIds = installedApps.map(x => x.app.id);
-  const installableApps = apps.filter(x => !installedAppsIds.includes(x.id));
-  console.log(chalk.yellow.bold('Installed Apps:'));
-  for (const appOrg of installedApps) {
-    console.log(chalk.yellow.bold(`${appOrg.app.name}: ${appOrg.app.identifier}`));
-  }
-  const questions = [];
-  questions.push({
-    type: 'list',
-    name: 'appIdentifier',
-    message: 'Which app would you like to install?',
-    choices: installableApps.map(x => x.identifier)
-  });
-  let answers = await inquirer.prompt(questions);
-  const app = installableApps.find(x => x.identifier === answers.appIdentifier);
-  let configProperties: any;
-  if (app.configProperties) {
-    configProperties = await getConfigProperties(app);
-  }
-  console.log('%s Installing apps', chalk.green.bold('APP INSTALLATION'));
-
-  const appOrg = await installAppToOrg(app, configProperties);
-  // eslint-disable-next-line no-constant-condition
-  while (true) {
-    await delay(1000);
-    try {
-      const installingApp = await new Entities().get({ entityName: 'app-org', id: appOrg.id });
-      if (installingApp.status === 'READY') {
-        console.log('%s App installed', chalk.green.bold('APP INSTALLATION'));
-        break;
-      }
-      if (installingApp.status === 'FAILED_INSTALLING') {
-        console.log('%s App installation failed', chalk.red.bold('APP INSTALLATION'));
-        return;
-      }
-      process.stdout.write('.');
-    } catch (e) {
-      console.log('%s App installation failed', chalk.red.bold('APP INSTALLATION'));
-      console.log('Error is:', e);
-      return;
-    }
-  }
-
-  const workflowTemplateDefinitions = await getWorkflowTemplateDefinitionsForApp({ appId: app.id });
-  if (!workflowTemplateDefinitions.length) {
-    return;
-  }
-  answers = await inquirer.prompt([{
-    type: 'confirm',
-    name: 'shouldInstallWorkflows',
-    message: 'Would you like to install the Workflows associated with this app?',
-    default: false
-  }]);
-
-  if (!answers.shouldInstallWorkflows) {
-    console.log('%s Not installing associated app workflows', chalk.yellow.bold('APP INSTALLATION'));
-    return;
-  }
-
-  new WorkflowTemplateDefinitionDeployer().installWorkflowTemplateDefinitions(workflowTemplateDefinitions);
-}
-
-function delay(ms: number) {
-  return new Promise(resolve => setTimeout(resolve, ms));
-}

package/src/apps/upgrade-app/app-upgrader.ts

@@ -1,132 +0,0 @@
-import inquirer from 'inquirer';
-import chalk from 'chalk';
-import { Entities } from '@contrail/sdk';
-import { authUser } from '../../auth/login';
-import { deleteAppOrg, getAppVersions, getAvailableApps, getInstalledApps, installAppToOrg, upgradeAppVersion } from '../../api/apps';
-
-async function getConfigProperties(app) {
-  const config = {};
-  for (const key of Object.keys(app.configProperties)) {
-    const slug = app.configProperties[key]['slug'];
-    const name = app.configProperties[key]['label'];
-    const type = app.configProperties[key]['propertyType'];
-    const questions = [];
-    questions.push({
-      type: 'input',
-      name: 'configAnswer',
-      message: `[App config] ${name} (${type}):`,
-    });
-    const answers = await inquirer.prompt(questions);
-    config[slug] = answers.configAnswer;
-  }
-  return config;
-}
-
-export async function uninstallApp() {
-  await authUser();
-  const installedApps = await getInstalledApps();
-  const answers = await inquirer.prompt([{
-    type: 'list',
-    name: 'appIdentifier',
-    message: 'Which app would you like to uninstall?',
-    choices: installedApps.map(x => x.app.identifier)
-  }]);
-  const appToDelete = installedApps.find(x => x.app.identifier === answers.appIdentifier);
-  console.log('%s Uninstalling app', chalk.green.bold('APP INSTALLATION'));
-  await deleteAppOrg(appToDelete.id);
-  // eslint-disable-next-line no-constant-condition
-  while (true) {
-    await delay(1000);
-    try {
-      const appStillDeleting = await new Entities().get({ entityName: 'app-org', id: appToDelete.id });
-      if (!appStillDeleting) {
-        break;
-      }
-      process.stdout.write('.');
-    } catch (e) {
-      console.log('Error is:', e);
-      break;
-    }
-  }
-  console.log('%s App Uninstalled', chalk.green.bold('APP INSTALLATION'));
-}
-
-export async function upgradeApp() {
-  await authUser();
-  const allApps = await getAvailableApps();
-  const installedApps = await getInstalledApps();
-  let answers = await inquirer.prompt([{
-    type: 'list',
-    name: 'appIdentifier',
-    message: 'Which app would you like to upgrade?',
-    choices: installedApps.map(x => x.app.identifier)
-  }]);
-  const appOrgToUpgrade = installedApps.find(x => x.app.identifier === answers.appIdentifier);
-  const appToUpgrade = allApps.find(x => x.identifier === answers.appIdentifier);
-  const versions = await getAppVersions(appToUpgrade);
-  answers = await inquirer.prompt([{
-    type: 'list',
-    name: 'appVersion',
-    message: 'Which app version would you like to upgrade to?',
-    choices: versions.map(x => {
-      const number = x.versionNumber.toString().padStart(4, '0');
-      const name = x.id === appOrgToUpgrade.appVersionId ? `${number} (${x.createdOn}) (current)` : `${number} (${x.createdOn})`;
-      return {
-        value: x.id, name
-      };
-    }).sort((x, y) => { return x.name > y.name ? -1 : 1; })
-  }]);
-
-  console.log(`%s Upgrading app to version ${answers.appVersion}`, chalk.green.bold('APP INSTALLATION'));
-  await upgradeAppVersion(appOrgToUpgrade, answers.appVersion);
-  // eslint-disable-next-line no-constant-condition
-  while (true) {
-    await delay(1000);
-    const appStillUpgrading = await new Entities().get({ entityName: 'app-org', id: appOrgToUpgrade.id });
-    if (appStillUpgrading.status === 'READY') {
-      console.log('%s App Upgraded', chalk.green.bold('APP INSTALLATION'));
-      return;
-    }
-    if (appStillUpgrading.status === 'FAILED_INSTALLING') {
-      console.log('%s App Upgrade FAILED!', chalk.red.bold('APP INSTALLATION'));
-      return;
-    }
-    console.log('checking app status...');
-  }
-}
-
-export async function installApp() {
-  await authUser();
-  const apps = await getAvailableApps();
-  if (!apps.length) {
-    throw new Error('No apps are available to install...');
-  }
-  const installedApps = await getInstalledApps();
-  const installedAppsIds = installedApps.map(x => x.app.id);
-  const installableApps = apps.filter(x => !installedAppsIds.includes(x.id));
-  console.log(chalk.yellow.bold('Installed Apps:'));
-  for (const appOrg of installedApps) {
-    console.log(chalk.yellow.bold(`${appOrg.app.name}: ${appOrg.app.identifier}`));
-  }
-  const questions = [];
-  questions.push({
-    type: 'list',
-    name: 'appIdentifier',
-    message: 'Which app would you like to install?',
-    choices: installableApps.map(x => x.identifier)
-  });
-  const answers = await inquirer.prompt(questions);
-  const app = installableApps.find(x => x.identifier === answers.appIdentifier);
-  let configProperties: any;
-  if (app.configProperties) {
-    configProperties = await getConfigProperties(app);
-  }
-  console.log('%s Installing apps', chalk.green.bold('APP INSTALLATION'));
-
-  await installAppToOrg(app, configProperties);
-  console.log('%s App installed', chalk.green.bold('APP INSTALLATION'));
-}
-
-function delay(ms: number) {
-  return new Promise(resolve => setTimeout(resolve, ms));
-}

package/src/auth/auth.ts

@@ -1,10 +0,0 @@
-export interface AuthContext {
-  apiUserToken: string;
-  apiGateway?: string;
-  orgSlug?: string;
-  orgId?: string;
-}
-
-export class Auth {
-  public static config: AuthContext;
-}