@itentialopensource/adapter-gitlab 0.8.1 → 0.9.0

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.9.0 [05-30-2023]
+
+* Minor/adapt 2433
+
+See merge request itentialopensource/adapters/devops-netops/adapter-gitlab!16
+
+---
+
 ## 0.8.1 [02-02-2023]
 
 * Added option to task and updated adapter-utils version to fix security issues

package/adapter.js

@@ -14161,7 +14161,21 @@ class Gitlab extends AdapterBaseCl {
    */
   /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
   getV4ProjectsIdRepositoryTree(id, ref, pathParam, recursive, perPage, callback) {
-    const meth = 'adapter-getV4ProjectsIdRepositoryTree';
+    const queryData = { ref, pathParam, recursive, perPage };
+    this.getV4ProjectsIdRepositoryTreeWithOptions(id, queryData, callback);
+  }
+
+  /**
+   * @summary Get a project repository tree
+   *
+   * @function getV4ProjectsIdRepositoryTree
+   * @param {string} id - The ID of a project
+   * @param {object} queryData - object of query data - id, ref, pathParam, recursive, perPage, page
+   * @param {getCallback} callback - a callback function to return the result
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getV4ProjectsIdRepositoryTreeWithOptions(id, queryData, callback) {
+    const meth = 'adapter-getV4ProjectsIdRepositoryTreeWithOptions';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
@@ -14179,7 +14193,7 @@ class Gitlab extends AdapterBaseCl {
     }
 
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
-    const queryParamsAvailable = { ref, pathParam, recursive, per_page: perPage };
+    const queryParamsAvailable = queryData;
     const queryParams = {};
     const pathVars = [id];
     const bodyVars = {};

package/entities/application/mockdatafiles/getV4ApplicationSettings-default.json

@@ -28,4 +28,5 @@
   "signup_enabled": "string",
   "updated_at": "string",
   "user_oauth_applications": "string"
-}
+}
+  

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-gitlab",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "This adapter integrates with system described as: gitlab.",
   "main": "adapter.js",
   "systemName": "GitLab",

package/pronghorn.json

@@ -9056,6 +9056,50 @@
       },
       "task": true
     },
+    {
+      "name": "getV4ProjectsIdRepositoryTreeWithOptions",
+      "summary": "Get a project repository tree",
+      "description": "Get a project repository tree",
+      "input": [
+        {
+          "name": "id",
+          "type": "string",
+          "info": "The ID of a project",
+          "required": true,
+          "schema": {
+            "title": "id",
+            "type": "string"
+          }
+        },
+        {
+          "name": "queryData",
+          "type": "object",
+          "info": "Contains properties: id, ref, pathParam, recursive, perPage, page",
+          "required": false,
+          "schema": {
+            "title": "queryData",
+            "type": "object"
+          }
+        }
+      ],
+      "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": "/getV4ProjectsIdRepositoryTree"
+      },
+      "task": true
+    },
     {
       "name": "getV4ProjectsIdRunners",
       "summary": "Get runners available for project",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.7.4",
-  "configLines": 27766,
+  "version": "0.8.0",
+  "configLines": 27810,
   "scriptLines": 1707,
-  "codeLines": 45517,
-  "testLines": 41863,
-  "testCases": 2219,
-  "totalCodeLines": 89087,
-  "wfTasks": 560
+  "codeLines": 45531,
+  "testLines": 41927,
+  "testCases": 2222,
+  "totalCodeLines": 89165,
+  "wfTasks": 561
 }

package/test/integration/adapterTestIntegration.js

@@ -6412,6 +6412,39 @@ describe('[integration] GitLab Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#getV4ProjectsIdRepositoryTreeWithOptions - errors', () => {
+      it('should work if integrated or standalone with mockdata', (done) => {
+        try {
+          a.getV4ProjectsIdRepositoryTreeWithOptions(projectId, {}, (data, error) => {
+            try {
+              runCommonAsserts(data, error);
+
+              if (stub) {
+                assert.equal('string', data.response.id);
+                assert.equal('string', data.response.mode);
+                assert.equal('string', data.response.name);
+                assert.equal('string', data.response.pathParam);
+                assert.equal('string', data.response.type);
+                projectFileName = data.response.name;
+              } else {
+                runCommonAsserts(data, error);
+                projectFileName = data.response[0].name;
+              }
+
+              saveMockData('Projects', 'getV4ProjectsIdRepositoryTree', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#getV4ProjectsIdRunners - errors', () => {
       it('should work if integrated or standalone with mockdata', (done) => {
         try {

package/test/unit/adapterTestUnit.js

@@ -8524,7 +8524,37 @@ describe('[unit] GitLab Adapter Test', () => {
           a.getV4ProjectsIdRepositoryTree(null, null, null, null, null, (data, error) => {
             try {
               const displayE = 'id is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-gitlab-adapter-getV4ProjectsIdRepositoryTree', displayE);
+              runErrorAsserts(data, error, 'AD.300', 'Test-gitlab-adapter-getV4ProjectsIdRepositoryTreeWithOptions', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    const fakeData = {};
+    describe('#getV4ProjectsIdRepositoryTreeWithOptions - errors', () => {
+      it('should have a getV4ProjectsIdRepositoryTreeWithOptions function', (done) => {
+        try {
+          assert.equal(true, typeof a.getV4ProjectsIdRepositoryTreeWithOptions === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing id', (done) => {
+        try {
+          a.getV4ProjectsIdRepositoryTreeWithOptions(null, fakeData, (data, error) => {
+            try {
+              const displayE = 'id is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-gitlab-adapter-getV4ProjectsIdRepositoryTreeWithOptions', displayE);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);