@itentialopensource/adapter-gitlab 0.10.2 → 0.12.0

package/CALLS.md

@@ -221,7 +221,7 @@ Specific adapter calls are built based on the API of the GitLab. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getV4Groups(statistics, allAvailable, search, orderBy = name, sort = asc, skipGroups, withCustomAttributes, owned, minAccessLevel, callback)</td>
+    <td style="padding:15px">getV4Groups(statistics, allAvailable, search, orderBy = 'name', sort = 'asc', skipGroups, withCustomAttributes, owned, minAccessLevel, callback)</td>
     <td style="padding:15px">Get a groups list</td>
     <td style="padding:15px">{base_path}/{version}/groups?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -275,7 +275,7 @@ Specific adapter calls are built based on the API of the GitLab. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getV4GroupsIdIssues(id, state = opened, labels, milestone, orderBy = created_at, sort = asc, page, perPage, callback)</td>
+    <td style="padding:15px">getV4GroupsIdIssues(id, state = 'opened', labels, milestone, orderBy = 'created_at', sort = 'asc', page, perPage, callback)</td>
     <td style="padding:15px">Get a list of group issues</td>
     <td style="padding:15px">{base_path}/{version}/groups/{pathv1}/issues?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -641,7 +641,7 @@ Specific adapter calls are built based on the API of the GitLab. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getV4Issues(state = opened, labels, milestone, orderBy = created_at, sort = asc, page, perPage, callback)</td>
+    <td style="padding:15px">getV4Issues(state = 'opened', labels, milestone, orderBy = 'created_at', sort = 'asc', page, perPage, callback)</td>
     <td style="padding:15px">Get currently authenticated user's issues</td>
     <td style="padding:15px">{base_path}/{version}/issues?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -671,7 +671,7 @@ Specific adapter calls are built based on the API of the GitLab. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getV4Projects(orderBy = id, sort = asc, archived, visibility = public, search, simple, owned, starred, membership, statistics, withCustomAttributes, withMergeRequestsEnabled, withProgrammingLanguage, wikiChecksumFailed, repositoryChecksumFailed, minAccessLevel, withIssuesEnabled, callback)</td>
+    <td style="padding:15px">getV4Projects(orderBy = 'id', sort = 'asc', archived, visibility = 'public', search, simple, owned, starred, membership, statistics, withCustomAttributes, withMergeRequestsEnabled, withProgrammingLanguage, wikiChecksumFailed, repositoryChecksumFailed, minAccessLevel, withIssuesEnabled, callback)</td>
     <td style="padding:15px">Get a projects list for authenticated user</td>
     <td style="padding:15px">{base_path}/{version}/projects?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -905,7 +905,7 @@ Specific adapter calls are built based on the API of the GitLab. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getV4ProjectsIdIssues(id, state = opened, iids, labels, milestone, orderBy = created_at, sort = asc, page, perPage, callback)</td>
+    <td style="padding:15px">getV4ProjectsIdIssues(id, state = 'opened', iids, labels, milestone, orderBy = 'created_at', sort = 'asc', page, perPage, callback)</td>
     <td style="padding:15px">Get a list of project issues</td>
     <td style="padding:15px">{base_path}/{version}/projects/{pathv1}/issues?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -971,7 +971,7 @@ Specific adapter calls are built based on the API of the GitLab. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getV4ProjectsIdMergeRequests(id, state = opened, orderBy = created_at, sort = asc, page, perPage, callback)</td>
+    <td style="padding:15px">getV4ProjectsIdMergeRequests(id, state = 'opened', orderBy = 'created_at', sort = 'asc', page, perPage, callback)</td>
     <td style="padding:15px">List merge requests</td>
     <td style="padding:15px">{base_path}/{version}/projects/{pathv1}/merge_requests?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -983,7 +983,7 @@ Specific adapter calls are built based on the API of the GitLab. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getV4ProjectsIdMilestones(id, state = active, page, perPage, callback)</td>
+    <td style="padding:15px">getV4ProjectsIdMilestones(id, state = 'active', page, perPage, callback)</td>
     <td style="padding:15px">Get a list of project milestones</td>
     <td style="padding:15px">{base_path}/{version}/projects/{pathv1}/milestones?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -1037,7 +1037,7 @@ Specific adapter calls are built based on the API of the GitLab. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getV4ProjectsIdPipelines(id, page, perPage, scope = running, callback)</td>
+    <td style="padding:15px">getV4ProjectsIdPipelines(id, page, perPage, scope = 'running', callback)</td>
     <td style="padding:15px">Get all Pipelines of the project</td>
     <td style="padding:15px">{base_path}/{version}/projects/{pathv1}/pipelines?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -1217,7 +1217,7 @@ Specific adapter calls are built based on the API of the GitLab. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getV4ProjectsIdRunners(id, scope = active, status, tagList, callback)</td>
+    <td style="padding:15px">getV4ProjectsIdRunners(id, scope = 'active', status, tagList, callback)</td>
     <td style="padding:15px">Get runners available for project</td>
     <td style="padding:15px">{base_path}/{version}/projects/{pathv1}/runners?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -3065,7 +3065,7 @@ Specific adapter calls are built based on the API of the GitLab. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getV4Runners(scope = active, status, tagList, callback)</td>
