@itentialopensource/adapter-git 0.1.1 → 0.3.0

package/TROUBLESHOOT.md

@@ -0,0 +1,47 @@
+## Troubleshoot
+
+Run `npm run troubleshoot` to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.
+
+You also have the option to run individual commands to perform specific test:
+
+- `npm run healthcheck` will perform a healthcheck request of with current setting.
+- `npm run basicget` will perform some non-parameter GET request with current setting.
+- `npm run connectivity` will perform networking diagnostics of the adatper endpoint.
+
+### Connectivity Issues
+
+1. You can run the adapter troubleshooting script which will check connectivity, run the healthcheck and run basic get calls.
+
+```bash
+npm run troubleshoot
+```
+
+2. Verify the adapter properties are set up correctly.
+
+```text
+Go into the Itential Platform GUI and verify/update the properties
+```
+
+3. Verify there is connectivity between the Itential Platform Server and Git Server.
+
+```text
+ping the ip address of Git server
+try telnet to the ip address port of Git
+execute a curl command to the other system
+```
+
+4. Verify the credentials provided for Git.
+
+```text
+login to Git using the provided credentials
+```
+
+5. Verify the API of the call utilized for Git Healthcheck.
+
+```text
+Go into the Itential Platform GUI and verify/update the properties
+```
+
+### Functional Issues
+
+Adapter logs are located in `/var/log/pronghorn`. In older releases of the Itential Platform, there is a `pronghorn.log` file which contains logs for all of the Itential Platform. In newer versions, adapters can be configured to log into their own files.

package/adapter.js

@@ -10,6 +10,7 @@
 /* eslint import/no-dynamic-require: warn */
 /* eslint global-require: warn */
 /* eslint no-await-in-loop: warn */
+/* eslint default-param-last: warn */
 
 /* Required libraries.  */
 const fs = require('fs-extra');
@@ -252,6 +253,72 @@ class Git extends EventEmitterCl {
     }
   }
 
