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

README.md

@@ -398,6 +398,40 @@ HTTP call to the platform:<br/>
   }
   ```
 
+### fetchDeviceDetails:
+
+- Request:<br>
+  Making a call to fetch device details and the token required for dynamically fetching details .<br>
+
+  Format:
+  ```
+   {
+    "method": "fcs.fetchDeviceDetails",
+    "params": <deviceId>
+  }
+
+  ```
+  Examples:
+  ```
+   {
+
+    "method": "fcs.fetchDeviceDetails",
+    "params": "354444327"
+  }
+   ```
+- Response:<br>
+  Receives the updated environment variable device_data with dynamic device details.
+Example:
+
+  ```
+  {
+    "DEVICEID": "354444327",
+    "DEVICE_TYPE": "ipstb",
+    "DEVICE_MODEL": "VALUE",
+     ...
+}
+  ```
+
 ## Interaction Log service
 
 See [Interaction_Logs,md](/Docs//Interaction_Logs.md)

cypress/plugins/testDataProcessor.js

@@ -280,14 +280,8 @@ function testDataHandler(requestType, dataIdentifier, fireboltObject) {
                       if (!deviceMac) {
                         logger.info('Falling back to default device data path');
                       }
-                      let deviceData = fetchAndParseDataFromJson(deviceDataPath, data.type);
-                      if (deviceData === CONSTANTS.NO_DATA) {
-                        logger.info(
-                          `Expected deviceData not found for ${data.type}. Returning ${data.type} as is.`
-                        );
-                        deviceData = data.type;
-                      }
-                      data.type = deviceData;
+                      const deviceData = fetchDataFromFile(deviceDataPath);
+                      envVariables[CONSTANTS.DEVICE_DATA] = deviceData;
                       break;
 
                     default:

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',
@@ -192,6 +195,7 @@ module.exports = {
   CUSTOM: 'custom',
   VALIDATION_FUNCTION: 'validationFunction',
   NOT_SUPPORTED: 'NOT_SUPPORTED',
+  FETCH_DEVICE_DETAILS_DYNAMICALLY_FLAG: 'fetch_device_details_dynamically',
   FIRST_PARTY_APPID: 'firstPartyAppId',
   GENERATE_HTML_REPORT: true,
   GETEVENTRESPONSE_ERROR_MSG: 'Received error: Requested listener not found',
@@ -362,6 +366,7 @@ module.exports = {
     SETFIREBOLTINTERACTIONSHANDLER: 'fcs.setFireboltInteractionsHandler',
     CREATE_MARKER: 'performance.createMarker',
     UNLOADAPP: 'fcs.unloadApp',
+    FETCHDEVICEDETAILS: 'fcs.fetchDeviceDetails',
   },
   REQUEST_MAP_INTERACTIONS_SERVICE: 'Request map for firebolt interactions service : ',
   RESPONSE: 'Response: ',

cypress/support/step_definitions/testSetup.js

@@ -54,6 +54,23 @@ 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 (Cypress.env(CONSTANTS.FETCH_DEVICE_DETAILS_DYNAMICALLY_FLAG)) {
+      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

@@ -63,6 +63,32 @@ Given(
             : CONSTANTS.NULL_RESPONSE;
           const expectingError = item.expectingError;
           const isNullCase = item.isNullCase || false;
+          // check if the dynamic device details env is present
+          if (
+            Cypress.env(CONSTANTS.DEVICE_DATA) &&
+            Object.keys(Cypress.env(CONSTANTS.DEVICE_DATA)).length > 0
+          ) {
+            let type;
+            // if the validation object used for current validation contains the required data
+            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 &&
+                  contentObject.data[i].validations[0].mode == CONSTANTS.DEVICE_CONTENT_VALIDATION
+                ) {
+                  type = contentObject.data[i].validations[0].type;
+                  // if the dynamic device details env contains the validation key
+                  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

cypress/support/step_definitions/validations.md

@@ -445,6 +445,88 @@ While validating, if a key is present in both fcs-validation jsons (eg: cypress/
         ]
 }
 
+# Dynamic Content Validation
+
+### Background:
+For the fixture validations mentioned in [Supported Validations](./validations.md#supported-validations), deviceContentValidation is used when the validation is done based on device specific value.
+For eg :
+
+```
+    "DEVICE_ID": {
+        "data": [
+            {
+                "type": "fixture",
+                "validations": [
+                    {
+                        "mode": "deviceContentValidation",
+                        "type": "DEVICEID",
+                        "description": "Validation of the Device Id Format"
+                    }
+                ]
+            }
+        ]
+    }
+
+```
+
+When the validation mode is "deviceContentValidation", the source of truth for the validation can be taken in two ways:
+1. Static data 
+2. Dynamic data
+
+Static data :
+For static data, the source of truth is stored in a <deviceMac.json> file placed [here](../../fixtures/external/devices/) based on the deviceMac value being tested. When the test begins, these values are loaded into an object stored in an environment variable called deviceData. If deviceMac.json is not found in the specified path, the values are saved as they are, for example: DEVICEID: "DEVICEID".
+
+Dynamic data :
+For dynamic data, the source of truth is fetched from the configModule's override function called "fetchDeviceDetails" explained [here](https://github.com/rdkcentral/firebolt-certification-suite?tab=readme-ov-file#request-overrides).
+
+### Usage :
+
+To fetch dynamic data from configModule, set an environment variable fetch_device_details_dynamically as true in the [supportConfig.json](../../../supportConfig.json). If this environment variable is true, dynamic details will be fetched from configModule based on the platform and override the existing environment variable deviceData, which holds the static data from <deviceMac.json>.
+
+If the dynamic device details fetching fails in configModule, the data will default to the static data. FCS expects the source of truth to be generated for the modules listed in [DYNAMIC_DEVICE_DETAILS_MODULES](../constants/constants.js). 
+
+
+### Implementation :
+
+The configModule should have an override function "fetchDeviceDetails" as explained [here](https://github.com/rdkcentral/firebolt-certification-suite?tab=readme-ov-file#request-overrides). This function should fetch the data and return it in the format specified below. If deviceId, deviceType, and distributor values need to be extracted, they should be saved as "DEVICEID", "DEVICE_TYPE", and "DEVICE_DISTRIBUTOR" keys, as these are the key names used in the validationObject. These values will then replace the values in <device-mac.json> stored in the environment variable "DEVICE_DATA" in FCS.
+
+When the test starts, deviceId is passed from FCS to this override function for the modules listed in [DYNAMIC_DEVICE_DETAILS_MODULES](../constants/constants.js) as the only parameter, which is later used to extract device details. If the data contains multiple objects, the required device details are fetched by mapping them with the corresponding deviceId passed from FCS to configModule.
+For example, if activeDevicedata is the dynamic device response, the data extraction will be as follows:
+
+#### Format
+
+```
+    if (activeDevicedata.id == deviceId) {
+      extractedData.DEVICEID = activeDevicedata.id;
+      extractedData.DEVICE_TYPE = activeDevicedata.data.deviceType;
+      extractedData.DEVICE_DISTRIBUTOR = deviceData[0].data.partner;
+
+    }
+    Cypress.env(CONSTANTS.DEVICE_DATA, extractedData);
+```
+
+### Example :
+From FCS, the override function is invoked in the following format:
+Format:
+  ```
+   {
+    "method": "fcs.fetchDeviceDetails",
+    "params": <deviceId>
+  }
+
+The response by overriding the static values in the environment will be as follows:
+Example:
+
+  ```
+  {
+    "DEVICEID": "354444327",
+    "DEVICE_TYPE": "ipstb",
+    "DEVICE_MODEL": "VALUE",
+     ...
+}
+  ```
+
+
 ## Error Content Validation
 
 ### Background