+    <td style="padding:15px">getV4Runners(scope = 'active', status, tagList, callback)</td>
     <td style="padding:15px">Get runners available for user</td>
     <td style="padding:15px">{base_path}/{version}/runners?{query}</td>
     <td style="padding:15px">Yes</td>

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.12.0 [12-06-2023]
+
+* More migration changes
+
+See merge request itentialopensource/adapters/devops-netops/adapter-gitlab!19
+
+---
+
+## 0.11.0 [11-07-2023]
+
+* More migration changes
+
+See merge request itentialopensource/adapters/devops-netops/adapter-gitlab!19
+
+---
+
 ## 0.10.2 [10-19-2023]
 
 * more meta changes

package/metadata.json

@@ -37,7 +37,7 @@
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-gitlab",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-gitlab.git",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-gitlab",
     "docLink": "https://docs.itential.com/opensource/docs/gitlab",
     "demoLinks": [
       "https://www.itential.com/blog/company/hybrid-cloud-automation/how-netdevops-teams-can-rapidly-build-design-network-automations/",

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-gitlab",
-  "version": "0.10.2",
+  "version": "0.12.0",
   "description": "This adapter integrates with system described as: gitlab.",
   "main": "adapter.js",
   "systemName": "Gitlab",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.8",
+  "engineVersion": "1.67.10",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -55,7 +55,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-gitlab#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.1.7",
+    "@itentialopensource/adapter-utils": "^5.3.2",
     "acorn": "^8.10.0",
     "ajv": "^8.12.0",
     "axios": "^1.4.0",

package/propertiesSchema.json

@@ -109,6 +109,14 @@
     },
     "cache": {
       "$ref": "#/definitions/cache"
+    },
+    "service": {
+      "type": "string",
+      "description": "Service we are integrating with -- used with AWS Authentication",
+      "examples": [
+        "ec2",
+        "route53"
+      ]
     }
   },
   "required": [
@@ -131,7 +139,8 @@
             "jwt_token",
             "request_token",
             "no_authentication",
-            "multi_step_authentication"
+            "multi_step_authentication",
+            "aws_authentication"
           ]
         },
         "username": {

package/report/adapterInfo.json

@@ -1,6 +1,6 @@
 {
-  "version": "0.10.1",
-  "configLines": 28584,
+  "version": "0.11.0",
+  "configLines": 28593,
   "scriptLines": 1783,
   "codeLines": 45044,
   "testLines": 42496,

package/report/updateReport1698421417178.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors no longer available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors that have been updated (e.g. recommendation changes)",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 17
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.3.0"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 77
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 347
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 642
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 25322
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 1629
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 15922
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 556
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1453
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 42697
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 2185
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/utils/methodDocumentor.js

@@ -77,6 +77,7 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
   // parsing the file to get the function and class declarations.
   const aFileFuncArgs = acorn.parse(aFile, { ecmaVersion: 2020 });
 
+  let callName = 'identifyRequest';
   // Looping through all the declarations parsed:
   aFileFuncArgs.body.forEach((e) => {
     // Getting only the class declaration as it has our required functions.
@@ -89,8 +90,10 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
         method.value.params.forEach((param) => {
           if (param.type === 'Identifier') {
             funcArgs.push(param.name);
+          } else if (param.type === 'RestElement') {
+            funcArgs.push(`...${param.argument.name}`);
           } else {
-            const args = `${param.left.name} = ${param.right.value}`;
+            const args = `${param.left.name} = ${param.right.raw}`;
             funcArgs.push(args);
           }
         });
@@ -102,7 +105,7 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
         });
         const requests = [];
         for (let i = 0; i < callList.length; i += 1) {
-          if (callList[i].callee.property && callList[i].callee.property.name === 'identifyRequest') {
+          if (callList[i].callee.property && callList[i].callee.property.name === callName) {
             requests.push(callList[i]);
           }
         }
@@ -114,7 +117,16 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
           const entity = expr.arguments[0].value;
           const actionName = expr.arguments[1].value;
           if (expr !== undefined && (expr.arguments[0].type !== 'Literal' || expr.arguments[1].type !== 'Literal')) {
-            throw new Error(`Bad inputs in method ${funcName}`);
+            const param1 = method.value.params[0];
+            const param2 = method.value.params[1];
+            if (param1.type !== 'Identifier' || param2.type !== 'Identifier'
+                || expr.arguments[0].type !== 'Identifier' || expr.arguments[1].type !== 'Identifier'
+                || param1.name !== expr.arguments[0].name || param2.name !== expr.arguments[1].name) {
+              throw new Error(`identifyRequest proxy method ${funcName} unknown format`);
+            } else if (callName !== 'identifyRequest') {
+              throw new Error(`MethodDocumentor not yet programmed to handle multiple helper methods: 1) ${callName}, 2) ${funcName}`);
+            }
+            callName = funcName;
           }
           const entityPath = getPathFromEntity(entity, actionName);
 
@@ -197,6 +209,7 @@ function readMDFile(filename, functionList) {
   // Creating the tags for each method to be appended to the file.
   const tdBeginTag = '    <td style="padding:15px">';
   const tdEndTag = '</td>';
+
   functionList.forEach((func) => {
     const signCommand = `${tdBeginTag}${func.method_signature}${tdEndTag}`;
     const descCommand = `${tdBeginTag}${func.description}${tdEndTag}`;