+  createBranch(options, callback) {
+    const meth = 'adapter-createBranch';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+    try {
+      // verify the required data has been provided
+      if (options === undefined || options === null || options === '') {
+        const errorObj = formatErrorObject(origin, 'Missing Data', ['options'], null, null, null);
+        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+        return callback(null, errorObj);
+      }
+
+      const copiedOptions = { ...options };
+      copiedOptions.fs = fs;
+      git.branch(copiedOptions)
+        .then(() => callback({
+          status: 'success',
+          code: 200
+        }))
+        .catch((err) => {
+          const errorObj = formatErrorObject(origin, 'Creating new branch failed', null, null, null, err);
+          log.error('error:', err);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        });
+    } catch (ex) {
+      const errorObj = formatErrorObject(origin, 'Caught Exception', null, null, null, ex);
+      log.error(ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  checkoutBranch(options, callback) {
+    const meth = 'adapter-checkoutBranch';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+    try {
+      // verify the required data has been provided
+      if (options === undefined || options === null || options === '') {
+        const errorObj = formatErrorObject(origin, 'Missing Data', ['options'], null, null, null);
+        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+        return callback(null, errorObj);
+      }
+
+      const copiedOptions = { ...options };
+      copiedOptions.fs = fs;
+      git.checkout(copiedOptions)
+        .then(() => callback({
+          status: 'success',
+          code: 200
+        }))
+        .catch((err) => {
+          const errorObj = formatErrorObject(origin, 'Checking out failed', null, null, null, err);
+          log.error('error:', err);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        });
+    } catch (ex) {
+      const errorObj = formatErrorObject(origin, 'Caught Exception', null, null, null, ex);
+      log.error(ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
   removeFile(options, callback) {
     const meth = 'adapter-removeFile';
     const origin = `${this.id}-${meth}`;
@@ -456,7 +523,7 @@ class Git extends EventEmitterCl {
     }
   }
 
-  removeAndPushFile(cloneOptions, removeFileOptions, commitOptions, pushOptions, callback) {
+  removeAndPushFile(cloneOptions, createAndCheckoutNewBranch = false, checkoutExistingBranch = false, branchOptions, checkoutOptions, removeFileOptions, commitOptions, pushOptions, callback) {
     const meth = 'adapter-removeAndPushFile';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
@@ -483,6 +550,24 @@ class Git extends EventEmitterCl {
         log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
         return callback(null, errorObj);
       }
+      if (createAndCheckoutNewBranch) {
+        if (branchOptions === undefined || branchOptions === null || branchOptions === '') {
+          const errorObj = formatErrorObject(origin, 'Missing Data', ['branch options'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+        if (checkoutOptions === undefined || checkoutOptions === null || checkoutOptions === '') {
+          const errorObj = formatErrorObject(origin, 'Missing Data', ['checkout options'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+      } else if (!createAndCheckoutNewBranch && checkoutExistingBranch) {
+        if (checkoutOptions === undefined || checkoutOptions === null || checkoutOptions === '') {
+          const errorObj = formatErrorObject(origin, 'Missing Data', ['checkout options'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+      }
 
       const copiedCloneOptions = { ...cloneOptions };
       copiedCloneOptions.fs = fs;
@@ -512,6 +597,32 @@ class Git extends EventEmitterCl {
             task: 'clone',
             result: 'success'
           });
+          if (createAndCheckoutNewBranch) {
+            const copiedBranchOptions = { ...branchOptions };
+            const copiedCheckoutOptions = { ...checkoutOptions };
+            copiedBranchOptions.fs = fs;
+            copiedCheckoutOptions.fs = fs;
+            return git.branch(copiedBranchOptions)
+              .then(() => git.checkout(copiedCheckoutOptions));
+          }
+          if (checkoutExistingBranch) {
+            const copiedCheckoutOptions = { ...checkoutOptions };
+            copiedCheckoutOptions.fs = fs;
+            return git.checkout(copiedCheckoutOptions);
+          }
+        })
+        .then(() => {
+          if (createAndCheckoutNewBranch) {
+            successfulResult.results.push({
+              task: 'create and checkout new branch',
+              result: 'success'
+            });
+          } else if (!createAndCheckoutNewBranch && checkoutExistingBranch) {
+            successfulResult.results.push({
+              task: 'checkout existing branch',
+              result: 'success'
+            });
+          }
           if (Array.isArray(removeFileOptions.filepath)) {
             return Promise.all(
               removeFileOptions.filepath.map((file) => {

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,47 @@
+{
+    "name": "adapter-git",
+    "webName": "Adapter for Integration to Git",
+    "vendor": "Git",
+    "product": "Git",
+    "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-git",
+        "repoLink": "https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-git.git",
+        "docLink": "https://docs.itential.com/opensource/docs/git",
+        "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/git/",
+        "vendorLink": "",
+        "productLink": "",
+        "apiLinks": []
+    },
+    "assets": [],
+    "relatedItems": {
+        "adapters": [],
+        "integrations": [],
+        "ecosystemApplications": [],
+        "workflowProjects": [],
+        "transformationProjects": [],
+        "exampleProjects": []
+    }
+}

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@itentialopensource/adapter-git",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Itential adapter to run git commands",
   "main": "adapter.js",
-  "wizardVersion": "2.35.0",
-  "engineVersion": "1.40.2",
+  "wizardVersion": "2.44.7",
+  "engineVersion": "1.67.14",
+  "adapterType": "library",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
     "preinstall": "node utils/setup.js && npm install --package-lock-only --ignore-scripts && npx npm-force-resolutions",
-    "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",
@@ -41,30 +43,26 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-git#readme",
   "dependencies": {
-    "ajv": "^6.12.0",
+    "ajv": "^8.12.0",
     "isomorphic-git": "^1.21.0",
     "avsc": "^5.4.21",
-    "fs-extra": "^8.1.0",
+    "fs-extra": "^11.1.1",
     "json-query": "^2.2.2",
-    "package-json-validator": "^0.6.3",
     "patch-package": "^6.4.7",
     "readline-sync": "^1.4.10",
     "request": "^2.88.2",
     "uuid": "^3.0.1"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "eslint": "^7.2.0",
-    "eslint-config-airbnb-base": "^14.2.0",
-    "eslint-plugin-import": "^2.21.2",
-    "eslint-plugin-json": "^2.1.1",
+    "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.0.1",
     "nyc": "^15.1.0",
-    "testdouble": "^3.16.1",
+    "testdouble": "^3.18.0",
     "winston": "^3.3.3"
   },
-  "resolutions": {
-    "minimist": "^1.2.5"
-  },
   "private": false
 }

package/pronghorn.json

@@ -191,10 +191,62 @@
       ],
       "task": true
     },
+    {
+      "name": "createBranch",
+      "summary": "Create a branch",
+      "description": "Create a branch",
+      "input": [
+        {
+          "name": "options",
+          "type": "object",
+          "info": "options to create a branch",
+          "required": true
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result"
+      },
+      "route": {
+        "verb": "POST",
+        "path": "/createBranch"
+      },
+      "roles": [
+        "admin"
+      ],
+      "task": true
+    },
+    {
+      "name": "checkoutBranch",
+      "summary": "Checkout a branch",
+      "description": "Checkout a branch",
+      "input": [
+        {
+          "name": "options",
+          "type": "object",
+          "info": "options to checkout a branch",
+          "required": true
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result"
+      },
+      "route": {
+        "verb": "POST",
+        "path": "/checkoutBranch"
+      },
+      "roles": [
+        "admin"
+      ],
+      "task": true
+    },
     {
       "name": "removeAndPushFile",
-      "summary": "Clone the repo, remove a file, commit then push",
-      "description": "Clone the repo, remove a file, commit then push",
+      "summary": "Clone the repo, checkout branch, remove a file, commit then push",
+      "description": "Clone the repo, checkout branch, remove a file, commit then push",
       "input": [
         {
           "name": "cloneOptions",
@@ -202,6 +254,30 @@
           "info": "options to clone a repo",
           "required": true
         },
+        {
+          "name": "createAndCheckoutNewBranch",
+          "type": "boolean",
+          "info": "whether to create and checkout a new branch",
+          "required": false
+        },
+        {
+          "name": "checkoutExistingBranch",
+          "type": "boolean",
+          "info": "whether to checkout an existing branch",
+          "required": false
+        },
+        {
+          "name": "branchOptions",
+          "type": "object",
+          "info": "options to create a new branch",
+          "required": false
+        },
+        {
+          "name": "checkoutOptions",
+          "type": "object",
+          "info": "options to checkout a branch",
+          "required": false
+        },
         {
           "name": "removeFileOptions",
           "type": "object",

package/propertiesDecorators.json

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

package/test/integration/adapterTestIntegration.js

@@ -182,6 +182,58 @@ describe('[integration] Git Adapter Test', () => {
       }
     });
 
+    const branchOptions = {
+      dir: '../../test',
+      ref: 'patch/test'
+    };
+    describe('#createBranch', () => {
+      if (!stub) {
+        it('should create a new branch', (done) => {
+          try {
+            a.createBranch(branchOptions, (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);
+          }
+        }).timeout(attemptTimeout);
+      }
+    });
+
+    const checkoutOptions = {
+      dir: '../../test',
+      ref: 'patch/test'
+    };
+    describe('#checkoutBranch', () => {
+      if (!stub) {
+        it('should checkout a branch', (done) => {
+          try {
+            a.checkoutBranch(checkoutOptions, (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);
+          }
+        }).timeout(attemptTimeout);
+      }
+    });
+
     const removeOptions = {
       dir: '../../test',
       filepath: 'README.md'

package/test/unit/adapterTestUnit.js

@@ -16,6 +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();
 
@@ -134,7 +137,7 @@ describe('[unit] Git Adapter Test', () => {
 
       mocha.afterEach(function x() {
         state.passed = state.passed
-        && (this.currentTest.state === 'passed');
+          && (this.currentTest.state === 'passed');
       });
       mocha.beforeEach(function x() {
         if (!state.passed) {
@@ -171,23 +174,33 @@ describe('[unit] Git 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');
@@ -244,10 +257,10 @@ describe('[unit] Git Adapter Test', () => {
 
               // if there are inputs defined but not on the method line
               if (wfparams.length === 0 && (pronghornDotJson.methods[m].input
-                  && pronghornDotJson.methods[m].input.length > 0)) {
+                && pronghornDotJson.methods[m].input.length > 0)) {
                 paramissue = true;
               } else if (wfparams.length > 0 && (!pronghornDotJson.methods[m].input
-                  || pronghornDotJson.methods[m].input.length === 0)) {
+                || pronghornDotJson.methods[m].input.length === 0)) {
                 // if there are no inputs defined but there are on the method line
                 paramissue = true;
               } else {
@@ -551,6 +564,54 @@ describe('[unit] Git Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#createBranch - errors', () => {
+      it('should have a createBranch function', (done) => {
+        assert.equal(true, typeof a.createBranch === 'function');
+        done();
+      });
+      it('should error on createBranch - no options', (done) => {
+        try {
+          a.createBranch(null, (data, error) => {
+            try {
+              const displayE = 'options is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-Git-adapter-createBranch', displayE);
+              done();
+            } catch (ex) {
+              log.error(`Test Failure: ${ex}`);
+              done(ex);
+            }
+          });
+        } catch (exc) {
+          log.error(`Adapter Exception: ${exc}`);
+          done(exc);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#checkoutBranch - errors', () => {
+      it('should have a checkoutBranch function', (done) => {
+        assert.equal(true, typeof a.checkoutBranch === 'function');
+        done();
+      });
+      it('should error on checkoutBranch - no options', (done) => {
+        try {
+          a.checkoutBranch(null, (data, error) => {
+            try {
+              const displayE = 'options is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-Git-adapter-checkoutBranch', displayE);
+              done();
+            } catch (ex) {
+              log.error(`Test Failure: ${ex}`);
+              done(ex);
+            }
+          });
+        } catch (exc) {
+          log.error(`Adapter Exception: ${exc}`);
+          done(exc);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#removeAndPushFile - errors', () => {
       it('should have a removeAndPushFile function', (done) => {
         assert.equal(true, typeof a.removeAndPushFile === 'function');
@@ -558,7 +619,7 @@ describe('[unit] Git Adapter Test', () => {
       });
       it('should error on removeAndPushFile - no cloneOptions', (done) => {
         try {
-          a.removeAndPushFile(null, null, null, null, (data, error) => {
+          a.removeAndPushFile(null, null, null, null, null, null, null, null, (data, error) => {
             try {
               const displayE = 'clone options is required';
               runErrorAsserts(data, error, 'AD.300', 'Test-Git-adapter-removeAndPushFile', displayE);
@@ -575,7 +636,7 @@ describe('[unit] Git Adapter Test', () => {
       }).timeout(attemptTimeout);
       it('should error on removeAndPushFile - no removeFileOptions', (done) => {
         try {
-          a.removeAndPushFile({}, null, null, null, (data, error) => {
+          a.removeAndPushFile({}, null, null, null, null, null, null, null, (data, error) => {
             try {
               const displayE = 'remove file options is required';
               runErrorAsserts(data, error, 'AD.300', 'Test-Git-adapter-removeAndPushFile', displayE);
@@ -592,7 +653,7 @@ describe('[unit] Git Adapter Test', () => {
       }).timeout(attemptTimeout);
       it('should error on removeAndPushFile - no commitOptions', (done) => {
         try {
-          a.removeAndPushFile({}, {}, null, null, (data, error) => {
+          a.removeAndPushFile({}, null, null, null, null, {}, null, null, (data, error) => {
             try {
               const displayE = 'commit options is required';
               runErrorAsserts(data, error, 'AD.300', 'Test-Git-adapter-removeAndPushFile', displayE);
@@ -609,7 +670,7 @@ describe('[unit] Git Adapter Test', () => {
       }).timeout(attemptTimeout);
       it('should error on removeAndPushFile - no pushOptions', (done) => {
         try {
-          a.removeAndPushFile({}, {}, {}, null, (data, error) => {
+          a.removeAndPushFile({}, null, null, null, null, {}, {}, null, (data, error) => {
             try {
               const displayE = 'push options is required';
               runErrorAsserts(data, error, 'AD.300', 'Test-Git-adapter-removeAndPushFile', displayE);