Dev to Main Merge 9/12

README.md

@@ -18,6 +18,7 @@ It has the following features -
   - [FCA URL deployed and available in the S3](#fca-url-deployed-and-available-in-the-s3)
   - [Below are the steps to run FCA in local system](#below-are-the-steps-to-run-fca-in-local-system)
 - [Supported ways of Execution](#supported-ways-of-execution)
+- [Sanity Suite Flow](./docs/index.md)
 - [Supported targets](#supported-targets)
 - [Supported Modes of execution](#supported-modes-of-execution)
 - [Supported validations](#supported-validations)

docs/index.md

@@ -0,0 +1,7 @@
+# Sanity Suite Flow chart
+
+## Implementation
+![Implementation Diagram](./images/testRunnerFlow.png)
+
+## Generating Report Logs
+![Manual Trigger Diagram](./images/generateAPIValidaionResult.png)

package.json

@@ -1,12 +1,12 @@
 {
-  "version": "1.2.0",
+  "version": "1.3.0",
   "name": "firebolt-certification",
   "description": "Reference App to demonstrate Firebolt APIs and Lifecycle",
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.0.9",
-    "@firebolt-js/discovery-sdk": "1.2.0",
-    "@firebolt-js/manage-sdk": "1.2.0",
-    "@firebolt-js/sdk": "1.2.0",
+    "@firebolt-js/discovery-sdk": "1.3.0",
+    "@firebolt-js/manage-sdk": "1.3.0",
+    "@firebolt-js/sdk": "1.3.0",
     "@lightningjs/core": "2.11.0",
     "@lightningjs/sdk": "^5.0.1",
     "@lightningjs/ui-components": "^2.2.2",

src/EventInvocation.js

@@ -138,7 +138,7 @@ export class EventInvocation {
         let schemaValidationResult = {};
         let schemaValidationStatus = CONSTANTS.PASS;
         if (message.params.isNotSupportedApi == true) {
-          schemaValidationResult = errorSchemaCheck(listenerResponse, process.env.COMMUNICATION_MODE);
+          schemaValidationResult = errorSchemaCheck(listenerResponse);
           schemaValidationStatus = CONSTANTS.FAIL;
         }
         registrationResponse['eventListenerSchemaResult'] = {
@@ -153,7 +153,7 @@ export class EventInvocation {
         }
         registrationResponse['eventListenerResponse'] = { result: null, error: listenerResponse };
         // In case of error, validate error against errorschema
-        const schemaValidationResult = errorSchemaCheck(listenerResponse, process.env.COMMUNICATION_MODE);
+        const schemaValidationResult = errorSchemaCheck(listenerResponse);
         if (schemaValidationResult && schemaValidationResult.errors && schemaValidationResult.errors.length > 0) {
           registrationResponse['eventListenerSchemaResult'] = {
             status: CONSTANTS.FAIL,

src/MethodInvoker.js

@@ -103,7 +103,7 @@ export class MethodInvoker {
       if (process.env.STANDALONE == true) {
         // if the method is not supported and it gives a valid response, validate against errorschema instead of api schema
         if (message.params.isNotSupportedApi == true && response != undefined) {
-          schemaValidationResult = errorSchemaCheck(response, process.env.COMMUNICATION_MODE);
+          schemaValidationResult = errorSchemaCheck(response);
         }
       }
     } catch (error) {
@@ -135,7 +135,7 @@ export class MethodInvoker {
     let apiResponse, responseCode, schemaValidationStatus;
     if (err) {
       apiResponse = { result: null, error: err };
-      schemaValidationResult = errorSchemaCheck(err, process.env.COMMUNICATION_MODE);
+      schemaValidationResult = errorSchemaCheck(err);
       if (schemaValidationResult && schemaValidationResult.errors && schemaValidationResult.errors.length > 0) {
         if (err.message != undefined && CONSTANTS.ERROR_LIST.includes(err.message)) {
           responseCode = CONSTANTS.STATUS_CODE[3];

src/ValidationView.js

@@ -122,7 +122,7 @@ export default class ValidationView extends lng.Component {
         },
         color: 0xff123456,
       },
-      ContentValidationStateText: {
+      Message: {
         x: 530,
         y: 200,
         w: 1920 - 700,
@@ -198,7 +198,7 @@ export default class ValidationView extends lng.Component {
         this.tag('UpdateText').text = CONSTANTS.VALIDATION_SCROLLMESSAGE;
         this.tag('ApititleText').text = '';
         this.tag('SchemaValidationStateText').text = '';
-        this.tag('ContentValidationStateText').text = '';
+        this.tag('Message').text = '';
         this.tag('ValidationData').text = '';
       }
     } else {
@@ -230,45 +230,39 @@ export default class ValidationView extends lng.Component {
     const { err, fail, code } = _displayparms;
     this.tag('ValidationData').color = 0xff123456;
     let schemaValidationStateText = null,
-      contentValidationStateText = null,
+      message = null,
       validationData = null;
     if (code != undefined) {
       let codeObject = null,
         isCodeTypeObject = true,
         messageString = null;
       try {
         codeObject = JSON.parse(_displayparms.code);
-        messageString = codeObject.Message;
-        if (typeof codeObject.Message != 'string') {
-          messageString = JSON.stringify(codeObject.Message, null, 1);
+        messageString = codeObject.Response;
+        if (typeof codeObject.Response != 'string') {
+          messageString = JSON.stringify(codeObject.Response, null, 1);
         }
         isCodeTypeObject = true;
       } catch (err) {
         isCodeTypeObject = false;
       }
       if (isCodeTypeObject) {
-        schemaValidationStateText = CONSTANTS.SCHEMA_VALIDATION_STATUSMESSAGE + codeObject.Schema;
-        contentValidationStateText = CONSTANTS.CONTENT_VALIDATION_STATUSMESSAGE + codeObject.Content;
-        if (fail) {
-          validationData = CONSTANTS.ERROR_MESSAGE + messageString;
-        } else {
-          validationData = CONSTANTS.API_RESPONSE + messageString;
-        }
+        schemaValidationStateText = CONSTANTS.SCHEMA_VALIDATION_STATUSMESSAGE + codeObject['Schema Validation'];
+        message = 'Message: ' + codeObject.Message;
+        validationData = CONSTANTS.API_RESPONSE + messageString;
       } else {
         schemaValidationStateText = CONSTANTS.SCHEMA_VALIDATION_STATUSMESSAGE + CONSTANTS.SCHEMA_CONTENT_SKIPPED;
-        contentValidationStateText = CONSTANTS.CONTENT_VALIDATION_STATUSMESSAGE + CONSTANTS.SCHEMA_CONTENT_SKIPPED;
-        validationData = CONSTANTS.ERROR_MESSAGE + 'JSON parse failed (ValidationView)';
+        validationData = CONSTANTS.API_RESPONSE + 'JSON parse failed (ValidationView)';
       }
     } else {
       // Remove if not needed after testing
       schemaValidationStateText = CONSTANTS.SCHEMA_VALIDATION_STATUSMESSAGE + CONSTANTS.SCHEMA_CONTENT_SKIPPED;
-      contentValidationStateText = CONSTANTS.CONTENT_VALIDATION_STATUSMESSAGE + CONSTANTS.SCHEMA_CONTENT_SKIPPED;
-      validationData = CONSTANTS.ERROR_MESSAGE + 'Received response as undefined';
+      validationData = CONSTANTS.API_RESPONSE + 'Received response as undefined';
     }
     // Updating values in UI
     this.tag('ApititleText').text = CONSTANTS.API_TITLE + _displayparms.fullTitle;
     this.tag('SchemaValidationStateText').text = schemaValidationStateText;
-    this.tag('ContentValidationStateText').text = contentValidationStateText;
+    this.tag('Message').text = message;
 
     /* 
         Schema data for some APIs are large enough to break the render engine.

src/constant.js

@@ -67,7 +67,7 @@ export const CONSTANTS = {
   CONTENT_ERROR: 'Content Error',
   RDK_SERVICES: 'org.rdk.',
   API_TITLE: 'API TITLE: ',
-  API_RESPONSE: 'API Response: ',
+  API_RESPONSE: 'Response: ',
   INVOKE_TEST_MESSAGE: '**** Click Invoke to run tests ****',
   VALIDATION_MESSAGE: '***** Validation Started ******',
   VALIDATION_SCROLLMESSAGE: "Scroll down through the menu's to view the result",
@@ -172,6 +172,6 @@ export const CONSTANTS = {
   EXCLUDED_METHODS_FOR_MFOS: [],
   ...CONFIG_CONSTANTS,
   VERSIONS: 'Versions',
-  ERROR_SCHEMA_TRANSPORT: 'errorSchemaTransport',
-  ERROR_SCHEMA_SDK: 'errorSchemaSDK',
+  NO_RESULT_OR_ERROR_MESSAGE: 'No result or error in response. eg: {jsonrpc: "2.0", id: x }',
+  SCHEMA_VALIDATION: 'Schema Validation',
 };

src/pubsub/handlers/RunTestHandler.js

@@ -71,7 +71,7 @@ export default class RunTestHandler extends BaseHandler {
 
   async getValidationReport(message) {
     const sdkMode = message.action;
-    process.env.COMMUNICATION_MODE = message.context.communicationMode;
+    process.env.COMMUNICATION_MODE = message.context.communicationMode ? message.context.communicationMode : CONSTANTS.TRANSPORT;
 
     const sdkInvokerInfo = new Test_Runner();
     let validatedMenu;

src/source/errorSchema.json

@@ -1,57 +1,23 @@
 {
-    "errorSchemaSDK": {
-        "oneOf": [
-            {
-                "type": "object",
-                "additionalProperties": false,
-                "required": [
-                    "code",
-                    "message"
-                ],
-                "properties": {
-                    "code": {
-                        "title": "errorObjectCode",
-                        "description": "A Number that indicates the error type that occurred. This MUST be an integer. The error codes from and including -32768 to -32000 are reserved for pre-defined errors. These pre-defined errors SHOULD be assumed to be returned from any JSON-RPC api.",
-                        "type": "integer"
-                    },
-                    "message": {
-                        "title": "errorObjectMessage",
-                        "description": "A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.",
-                        "type": "string"
-                    },
-                    "data": {
-                        "title": "errorObjectData",
-                        "description": "A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.)."
-                    }
-                }
-            },
-            {
-                "type": "string"
-            }
-        ]
-    },
-    "errorSchemaTransport": {
-        "type": "object",
-        "additionalProperties": false,
-        "required": [
-            "code",
-            "message"
-        ],
-        "properties": {
-            "code": {
-                "title": "errorObjectCode",
-                "description": "A Number that indicates the error type that occurred. This MUST be an integer. The error codes from and including -32768 to -32000 are reserved for pre-defined errors. These pre-defined errors SHOULD be assumed to be returned from any JSON-RPC api.",
-                "type": "integer"
-            },
-            "message": {
-                "title": "errorObjectMessage",
-                "description": "A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.",
-                "type": "string"
-            },
-            "data": {
-                "title": "errorObjectData",
-                "description": "A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.)."
-            }
-        }
+  "errorSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": ["code", "message"],
+    "properties": {
+      "code": {
+        "title": "errorObjectCode",
+        "description": "A Number that indicates the error type that occurred. This MUST be an integer. The error codes from and including -32768 to -32000 are reserved for pre-defined errors. These pre-defined errors SHOULD be assumed to be returned from any JSON-RPC api.",
+        "type": "integer"
+      },
+      "message": {
+        "title": "errorObjectMessage",
+        "description": "A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.",
+        "type": "string"
+      },
+      "data": {
+        "title": "errorObjectData",
+        "description": "A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.)."
+      }
     }
-}
+  }
+}

src/utils/Utils.js

@@ -18,7 +18,7 @@
 
 import { CONSTANTS } from '../constant';
 import FireboltExampleInvoker from '../FireboltExampleInvoker';
-import errorSchema from '../source/errorSchema.json';
+import errorSchemaObject from '../source/errorSchema.json';
 import censorDataJson from 'CensorData';
 
 const { v4: uuidv4 } = require('uuid');
@@ -117,7 +117,6 @@ async function getschemaValidationDone(name, response, sdkType) {
  * @param response - response of the method
  */
 function censorData(methodName, response) {
-  let json;
   try {
     const json = censorDataJson;
     if (methodName in json) {
@@ -292,11 +291,10 @@ function filterExamples(programlist, programType, offeringType) {
   return offeringList;
 }
 
-function errorSchemaCheck(err, communicationMode) {
+function errorSchemaCheck(err) {
   let schemaValidationResult;
-  if (errorSchema) {
-    const errorSchemaBasedOnMode = communicationMode == CONSTANTS.TRANSPORT ? errorSchema[CONSTANTS.ERROR_SCHEMA_TRANSPORT] : errorSchema[CONSTANTS.ERROR_SCHEMA_SDK];
-    schemaValidationResult = validator.validate(err, errorSchemaBasedOnMode);
+  if (errorSchemaObject) {
+    schemaValidationResult = validator.validate(err, errorSchemaObject.errorSchema);
   }
   return schemaValidationResult;
 }