@itentialopensource/adapter-mockdevice 2.0.0 → 2.1.0

package/AUTH.md

@@ -0,0 +1,10 @@
+## Authenticating Mock Device Adapter 
+
+This document will go through the steps for authenticating the Mock Device adapter with. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. 
+
+### Authentication
+
+### Troubleshooting
+- Make sure you copied over the correct username and password.
+- Turn on debug level logs for the adapter in IAP Admin Essentials.
+- Investigate the logs

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 2.1.0 [01-08-2024]
+
+* 2023 migration changes
+
+See merge request itentialopensource/adapters/adapter-mockdevice!15
+
+---
+
+## 2.0.1 [08-11-2023]
+
+* Add response code to getConfig
+
+See merge request itentialopensource/adapters/adapter-mockdevice!13
+
+---
+
 ## 2.0.0 [06-01-2023]
 
 * Major/adapt 2666

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,43 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@itential.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the <a href="http://contributor-covenant.org" target="_blank">Contributor Covenant</a>, version 1.4, available at <a href="http://contributor-covenant.org/version/1/4/" target="_blank">version</a>

package/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+First off, thanks for taking the time to contribute!
+
+The following is a set of rules for contributing.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@itential.com.
+
+## How to Contribute
+
+Follow the contributing guide (here)[https://gitlab.com/itentialopensource/adapters/contributing-guide]

package/ENHANCE.md

@@ -0,0 +1,69 @@
+## Enhancements
+
+### Adding a Second Instance of an Adapter
+
+You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.
+
+### Adding Adapter Calls
+
+There are multiple ways to add calls to an existing adapter.
+
+The easiest way would be to use the Adapter Builder update process. This process takes in a Swagger or OpenAPI document, allows you to select the calls you want to add and then generates a zip file that can be used to update the adapter. Once you have the zip file simply put it in the adapter directory and execute `npm run adapter:update`.
+
+```bash
+mv updatePackage.zip adapter-mockdevice
+cd adapter-mockdevice
+npm run adapter:update
+```
+
+If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.
+
+If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.
+
+```text
+Files to update
+* entities/<entity>/action.json: add an action
+* entities/<entity>/schema.json (or the schema defined on the action): add action to the enum for ph_request_type
+* adapter.js: add the new method and make sure it calls the proper entity and action
+* pronghorn.json: add the new method
+* test/unit/adapterTestUnit.js (optional but best practice): add unit test(s) - function is there, any required parameters error when not passed in
+* test/integration/adapterTestIntegration.js (optional but best practice): add integration test
+```
+
+### Adding Adapter Properties
+
+While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
+
+```text
+Files to update
+* propertiesSchema.json: add the new property and how it is defined
+* sampleProperties: add the new property with a default value
+* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
+* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
+```
+
+### Changing Adapter Authentication
+
+Often an adapter is built before knowing the authentication and authentication processes can also change over time. The adapter supports many different kinds of authentication but it does require configuration. Some forms of authentication can be defined entirely with the adapter properties but others require configuration.
+
+```text
+Files to update
+* entities/.system/action.json: change the getToken action as needed
+* entities/.system/schemaTokenReq.json: add input parameters (external name is name in other system)
+* entities/.system/schemaTokenResp.json: add response parameters (external name is name in other system)
+* propertiesSchema.json: add any new property and how it is defined
+* sampleProperties: add any new property with a default value
+* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
+* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
+```
+
+### Enhancing Adapter Integration Tests
+
+The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.
+
+```text
+Files to update
+* test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.
+```
+
+As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.

package/adapter.js

@@ -1,5 +1,7 @@
 // Set globals
 /* global database pronghornProps log eventSystem */
+/* eslint default-param-last: warn */
+
 const path = require('path');
 const fs = require('fs');
 const { unzip } = require('zlib');
@@ -318,6 +320,7 @@ class MockDevice {
           });
         }
         return callback({
+          code: 200,
           device: deviceId,
           config: result.config
         });

package/changelogs/CHANGELOG.md

@@ -0,0 +1,15 @@
+## 2.0.1 [08-11-2023]
+
+* Add response code to getConfig
+
+See merge request itentialopensource/adapters/adapter-mockdevice!13
+
+---
+
+## 2.0.0 [06-01-2023]
+
+* Major/adapt 2666
+
+See merge request itentialopensource/adapters/staging/adapter-mockdevice!12
+
+---

package/error.json

