@itentialopensource/adapter-gitlab 0.8.0 → 0.8.1

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.8.1 [02-02-2023]
+
+* Added option to task and updated adapter-utils version to fix security issues
+
+See merge request itentialopensource/adapters/devops-netops/adapter-gitlab!15
+
+---
+
 ## 0.8.0 [05-19-2022]
 
 * Migration to the latest Adapter Foundation

package/adapter.js

@@ -2339,23 +2339,16 @@ class Gitlab extends AdapterBaseCl {
   }
 
   /**
-   * @summary Get a list of projects in this group.
+   * @summary Get a list of projects in this group with options.
    *
-   * @function getV4GroupsIdProjects
+   * @function getV4GroupsIdProjectsWitOptions
    * @param {string} id - The ID of a group
-   * @param {boolean} archived - Limit by archived status
-   * @param {string} visibility - Limit by visibility
-   * @param {string} search - Return list of authorized projects matching the search criteria
-   * @param {string} orderBy - Return projects ordered by field
-   * @param {string} sort - Return projects sorted in ascending and descending order
-   * @param {boolean} simple - Return only the ID, URL, name, and path of each project
-   * @param {number} page - Current page number
-   * @param {number} perPage - Number of items per page
+   * @param {object} queryData - query options object (e.g. sortBy, includeSubgroups)
    * @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 */
