@itentialopensource/adapter-db_oracle 0.1.6 → 0.2.0

package/changelogs/changelog.md

@@ -0,0 +1,40 @@
+
+## 0.1.8 [06-22-2023]
+
+* Remove any sensitive data logging
+
+See merge request itentialopensource/adapters/persistence/adapter-db_oracle!2
+
+---
+
+## 0.1.7 [06-22-2023]
+
+* Remove any sensitive data logging
+
+See merge request itentialopensource/adapters/persistence/adapter-db_oracle!2
+
+---
+
+## 0.1.6 [11-21-2019]
+
+* Bug fixes and performance improvements
+
+See commit 1253be6
+
+---
+
+## 0.1.5 [11-21-2019]
+
+* Bug fixes and performance improvements
+
+See commit 0f588d3
+
+---
+
+## 0.1.4 [11-21-2019]
+
+* Bug fixes and performance improvements
+
+See commit ca4d362
+
+---

package/error.json

@@ -96,6 +96,12 @@
       "displayString": "Invalid properties: $VARIABLE$",
       "recommendation": "Verify the properties for the adapter"
     },
+    {
+      "key": "Missing Properties",
+      "icode": "AD.306",
+      "displayString": "Property $VARIABLE$ is required",
+      "recommendation": "Please provide the required property"
+    },
     {
       "key": "Query Not Translated",
       "icode": "AD.310",
@@ -168,6 +174,12 @@
       "displayString": "Failure response received for $VARIABLE$",
       "recommendation": "Check the reason for failure in the stack trace"
     },
+    {
+      "key": "Suspended Adapter",
+      "icode": "AD.600",
+      "displayString": "Adapter is suspended",
+      "recommendation": "Check if external system is functional and unsuspend if appropriate"
+    },
     {
       "key": "Caught Exception",
       "icode": "AD.900",

package/metadata.json

@@ -0,0 +1,49 @@
+{
+  "name": "adapter-db_oracle",
+  "webName": "Adapter for Integration to Oracle Database",
+  "vendor": "Oracle",
+  "product": "Oracle DB",
+  "osVersion": [],
+  "apiVersions": [],
+  "iapVersions": [
+    "2021.1.x",
+    "2021.2.x",
+    "2022.1.x",
+    "2023.1.x"
+  ],
+  "method": "Library",
+  "type": "Adapter",
+  "domains": [
+    "Data Storage"
+  ],
+  "tags": [],
+  "useCases": [],
+  "deprecated": {
+    "isDeprecated": false
+  },
+  "brokerSince": "",
+  "documentation": {
+    "storeLink": "",
+    "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-db_oracle",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/persistence/adapter-db_oracle",
+    "docLink": "",
+    "demoLinks": [],
+    "trainingLinks": [],
+    "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
+    "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
+    "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
+    "webLink": "https://www.itential.com/adapters/oracle/",
+    "vendorLink": "",
+    "productLink": "",
+    "apiLinks": []
+  },
+  "assets": [],
+  "relatedItems": {
+    "adapters": [],
+    "integrations": [],
+    "ecosystemApplications": [],
+    "workflowProjects": [],
+    "transformationProjects": [],
+    "exampleProjects": []
+  }
+}

package/package.json

@@ -1,19 +1,22 @@
 {
   "name": "@itentialopensource/adapter-db_oracle",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "description": "Itential adapter to connect to oracle",
   "main": "adapter.js",
-  "wizardVersion": "2.41.0",
-  "engineVersion": "1.44.2",
+  "wizardVersion": "2.44.7",
+  "engineVersion": "1.67.14",
+  "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
     "preinstall": "node utils/setup.js",
-    "lint": "eslint . --ext .json --ext .js",
+    "deinstall": "node utils/removeHooks.js",
+    "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
+    "lint:errors": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js --quiet",
     "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
     "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
     "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
     "test": "npm run test:unit && npm run test:integration",
-    "deploy": "npm publish --registry=http://registry.npmjs.org --access=public",
+    "deploy": "npm publish --registry=https://registry.npmjs.org --access=public",
     "build": "npm run deploy"
   },
   "keywords": [
@@ -38,23 +41,22 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/persistence/adapter-db_oracle#readme",
   "dependencies": {
-    "ajv": "^6.10.0",
-    "fs-extra": "^7.0.0",
+    "ajv": "^8.12.0",
+    "fs-extra": "^11.1.1",
     "oracledb": "^4.0.1",
-    "package-json-validator": "^0.6.3",
-    "readline-sync": "^1.4.9",
-    "uuid": "^3.0.1"
+    "readline-sync": "^1.4.10",
+    "uuid": "^3.1.0"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "eslint": "^5.14.1",
-    "eslint-config-airbnb-base": "^13.1.0",
-    "eslint-plugin-import": "^2.16.0",
-    "eslint-plugin-json": "^1.4.0",
-    "mocha": "^5.2.0",
-    "nyc": "^14.1.1",
-    "testdouble": "^3.8.1",
-    "winston": "^2.4.0"
+    "chai": "^4.3.7",
+    "eslint": "^8.44.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-json": "^3.1.0",
+    "mocha": "^9.1.2",
+    "nyc": "^15.1.0",
+    "testdouble": "^3.18.0",
+    "winston": "^3.3.3"
   },
   "private": false
 }

package/propertiesDecorators.json

@@ -0,0 +1,14 @@
+[
+  {
+    "type": "encryption",
+    "pointer": "/authentication/password"
+  },
+  {
+    "type": "encryption",
+    "pointer": "/authentication/token"
+  },
+  {
+    "type": "encryption",
+    "pointer": "/mongo/password"
+  }
+]

package/report/adapterInfo.json

@@ -0,0 +1,10 @@
+{
+  "version": "0.1.8",
+  "configLines": 424,
+  "scriptLines": 516,
+  "codeLines": 492,
+  "testLines": 963,
+  "testCases": 45,
+  "totalCodeLines": 1971,
+  "wfTasks": 7
+}

package/sampleProperties.json

@@ -6,12 +6,12 @@
     "host": "localhost",
     "port": 3306,
     "authentication": {
-        "username": "your username",
-        "password": "your password"
+      "username": "your username",
+      "password": "your password"
     }
   },
   "groups": [],
   "brokers": [],
   "logLevel": "none",
   "timeout": 60000
