@itentialopensource/adapter-oracle_cloud 0.3.2 → 0.4.0

package/TAB2.md

@@ -0,0 +1,349 @@
+# Oracle Cloud
+
+## Table of Contents 
+
+  - [Specific Adapter Information](#specific-adapter-information) 
+    - [Authentication](#authentication) 
+    - [Sample Properties](#sample-properties) 
+    - [Swagger](#swagger) 
+  - [Generic Adapter Information](#generic-adapter-information) 
+
+## Specific Adapter Information
+### Authentication
+
+This document will go through the steps for authenticating the Oracle Cloud adapter with OAuth Authentication and Basic Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. 
+
+#### OAuth Two Step Token Authentication
+The Oracle Cloud adapter requires OAuth Two Step Token Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
+
+Oracle Cloud requires Basic Authentication on the token request along with a grant type of "client_credentials".
+
+STEPS  
+1. Ensure you have access to a Oracle Cloud server and that it is running
+2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
+3. Use the properties below for the ```properties.authentication``` field
+```json
+"authentication": {
+      "auth_method": "request_token",
+      "username": "clientID",
+      "password": "clientSecret",
+      "token_timeout": 1800000,
+      "token_cache": "local",
+      "invalid_token_error": 401,
+      "auth_field": "header.headers.Authorization",
+      "auth_field_format": "Bearer {token}",
+      "grant_type": "client_credentials",
+      "scope": "scopeString",
+      "sso": {
+        "protocol": "https",
+        "host": "idcs_tenantname",
+        "port": 443
+      }
+}
+```
+4. Restart the adapter. If your properties were set correctly, the adapter should go online. 
+
+
+#### Basic Authentication
+The Oracle Cloud adapter can also authenticate using Basic Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
+
+STEPS  
+1. Ensure you have access to a Oracle Cloud server and that it is running
+2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
+3. Use the properties below for the ```properties.authentication``` field
+```json
+"authentication": {
+  "auth_method": "basic user_password",
+  "username": "<username>",
+  "password": "<password>",
+  "token_timeout": 1800000,
+  "token_cache": "local",
+  "invalid_token_error": 401,
+  "auth_field": "header.headers.Authorization",
+  "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
+  "auth_logging": false,
+}
+```
+4. Restart the adapter. If your properties were set correctly, the adapter should go online. 
+
+#### Troubleshooting
+- Make sure you copied over the correct username and password.
+- Turn on debug level logs for the adapter in IAP Admin Essentials.
+- Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
+- Investigate the logs - in particular:
+  - The FULL REQUEST log to make sure the proper headers are being sent with the request.
+  - The FULL BODY log to make sure the payload is accurate.
+  - The CALL RETURN log to see what the other system is telling us.
+- Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
+- Remember when you are done to turn auth_logging off as you do not want to log credentials.
+### Sample Properties
+
+Sample Properties can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
+
+```json
+  "properties": {
+    "host": "localhost",
+    "port": 443,
+    "choosepath": "",
+    "base_path": "/",
+    "version": "",
+    "cache_location": "none",
+    "encode_pathvars": true,
+    "encode_queryvars": true,
+    "save_metric": false,
+    "stub": true,
+    "protocol": "https",
+    "authentication": {
+      "auth_method": "request_token",
+      "username": "clientId",
+      "password": "clientSecret",
+      "token": "token",
+      "token_timeout": 1800000,
+      "token_cache": "local",
+      "invalid_token_error": 401,
+      "auth_field": "header.headers.Authorization",
+      "auth_field_format": "Bearer {token}",
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": "client_credentials",
+      "scope": "scopeString",
+      "sensitive": [],
+      "sso": {
+        "protocol": "https",
+        "host": "idcs_tenantname",
+        "port": 443
+      },
+      "multiStepAuthCalls": [
+        {
+          "name": "",
+          "requestFields": {},
+          "responseFields": {},
+          "successfullResponseCode": 200
+        }
+      ]
+    },
+    "healthcheck": {
+      "type": "none",
+      "frequency": 60000,
+      "query_object": {},
+      "addlHeaders": {}
+    },
+    "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": {
+      "enabled": false,
+      "getDevice": [
+        {
+          "path": "/not/mapped",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "insample": "{port}"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial": "{serial}"
+          }
+        }
+      ],
+      "getDevicesFiltered": [
+        {
+          "path": "/not/mapped",
+          "method": "GET",
+          "pagination": {
+            "offsetVar": "",
+            "limitVar": "",
+            "incrementBy": "limit",
+            "requestLocation": "query"
+          },
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial": "{serial}",
+            "id": "{myid}"
+          }
+        }
+      ],
+      "isAlive": [
+        {
+          "path": "/not/mapped/{devID}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "devID": "{id}"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "status": "return2xx",
+            "statusValue": "AD.200"
+          }
+        }
+      ],
+      "getConfig": [
+        {
+          "path": "/not/mapped/{devID}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "devID": "{id}"
+          },
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ],
+      "getCount": [
+        {
+          "path": "/not/mapped",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ]
+    },
+    "cache": {
+      "enabled": false,
+      "entities": [
+        {
+          "entityType": "device",
+          "frequency": 3600,
+          "flushOnFail": false,
+          "limit": 10000,
+          "retryAttempts": 5,
+          "sort": true,
+          "populate": [
+            {
+              "path": "/not/mapped",
+              "method": "GET",
+              "pagination": {
+                "offsetVar": "",
+                "limitVar": "",
+                "incrementBy": "limit",
+                "requestLocation": "query"
+              },
+              "query": {},
+              "body": {},
+              "headers": {},
+              "handleFailure": "ignore",
+              "requestFields": {},
+              "responseDatakey": "",
+              "responseFields": {
+                "name": "{this}{||}{that}",
+                "ostype": "{osfield}",
+                "ostypePrefix": "meraki-",
+                "port": "{port}",
+                "ipaddress": "{ip_addr}",
+                "serial": "{serial}",
+                "id": "{myid}"
+              }
+            }
+          ],
+          "cachedTasks": [
+            {
+              "name": "",
+              "filterField": "",
+              "filterLoc": ""
+            }
+          ]
+        }
+      ]
+    }
+  }
+```
+### [Swagger](https://gitlab.com/itentialopensource/adapters/cloud/adapter-oracle_cloud/-/blob/master/report/adapter-openapi.json) 
+
+## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/cloud/adapter-oracle_cloud/-/blob/master/README.md) 
+

package/entities/.system/action.json

@@ -4,14 +4,16 @@
       "name": "getToken",
       "protocol": "REST",
       "method": "POST",
-      "entitypath": "{base_path}/{version}/login",
+      "entitypath": "{base_path}/{version}/oauth2/v1/token",
       "requestSchema": "schemaTokenReq.json",
       "responseSchema": "schemaTokenResp.json",
       "timeout": 0,
       "sendEmpty": false,
-      "requestDatatype": "",
-      "responseDatatype": "",
-      "headers": {},
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "JSON",
+      "headers": {
+        "Authorization": "Basic {b64}{username}:{password}{/b64}"
+      },
       "sso": {
         "protocol": "",
         "host": "",

package/entities/.system/mockdatafiles/getToken-default.json

@@ -1,3 +1,3 @@
 {
-  "token": "garbagetoken"
+  "access_token": "garbagetoken"
 }

package/entities/.system/schemaTokenReq.json

@@ -36,6 +36,50 @@
       },
       "external_name": "password"
     },
+    "client_id": {
+      "type": "string",
+      "description": "client id to log in with",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "client_id"
+    },
+    "client_secret": {
+      "type": "string",
+      "description": "client secret to log in with",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "client_secret"
+    },
+    "scope": {
+      "type": "string",
+      "description": "scope",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "scope"
+    },
+    "grant_type": {
+      "type": "string",
+      "description": "grant type to log in with",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "grant_type"
+    },
     "token": {
       "type": "string",
       "description": "token returned by system",

package/entities/.system/schemaTokenResp.json

@@ -46,7 +46,7 @@
         "type": "AES",
         "key": ""
       },
-      "external_name": "token"
+      "external_name": "access_token"
     }
   },
   "definitions": {}

package/metadata.json

@@ -42,20 +42,41 @@
     "isDeprecated": false
   },
   "brokerSince": "",
+  "authMethods": [
+    {
+      "type": "OAuth",
+      "primary": true
+    },
+    {
+      "type": "Basic Auth",
+      "primary": false
+    }
+  ],
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-oracle_cloud",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-oracle_cloud",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-oracle_cloud",
     "docLink": "https://docs.itential.com/opensource/docs/oracle-cloud",
     "demoLinks": [],
-    "trainingLinks": [],
+    "trainingLinks": [
+      {
+        "title": "Itential Academy",
+        "link": "https://www.itential.com/itential-academy/"
+      }
+    ],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
     "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
     "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
     "webLink": "",
     "vendorLink": "https://www.oracle.com/",
-    "productLink": "",
-    "apiLinks": []
+    "productLink": "https://www.oracle.com/cloud/",
+    "apiLinks": [
+      {
+        "link": "https://docs.oracle.com/en/cloud/paas/content-cloud/rest-api-documents/rest-endpoints.html",
+        "title": "Oracle Cloud Content Management REST API",
+        "public": true
+      }
+    ]
   },
   "assets": [],
   "relatedItems": {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@itentialopensource/adapter-oracle_cloud",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "This adapter integrates with system described as: restApiForDocuments.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.12",
+  "engineVersion": "1.67.20",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -15,7 +15,6 @@
     "test:baseunit": "mocha test/unit/adapterBaseTestUnit.js --LOG=error",
     "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
     "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
-    "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
     "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
     "adapter:install": "npm i && node utils/tbScript.js install",
     "adapter:checkMigrate": "node utils/checkMigrate.js",
@@ -43,20 +42,20 @@
   ],
   "license": "Apache-2.0",
   "engines": {
-    "node": ">= 8.0.0",
+    "node": ">= 14.0.0",
     "npm": ">= 6.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:itentialopensource/adapters/cloud/adapter-oracle_cloud.git"
+    "url": "git@gitlab.com:itentialopensource/adapters/adapter-oracle_cloud.git"
   },
   "author": "Itential",
