errorschema fix (#208)

* FIRECERT-2274-errorschema fix * FIRECERT-2274-parse fix * FIRECERT-2274-dummy commit * FIRECERT-2274-reverted dummy commit
rdkcentral · Sep 2, 2024 · 80b6610 · 80b6610
1 parent 1b722d4
commit 80b6610
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 73 deletions.
diff --git a/src/EventInvocation.js b/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,

diff --git a/src/MethodInvoker.js b/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];

diff --git a/src/Test_Runner.js b/src/Test_Runner.js
@@ -36,7 +36,7 @@ const utils = require('./utils/Utils');
 import LifecycleHistory from './LifeCycleHistory';
 import { Device } from '@firebolt-js/sdk';
 import { MODULE_MAP } from './FireboltExampleInvoker';
-import errorSchema from './source/errorSchema.json';
+import errorSchemaObject from './source/errorSchema.json';
 const $RefParser = require('@apidevtools/json-schema-ref-parser');
 const Validator = require('jsonschema').Validator;
 const validator = new Validator();
@@ -52,7 +52,7 @@ const TAG = '[Test_Runner]: ';
  */
 let execMode;
 let invokedSdk;
-let errorSchemaBasedOnMode;
+let errorSchemaValue;
 
 /*
 Start and End time of API invocation
@@ -103,7 +103,7 @@ export class Test_Runner {
     const resultStartTime = new Date();
     let suiteStartTime = new Date();
     let errorSchemaResult;
-    errorSchemaBasedOnMode = process.env.COMMUNICATION_MODE == CONSTANTS.TRANSPORT ? errorSchema[CONSTANTS.ERROR_SCHEMA_TRANSPORT] : errorSchema[CONSTANTS.ERROR_SCHEMA_SDK];
+    errorSchemaValue = errorSchemaObject.errorSchema;
 
     // This is the list of validation Results for each api ,This is the list that will be used for creating the report
     for (const executionMode of execModes) {
@@ -204,9 +204,9 @@ export class Test_Runner {
                 }
                 if (this.methodFilters.isExceptionMethod(methodObj.name, example.params)) {
                   if (method.examples[exampleIndex].schema) {
-                    method.examples[exampleIndex].schema = errorSchemaBasedOnMode;
+                    method.examples[exampleIndex].schema = errorSchemaValue;
                   } else {
-                    method.result.schema = errorSchemaBasedOnMode;
+                    method.result.schema = errorSchemaValue;
                   }
                 }
                 if (communicationMode == CONSTANTS.TRANSPORT) {
@@ -1222,15 +1222,15 @@ export class Test_Runner {
     let obj;
     const NOT_SUPPORTED_ERROR_MESSAGES = ['Unsupported', 'Not supported', 'not supported'];
     const errMessage = '{"code":' + error.code + ',"message":' + error.message + '}';
-    const schemaValidationResult = errorSchemaCheck(error, process.env.COMMUNICATION_MODE);
+    const schemaValidationResult = errorSchemaCheck(error);
     if (schemaValidationResult && schemaValidationResult.errors && schemaValidationResult.errors.length > 0) {
       obj = {
         error: error,
         param: example.params,
         errorSchemaResult: true,
         methodWithExampleName: methodWithExampleName,
         methodUuid: this.createUUID(),
-        schemaData: errorSchemaBasedOnMode,
+        schemaData: errorSchemaValue,
         apiExecutionStartTime: apiExecutionStartTime,
         apiExecutionEndTime: apiExecutionEndTime,
       };

diff --git a/src/constant.js b/src/constant.js
@@ -172,6 +172,4 @@ export const CONSTANTS = {
   EXCLUDED_METHODS_FOR_MFOS: [],
   ...CONFIG_CONSTANTS,
   VERSIONS: 'Versions',
-  ERROR_SCHEMA_TRANSPORT: 'errorSchemaTransport',
-  ERROR_SCHEMA_SDK: 'errorSchemaSDK',
 };
diff --git a/src/source/errorSchema.json b/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.)."
+      }
     }
-}
+  }
+}
diff --git a/src/utils/Utils.js b/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');
@@ -292,11 +292,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;
 }