-}
+}

package/test/.eslintrc.js

@@ -1,16 +1,16 @@
 module.exports = {
   env: {
-    mocha: true,
+    mocha: true
   },
   globals: {
     // Pronghorn globals.
-    log: true,
+    log: true
   },
   rules: {
     // Mocha preference for describe context.
     'prefer-arrow-callback': 'off',
     'func-names': 'off',
     // We want to isolate dependencies.
-    'global-require': 'off',
-  },
+    'global-require': 'off'
+  }
 };

package/test/integration/adapterTestIntegration.js

@@ -1,7 +1,7 @@
 /* @copyright Itential, LLC 2019 (pre-modifications) */
 
 // Set globals
-/* global describe it log pronghornProps */
+/* global pronghornProps */
 /* eslint no-unused-vars: warn */
 /* eslint no-underscore-dangle: warn  */
 
@@ -93,7 +93,7 @@ process.argv.forEach((val) => {
 });
 
 // need to set global logging
-global.log = new (winston.Logger)({
+global.log = winston.createLogger({
   level: logLevel,
   levels: myCustomLevels.levels,
   transports: [
@@ -129,7 +129,7 @@ function runErrorAsserts(data, error, code, origin, displayStr) {
 }
 
 // require the adapter that we are going to be using
-const Oracle = require('../../adapter.js');
+const Oracle = require('../../adapter');
 
 // begin the testing - these should be pretty well defined between the describe and the it!
 describe('[integration] Oracle Adapter Test', () => {

package/test/unit/adapterTestUnit.js

@@ -1,7 +1,7 @@
 /* @copyright Itential, LLC 2019 (pre-modifications) */
 
 // Set globals
-/* global describe it log pronghornProps */
+/* global pronghornProps */
 /* eslint global-require:warn */
 /* eslint no-unused-vars: warn */
 
@@ -16,7 +16,9 @@ const execute = require('child_process').execSync;
 const { expect } = require('chai');
 const { use } = require('chai');
 const td = require('testdouble');
+const Ajv = require('ajv');
 
+const ajv = new Ajv({ strictSchema: false, allErrors: true, allowUnionTypes: true });
 const anything = td.matchers.anything();
 
 // stub and attemptTimeout are used throughout the code so set them here
@@ -97,7 +99,7 @@ process.argv.forEach((val) => {
 });
 
 // need to set global logging
-global.log = new (winston.Logger)({
+global.log = winston.createLogger({
   level: logLevel,
   levels: myCustomLevels.levels,
   transports: [
@@ -121,9 +123,8 @@ function runErrorAsserts(data, error, code, origin, displayStr) {
   assert.equal(displayStr, error.IAPerror.displayString);
 }
 
-
 // require the adapter that we are going to be using
-const Oracle = require('../../adapter.js');
+const Oracle = require('../../adapter');
 
 // delete the .DS_Store directory in entities -- otherwise this will cause errors
 const dirPath = path.join(__dirname, '../../entities/.DS_Store');
@@ -187,23 +188,33 @@ describe('[unit] Oracle Adapter Test', () => {
         });
       });
       it('package.json should be validated', (done) => {
-        const packageDotJson = require('../../package.json');
-        const { PJV } = require('package-json-validator');
-        const options = {
-          warnings: true, // show warnings
-          recommendations: true // show recommendations
-        };
-        const results = PJV.validate(JSON.stringify(packageDotJson), 'npm', options);
-
-        if (results.valid === false) {
-          log.error('The package.json contains the following errors: ');
-          log.error(util.inspect(results));
-          assert.equal(true, results.valid);
-        } else {
-          assert.equal(true, results.valid);
-        }
+        try {
+          const packageDotJson = require('../../package.json');
+          // Define the JSON schema for package.json
+          const packageJsonSchema = {
+            type: 'object',
+            properties: {
+              name: { type: 'string' },
+              version: { type: 'string' }
+              // May need to add more properties as needed
+            },
+            required: ['name', 'version']
+          };
+          const validate = ajv.compile(packageJsonSchema);
+          const isValid = validate(packageDotJson);
+
+          if (isValid === false) {
+            log.error('The package.json contains errors');
+            assert.equal(true, isValid);
+          } else {
+            assert.equal(true, isValid);
+          }
 
-        done();
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
       });
       it('package.json should be customized', (done) => {
         const packageDotJson = require('../../package.json');

package/utils/adapterInfo.js

@@ -0,0 +1,206 @@
+#!/usr/bin/env node
+/* @copyright Itential, LLC 2019 */
+/* eslint global-require:warn */
+/* eslint import/no-dynamic-require:warn */
+/* eslint prefer-destructuring:warn */
+
+const path = require('path');
+const fs = require('fs-extra');
+
+/**
+ * This script will determine the information about the adapter and store
+ * it into a file in the adapter.
+ */
+
+/**
+ * get adapter information
+ */
+function adapterInfo() {
+  // set the base pase of the adapter - tool shoud be one level up in utils
+  let adaptdir = __dirname;
+  const infoRes = {};
+
+  if (adaptdir.endsWith('/utils')) {
+    adaptdir = adaptdir.substring(0, adaptdir.length - 6);
+  }
+  const pack = require(`${adaptdir}/package.json`);
+  infoRes.version = pack.version;
+
+  let configCount = 0;
+  if (fs.existsSync(`${adaptdir}/pronghorn.json`)) {
+    const cFile = fs.readFileSync(`${adaptdir}/pronghorn.json`, 'utf8');
+    configCount += cFile.split('\n').length;
+  } else {
+    console.log('Missing - pronghorn.json');
+  }
+  if (fs.existsSync(`${adaptdir}/propertiesSchema.json`)) {
+    const cFile = fs.readFileSync(`${adaptdir}/propertiesSchema.json`, 'utf8');
+    configCount += cFile.split('\n').length;
+  } else {
+    console.log('Missing - propertiesSchema.json');
+  }
+  if (fs.existsSync(`${adaptdir}/error.json`)) {
+    const cFile = fs.readFileSync(`${adaptdir}/error.json`, 'utf8');
+    configCount += cFile.split('\n').length;
+  } else {
+    console.log('Missing - error.json');
+  }
+  const entitydir = path.join(adaptdir, '/entities');
+  if (fs.existsSync(entitydir) && fs.statSync(entitydir).isDirectory()) {
+    const entities = fs.readdirSync(entitydir);
+    // need to go through each entity in the entities directory
+    for (let e = 0; e < entities.length; e += 1) {
+      if (fs.statSync(`${entitydir}/${entities[e]}`).isDirectory()) {
+        const cfiles = fs.readdirSync(entitydir);
+        for (let c = 0; c < cfiles.length; c += 1) {
+          if (cfiles[c].endsWith('.json')) {
+            const ccFile = fs.readFileSync(`${entitydir}/${entities[e]}/${cfiles[c]}`, 'utf8');
+            configCount += ccFile.split('\n').length;
+          }
+        }
+      }
+    }
+  } else {
+    console.log('Could not find the entities directory');
+  }
+  infoRes.configLines = configCount;
+
+  let scodeCount = 0;
+  if (fs.existsSync(`${adaptdir}/utils/artifactize.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/artifactize.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/artifactize.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/basicGet.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/basicGet.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/basicGet.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/checkMigrate.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/checkMigrate.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/checkMigrate.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/findPath.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/findPath.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/findPath.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/modify.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/modify.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/modify.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/packModificationScript.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/packModificationScript.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/packModificationScript.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/setup.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/setup.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/setup.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/tbScript.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/tbScript.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/tbScript.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/tbUtils.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/tbUtils.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/tbUtils.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/testRunner.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/testRunner.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/testRunner.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/troubleshootingAdapter.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/troubleshootingAdapter.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/troubleshootingAdapter.js');
+  }
+  infoRes.scriptLines = scodeCount;
+
+  let codeCount = 0;
+  if (fs.existsSync(`${adaptdir}/adapter.js`)) {
+    const aFile = fs.readFileSync(`${adaptdir}/adapter.js`, 'utf8');
+    codeCount += aFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/adapter.js');
+  }
+  if (fs.existsSync(`${adaptdir}/adapterBase.js`)) {
+    const aFile = fs.readFileSync(`${adaptdir}/adapterBase.js`, 'utf8');
+    codeCount += aFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/adapterBase.js');
+  }
+  infoRes.codeLines = codeCount;
+
+  let tcodeCount = 0;
+  let ttestCount = 0;
+  if (fs.existsSync(`${adaptdir}/test/integration/adapterTestBasicGet.js`)) {
+    const tFile = fs.readFileSync(`${adaptdir}/test/integration/adapterTestBasicGet.js`, 'utf8');
+    tcodeCount += tFile.split('\n').length;
+    ttestCount += tFile.split('it(\'').length;
+  } else {
+    console.log('Missing - test/integration/adapterTestBasicGet.js');
+  }
+  if (fs.existsSync(`${adaptdir}/test/integration/adapterTestConnectivity.js`)) {
+    const tFile = fs.readFileSync(`${adaptdir}/test/integration/adapterTestConnectivity.js`, 'utf8');
+    tcodeCount += tFile.split('\n').length;
+    ttestCount += tFile.split('it(\'').length;
+  } else {
+    console.log('Missing - test/integration/adapterTestConnectivity.js');
+  }
+  if (fs.existsSync(`${adaptdir}/test/integration/adapterTestIntegration.js`)) {
+    const tFile = fs.readFileSync(`${adaptdir}/test/integration/adapterTestIntegration.js`, 'utf8');
+    tcodeCount += tFile.split('\n').length;
+    ttestCount += tFile.split('it(\'').length;
+  } else {
+    console.log('Missing - test/integration/adapterTestIntegration.js');
+  }
+  if (fs.existsSync(`${adaptdir}/test/unit/adapterBaseTestUnit.js`)) {
+    const tFile = fs.readFileSync(`${adaptdir}/test/unit/adapterBaseTestUnit.js`, 'utf8');
+    tcodeCount += tFile.split('\n').length;
+    ttestCount += tFile.split('it(\'').length;
+  } else {
+    console.log('Missing - test/unit/adapterBaseTestUnit.js');
+  }
+  if (fs.existsSync(`${adaptdir}/test/unit/adapterTestUnit.js`)) {
+    const tFile = fs.readFileSync(`${adaptdir}/test/unit/adapterTestUnit.js`, 'utf8');
+    tcodeCount += tFile.split('\n').length;
+    ttestCount += tFile.split('it(\'').length;
+  } else {
+    console.log('Missing - test/unit/adapterTestUnit.js');
+  }
+  infoRes.testLines = tcodeCount;
+  infoRes.testCases = ttestCount;
+  infoRes.totalCodeLines = scodeCount + codeCount + tcodeCount;
+
+  if (fs.existsSync(`${adaptdir}/pronghorn.json`)) {
+    // Read the entity schema from the file system
+    const phFile = path.join(adaptdir, '/pronghorn.json');
+    const prong = require(phFile);
+    infoRes.wfTasks = prong.methods.length;
+  } else {
+    console.log('Missing - pronghorn.json');
+  }
+
+  console.log(JSON.stringify(infoRes));
+  fs.writeFileSync(`${adaptdir}/report/adapterInfo.json`, JSON.stringify(infoRes, null, 2));
+}
+
+adapterInfo();

package/utils/artifactize.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 /* @copyright Itential, LLC 2019 */
 
-const fs = require('fs-extra');
 const path = require('path');
+const fs = require('fs-extra');
 
 async function createBundle(adapterOldDir) {
   // set directories
@@ -15,7 +15,6 @@ async function createBundle(adapterOldDir) {
   const shortenedName = originalName.replace('adapter-', '');
   const artifactName = originalName.replace('adapter', 'bundled-adapter');
 
-
   const adapterNewDir = path.join(artifactDir, 'bundles', 'adapters', originalName);
   fs.ensureDirSync(adapterNewDir);
 
@@ -121,7 +120,7 @@ async function createBundle(adapterOldDir) {
 
   // Run the commands in parallel
   try {
-    await Promise.all(ops.map(async op => op()));
+    await Promise.all(ops.map(async (op) => op()));
   } catch (e) {
     throw new Error(e);
   }
@@ -134,18 +133,14 @@ async function createBundle(adapterOldDir) {
 }
 
 async function artifactize(entryPathToAdapter) {
-  try {
-    const truePath = path.resolve(entryPathToAdapter);
-    const packagePath = path.join(truePath, 'package');
-    // remove adapter from package and move bundle in
-    const pathObj = await createBundle(packagePath);
-    const { bundlePath } = pathObj;
-    fs.removeSync(packagePath);
-    fs.moveSync(bundlePath, packagePath);
-    return 'Bundle successfully created and old folder system removed';
-  } catch (e) {
-    throw e;
-  }
+  const truePath = path.resolve(entryPathToAdapter);
+  const packagePath = path.join(truePath, 'package');
+  // remove adapter from package and move bundle in
+  const pathObj = await createBundle(packagePath);
+  const { bundlePath } = pathObj;
+  fs.removeSync(packagePath);
+  fs.moveSync(bundlePath, packagePath);
+  return 'Bundle successfully created and old folder system removed';
 }
 
 module.exports = { createBundle, artifactize };

package/utils/packModificationScript.js

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
 /* @copyright Itential, LLC 2019 */
 
-const fs = require('fs-extra');
 const path = require('path');
 const { spawnSync } = require('child_process');
-const { createBundle } = require('./artifactize.js');
+const fs = require('fs-extra');
+const { createBundle } = require('./artifactize');
 
 const nodeEntryPath = path.resolve('.');
 createBundle(nodeEntryPath).then((pathObj) => {

package/utils/removeHooks.js

@@ -0,0 +1,20 @@
+const fs = require('fs');
+
+/**
+ * This script will uninstall pre-commit or pre-push hooks in case there's ever a need to
+ * commit/push something that has issues
+ */
+
+const precommitPath = '.git/hooks/pre-commit';
+const prepushPath = '.git/hooks/pre-push';
+fs.unlink(precommitPath, (err) => {
+  if (err && err.code !== 'ENOENT') {
+    console.log(`${err.message}`);
+  }
+});
+
+fs.unlink(prepushPath, (err) => {
+  if (err && err.code !== 'ENOENT') {
+    console.log(`${err.message}`);
+  }
+});