-  "homepage": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-oracle_cloud#readme",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-oracle_cloud#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.3.8",
+    "@itentialopensource/adapter-utils": "^5.5.0",
     "acorn": "^8.10.0",
     "ajv": "^8.12.0",
-    "axios": "^1.6.7",
+    "axios": "^1.6.8",
     "commander": "^11.0.0",
     "dns-lookup-promise": "^1.0.4",
     "fs-extra": "^11.1.1",
@@ -64,7 +63,6 @@
     "mocha": "^10.3.0",
     "mocha-param": "^2.0.1",
     "mongodb": "^4.16.0",
-    "nyc": "^15.1.0",
     "ping": "^0.4.4",
     "prompts": "^2.4.2",
     "readline-sync": "^1.4.10",

package/propertiesSchema.json

@@ -945,6 +945,11 @@
     "devicebroker": {
       "type": "object",
       "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether or not the device broker calls have been mapped",
+          "default": false
+        },
         "getDevice": {
           "type": "array",
           "description": "Broker call(s) to getDevice",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.2.0",
-  "configLines": 12789,
+  "version": "0.3.3",
+  "configLines": 12794,
   "scriptLines": 1783,
   "codeLines": 12805,
-  "testLines": 10701,
+  "testLines": 10700,
   "testCases": 535,
-  "totalCodeLines": 25289,
+  "totalCodeLines": 25288,
   "wfTasks": 140
 }