@itentialopensource/adapter-gitlab 0.15.2 → 0.15.4

package/BROKER.md

@@ -22,18 +22,25 @@ Below is an example of how you may set up the properties for this call.
   {
     "path": "/{org}/get/devices",
     "method": "GET",
+    "pagination": {
+      "offsetVar": "",
+      "limitVar": "",
+      "incrementBy": "limit",
+      "requestLocation": "query"
+    },
     "query": {},
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
       "org": "555"
     },
     "responseFields": {
-      "name": "host",
-      "ostype": "os",
+      "name": "{hostField}",
+      "ostype": "{osField}",
       "ostypePrefix": "system-",
-      "ipaddress": "attributes.ipaddr",
+      "ipaddress": "{attributes.ipaddr}",
       "port": "443"
     }
   },
@@ -44,16 +51,17 @@ Below is an example of how you may set up the properties for this call.
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
       "org": "777"
     },
     "responseFields": {
-      "name": "host",
-      "ostype": "os",
+      "name": "{hostField}",
+      "ostype": "{osField}",
       "ostypePrefix": "system-",
-      "ipaddress": "attributes.ipaddr",
+      "ipaddress": "{attributes.ipaddr}",
       "port": "443",
-      "myorg": "org"
+      "myorg": "{orgField}"
     }
   }
 ]
@@ -88,12 +96,13 @@ Below is an example of how you may set up the properties for this call.
     "headers": {},
     "handleFailure": "ignore",
     "statusValue": "online",
+    "responseDataKey": "",
     "requestFields": {
-      "org": "myorg",
-      "id": "name"
+      "org": "{myorg}",
+      "id": "{name}"
     },
     "responseFields": {
-      "status": "status"
+      "status": "{status}"
     }
   }
 ]
@@ -129,9 +138,10 @@ Below is an example of how you may set up the properties for this call.
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
-      "org": "myorg",
-      "id": "name"
+      "org": "{myorg}",
+      "id": "{name}"
     }
     "responseFields": {}
   },
@@ -142,8 +152,9 @@ Below is an example of how you may set up the properties for this call.
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
-      "org": "myorg"
+      "org": "{myorg}"
     }
     "responseFields": {}
   }
@@ -178,17 +189,18 @@ Below is an example of how you may set up the properties for this call.
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
-      "org": "myorg",
-      "id": "name"
+      "org": "{myorg}",
+      "id": "{name}"
     },
     "responseFields": {
-      "name": "host",
-      "ostype": "os",
+      "name": "{hostField}",
+      "ostype": "{osField}",
       "ostypePrefix": "system-",
-      "ipaddress": "attributes.ipaddr",
+      "ipaddress": "{attributes.ipaddr}",
       "port": "443",
-      "myorg": "org"
+      "myorg": "{orgField}"
     }
   }
 ]

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.15.4 [10-15-2024]
+
+* Changes made at 2024.10.14_21:29PM
+
+See merge request itentialopensource/adapters/adapter-gitlab!35
+
+---
+
+## 0.15.3 [08-26-2024]
+
+* update dependencies and metadata
+
+See merge request itentialopensource/adapters/adapter-gitlab!33
+
+---
+
 ## 0.15.2 [08-15-2024]
 
 * Changes made at 2024.08.14_19:48PM

package/TAB2.md

@@ -62,9 +62,9 @@ Sample Properties can be used to help you configure the adapter in the Itential
     "protocol": "https",
     "authentication": {
       "auth_method": "static_token",
-      "username": "exampleUsername",
-      "password": "examplePassword",
-      "token": "statictoken",
+      "username": "username",
+      "password": "password",
+      "token": "token",
       "token_timeout": 1800000,
       "token_cache": "local",
       "invalid_token_error": 401,

package/metadata.json

@@ -1,8 +1,10 @@
 {
   "name": "adapter-gitlab",
   "webName": "Adapter for Integration to GitLab",
+  "supportLevel": "certified",
   "vendor": "GitLab",
   "product": "GitLab",
+  "techAlliance": false,
   "osVersion": [],
   "apiVersions": [
     "4"
@@ -31,8 +33,8 @@
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-gitlab",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-gitlab",
-    "docLink": "https://docs.itential.com/opensource/docs/gitlab",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-gitlab",
+    "docLink": "https://gitlab.com/itentialopensource/adapters/adapter-gitlab/-/blob/master/README.md?ref_type=heads",
     "demoLinks": [
       {
         "title": "How NetDevOps Teams can Rapidly Build & Design Network Automations",
@@ -64,7 +66,11 @@
         "public": true
       }
     ],
-    "workshopLinks": [],
+    "workshopLinks": [
+      {
+        "title": "CI/CD Pipeline"
+      }
+    ],
     "workshopHomePage": "https://www.itential.com/get-started/"
   },
   "assets": [],
@@ -178,7 +184,5 @@
       "type": "API Key",
       "primary": true
     }
-  ],
-  "supportLevel": "community",
-  "techAlliance": false
+  ]
 }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-gitlab",
-  "version": "0.15.2",
+  "version": "0.15.4",
   "description": "This adapter integrates with system described as: gitlab.",
   "main": "adapter.js",
   "systemName": "Gitlab",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.16",
+  "engineVersion": "1.68.2",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -54,7 +54,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-gitlab#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.6.0",
+    "@itentialopensource/adapter-utils": "^5.9.4",
     "acorn": "^8.12.1",
     "ajv": "^8.17.1",
     "axios": "^1.7.4",
