@itentialopensource/adapter-six_connect 0.6.1 → 0.7.1

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.7.1 [03-14-2023]
+
+* Add a task to ipam entity
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-six_connect!11
+
+---
+
+## 0.7.0 [07-25-2022]
+
+* Changes for smartAssign -- added smartAssignTags and smartAssignObject for requested changes
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-six_connect!10
+
+---
+
 ## 0.6.1 [06-04-2022]
 
 * Add schema for query parameter changes in names

package/adapter.js

@@ -2104,12 +2104,63 @@ class SixConnect extends AdapterBaseCl {
    * @summary Smart assign by using Resource ID
    *
    * @function smartAssign
-   * @param {object} body - body param
+   * @param {string} type - type for assignment
+   * @param {number} rir - rir for assignment
+   * @param {string} mask - mask for assignment
+   * @param {string} resource_id - resource_id for assignment
+   * @param {string} region_id - region_id for assignment
    * @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 */
   smartAssign(type, rir, mask, resource_id, region_id, callback) {
-    const meth = 'adapter-smartAssign';
+    const bodyVars = {
+      type,
+      rir,
+      mask,
+      resource_id,
+      region_id,
+      tags_mode: 'intersection'
+    };
+    this.smartAssignObject(bodyVars, callback);
+  }
+
+  /**
+   * @summary Smart assign by using Resource ID with Tags
+   *
+   * @function smartAssignTags
+   * @param {string} type - type for assignment
+   * @param {number} rir - rir for assignment
+   * @param {string} mask - mask for assignment
+   * @param {string} resource_id - resource_id for assignment
+   * @param {string} region_id - region_id for assignment
+   * @param {array} tags - tags for assignment
+   * @param {string} tags_mode - tags_mode for assignment
+   * @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 */
+  smartAssignTags(type, rir, mask, resource_id, region_id, tags, tags_mode, callback) {
+    const bodyVars = {
+      type,
+      rir,
+      mask,
+      resource_id,
+      region_id,
+      tags,
+      tags_mode
+    };
+    this.smartAssignObject(bodyVars, callback);
+  }
+
+  /**
+   * @summary Smart assign by using Full Body
+   *
+   * @function smartAssignObject
+   * @param {object} body - body param
+   * @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 */
+  smartAssignObject(body, callback) {
+    const meth = 'adapter-smartAssignObject';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
@@ -2124,14 +2175,7 @@ class SixConnect extends AdapterBaseCl {
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
     const queryParams = {};
     const pathVars = [];
-    const bodyVars = {
-      type,
-      rir,
-      mask,
-      resource_id,
-      region_id,
-      tags_mode: 'intersection'
-    };
+    const bodyVars = body;
 
     // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders
     const reqObj = {
@@ -2151,7 +2195,7 @@ class SixConnect extends AdapterBaseCl {
           return callback(null, irReturnError);
         }
         if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
-          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['smartAssign'], null, null, null);
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['smartAssignObject'], null, null, null);
           log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
           return callback(null, errorObj);
         }
@@ -7254,6 +7298,81 @@ class SixConnect extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @summary CREATE IPAM Swip
+   *
+   * @function postIpamSwip
+   * @param {string} netblockId - netblock id
+   * @param {object} body - body param
+   * @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 */
+  postIpamSwip(netblockId, body, callback) {
+    const meth = 'adapter-postIpamSwip';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (netblockId === undefined || netblockId === null || netblockId === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['netblockId'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [netblockId];
+    const bodyVars = body;
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+        && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('ipam', 'postIpamSwip', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['postIpamSwip'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
   /**
    * @summary Get workflows
    *

package/entities/ipam/action.json

@@ -1805,6 +1805,27 @@
           "mockFile": ""
         }
       ]
+    },
+    {
+      "name": "postIpamSwip",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/ipam/swip/{pathv1}/simple?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
     }
   ]
 }

package/entities/ipam/schema.json

@@ -2,7 +2,7 @@
   "$id": "schema.json",
   "type": "object",
   "schema": "http://json-schema.org/draft-07/schema#",
-  "translate": false,
+  "translate": true,
   "dynamicfields": true,
   "properties": {
     "ph_request_type": {
@@ -95,12 +95,13 @@
         "getVlanDomains",
         "retrieveDomainVlan",
         "retrieveVlan",
-        "getSizeSizes"
+        "getSizeSizes",
+        "postIpamSwip"
       ],
       "external_name": "ph_request_type"
     },
     "lirId": {
-      "type": "string",
+      "type": ["string", "number"],
       "description": "lir id",
       "parse": false,
       "encode": false,
@@ -111,7 +112,7 @@
       "external_name": "lir_id"
     },
     "regionId": {
-      "type": "string",
+      "type": ["string", "number"],
       "description": "region id",
       "parse": false,
       "encode": false,
@@ -122,7 +123,7 @@
       "external_name": "region_id"
     },
     "resourceId": {
-      "type": "string",
+      "type": ["string", "number"],
       "description": "resource id",
       "parse": false,
       "encode": false,
@@ -133,7 +134,7 @@
       "external_name": "resource_id"
     },
     "vlanId": {
-      "type": "string",
+      "type": ["string", "number"],
       "description": "vlan id",
       "parse": false,
       "encode": false,
@@ -144,7 +145,7 @@
       "external_name": "vlan_id"
     },
     "ruleId": {
-      "type": "string",
+      "type": ["string", "number"],
       "description": "rule id",
       "parse": false,
       "encode": false,
@@ -155,7 +156,7 @@
       "external_name": "rule_id"
     },
     "orgId": {
-      "type": "string",
+      "type": ["string", "number"],
       "description": "org id",
       "parse": false,
       "encode": false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-six_connect",
-  "version": "0.6.1",
+  "version": "0.7.1",
   "description": "This adapter integrates with system Six_connect",
   "main": "adapter.js",
   "systemName": "6connect",

package/pronghorn.json

@@ -1918,6 +1918,134 @@
       },
       "task": true
     },
+    {
+      "name": "smartAssignTags",
+      "summary": "Smart assign by using Resource ID",
+      "description": "Smart assign by using Resource ID",
+      "input": [
+        {
+          "name": "type",
+          "type": "string",
+          "info": "",
+          "required": true,
+          "schema": {
+            "title": "type",
+            "type": "string"
+          }
+        },
+        {
+          "name": "rir",
+          "type": "string",
+          "info": "",
+          "required": true,
+          "schema": {
+            "title": "rir",
+            "type": "string"
+          }
+        },
+        {
+          "name": "mask",
+          "type": "string",
+          "info": "",
+          "required": true,
+          "schema": {
+            "title": "mask",
+            "type": "string"
+          }
+        },
+        {
+          "name": "resource_id",
+          "type": "string",
+          "info": "",
+          "required": true,
+          "schema": {
+            "title": "resource_id",
+            "type": "string"
+          }
+        },
+        {
+          "name": "region_id",
+          "type": "string",
+          "info": "",
+          "required": true,
+          "schema": {
+            "title": "region_id",
+            "type": "string"
+          }
+        },
+        {
+          "name": "tags",
+          "type": "array",
+          "info": "",
+          "required": true,
+          "schema": {
+            "title": "tags",
+            "type": "array"
+          }
+        },
+        {
+          "name": "tags_mode",
+          "type": "string",
+          "info": "",
+          "required": true,
+          "schema": {
+            "title": "tags_mode",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/smartAssignTags"
+      },
+      "task": true
+    },
+    {
+      "name": "smartAssignObject",
+      "summary": "Smart assign by using Resource ID",
+      "description": "Smart assign by using Resource ID",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "",
+          "required": true,
+          "schema": {
+            "title": "body",
+            "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": "/smartAssignObject"
+      },
+      "task": true
+    },
     {
       "name": "deleteSwip1",
       "summary": "Deassign by using Netblock CIDR",
@@ -4959,6 +5087,50 @@
       },
       "task": true
     },
+    {
+      "name": "postIpamSwip",
+      "summary": "Create IPAM Swip",
+      "description": "Creates a new IPAM swip.",
+      "input": [
+        {
+          "name": "netblockId",
+          "type": "string",
+          "info": "",
+          "required": true,
+          "schema": {
+            "title": "netblockId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "",
+          "required": false,
+          "schema": {
+            "title": "body",
+            "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": "/postIpamSwip"
+      },
+      "task": true
+    },
     {
       "name": "getWorkflows",
       "summary": "Get workflows",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.5.3",
-  "configLines": 13308,
+  "version": "0.7.0",
+  "configLines": 13480,
   "scriptLines": 1707,
-  "codeLines": 18888,
-  "testLines": 11115,
-  "testCases": 523,
-  "totalCodeLines": 31710,
-  "wfTasks": 233
+  "codeLines": 19007,
+  "testLines": 11198,
+  "testCases": 527,
+  "totalCodeLines": 31912,
+  "wfTasks": 236
 }

package/test/integration/adapterTestIntegration.js

@@ -4655,5 +4655,59 @@ describe('[integration] Six_connect Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    describe('#getNetblocks - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.getNetblocks('fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', (data, error) => {
+            try {
+              if (stub) {
+                log.error(data);
+              } else {
+                log.error(data);
+              }
+
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    const postIpamSwipBodyParam = {
+      lir_id: '16',
+      entity_handle: 'ZAYOB',
+      net_handle: 'ZAYO-IPYX-123456'
+    };
+    describe('#postIpamSwip - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.postIpamSwip('fakedata', postIpamSwipBodyParam, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-six_connect-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('ipam', 'postIpamSwip', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
   });
 });

package/test/unit/adapterTestUnit.js

@@ -5320,5 +5320,34 @@ describe('[unit] Six_connect Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    describe('#postIpamSwip - errors', () => {
+      it('should have a postIpamSwip function', (done) => {
+        try {
+          assert.equal(true, typeof a.postIpamSwip === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing netblockId', (done) => {
+        try {
+          a.postIpamSwip(null, null, (data, error) => {
+            try {
+              const displayE = 'netblockId is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-six_connect-adapter-postIpamSwip', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
   });
 });