@itentialopensource/adapter-etsi_sol003 0.1.2 → 0.3.0

package/utils/tbUtils.js

@@ -3,10 +3,11 @@
 /* eslint import/no-extraneous-dependencies: warn */
 /* eslint global-require: warn */
 /* eslint import/no-dynamic-require: warn */
+/* eslint-disable no-console */
 
 const path = require('path');
-const fs = require('fs-extra');
 const cp = require('child_process');
+const fs = require('fs-extra');
 
 module.exports = {
   SERVICE_CONFIGS_COLLECTION: 'service_configs',
@@ -100,10 +101,8 @@ module.exports = {
    *
    * @function decryptProperties
    */
-  decryptProperties: (props, iapDir, discovery) => {
-    const propertyEncryptionClassPath = path.join(iapDir, 'node_modules/@itential/pronghorn-core/core/PropertyEncryption.js');
-    const isEncrypted = props.pathProps.encrypted;
-    const PropertyEncryption = discovery.require(propertyEncryptionClassPath, isEncrypted);
+  decryptProperties: (props, iapDir) => {
+    const { PropertyEncryption } = require(path.join(iapDir, 'node_modules/@itential/itential-utils'));
     const propertyEncryption = new PropertyEncryption({
       algorithm: 'aes-256-ctr',
       key: 'TG9uZ0Rpc3RhbmNlUnVubmVyUHJvbmdob3JuCg==',
@@ -159,8 +158,7 @@ module.exports = {
    * @param {Object} healthcheck - {Object} healthcheck - ./entities/.system/action.json object
    */
   getHealthCheckEndpoint: (healthcheck) => {
-    const endpoint = healthcheck.actions[1].entitypath.slice(21,
-      healthcheck.actions[1].entitypath.length - 8);
+    const endpoint = healthcheck.actions[1].entitypath.slice(21, healthcheck.actions[1].entitypath.length - 8);
     return { healthCheckEndpoint: endpoint };
   },
 
@@ -202,6 +200,7 @@ module.exports = {
       try {
         stdout = cp.execSync(cmd).toString();
       } catch (error) {
+        console.log('execute command error', error.stdout.toString(), error.stderr.toString());
         stdout = error.stdout.toString();
       }
       const output = this.getTestCount(stdout);
@@ -289,10 +288,12 @@ module.exports = {
    */
   runConnectivity: function runConnectivity(host, scriptFlag) {
     let testPath = 'test/integration/adapterTestConnectivity.js';
+    let executable = 'mocha';
     if (!scriptFlag) {
       testPath = path.resolve(__dirname, '..', testPath);
+      executable = path.join(__dirname, '..', 'node_modules/mocha/bin/mocha');
     }
-    return this.systemSync(`mocha ${testPath} --HOST=${host} --timeout 10000 --exit`, !scriptFlag);
+    return this.systemSync(`${executable} ${testPath} --HOST=${host} --timeout 10000 --exit`, !scriptFlag);
   },
 
   /**
@@ -305,9 +306,9 @@ module.exports = {
    * @param {Object} sampleProperties - './sampleProperties.json' in adapter dir
    */
   createAdapter: function createAdapter(pronghornProps, profileItem, sampleProperties, adapterPronghorn) {
-    const dirname = this.getDirname();
-    const packagePath = `${dirname.split('node_modules')[0]}package.json`;
-    const info = JSON.parse(fs.readFileSync(packagePath));
+    const iapDir = this.getIAPHome();
+    const packageFile = path.join(iapDir, 'package.json');
+    const info = JSON.parse(fs.readFileSync(packageFile));
     const version = parseInt(info.version.split('.')[0], 10);
 
     let adapter = {};
@@ -339,34 +340,42 @@ module.exports = {
     return adapter;
   },
 
-  getPronghornProps: function getPronghornProps(iapDir) {
+  getPronghornProps: function getPronghornProps() {
+    const iapDir = this.getIAPHome();
     console.log('Retrieving properties.json file...');
     const rawProps = require(path.join(iapDir, 'properties.json'));
     console.log('Decrypting properties...');
-    const { Discovery } = require(path.join(iapDir, 'node_modules/@itential/itential-utils'));
-    const discovery = new Discovery();
-    const pronghornProps = this.decryptProperties(rawProps, iapDir, discovery);
+    const pronghornProps = this.decryptProperties(rawProps, iapDir);
     console.log('Found properties.\n');
     return pronghornProps;
   },
 
+  getAllAdapterInstances: async function getAllAdapterInstances() {
+    const database = await this.getIAPDatabaseConnection();
+    const { name } = require(path.join(__dirname, '..', 'package.json'));
+    const query = { model: name };
+    const options = { projection: { name: 1 } };
+    const adapterInstancesNames = await database.collection(this.SERVICE_CONFIGS_COLLECTION).find(
+      query,
+      options
+    ).toArray();
+    return adapterInstancesNames;
+  },
+
   // get database connection and existing adapter config
-  getAdapterConfig: async function getAdapterConfig() {
-    const newDirname = this.getDirname();
-    let iapDir;
-    if (this.withinIAP(newDirname)) { // when this script is called from IAP
-      iapDir = newDirname;
+  getAdapterConfig: async function getAdapterConfig(adapterId) {
+    const database = await this.getIAPDatabaseConnection();
+    const { name } = require(path.join(__dirname, '..', 'package.json'));
+    let query = {};
+    if (!adapterId) {
+      query = { model: name };
     } else {
-      iapDir = path.join(this.getDirname(), 'utils', '../../../../');
+      query = { _id: adapterId };
     }
-    const pronghornProps = this.getPronghornProps(iapDir);
-    console.log('Connecting to Database...');
-    const database = await this.connect(iapDir, pronghornProps);
-    console.log('Connection established.');
-    const { name } = require(path.join(__dirname, '..', 'package.json'));
     const serviceItem = await database.collection(this.SERVICE_CONFIGS_COLLECTION).findOne(
-      { model: name }
+      query
     );
+    const pronghornProps = await this.getPronghornProps();
     return { database, serviceItem, pronghornProps };
   },
 
@@ -405,45 +414,74 @@ module.exports = {
   },
 
   /**
-   * @summary Check whether adapter is located within IAP node_modules
-   *          by loading properties.json. If not, return false.
-   * @function withinIAP
-   * @param {String} iapDir root directory of IAP
+   * @summary Obtain the IAP installation directory depending on how adapter is used:
+   * by IAP, or by npm run CLI interface
+   * @returns IAP installation directory or null if adapter running without IAP
+   * @function getIAPHome
    */
-  withinIAP: (iapDir) => {
-    try {
-      const rawProps = require(path.join(iapDir, 'properties.json'));
-      return rawProps;
-    } catch (error) {
-      return false;
+  getIAPHome: function getIAPHome() {
+    let IAPHomePath = null;
+    // check if adapter started via IAP, use path injected by core
+    if (process.env.iap_home) IAPHomePath = process.env.iap_home;
+    // check if adapter started via CLI `npm run <command>` so we have to be located under
+    // <IAP_HOME>/node_modules/@itentialopensource/<adapter_name>/ directory
+    const currentExecutionPath = this.getCurrentExecutionPath();
+    if (currentExecutionPath.indexOf('/node_modules') >= 0) {
+      [IAPHomePath] = currentExecutionPath.split('/node_modules');
     }
+    return IAPHomePath;
   },
 
   /**
-   * @summary Used to determine the proper dirname to return in case adapter reference is
-   * symlinked withink IAP
-   * @returns the symlinked path (using pwd command) of the adapter in case properties.json
-   * is not found in the original path
-   * @function getDirname
+   * @summary get current execution path without resolving symbolic links,
+   * use `pwd` command wihout '-P' option (resolving symlinks) https://linux.die.net/man/1/pwd
+   * @returns
+   * @function getCurrentExecutionPAth
    */
-  getDirname: function getDirname() {
-    if (this.withinIAP(path.join(__dirname, '../../../../'))) {
-      return __dirname;
-    }
+  getCurrentExecutionPath: function getCurrentExecutionPAth() {
     const { stdout } = this.systemSync('pwd', true);
     return stdout.trim();
   },
 
+  /**
+   * @summary checks if command executed from <IAP_HOME>/node_modules/@itentialopensource/<adapter_name>/ location
+   * @returns true if command executed under <IAP_HOME>/node_modules/@itentialopensource/<adapter_name>/ path
+   * @function areWeUnderIAPinstallationDirectory
+   */
+  areWeUnderIAPinstallationDirectory: function areWeUnderIAPinstallationDirectory() {
+    return path.join(this.getCurrentExecutionPath(), '../../..') === this.getIAPHome();
+  },
+
+  getIAPDatabaseConnection: async function getIAPDatabaseConnection() {
+    const pronghornProps = await this.getPronghornProps();
+    const database = await this.connect(pronghornProps);
+    return database;
+  },
+
   /**
    * @summary connect to mongodb
    *
    * @function connect
    * @param {Object} properties - pronghornProps
    */
-  connect: async function connect(iapDir, properties) {
-    // Connect to Mongo
+  connect: async function connect(properties) {
+    let dbConnectionProperties = {};
+    if (properties.mongoProps) {
+      dbConnectionProperties = properties.mongoProps;
+    } else if (properties.mongo) {
+      if (properties.mongo.url) {
+        dbConnectionProperties.url = properties.mongo.url;
+      } else {
+        dbConnectionProperties.url = `mongodb://${properties.mongo.host}:${properties.mongo.port}`;
+      }
+      dbConnectionProperties.db = properties.mongo.database;
+    }
+    if (!dbConnectionProperties.url || !dbConnectionProperties.db) {
+      throw new Error('Mongo properties are not specified in IAP configuration!');
+    }
+    const iapDir = this.getIAPHome();
     const { MongoDBConnection } = require(path.join(iapDir, 'node_modules/@itential/database'));
-    const connection = new MongoDBConnection(properties.mongoProps);
+    const connection = new MongoDBConnection(dbConnectionProperties);
     const database = await connection.connect(true);
     return database;
   }

package/utils/testRunner.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 /* @copyright Itential, LLC 2019 */
 
+const execute = require('child_process').exec;
 const fs = require('fs-extra');
 const rl = require('readline-sync');
-const execute = require('child_process').exec;
 
 /**
  * This script will determine the type of integration test to run
@@ -47,11 +47,11 @@ function replaceTestVars(test) {
   let intTest = fs.readFileSync(test, 'utf8');
 
   // replace stub variable but check if it exists first
-  let sindex = intTest.indexOf('const stub');
+  let sindex = intTest.indexOf('samProps.stub');
   let eindex = intTest.indexOf(';', sindex);
   let replStr = intTest.substring(sindex, eindex + 1);
   if (sindex > -1) {
-    intTest = intTest.replace(replStr, `const stub = ${stub};`);
+    intTest = intTest.replace(replStr, `samProps.stub = ${stub};`);
   }
 
   // replace isRapidFail variable but check if it exists first
@@ -71,46 +71,46 @@ function replaceTestVars(test) {
   }
 
   // replace host variable
-  sindex = intTest.indexOf('const host');
+  sindex = intTest.indexOf('samProps.host');
   eindex = intTest.indexOf(';', sindex);
   replStr = intTest.substring(sindex, eindex + 1);
-  intTest = intTest.replace(replStr, `const host = '${host}';`);
+  intTest = intTest.replace(replStr, `samProps.host = '${host}';`);
 
   // replace username variable
-  sindex = intTest.indexOf('const username');
+  sindex = intTest.indexOf('samProps.authentication.username');
   eindex = intTest.indexOf(';', sindex);
   replStr = intTest.substring(sindex, eindex + 1);
-  intTest = intTest.replace(replStr, `const username = '${username}';`);
+  intTest = intTest.replace(replStr, `samProps.authentication.username = '${username}';`);
 
   // replace password variable
-  sindex = intTest.indexOf('const password');
+  sindex = intTest.indexOf('samProps.authentication.password');
   eindex = intTest.indexOf(';', sindex);
   replStr = intTest.substring(sindex, eindex + 1);
-  intTest = intTest.replace(replStr, `const password = '${password}';`);
+  intTest = intTest.replace(replStr, `samProps.authentication.password = '${password}';`);
 
   // replace protocol variable
-  sindex = intTest.indexOf('const protocol');
+  sindex = intTest.indexOf('samProps.protocol');
   eindex = intTest.indexOf(';', sindex);
   replStr = intTest.substring(sindex, eindex + 1);
-  intTest = intTest.replace(replStr, `const protocol = '${protocol}';`);
+  intTest = intTest.replace(replStr, `samProps.protocol = '${protocol}';`);
 
   // replace port variable
-  sindex = intTest.indexOf('const port');
+  sindex = intTest.indexOf('samProps.port');
   eindex = intTest.indexOf(';', sindex);
   replStr = intTest.substring(sindex, eindex + 1);
-  intTest = intTest.replace(replStr, `const port = ${port};`);
+  intTest = intTest.replace(replStr, `samProps.port = ${port};`);
 
   // replace sslenable variable
-  sindex = intTest.indexOf('const sslenable');
+  sindex = intTest.indexOf('samProps.ssl.enabled');
   eindex = intTest.indexOf(';', sindex);
   replStr = intTest.substring(sindex, eindex + 1);
-  intTest = intTest.replace(replStr, `const sslenable = ${sslenable};`);
+  intTest = intTest.replace(replStr, `samProps.ssl.enabled = ${sslenable};`);
 
   // replace sslinvalid variable
-  sindex = intTest.indexOf('const sslinvalid');
+  sindex = intTest.indexOf('samProps.ssl.accept_invalid_cert');
   eindex = intTest.indexOf(';', sindex);
   replStr = intTest.substring(sindex, eindex + 1);
-  intTest = intTest.replace(replStr, `const sslinvalid = ${sslinvalid};`);
+  intTest = intTest.replace(replStr, `samProps.ssl.accept_invalid_cert = ${sslinvalid};`);
 
   console.log(`Updates to ${test} complete`);
   fs.writeFileSync(test, intTest);

package/utils/troubleshootingAdapter.js

@@ -134,9 +134,13 @@ const offline = async () => {
 };
 
 const troubleshoot = async (props, scriptFlag, persistFlag, adapter) => {
-  // get database connection and existing adapter config
-  const { database, serviceItem } = await utils.getAdapterConfig();
-  // where troubleshoot should start
+  let serviceItem;
+  if (adapter && adapter.allProps) {
+    serviceItem = { properties: { properties: adapter.allProps } };
+  }
+  if (adapter && adapter.properties && adapter.properties.properties) {
+    serviceItem = adapter.properties;
+  }
   if (serviceItem) {
     if (!scriptFlag || rls.keyInYN(`Start verifying the connection and authentication properties for ${name}?`)) {
       const { result, updatedAdapter } = VerifyHealthCheckEndpoint(serviceItem, props, scriptFlag);
@@ -154,10 +158,9 @@ const troubleshoot = async (props, scriptFlag, persistFlag, adapter) => {
       }
 
       if (persistFlag && healthRes) {
+        const { database } = await utils.getIAPDatabaseConnection();
         const update = { $set: { properties: updatedAdapter.properties } };
-        await database.collection(utils.SERVICE_CONFIGS_COLLECTION).updateOne(
-          { model: name }, update
-        );
+        await database.collection(utils.SERVICE_CONFIGS_COLLECTION).updateOne({ model: name }, update);
         if (scriptFlag) {
           console.log(`${name} updated.`);
         }

package/workflows/README.md

@@ -1,3 +0,0 @@
-# Adapter Workflows
-
-This directory contains workflows that support the adapter use cases. These workflows can be imported into IAP. If the adapter is installed using App-Artifact the workflows should be automatically imported.