@itentialopensource/adapter-algosec_fireflow 0.1.1

package/report/creationReport.json

@@ -0,0 +1,395 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "Standard adapter errors available for use",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 16
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 7
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.48.0"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 70
+    },
+    {
+      "owner": "adapterJS",
+      "description": "Lines of code generated in adapter.js",
+      "value": 1909
+    },
+    {
+      "owner": "adapterJS",
+      "description": "Number of Functions added to adapter.js",
+      "value": 13
+    },
+    {
+      "owner": "pronghornJson",
+      "description": "Number of Methods added to pronghorn.json",
+      "value": 13
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 338
+    },
+    {
+      "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": 200
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the CALLS.md",
+      "value": 171
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the AUTH.md",
+      "value": 40
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SYSTEMINFO.md",
+      "value": 11
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 1672
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 80
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 759
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 18
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for AuthenticationExternalController entity",
+      "value": 1
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for WorkOrderExternalController entity",
+      "value": 2
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for RuleRemovalChangeRequestExternalController entity",
+      "value": 1
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for TrafficChangeRequestExternalController entity",
+      "value": 3
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for ActiveChangeExternalController entity",
+      "value": 2
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for ObjectChangeRequestExternalController entity",
+      "value": 1
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for SavedSearchController entity",
+      "value": 1
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for SessionExternalController entity",
+      "value": 1
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for RequestTemplateExternalController entity",
+      "value": 1
+    },
+    {
+      "owner": "actionJson",
+      "description": "Total number of actions",
+      "value": 13
+    },
+    {
+      "owner": "actionJson",
+      "description": "Total number of entities",
+      "value": 9
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for AuthenticationExternalController entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for WorkOrderExternalController entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for RuleRemovalChangeRequestExternalController entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for TrafficChangeRequestExternalController entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for ActiveChangeExternalController entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for ObjectChangeRequestExternalController entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for SavedSearchController entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for SessionExternalController entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for RequestTemplateExternalController entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Total number of schemas",
+      "value": 9
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for AuthenticationExternalController entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for WorkOrderExternalController entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for RuleRemovalChangeRequestExternalController entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for TrafficChangeRequestExternalController entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for ActiveChangeExternalController entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for ObjectChangeRequestExternalController entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for SavedSearchController entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for SessionExternalController entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for RequestTemplateExternalController entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Total number of mock data files",
+      "value": 0
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for .system entity",
+      "value": 2
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for .system entity",
+      "value": 3
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for .system entity",
+      "value": 2
+    },
+    {
+      "owner": "System",
+      "description": "System entity files",
+      "value": 6
+    },
+    {
+      "owner": "usecases",
+      "description": "Number of workflows",
+      "value": 0
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1788
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 38
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 6128
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 98
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 70
+    }
+  ],
+  "warnings": [],
+  "apiParsingReport": {
+    "no_mockdata": [
+      {
+        "fnName": "authenticateUsingPOST",
+        "method": "post",
+        "path": "/authentication/authenticate"
+      },
+      {
+        "fnName": "calculateWorkOrderUsingPOST",
+        "method": "post",
+        "path": "/change-request/traffic/{changeRequestId}/work-order/calculate"
+      },
+      {
+        "fnName": "getWorkOrderCalculationStatusUsingGET",
+        "method": "get",
+        "path": "/change-request/traffic/{changeRequestId}/work-order/calculation/status"
+      },
+      {
+        "fnName": "createRuleRemovalRequestUsingPOST",
+        "method": "post",
+        "path": "/change-requests/rule-removal"
+      },
+      {
+        "fnName": "createTrafficChangeRequestUsingPOST",
+        "method": "post",
+        "path": "/change-requests/traffic"
+      },
+      {
+        "fnName": "getTicketUsingGET",
+        "method": "get",
+        "path": "/change-requests/traffic/{changeRequestId}"
+      },
+      {
+        "fnName": "updateTrafficChangeRequestCustomFieldsUsingPUT",
+        "method": "put",
+        "path": "/change-requests/traffic/{changeRequestId}/fields"
+      },
+      {
+        "fnName": "calculateActiveChangeUsingPOST",
+        "method": "post",
+        "path": "/change-requests/traffic/{changeRequestId}/work-order/implement"
+      },
+      {
+        "fnName": "getActiveChangeStatusUsingGET",
+        "method": "get",
+        "path": "/change-requests/traffic/{changeRequestId}/work-order/implementation/result"
+      },
+      {
+        "fnName": "createObjectChangeRequestUsingPOST",
+        "method": "post",
+        "path": "/request/object"
+      },
+      {
+        "fnName": "getSavedSearchByNameProxyUsingGET",
+        "method": "get",
+        "path": "/savedsearch"
+      },
+      {
+        "fnName": "verifySessionStatusUsingGET",
+        "method": "get",
+        "path": "/session"
+      },
+      {
+        "fnName": "getTemplatesUsingGET",
+        "method": "get",
+        "path": "/templates"
+      }
+    ],
+    "errors": [],
+    "warnings": [],
+    "callsTotal": 13,
+    "callsConverted": 13,
+    "no_mockdata_num": 13
+  }
+}