@@ -0,0 +1,190 @@
+{
+    "errors": [
+      {
+        "key": "Unable To Save To Database",
+        "icode": "AD.100",
+        "displayString": "Error on saving to Database $VARIABLE$",
+        "recommendation": "Verify the database connectivity and credentials"
+      },
+      {
+        "key": "Database Error",
+        "icode": "AD.101",
+        "displayString": "Database Error: $VARIABLE$",
+        "recommendation": "Verify the database connectivity, schema and permissions"
+      },
+      {
+        "key": "Database Credentials",
+        "icode": "AD.102",
+        "displayString": "Database Error: Invalid Credentials",
+        "recommendation": "Verify the database credentials"
+      },
+      {
+        "key": "No Queue Item",
+        "icode": "AD.110",
+        "displayString": "Queue Item $VARIABLE$ not found in queue",
+        "recommendation": "Make sure the queue is working properly"
+      },
+      {
+        "key": "Unable To Create Queue",
+        "icode": "AD.111",
+        "displayString": "Unable to create queue: $VARIABLE$",
+        "recommendation": "Verify access to the database, redis or system memory"
+      },
+      {
+        "key": "Queue Full",
+        "icode": "AD.112",
+        "displayString": "Request $VARIABLE$ Transaction $VARIABLE$ rejected - queue full at $VARIABLE$",
+        "recommendation": "Make sure the queue is working properly"
+      },
+      {
+        "key": "Unable To Clear Queue",
+        "icode": "AD.113",
+        "displayString": "Unable to clear queue: $VARIABLE$",
+        "recommendation": "Make sure the queue exists"
+      },
+      {
+        "key": "Unable To Claim Turn",
+        "icode": "AD.114",
+        "displayString": "Request $VARIABLE$ Transaction $VARIABLE$ unable to claim license: $VARIABLE$",
+        "recommendation": "Make sure the queue is working properly"
+      },
+      {
+        "key": "Unable To Free Turn",
+        "icode": "AD.115",
+        "displayString": "Request $VARIABLE$ Transaction $VARIABLE$ unable to free license: $VARIABLE$",
+        "recommendation": "Make sure the queue is working properly"
+      },
+      {
+        "key": "Item In Wrong State",
+        "icode": "AD.116",
+        "displayString": "Queue item is in the wrong state: $VARIABLE$ ",
+        "recommendation": "Make sure the queue is working properly"
+      },
+      {
+        "key": "Missing Data",
+        "icode": "AD.300",
+        "displayString": "$VARIABLE$ is required",
+        "recommendation": "Please provide the required data"
+      },
+      {
+        "key": "Missing File",
+        "icode": "AD.301",
+        "displayString": "Can not open file $VARIABLE$",
+        "recommendation": "Verify the file exists and has proper permissions"
+      },
+      {
+        "key": "Invalid Action File",
+        "icode": "AD.302",
+        "displayString": "Invalid action file: $VARIABLE$ in $VARIABLE$",
+        "recommendation": "Verify the action file"
+      },
+      {
+        "key": "Unsupported Protocol",
+        "icode": "AD.303",
+        "displayString": "Protocol $VARIABLE$ not currently supported",
+        "recommendation": "Verify the protocol on the action"
+      },
+      {
+        "key": "Invalid Schema File",
+        "icode": "AD.304",
+        "displayString": "Invalid schema file: $VARIABLE$ in $VARIABLE$",
+        "recommendation": "Verify the action file"
+      },
+      {
+        "key": "Invalid Properties",
+        "icode": "AD.305",
+        "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",
+        "displayString": "Query Not Translated",
+        "recommendation": "Verify the information passed in the query object"
+      },
+      {
+        "key": "Payload Not Translated",
+        "icode": "AD.311",
+        "displayString": "Payload Not Translated",
+        "recommendation": "Verify the information passed in the payload object"
+      },
+      {
+        "key": "Schema Validation Failure",
+        "icode": "AD.312",
+        "displayString": "Schema validation failed on $VARIABLE$",
+        "recommendation": "Verify the information provided is in the correct format with everything required"
+      },
+      {
+        "key": "Entity Cache Not Loading",
+        "icode": "AD.320",
+        "displayString": "Could not load entity: $VARIABLE$, into cache",
+        "recommendation": "Verify the cache is working properly"
+      },
+      {
+        "key": "Error Verifying Entity Cache",
+        "icode": "AD.321",
+        "displayString": "Could not verify entity in cache",
+        "recommendation": "Verify the cache is working properly"
+      },
+      {
+        "key": "Unable To Authenticate",
+        "icode": "AD.400",
+        "displayString": "Unable to authenticate with $VARIABLE$, response $VARIABLE$",
+        "recommendation": "Verify the user credentials and check the response for more information"
+      },
+      {
+        "key": "Unable To Encode",
+        "icode": "AD.401",
+        "displayString": "Can not perform base64 encoding on $VARIABLE$",
+        "recommendation": "Check the authentication format"
+      },
+      {
+        "key": "Unable To Get Token",
+        "icode": "AD.402",
+        "displayString": "Unable to get token for user: $VARIABLE$",
+        "recommendation": "Verify the user credentials and the system information"
+      },
+      {
+        "key": "Error On Request",
+        "icode": "AD.500",
+        "displayString": "Error $VARIABLE$ received on request",
+        "recommendation": "Verify the request is accurate via debug logs and postman"
+      },
+      {
+        "key": "Request Timeout",
+        "icode": "AD.501",
+        "displayString": "The Adapter has run out of time for the request",
+        "recommendation": "Increase your adapter request.attempt_timeout property"
+      },
+      {
+        "key": "Invalid Response",
+        "icode": "AD.502",
+        "displayString": "Invalid response received for $VARIABLE$",
+        "recommendation": "Verify the request is accurate via debug logs and postman"
+      },
+      {
+        "key": "Failure Response",
+        "icode": "AD.503",
+        "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",
+        "displayString": "Caught Exception $VARIABLE$",
+        "recommendation": "Evaluate why the exception took place"
+      }
+    ]
+  }

