@itentialopensource/adapter-git 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.2.0 [03-09-2023]
+
+* Add tasks to create and checkout branch
+
+See merge request itentialopensource/adapters/devops-netops/adapter-git!1
+
+---
+
 ## 0.1.1 [03-07-2023]
 
 * Bug fixes and performance improvements
@@ -6,4 +14,3 @@
 See commit caed158
 
 ---
-

package/adapter.js

@@ -252,6 +252,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 +522,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 +549,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 +596,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-git",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Itential adapter to run git commands",
   "main": "adapter.js",
   "wizardVersion": "2.35.0",

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/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

@@ -551,6 +551,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 +606,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 +623,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 +640,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 +657,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);