@@ -69,7 +69,7 @@
     "prompts": "^2.4.2",
     "readline-sync": "^1.4.10",
     "semver": "^7.6.3",
-    "winston": "^3.13.1"
+    "winston": "^3.14.2"
   },
   "devDependencies": {
     "chai": "^4.3.7",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.13.5",
+  "version": "0.15.2",
   "configLines": 28652,
   "scriptLines": 1783,
   "codeLines": 45130,
-  "testLines": 42558,
-  "testCases": 2259,
-  "totalCodeLines": 89471,
+  "testLines": 42542,
+  "testCases": 2258,
+  "totalCodeLines": 89455,
   "wfTasks": 571
 }

package/sampleProperties.json

@@ -15,9 +15,9 @@
     "protocol": "https",
     "authentication": {
       "auth_method": "static_token",
-      "username": "exampleUsername",
-      "password": "examplePassword",
-      "token": "statictoken",
+      "username": "username",
+      "password": "password",
+      "token": "token",
       "token_timeout": 1800000,
       "token_cache": "local",
       "invalid_token_error": 401,

package/test/integration/adapterTestConnectivity.js

@@ -4,7 +4,6 @@
 /* eslint no-unused-vars: warn */
 
 const assert = require('assert');
-const http = require('http');
 const https = require('https');
 const mocha = require('mocha');
 const ping = require('ping');
@@ -53,29 +52,6 @@ describe('[integration] Adapter Test', () => {
         });
     });
 
-    it('Support HTTP on port 80', (done) => {
-      const requestOptions = {
-        host,
-        port: 80,
-        method: 'HEAD'
-      };
-
-      const req = http.request(requestOptions, (res) => {
-        try {
-          assert.ok(res.statusCode >= 200 && res.statusCode < 400);
-          done();
-        } catch (error) {
-          done(error);
-        }
-      });
-
-      req.on('error', (err) => {
-        done(err);
-      });
-
-      req.end();
-    });
-
     it('Support HTTPS on port 443', (done) => {
       const requestOptions = {
         host,

package/test/integration/adapterTestIntegration.js

@@ -36,13 +36,17 @@ const samProps = require(`${adaptdir}/sampleProperties.json`).properties;
 // these variables can be changed to run in integrated mode so easier to set them here
 // always check these in with bogus data!!!
 samProps.stub = true;
-samProps.host = 'replace.hostorip.here';
-samProps.authentication.username = 'username';
-samProps.authentication.password = 'password';
-samProps.protocol = 'http';
-samProps.port = 80;
-samProps.ssl.enabled = false;
-samProps.ssl.accept_invalid_cert = false;
+
+// uncomment if connecting
+// samProps.host = 'replace.hostorip.here';
+// samProps.authentication.username = 'username';
+// samProps.authentication.password = 'password';
+// samProps.authentication.token = 'password';
+// samProps.protocol = 'http';
+// samProps.port = 80;
+// samProps.ssl.enabled = false;
+// samProps.ssl.accept_invalid_cert = false;
+
 if (samProps.request.attempt_timeout < 30000) {
   samProps.request.attempt_timeout = 30000;
 }

package/test/unit/adapterTestUnit.js

@@ -36,13 +36,17 @@ const samProps = require(`${adaptdir}/sampleProperties.json`).properties;
 // these variables can be changed to run in integrated mode so easier to set them here
 // always check these in with bogus data!!!
 samProps.stub = true;
-samProps.host = 'replace.hostorip.here';
-samProps.authentication.username = 'username';
-samProps.authentication.password = 'password';
-samProps.protocol = 'http';
-samProps.port = 80;
-samProps.ssl.enabled = false;
-samProps.ssl.accept_invalid_cert = false;
+
+// uncomment if connecting
+// samProps.host = 'replace.hostorip.here';
+// samProps.authentication.username = 'username';
+// samProps.authentication.password = 'password';
+// samProps.authentication.token = 'password';
+// samProps.protocol = 'http';
+// samProps.port = 80;
+// samProps.ssl.enabled = false;
+// samProps.ssl.accept_invalid_cert = false;
+
 samProps.request.attempt_timeout = 1200000;
 const attemptTimeout = samProps.request.attempt_timeout;
 const { stub } = samProps;
@@ -323,7 +327,7 @@ describe('[unit] GitLab Adapter Test', () => {
           assert.equal('^0.4.4', packageDotJson.dependencies.ping);
           assert.equal('^1.4.10', packageDotJson.dependencies['readline-sync']);
           assert.equal('^7.6.3', packageDotJson.dependencies.semver);
-          assert.equal('^3.13.1', packageDotJson.dependencies.winston);
+          assert.equal('^3.14.2', packageDotJson.dependencies.winston);
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -561,7 +565,7 @@ describe('[unit] GitLab Adapter Test', () => {
           log.error(`Adapter Exception: ${error}`);
           done(error);
         }
-      });
+      }).timeout(attemptTimeout);
     });
 
     describe('propertiesSchema.json', () => {

package/compliance-report.json

@@ -1,9 +0,0 @@
-{
-  "ComplianceEntries": [
-    {
-      "name": "Compliance Summary",
-      "numInvalidProjects": 0,
-      "numValidProjects": 0
-    }
-  ]
-}

package/compliance-report.txt

@@ -1,5 +0,0 @@
----------------------------------------------------------------------------------------------
-**** Project Compliance Summary ****
-0 project(s) are not valid
-0 project(s) are valid
----------------------------------------------------------------------------------------------