package/metadata.json

@@ -0,0 +1,47 @@
+{
+    "name": "adapter-mockdevice",
+    "webName": "Adapter for Integration to Mockdevice",
+    "vendor": "Mockdevice",
+    "product": "Mockdevice",
+    "osVersion": [],
+    "apiVersions": [],
+    "iapVersions": [
+        "2021.1.x",
+        "2021.2.x",
+        "2022.1.x",
+        "2023.1.x"
+    ],
+    "method": "Library",
+    "type": "Adapter",
+    "domains": [],
+    "tags": [],
+    "useCases": [],
+    "deprecated": {
+        "isDeprecated": false
+    },
+    "brokerSince": "",
+    "documentation": {
+        "storeLink": "",
+        "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-mockdevice",
+        "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-mockdevice",
+        "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": "",
+        "vendorLink": "",
+        "productLink": "",
+        "apiLinks": []
+    },
+    "assets": [],
+    "relatedItems": {
+        "adapters": [],
+        "integrations": [],
+        "ecosystemApplications": [],
+        "workflowProjects": [],
+        "transformationProjects": [],
+        "exampleProjects": []
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-mockdevice",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "mock implementation of device broker",
   "license": "Apache-2.0",
   "repository": {
@@ -16,7 +16,7 @@
   },
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
-    "preinstall": "node utils/setup.js && npm install --package-lock-only --ignore-scripts && npx npm-force-resolutions",
+    "preinstall": "node utils/setup.js",
     "deinstall": "node utils/removeHooks.js",
     "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
     "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
@@ -38,22 +38,22 @@
     "Pre-Release"
   ],
   "dependencies": {
-    "ajv": "^8.6.3",
+    "ajv": "^8.12.0",
     "axios": "^0.21.0",
     "esprima": "^4.0.1",
-    "fs-extra": "^8.1.0",
-    "package-json-validator": "^0.6.3",
+    "fs-extra": "^11.1.1",
     "readline-sync": "^1.4.10",
-    "semver": "^7.3.2"
+    "semver": "^7.5.4"
   },
   "devDependencies": {
-    "chai": "^4.3.4",
-    "eslint": "^7.23.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",
     "eslint-config-airbnb": "^18.2.1",
     "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-jsdoc": "^32.3.0",
-    "eslint-plugin-json": "^2.1.2",
     "eslint-plugin-mocha": "^8.1.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.3.1",
@@ -69,7 +69,7 @@
     "prettier-plugin-package": "^1.3.0",
     "pretty-quick": "^3.1.0",
     "shellcheck": "^1.0.0",
-    "testdouble": "^3.16.1",
+    "testdouble": "^3.18.0",
     "winston": "^3.3.3"
   },
   "lint-staged": {

package/propertiesDecorators.json

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

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,9 +1,9 @@
 #!/usr/bin/env node
 /* @copyright Itential, LLC 2019 */
 
-const fs = require('fs-extra');
 const path = require('path');
 const { spawnSync } = require('child_process');
+const fs = require('fs-extra');
 const { createBundle } = require('./artifactize');
 
 const nodeEntryPath = path.resolve('.');

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}`);
+  }
+});

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);