-  getV4GroupsIdProjects(id, archived, visibility = 'public', search, orderBy = 'id', sort = 'asc', simple, page, perPage, callback) {
-    const meth = 'adapter-getV4GroupsIdProjects';
+  getV4GroupsIdProjectsWithOptions(id, queryData, callback) {
+    const meth = 'adapter-getV4GroupsIdProjectsWithOptions';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
@@ -2373,7 +2366,7 @@ class Gitlab extends AdapterBaseCl {
     }
 
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
-    const queryParamsAvailable = { archived, visibility, search, orderBy, sort, simple, page, perPage };
+    const queryParamsAvailable = queryData;
     const queryParams = {};
     const pathVars = [id];
     const bodyVars = {};
@@ -2420,6 +2413,27 @@ class Gitlab extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @summary Get a list of projects in this group.
+   *
+   * @function getV4GroupsIdProjects
+   * @param {string} id - The ID of a group
+   * @param {boolean} archived - Limit by archived status
+   * @param {string} visibility - Limit by visibility
+   * @param {string} search - Return list of authorized projects matching the search criteria
+   * @param {string} orderBy - Return projects ordered by field
+   * @param {string} sort - Return projects sorted in ascending and descending order
+   * @param {boolean} simple - Return only the ID, URL, name, and path of each project
+   * @param {number} page - Current page number
+   * @param {number} perPage - Number of items per 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 */
+  getV4GroupsIdProjects(id, archived, visibility = 'public', search, orderBy = 'id', sort = 'asc', simple, page, perPage, callback) {
+    const queryData = { archived, visibility, search, orderBy, sort, simple, page, perPage };
+    this.getV4GroupsIdProjectsWithOptions(id, queryData, callback);
+  }
+
   /**
    * @summary Transfer a project to the group namespace. Available only for admin.
    *

package/entities/groups/action.json

@@ -357,6 +357,27 @@
         }
       ]
     },
+    {
+      "name": "getV4GroupsIdProjectsWithOptions",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/groups/{pathv1}/projects?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
     {
       "name": "getV4GroupsIdProjects",
       "protocol": "REST",

package/entities/groups/schema.json

@@ -27,6 +27,7 @@
         "deleteV4GroupsIdMembersUserId",
         "getV4GroupsIdNotificationSettings",
         "putV4GroupsIdNotificationSettings",
+        "getV4GroupsIdProjectsWithOptions",
         "getV4GroupsIdProjects",
         "postV4GroupsIdProjectsProjectId",
         "getV4GroupsIdCustomAttributes",
@@ -299,6 +300,16 @@
         "key": ""
       },
       "external_name": "note_id"
+    },
+    "includeSubgroups": {
+      "description": "Include projects in subgroups of this group",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "include_subgroups"
     }
   },
   "definitions": {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-gitlab",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "This adapter integrates with system described as: gitlab.",
   "main": "adapter.js",
   "systemName": "GitLab",
@@ -54,7 +54,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-gitlab#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^4.45.5",
+    "@itentialopensource/adapter-utils": "^4.48.6",
     "ajv": "^6.12.0",
     "axios": "^0.21.0",
     "commander": "^2.20.0",

package/pronghorn.json

@@ -1609,6 +1609,50 @@
       },
       "task": true
     },
+    {
+      "name": "getV4GroupsIdProjectsWithOptions",
+      "summary": "Get a list of projects in this group.",
+      "description": "Get a list of projects in this group.",
+      "input": [
+        {
+          "name": "id",
+          "type": "string",
+          "info": "The ID of a group",
+          "required": true,
+          "schema": {
+            "title": "id",
+            "type": "string"
+          }
+        },
+        {
+          "name": "queryData",
+          "type": "object",
+          "info": "query options object (e.g. sortBy, includeSubgroups)",
+          "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": "/getV4GroupsIdProjectsWithOptions"
+      },
+      "task": true
+    },
     {
       "name": "getV4GroupsIdProjects",
       "summary": "Get a list of projects in this group.",

package/test/integration/adapterTestIntegration.js

@@ -1035,6 +1035,71 @@ describe('[integration] GitLab Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#getV4GroupsIdProjectsWithOptions - errors', () => {
+      it('should work if integrated or standalone with mockdata', (done) => {
+        try {
+          a.getV4GroupsIdProjectsWithOptions(groupId, {}, (data, error) => {
+            try {
+              runCommonAsserts(data, error);
+
+              if (stub) {
+                assert.equal('string', data.response.archived);
+                assert.equal('string', data.response.avatar_url);
+                assert.equal('string', data.response.builds_enabled);
+                assert.equal('string', data.response.container_registry_enabled);
+                assert.equal('string', data.response.created_at);
+                assert.equal('string', data.response.creator_id);
+                assert.equal('string', data.response.default_branch);
+                assert.equal('string', data.response.description);
+                assert.equal('object', typeof data.response.forked_from_project);
+                assert.equal('string', data.response.forks_count);
+                assert.equal('string', data.response.http_url_to_repo);
+                assert.equal('string', data.response.id);
+                assert.equal('string', data.response.issues_enabled);
+                assert.equal('string', data.response.last_activity_at);
+                assert.equal('string', data.response.lfs_enabled);
+                assert.equal('string', data.response.merge_requests_enabled);
+                assert.equal('string', data.response.name);
+                assert.equal('string', data.response.name_with_namespace);
+                assert.equal('object', typeof data.response.namespace);
+                assert.equal('string', data.response.only_allow_merge_if_all_discussions_are_resolved);
+                assert.equal('string', data.response.only_allow_merge_if_build_succeeds);
+                assert.equal('string', data.response.open_issues_count);
+                assert.equal('object', typeof data.response.owner);
+                assert.equal('string', data.response.path);
+                assert.equal('string', data.response.path_with_namespace);
+                assert.equal('string', data.response.public);
+                assert.equal('string', data.response.public_builds);
+                assert.equal('string', data.response.request_access_enabled);
+                assert.equal('string', data.response.runners_token);
+                assert.equal('string', data.response.shared_runners_enabled);
+                assert.equal('string', data.response.shared_with_groups);
+                assert.equal('string', data.response.snippets_enabled);
+                assert.equal('string', data.response.ssh_url_to_repo);
+                assert.equal('string', data.response.star_count);
+                assert.equal('object', typeof data.response.statistics);
+                assert.equal('string', data.response.tag_list);
+                assert.equal('string', data.response.visibility_level);
+                assert.equal('string', data.response.web_url);
+                assert.equal('string', data.response.wiki_enabled);
+              } else {
+                runCommonAsserts(data, error);
+              }
+
+              saveMockData('Groups', 'getV4GroupsIdProjectsWithOptions', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     // describe('#postV4GroupsIdProjectsProjectId - errors', () => {
     //   it('should work if integrated or standalone with mockdata', (done) => {
     //     const p = new Promise((resolve) => {

package/test/unit/adapterTestUnit.js

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