package/sampleProperties.json

@@ -0,0 +1,195 @@
+{
+  "id": "Adapter-algosec_fireflow",
+  "type": "AlgosecFireflow",
+  "properties": {
+    "host": "localhost",
+    "port": 443,
+    "base_path": "/FireFlow/api",
+    "version": "",
+    "cache_location": "none",
+    "encode_pathvars": true,
+    "encode_queryvars": true,
+    "save_metric": false,
+    "stub": true,
+    "protocol": "https",
+    "authentication": {
+      "auth_method": "request_token",
+      "username": "username",
+      "password": "password",
+      "token": "token",
+      "token_timeout": 1800000,
+      "token_cache": "local",
+      "invalid_token_error": 401,
+      "auth_field": "header.headers.Cookie",
+      "auth_field_format": "FireFlow_Session={token}",
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": ""
+    },
+    "healthcheck": {
+      "type": "none",
+      "frequency": 60000,
+      "query_object": {}
+    },
+    "throttle": {
+      "throttle_enabled": false,
+      "number_pronghorns": 1,
+      "sync_async": "sync",
+      "max_in_queue": 1000,
+      "concurrent_max": 1,
+      "expire_timeout": 0,
+      "avg_runtime": 200,
+      "priorities": [
+        {
+          "value": 0,
+          "percent": 100
+        }
+      ]
+    },
+    "request": {
+      "number_redirects": 0,
+      "number_retries": 3,
+      "limit_retry_error": [
+        0
+      ],
+      "failover_codes": [],
+      "attempt_timeout": 5000,
+      "global_request": {
+        "payload": {},
+        "uriOptions": {},
+        "addlHeaders": {},
+        "authData": {}
+      },
+      "healthcheck_on_timeout": true,
+      "return_raw": false,
+      "archiving": false,
+      "return_request": false
+    },
+    "proxy": {
+      "enabled": false,
+      "host": "",
+      "port": 1,
+      "protocol": "http",
+      "username": "",
+      "password": ""
+    },
+    "ssl": {
+      "ecdhCurve": "",
+      "enabled": false,
+      "accept_invalid_cert": false,
+      "ca_file": "",
+      "key_file": "",
+      "cert_file": "",
+      "secure_protocol": "",
+      "ciphers": ""
+    },
+    "mongo": {
+      "host": "",
+      "port": 0,
+      "database": "",
+      "username": "",
+      "password": "",
+      "replSet": "",
+      "db_ssl": {
+        "enabled": false,
+        "accept_invalid_cert": false,
+        "ca_file": "",
+        "key_file": "",
+        "cert_file": ""
+      }
+    },
+    "devicebroker": {
+      "getDevice": [
+        {
+          "path": "/get/devices/{id}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "host",
+            "ostype": "os",
+            "ostypePrefix": "system-",
+            "ipaddress": "attributes.ipaddr",
+            "port": "443"
+          }
+        }
+      ],
+      "getDevicesFiltered": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "host",
+            "ostype": "os",
+            "ostypePrefix": "system-",
+            "ipaddress": "attributes.ipaddr",
+            "port": "443"
+          }
+        }
+      ],
+      "isAlive": [
+        {
+          "path": "/get/devices/{id}/status",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "status": "status",
+            "statusValue": "online"
+          }
+        }
+      ],
+      "getConfig": [
+        {
+          "path": "/get/devices/{id}/configPart1",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ],
+      "getCount": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ]
+    }
+  },
+  "groups": [],
+  "brokers": [],
+  "logLevel": "none",
+  "timeout": 120000
+}

