@itentialopensource/adapter-db_mssql 0.3.0 → 1.0.0

package/pronghorn.json

@@ -6,7 +6,7 @@
   "title": "MicrosoftSQL",
   "src": "adapter.js",
   "roles": [
-      "admin"
+    "admin"
   ],
   "methods": [
     {
@@ -18,17 +18,29 @@
           "name": "sql",
           "type": "string",
           "info": "",
-          "required": true
+          "required": true,
+          "schema": {
+            "title": "sql",
+            "type": "string"
+          }
         }
       ],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing status, code and the result"
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
       },
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/query"
+      },
       "task": true
     },
     {
@@ -40,17 +52,29 @@
           "name": "sql",
           "type": "string",
           "info": "",
-          "required": true
+          "required": true,
+          "schema": {
+            "title": "sql",
+            "type": "string"
+          }
         }
       ],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing status, code and the result"
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
       },
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/create"
+      },
       "task": true
     },
     {
@@ -62,17 +86,63 @@
           "name": "sql",
           "type": "string",
           "info": "",
-          "required": true
+          "required": true,
+          "schema": {
+            "title": "sql",
+            "type": "string"
+          }
         }
       ],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing status, code and the result"
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
       },
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/select"
+      },
+      "task": true
+    },
+    {
+      "name": "selectNoRecordSet",
+      "summary": "select item from MicrosoftSQL server",
+      "description": "select item from MicrosoftSQL server",
+      "input": [
+        {
+          "name": "sql",
+          "type": "string",
+          "info": "",
+          "required": true,
+          "schema": {
+            "title": "sql",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/selectNoRecordSet"
+      },
       "task": true
     },
     {
@@ -84,17 +154,29 @@
           "name": "sql",
           "type": "string",
           "info": "",
-          "required": true
+          "required": true,
+          "schema": {
+            "title": "sql",
+            "type": "string"
+          }
         }
       ],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing status, code and the result"
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
       },
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/insert"
+      },
       "task": true
     },
     {
@@ -106,17 +188,29 @@
           "name": "sql",
           "type": "string",
           "info": "",
-          "required": true
+          "required": true,
+          "schema": {
+            "title": "sql",
+            "type": "string"
+          }
         }
       ],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing status, code and the result"
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
       },
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/update"
+      },
       "task": true
     },
     {
@@ -128,17 +222,29 @@
           "name": "sql",
           "type": "string",
           "info": "",
-          "required": true
+          "required": true,
+          "schema": {
+            "title": "sql",
+            "type": "string"
+          }
         }
       ],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing status, code and the result"
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
       },
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/delete"
+      },
       "task": true
     },
     {
@@ -150,18 +256,30 @@
           "name": "sql",
           "type": "string",
           "info": "",
-          "required": true
+          "required": true,
+          "schema": {
+            "title": "sql",
+            "type": "string"
+          }
         }
       ],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing status, code and the result"
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
       },
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/drop"
+      },
       "task": true
     }
   ]
-}
+}

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.4.0",
+  "configLines": 595,
+  "scriptLines": 580,
+  "codeLines": 606,
+  "testLines": 997,
+  "testCases": 48,
+  "totalCodeLines": 2183,
+  "wfTasks": 8
+}

package/sampleProperties.json

@@ -20,5 +20,7 @@
   },
   "brokers": [],
   "groups": [],
-  "requestTimeout": 1000000
-}
+  "requestTimeout": 1000000,
+  "logLevel": "none",
+  "timeout": 60000
+}

package/test/integration/adapterTestIntegration.js

@@ -129,7 +129,7 @@ function runErrorAsserts(data, error, code, origin, displayStr) {
 }
 
 // require the adapter that we are going to be using
-const MicrosoftSQL = require('../../adapter.js');
+const MicrosoftSQL = require('../../adapter');
 
 // begin the testing - these should be pretty well defined between the describe and the it!
 describe('[integration] MicrosoftSQL Adapter Test', () => {
@@ -284,6 +284,28 @@ describe('[integration] MicrosoftSQL Adapter Test', () => {
       }
     });
 
+    describe('#selectNoRecordSet', function () {
+      if (!stub) {
+        it('should select a record', (done) => {
+          try {
+            a.selectNoRecordSet(selectSQL, (data, error) => {
+              try {
+                runCommonAsserts(data, error);
+                assert.equal(200, data.code);
+                done();
+              } catch (ex) {
+                log.error(`Test Failure: ${ex}`);
+                done(ex);
+              }
+            });
+          } catch (exc) {
+            log.error(`Adapter Exception: ${exc}`);
+            done(exc);
+          }
+        });
+      }
+    });
+
     const querySQL = 'SELECT name FROM Dogs;';
     describe('#query', function () {
       if (!stub) {

package/test/unit/adapterTestUnit.js

@@ -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
@@ -122,7 +124,7 @@ function runErrorAsserts(data, error, code, origin, displayStr) {
 }
 
 // require the adapter that we are going to be using
-const MicrosoftSQL = require('../../adapter.js');
+const MicrosoftSQL = require('../../adapter');
 
 // delete the .DS_Store directory in entities -- otherwise this will cause errors
 const dirPath = path.join(__dirname, '../../entities/.DS_Store');
@@ -186,23 +188,33 @@ describe('[unit] MicrosoftSQL 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');
@@ -471,6 +483,30 @@ describe('[unit] MicrosoftSQL Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#selectNoRecordSet - errors', () => {
+      it('should have a selectNoRecordSet function', (done) => {
+        assert.equal(true, typeof a.selectNoRecordSet === 'function');
+        done();
+      });
+      it('should error on selectNoRecordSet - no sql string', (done) => {
+        try {
+          a.selectNoRecordSet(null, (data, error) => {
+            try {
+              const displayE = 'sql is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-db_mssql-adapter-selectNoRecordSet', displayE);
+              done();
+            } catch (ex) {
+              log.error(`Test Failure: ${ex}`);
+              done(ex);
+            }
+          });
+        } catch (exc) {
+          log.error(`Adapter Exception: ${exc}`);
+          done(exc);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#insert - errors', () => {
       it('should have a insert function', (done) => {
         assert.equal(true, typeof a.insert === 'function');

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

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) => {