feat: added support in env setup glue for fetching device details dynamically

cypress/support/constants/constants.js

@@ -84,10 +84,12 @@ module.exports = {
   DEVICEMODULEFORMAT: 'deviceModelFormat',
   DEVICE_AUDIO: 'device.audio',
   DEVICE_CONTENT_VALIDATION: 'deviceContentValidation',
+  DEVICE_DATA: 'deviceData',
   DEVICE_ENV: 'Device',
   DEVICE_FIRMWARE: 'Device Firmware',
   DEVICE_HDCP: 'device.hdcp',
   DEVICE_HDR: 'device.hdr',
+  DEVICE_ID: 'device.id',
   DEVICE_IP: 'deviceIp',
   DEVICE_MAC: 'deviceMac',
   DEVICE_MAC_UNAVAILABLE: 'Device MAC unavailable',
@@ -99,6 +101,7 @@ module.exports = {
   DEVICE_PLATFORM: 'device.platform',
   DEVICE_VIDEORESOLUTION: 'device.videoResolution',
   DISCOVERY_LAUNCH: 'discovery.launch',
+  DYNAMIC_DEVICE_DETAILS_MODULES: ['Device'],
   EMAIL: 'email',
   ENV_PLATFORM_SDK_VERSION: 'platformSdkVersion',
   ENV_PLATFORM: 'platform',
@@ -351,6 +354,7 @@ module.exports = {
     PERFORMANCE_THRESHOLD_VALIDATOR: 'performance.fetchPerformanceThreshold',
     CREATE_MARKER: 'performance.createMarker',
     UNLOADAPP: 'fcs.unloadApp',
+    FETCHDEVICEDETAILS: 'fcs.fetchDeviceDetails',
   },
   PERFORMANCE_METRICS: 'performanceMetrics',
   RESPONSE: 'Response: ',

cypress/support/step_definitions/testSetup.js

@@ -55,6 +55,21 @@ Given('the environment has been set up for {string} tests', (test) => {
     if (Cypress.env(CONSTANTS.TEST_TYPE).includes('rpc-Only')) {
       Cypress.env(CONSTANTS.IS_RPC_ONLY, true);
     }
+    // fetch device details dynamically
+    if (CONSTANTS.DYNAMIC_DEVICE_DETAILS_MODULES.includes(Cypress.env(CONSTANTS.TEST_TYPE))) {
+      cy.getDeviceData(CONSTANTS.DEVICE_ID, {}, CONSTANTS.ACTION_CORE.toLowerCase()).then(
+        (response) => {
+          if (response) {
+            const method = CONSTANTS.REQUEST_OVERRIDE_CALLS.FETCHDEVICEDETAILS;
+            const requestMap = {
+              method: method,
+              params: response,
+            };
+            cy.sendMessagetoPlatforms(requestMap);
+          }
+        }
+      );
+    }
   }
 });
 

cypress/support/step_definitions/validations.js

@@ -64,6 +64,31 @@ Given(
           const expectingError = item.expectingError;
           const isNullCase = item.isNullCase || false;
 
+          if (CONSTANTS.DYNAMIC_DEVICE_DETAILS_MODULES.includes(Cypress.env(CONSTANTS.TEST_TYPE))) {
+            if (
+              Cypress.env(CONSTANTS.DEVICE_DATA) &&
+              Object.keys(Cypress.env(CONSTANTS.DEVICE_DATA)).length > 0
+            ) {
+              let type;
+              if (contentObject && contentObject.data) {
+                for (let i = 0; i < contentObject.data.length; i++) {
+                  if (
+                    contentObject.data[i].validations &&
+                    contentObject.data[i].validations[0] &&
+                    contentObject.data[i].validations[0].type
+                  ) {
+                    type = contentObject.data[i].validations[0].type;
+                  }
+                  if (Cypress.env(CONSTANTS.DEVICE_DATA).hasOwnProperty(type)) {
+                    contentObject.data[i].validations[0].type = Cypress.env(CONSTANTS.DEVICE_DATA)[
+                      type
+                    ];
+                  }
+                }
+              }
+            }
+          }
+
           // If the app ID is not passed from the feature, the default app ID will be retrieved.
           appId = !appId
             ? UTILS.getEnvVariable(CONSTANTS.THIRD_PARTY_APP_ID)

cypress/support/step_definitions/validations.md

@@ -446,6 +446,25 @@ While validating, if a key is present in both fcs-validation jsons (eg: cypress/
         ]
 }
 
+# Dynamic Content Validation
+
+For deviceContentValidation, the source of truth is fetched from an external API, which is dependent on the configuration module or platform on which we are testing. For the validation part, an override module called "fetchDeviceDetails" is expected to be in configModule to fetch the device details with the corresponding Urls mentioned for each config to fetch the data. DeviceId is passed from fcs to this override module as the only parameter, which is later used for fetching device details in the "configHelper" module.
+
+The fetched data from configHelper is returned to corresponding configModule where the required data is extracted and saved to an env called "DEVICE_DATA". The data from configHelper is saved to this env as an object with the key names as the validation-key.
+Initially, it maps to required object with the key as "deviceMac", if the device data is having multiple objects.
+Later, for eg:, if deviceId and deviceType values are to be extracted, we will save the value into "DEVICEID" and "DEVICE_TYPE" keynames, as these are the keynames used in the validationObject.
+For eg:, if activeDevicedata is the device response, the data extraction will be as follows :
+
+#### Format
+
+```
+    if (activeDevicedata.id == deviceId) {
+      extractedData.DEVICEID = activeDevicedata.id;
+      extractedData.DEVICE_TYPE = activeDevicedata.data.deviceType;
+    }
+    Cypress.env(CONSTANTS.DEVICE_DATA, extractedData);
+```
+
 
 ## Error Content Validation