TAG-0.10.0 tag creation for 0.10.0

README.md

@@ -13,23 +13,26 @@ It has the following features -
 
 ## Table of Contents
 
-- [Brief overview](#brief-overview)
-- [Setup](#setup)
-  - [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)
-- [Supported targets](#supported-targets)
-- [Supported Modes of execution](#supported-modes-of-execution)
-- [Supported validations](#supported-validations)
-- [Supported ways of retrieving reports](#supported-ways-of-retrieving-reports)
-- [Supported Report Parameters](#supported-report-parameters)
-- [PR and merge process](#pr-and-merge-process)
-- [Supported URL parameters](#supported-url-parameters)
-- [Supported PubSub Handlers](#supported-pubsub-handlers)
-- [Plugins](#plugins)
-- [Connect to mock Firebolt OS](#connect-to-mock-firebolt-os)
-  - [Timeout in UI prompt](#timeout-in-ui-prompt)
-
+- [firebolt-certification-app](#firebolt-certification-app)
+  - [Brief overview](#brief-overview)
+  - [Table of Contents](#table-of-contents)
+  - [Setup](#setup)
+    - [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)
+  - [Supported targets](#supported-targets)
+  - [Supported Modes of execution](#supported-modes-of-execution)
+  - [Supported validations](#supported-validations)
+  - [Supported ways of retrieving reports](#supported-ways-of-retrieving-reports)
+  - [Supported Report Parameters](#supported-report-parameters)
+  - [PR and merge process](#pr-and-merge-process)
+  - [Supported URL parameters](#supported-url-parameters)
+  - [Supported Intent Parameters](#supported-intent-parameters)
+  - [Supported PubSub Handlers](#supported-pubsub-handlers)
+  - [Plugins](#plugins)
+  - [Connect to mock Firebolt OS](#connect-to-mock-firebolt-os)
+    - [Timeout in UI prompt](#timeout-in-ui-prompt)
+
 ## Setup
 
 Use a recent version of node. At the time of writing, Node 14.15.x was LTS. An `.nvmrc` file is included for those using a node version manager. Everyone else, swim at your own risk.
@@ -112,7 +115,33 @@ Mode of execution implies the way in which an API is invoked. There are 2 modes
   - If FCA systemui=true, FCA acts as the base app in case of ripple. The background color will be changed to purple and it will display one more button as "Launch FCA app" to launch FCA as third-party app on Ripple devices.
 - TestContext: testContext=true
   - If testContext=true, it will add the field context in mocha report generated
-
+- AppId: appId=`<appId>`
+  - `appId` used to launch the app.
+- Mac Address: macAddress=`<macAddress>`
+  -  `macAddress` of the device running the tests.
+- appType: appType=`<appType>`
+  -  `appType` is the type of app being launched.
+- Pub Sub Subscribe suffix : pubSubSubscribeSuffix=`<pubSubSubscribeSuffix>`
+  -  `pubSubSubscribeSuffix` is the subscribe suffix value used for Pub Sub communication.
+- Pub Sub Publish suffix : pubSubPublishSuffix=`<pubSubPublishSuffix>`
+  -  `pubSubPublishSuffix` is the publish suffix value used for Pub Sub communication.
+
+## Supported Intent Parameters
+- appType:
+  - Classifier for the app - Launch the certification app for certification validations. Launching a firebolt app for app certification.
+- appId: 
+  - When `appId` is specified in the intent, it will be used to launch the app.
+- macAddress: 
+  -  When `macAddress` is specified in the intent, it indicates the mac address of the device running the tests.
+- PubSub Publish Suffix: 
+  -  When `pubSubPublishSuffix` is specified in the intent, it publishes to the topic.
+- PubSub Subscribe Suffix: 
+  -  When `pubSubSubscribeSuffix` is specified in the intent, it subscribes to the topic.
+- pubSubUrl: 
+  - Sets the the url to use for a PubSub server.
+- registerprovider: 
+  - When `registerProvider = false`, then certification app will not register for userInterest provider.
+
 ## Supported PubSub Handlers
 
 The code for handling different types of PubSub requests is located in `./src/pubsub/handlers`. Below are the supported handlers for various types of PubSub requests.

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.0.0",
+  "version": "0.10.0",
   "name": "firebolt-certification",
   "description": "Reference App to demonstrate Firebolt APIs and Lifecycle",
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.0.9",
-    "@firebolt-js/manage-sdk": "1.0.0",
-    "@firebolt-js/sdk": "1.0.0",
-    "@lightningjs/core": "*",
+    "@firebolt-js/manage-sdk": "0.1.0-next.1",
+    "@firebolt-js/sdk": "0.10.0",
+    "@lightningjs/core": "2.11.0",
     "@lightningjs/sdk": "^5.0.1",
     "@lightningjs/ui-components": "^2.2.2",
     "dotenv": "^14.2.0",
@@ -16,11 +16,11 @@
     "glob-parent": "^5.1.2",
     "json-schema-ref-parser": "^9.0.9",
     "jsonschema": "^1.4.0",
-    "lzutf8": "0.6.0",
     "perf_hooks": "^0.0.1",
     "rxjs": "7.2.0",
     "uuid": "^9.0.0",
-    "winston": "^3.8.2",
+    "winston": "3.15.0",
+    "winston-transport": "4.7.1",
     "xml2js": "^0.5.0"
   },
   "scripts": {

src/App.js

@@ -32,12 +32,11 @@ import PinChallengeProviderDelegater from './providers/PinChallengeDelegater';
 import KeyboardProviderDelegater from './providers/KeyboardProviderDelegater';
 import AckChallengeProviderDelegater from './providers/AckChallengeDelegater';
 const logger = require('./utils/Logger')('App.js');
-import FireboltTransportInvoker from './FireboltTransportInvoker';
 import { handleAsyncFunction } from './utils/Utils';
 import { withAnnouncer } from '@lightningjs/ui-components';
 const Base = withAnnouncer(lng.Application);
 import Toast, { eventEmitter } from './Toast';
-import IntentReader from './IntentReader';
+import IntentReader from 'IntentReader';
 
 export default class App extends Base {
   static _template() {
@@ -100,18 +99,28 @@ export default class App extends Base {
     const testContext = new URLSearchParams(window.location.search).get('testContext');
     const reportingId = new URLSearchParams(appUrl.search).get('reportingId');
     const standalone = new URLSearchParams(appUrl.search).get('standalone');
+    const standalonePrefix = new URLSearchParams(appUrl.search).get('standalonePrefix');
     this.systemui = new URLSearchParams(window.location.search).get('systemui');
-    this.testToken = new URLSearchParams(window.location.search).get('testtoken');
     this.pubSubUuidPresent = false;
     this.appContinue = false;
     process.env.LIFECYCLE_VALIDATION = lifecycle;
     process.env.MOCKOS = false;
     process.env.MF_VALUE = false;
     testContext ? (process.env.TESTCONTEXT = JSON.parse(testContext)) : (process.env.TESTCONTEXT = false);
     process.env.TESTCONTEXT = true; // Making TESTCONTEXT = true by default. This line will be removed in later stages when required
-    process.env.TEST_TOKEN = this.testToken;
     process.env.REPORTINGID = reportingId;
     process.env.STANDALONE = standalone;
+    process.env.STANDALONE_PREFIX = standalonePrefix;
+    process.env.ID = 0;
+    process.env.MACADDRESS = new URLSearchParams(appUrl.search).get('macaddress');
+    process.env.CURRENT_APPID = new URLSearchParams(appUrl.search).get('appId');
+    process.env.APP_TYPE = new URLSearchParams(appUrl.search).get('appType');
+    process.env.PUB_SUB_URL = new URLSearchParams(appUrl.search).get('pubSubUrl');
+    process.env.PUB_SUB_TOKEN = new URLSearchParams(appUrl.search).get('pubSubToken');
+    process.env.PUBSUB_SUBSCRIBE_TOPIC_SUFFIX = new URLSearchParams(appUrl.search).get('pubSubSubscribeSuffix');
+    process.env.PUBSUB_PUBLISH_TOPIC_SUFFIX = new URLSearchParams(appUrl.search).get('pubSubPublishSuffix');
+    process.env.SDKS_AVAILABLE = [...CONSTANTS.defaultSDKs, ...CONSTANTS.additionalSDKs];
+    process.env.REGION = new URLSearchParams(appUrl.search).get('region');
     if (platform) {
       process.env.PLATFORM = platform;
     } else {
@@ -149,7 +158,6 @@ export default class App extends Base {
       this.pubSubListener();
     }
     getCurrentAppID().then((res) => {
-      process.env.APPID = res;
       this._setState('LoadingState');
     });
   }
@@ -377,6 +385,13 @@ export default class App extends Base {
           if (lifecycle_validationString == true) {
             process.env.LIFECYCLE_VALIDATION = 'true';
           }
+          if (query.params.pubSubPublishSuffix) {
+            process.env.PUBSUB_PUBLISH_TOPIC_SUFFIX = query.params.pubSubPublishSuffix;
+          }
+
+          if (query.params.pubSubSubscribeSuffix) {
+            process.env.PUBSUB_SUBSCRIBE_TOPIC_SUFFIX = query.params.pubSubSubscribeSuffix;
+          }
 
           process.env.APP_TYPE = query.params.appType ? query.params.appType.toLowerCase() : CONSTANTS.FIREBOLT_CONST;
 
@@ -393,18 +408,26 @@ export default class App extends Base {
             console.log('Error getting App Id :: ', err);
           }
 
-          if (query.params.testtoken) {
-            process.env.TEST_TOKEN = query.params.testtoken;
-          } else {
-            logger.error('No Test Token Found in Parameter Initialization response...', 'getParameterInitializationValues');
-          }
-
           if (query.params.macaddress) {
             process.env.MACADDRESS = query.params.macaddress;
           } else {
             logger.error('No Mac Address Found in Parameter Initialization response...', 'getParameterInitializationValues');
           }
+          // Set the pubSub URL if present
+          if (query.params.pubSubUrl) {
+            process.env.PUB_SUB_URL = query.params.pubSubUrl;
+          }
 
+          // Set the pubSub token if present
+          if (query.params.pubSubToken) {
+            process.env.PUB_SUB_TOKEN = query.params.pubSubToken;
+          }
+
+          // Set the region if present
+          if (query.params.region) {
+            process.env.REGION = query.params.region;
+          }
+
           if (query.task) {
             setTimeout(() => {
               const intentReader = new IntentReader();

src/EventInvocation.js

@@ -23,7 +23,7 @@
 //   * Return results of all the events
 // ************* End Description **********
 
-import { dereferenceOpenRPC, errorSchemaCheck, rpcEventHandler } from './utils/Utils';
+import { dereferenceOpenRPC, errorSchemaCheck } from './utils/Utils';
 import { MODULE_MAP } from './FireboltExampleInvoker';
 import { CONSTANTS } from './constant';
 import Transport from '@firebolt-js/sdk/dist/lib/Transport/index.mjs';
@@ -39,7 +39,9 @@ class EventHandler {
     this.moduleWithEventName = moduleWithEventName;
     const event = moduleWithEventName.split('.')[1];
     this.eventName = this.parseEventName(event);
-    this.eventSchema = this.getSchema(moduleWithEventName, schemaList);
+    if (process.env.STANDALONE == true) {
+      this.eventSchema = this.getSchema(moduleWithEventName, schemaList);
+    }
     this.initializationTime = new Date();
     this.eventListener = null;
   }
@@ -69,14 +71,24 @@ class EventHandler {
   }
   // Handle, parse and store the resolved event data from listener
   handleEvent(eventData) {
-    const eventSchemaResponse = this.eventSchemaValidation(eventData);
-    const eventDataObject = {
-      eventName: this.eventName,
-      eventListenerId: this.eventListener.eventListenerId,
-      eventResponse: eventData,
-      eventSchemaResult: eventSchemaResponse,
-      eventTime: new Date(),
-    };
+    let eventDataObject;
+    if (process.env.STANDALONE == true) {
+      const eventSchemaResponse = this.eventSchemaValidation(eventData);
+      eventDataObject = {
+        eventName: this.eventName,
+        eventListenerId: this.eventListener.eventListenerId,
+        eventResponse: eventData,
+        eventSchemaResult: eventSchemaResponse,
+        eventTime: new Date(),
+      };
+    } else {
+      eventDataObject = {
+        eventName: this.eventName,
+        eventListenerId: this.eventListener.id,
+        eventResponse: eventData,
+        eventTime: new Date(),
+      };
+    }
     eventHistory.push(eventDataObject);
   }
   // Schema validation for resolved event data
@@ -107,53 +119,68 @@ class EventHandler {
 export class EventInvocation {
   // This method accepts the message params and return the listener response and schema response
   async northBoundEventHandling(message) {
-    let responseCode;
     const eventParams = message.params;
     const moduleWithEventName = eventParams.event;
     const params = eventParams.params;
     const [listenerResponse, uniqueListenerKey] = await this.registerEvent(moduleWithEventName, params);
 
     const registrationResponse = {};
-    registrationResponse['eventName'] = moduleWithEventName;
-    registrationResponse['eventListenerId'] = uniqueListenerKey;
-    if (listenerResponse && Number.isInteger(listenerResponse) && listenerResponse > 0) {
-      registrationResponse['eventListenerResponse'] = {
-        listenerResponse: listenerResponse,
-        error: null,
-      };
+    if (process.env.STANDALONE == true) {
+      registrationResponse['eventName'] = moduleWithEventName;
+      registrationResponse['eventListenerId'] = uniqueListenerKey;
+      if (listenerResponse && Number.isInteger(listenerResponse) && listenerResponse > 0) {
+        registrationResponse['eventListenerResponse'] = {
+          listenerResponse: listenerResponse,
+          error: null,
+        };
       // Handling not supported api to check error schema if it gives a valid response
       let schemaValidationResult = {};
       let schemaValidationStatus = CONSTANTS.PASS;
       if (message.params.isNotSupportedApi == true) {
         schemaValidationResult = errorSchemaCheck(listenerResponse);
         schemaValidationStatus = CONSTANTS.FAIL;
       }
-      registrationResponse['eventListenerSchemaResult'] = {
-        status: schemaValidationStatus,
-        eventSchemaResult: schemaValidationResult,
-      };
-      eventHandlerMap.get(uniqueListenerKey).setEventListener(registrationResponse);
-    } else {
-      if (CONSTANTS.ERROR_LIST.includes(listenerResponse.message)) {
-        responseCode = CONSTANTS.STATUS_CODE[3];
-        registrationResponse['responseCode'] = responseCode;
-      }
-      registrationResponse['eventListenerResponse'] = { result: null, error: listenerResponse };
-      // In case of error, validate error against errorschema
-      const schemaValidationResult = errorSchemaCheck(listenerResponse);
-      if (schemaValidationResult && schemaValidationResult.errors && schemaValidationResult.errors.length > 0) {
         registrationResponse['eventListenerSchemaResult'] = {
-          status: CONSTANTS.FAIL,
-          eventSchemaResult: {},
+          status: schemaValidationStatus,
+          eventSchemaResult: schemaValidationResult,
         };
+        eventHandlerMap.get(uniqueListenerKey).setEventListener(registrationResponse);
       } else {
-        registrationResponse['eventListenerSchemaResult'] = {
-          status: CONSTANTS.PASS,
-          eventSchemaResult: schemaValidationResult,
+        if (CONSTANTS.ERROR_LIST.includes(listenerResponse.message)) {
+          const responseCode = CONSTANTS.STATUS_CODE[3];
+          registrationResponse['responseCode'] = responseCode;
+        }
+        registrationResponse['eventListenerResponse'] = { result: null, error: listenerResponse };
+        // In case of error, validate error against errorschema
+        const schemaValidationResult = errorSchemaCheck(listenerResponse);
+        if (schemaValidationResult && schemaValidationResult.errors && schemaValidationResult.errors.length > 0) {
+          registrationResponse['eventListenerSchemaResult'] = {
+            status: CONSTANTS.FAIL,
+            eventSchemaResult: {},
+          };
+        } else {
+          registrationResponse['eventListenerSchemaResult'] = {
+            status: CONSTANTS.PASS,
+            eventSchemaResult: schemaValidationResult,
+          };
+        }
+      }
+      return registrationResponse;
+    } else {
+      registrationResponse['jsonrpc'] = '2.0';
+      registrationResponse['id'] = null;
+      if (listenerResponse && Number.isInteger(listenerResponse) && listenerResponse > 0) {
+        registrationResponse['id'] = listenerResponse;
+        registrationResponse['result'] = {
+          listening: true,
+          event: moduleWithEventName,
         };
+        eventHandlerMap.get(uniqueListenerKey).setEventListener(registrationResponse);
+      } else {
+        registrationResponse['error'] = listenerResponse;
       }
+      return registrationResponse;
     }
-    return registrationResponse;
   }
 
   // This method will listen to event and capture the event response after triggering
@@ -298,8 +325,13 @@ export class EventInvocation {
   // Return the event response object for the eventName passed as the param
   getEventResponse(message) {
     try {
+      let filteredEventDataObjectList;
       const eventName = message.params.event;
-      const filteredEventDataObjectList = eventHistory.filter((element) => element.eventListenerId == eventName);
+      if (process.env.STANDALONE == true) {
+        filteredEventDataObjectList = eventHistory.filter((element) => element.eventListenerId == eventName);
+      } else {
+        filteredEventDataObjectList = eventHistory.filter((element) => element.eventListenerId.toString() == eventName.split('-').pop());
+      }
       if (filteredEventDataObjectList.length) {
         const eventDataObject = filteredEventDataObjectList[filteredEventDataObjectList.length - 1];
         return eventDataObject;