package/test/integration/adapterTestBasicGet.js

@@ -0,0 +1,83 @@
+/* @copyright Itential, LLC 2020 */
+
+/* global describe context before after */
+/* eslint global-require: warn */
+/* eslint no-unused-vars: warn */
+/* eslint import/no-extraneous-dependencies: warn */
+/* eslint import/no-dynamic-require: warn */
+/* eslint import/no-unresolved: warn */
+
+const mocha = require('mocha');
+const path = require('path');
+const assert = require('assert');
+const itParam = require('mocha-param');
+
+const utils = require('../../utils/tbUtils');
+const basicGet = require('../../utils/basicGet');
+const { name } = require('../../package.json');
+const { methods } = require('../../pronghorn.json');
+
+const getPronghornProps = (iapDir) => {
+  console.log('Retrieving properties.json file...');
+  const rawProps = require(path.join(iapDir, 'properties.json'));
+  console.log('Decrypting properties...');
+  const pronghornProps = utils.decryptProperties(rawProps, iapDir);
+  console.log('Found properties.\n');
+  return pronghornProps;
+};
+
+let a;
+
+describe('[integration] Adapter BasicGET Test', () => {
+  context('Testing GET calls without query parameters', () => {
+    before(async () => {
+      const iapDir = path.join(__dirname, '../../../../../');
+      if (!utils.areWeUnderIAPinstallationDirectory()) {
+        const sampleProperties = require('../../sampleProperties.json');
+        const adapter = { properties: sampleProperties };
+        a = basicGet.getAdapterInstance(adapter);
+      } else {
+        const pronghornProps = getPronghornProps(iapDir);
+        console.log('Connecting to Database...');
+        const database = await basicGet.connect(pronghornProps);
+        console.log('Connection established.');
+        const adapter = await database.collection(utils.SERVICE_CONFIGS_COLLECTION).findOne(
+          { model: name }
+        );
+        a = basicGet.getAdapterInstance(adapter);
+      }
+    });
+
+    after((done) => {
+      done();
+    });
+
+    const basicGets = methods.filter((method) => (method.route.verb === 'GET' && method.input.length === 0));
+    if (basicGets.length === 0) {
+      console.log('No non-parameter GET calls found.');
+      process.exit(0);
+    }
+    const functionNames = basicGets.map((g) => g.name);
+    const request = function request(f, ad) {
+      return new Promise((resolve, reject) => {
+        const getRespCode = (resp) => {
+          if (resp) {
+            if (resp.metrics.code !== 200) {
+              console.log('\x1b[31m', `Testing ${f} \nResponseCode: ${resp.metrics.code}`);
+            }
+            resolve(resp.metrics.code);
+          } else {
+            console.log('\x1b[31m', `call ${f} results in failure`);
+            reject(new Error(`${f} failed`));
+          }
+        };
+        ad[f](getRespCode, console.log);
+      });
+    };
+
+    itParam('GET call should return 200', functionNames, (fname) => {
+      console.log(`\t ${fname}`);
+      return request(fname, a).then((result) => assert.equal(result, 200));
+    });
+  });
+});