fix: Enhance streamer tests

Moved streamer open calls just before execute_command_lists.
Removed zeEventQueryStatus() check from streamer tests since they have a dedicated test.
Adjusted notifyNReport and samplingPeriod values to minimize the test runtimes.
Added a new read function in harness to read specific number of reports.

Related-To: VLCLJ-2365

Signed-off-by: shubham kumar <[email protected]>

Author: shubskmr

conformance_tests/tools/metrics/src/test_metric.cpp

@@ -1183,8 +1183,11 @@ TEST_F(
 
       lzt::execute_command_lists(commandQueue, 1, &commandList, nullptr);
       lzt::event_host_synchronize(eventHandle, UINT64_MAX);
-      std::vector<uint8_t> rawData;
       size_t rawDataSize = 0;
+      std::vector<uint8_t> rawData;
+      rawDataSize = lzt::metric_streamer_read_data_size(metricStreamerHandle, notifyEveryNReports);
+      EXPECT_GT(rawDataSize, 0);
+      rawData.resize(rawDataSize);      
       lzt::metric_streamer_read_data(metricStreamerHandle, notifyEveryNReports,
                                      rawDataSize, &rawData);
 
@@ -1214,6 +1217,9 @@ TEST_F(
     zetMetricStreamerTest,
     GivenValidMetricGroupWhenTimerBasedStreamerIsCreatedThenExpectStreamerToSucceed) {
 
+  /* The time in seconds for the buffer to overflow would be 2 * (notifyEveryNReports * (samplingPeriod/nanoSecToSeconds))
+   * For this test it will be 512 seconds which ensure this limit is never likely to hit even on the slowest of platform
+   */  
   uint32_t notifyEveryNReports = 256;
   uint32_t samplingPeriod = 1000000000;
   for (auto device : devices) {
@@ -1262,8 +1268,11 @@ TEST_F(
       lzt::execute_command_lists(commandQueue, 1, &commandList, nullptr);
       lzt::synchronize(commandQueue, std::numeric_limits<uint64_t>::max());
 
-      std::vector<uint8_t> rawData;
       size_t rawDataSize = 0;
+      std::vector<uint8_t> rawData;
+      rawDataSize = lzt::metric_streamer_read_data_size(metricStreamerHandle, notifyEveryNReports);
+      EXPECT_GT(rawDataSize, 0);
+      rawData.resize(rawDataSize);      
       lzt::metric_streamer_read_data(metricStreamerHandle, notifyEveryNReports,
                                      rawDataSize, &rawData);
 
@@ -1293,7 +1302,11 @@ TEST_F(
    * ZE_RESULT_NOT_READY. Once the expected time has elapsed it will come out of
    * the loop and expect the event to be generated.
    */
-
+  
+  /* The time in seconds for the buffer to overflow would be 2 * (notifyEveryNReports * (samplingPeriod/nanoSecToSeconds))
+   * For this test it will be 9 seconds. The execution time between metric_streamer_open_for_device and synchronize observed on average is less than 50% of this
+   * which ensure this limit is never likely to hit even on the slowest of platform
+   */ 
   uint32_t notifyEveryNReports = 4500;
   for (auto device : devices) {
 
@@ -1392,7 +1405,11 @@ TEST_F(
 TEST_F(
     zetMetricStreamerTest,
     GivenValidMetricGroupWhenTimerBasedStreamerIsCreatedThenExpectStreamerToGenrateCorrectNumberOfReports) {
-
+  
+  /* The time in seconds for the buffer to overflow would be 2 * (notifyEveryNReports * (samplingPeriod/nanoSecToSeconds))
+   * For this test it will be 9 seconds. The execution time between metric_streamer_open_for_device and synchronize observed on average is less than 50% of this
+   * which ensure this limit is never likely to hit even on the slowest of platform
+   */ 
   uint32_t notifyEveryNReports = 4500;
   for (auto device : devices) {
 
@@ -1749,8 +1766,11 @@ void run_ip_sampling_with_validation(
         LOG_WARNING << "elapsed time for workload completion is too short";
       }
 
-      std::vector<uint8_t> rawData;
       size_t rawDataSize = 0;
+      std::vector<uint8_t> rawData;
+      rawDataSize = lzt::metric_streamer_read_data_size(metricStreamerHandle, notifyEveryNReports);
+      EXPECT_GT(rawDataSize, 0);
+      rawData.resize(rawDataSize);      
       lzt::metric_streamer_read_data(metricStreamerHandle, notifyEveryNReports,
                                      rawDataSize, &rawData);
       lzt::validate_metrics(groupInfo.metricGroupHandle, rawDataSize,
@@ -2247,8 +2267,8 @@ TEST(
   eventPool.create_event(eventHandle, ZE_EVENT_SCOPE_FLAG_HOST,
                          ZE_EVENT_SCOPE_FLAG_HOST);
 
-  uint32_t notifyEveryNReports = 3000;
-  uint32_t samplingPeriod = 10000;
+  uint32_t notifyEveryNReports = 4500;
+  uint32_t samplingPeriod = 1000000;
   zet_metric_streamer_handle_t metricStreamerHandle =
       lzt::metric_streamer_open_for_device(device, groupInfo.metricGroupHandle,
                                            eventHandle, notifyEveryNReports,
@@ -2282,10 +2302,13 @@ TEST(
 
     EXPECT_GE(allReportsSize / oneReportSize, notifyEveryNReports);
 
-    std::vector<uint8_t> rawData;
     size_t rawDataSize = 0;
+    std::vector<uint8_t> rawData;
+    rawDataSize = lzt::metric_streamer_read_data_size(metricStreamerHandle, notifyEveryNReports);
+    EXPECT_GT(rawDataSize, 0);
+    rawData.resize(rawDataSize);      
     lzt::metric_streamer_read_data(metricStreamerHandle, notifyEveryNReports,
-                                   rawDataSize, &rawData);
+                                    rawDataSize, &rawData);
     lzt::validate_metrics(groupInfo.metricGroupHandle, rawDataSize,
                           rawData.data());
 
@@ -2330,8 +2353,8 @@ TEST(
   eventPool.create_event(eventHandle, ZE_EVENT_SCOPE_FLAG_HOST,
                          ZE_EVENT_SCOPE_FLAG_HOST);
 
-  uint32_t notifyEveryNReports = 3000;
-  uint32_t samplingPeriod = 10000;
+  uint32_t notifyEveryNReports = 4500;
+  uint32_t samplingPeriod = 1000000;
   zet_metric_streamer_handle_t metricStreamerHandle =
       lzt::metric_streamer_open_for_device(device, groupInfo.metricGroupHandle,
                                            eventHandle, notifyEveryNReports,
@@ -2364,10 +2387,13 @@ TEST(
 
   EXPECT_GE(allReportsSize / oneReportSize, notifyEveryNReports);
 
-  std::vector<uint8_t> rawData;
   size_t rawDataSize = 0;
+  std::vector<uint8_t> rawData;
+  rawDataSize = lzt::metric_streamer_read_data_size(metricStreamerHandle, notifyEveryNReports);
+  EXPECT_GT(rawDataSize, 0);
+  rawData.resize(rawDataSize);      
   lzt::metric_streamer_read_data(metricStreamerHandle, notifyEveryNReports,
-                                 rawDataSize, &rawData);
+                                  rawDataSize, &rawData);
   lzt::validate_metrics(groupInfo.metricGroupHandle, rawDataSize,
                         rawData.data());
 

utils/test_harness/tools/src/test_harness_metric.cpp

@@ -586,9 +586,6 @@ void metric_streamer_read_data(
     zet_metric_streamer_handle_t metricStreamerHandle, uint32_t reports,
     size_t &rawDataSize, std::vector<uint8_t> *metricData) {
   ASSERT_NE(nullptr, metricData);
-  rawDataSize = metric_streamer_read_data_size(metricStreamerHandle, reports);
-  EXPECT_GT(rawDataSize, 0);
-  metricData->resize(rawDataSize);
   EXPECT_EQ(ZE_RESULT_SUCCESS,
             zetMetricStreamerReadData(metricStreamerHandle, reports,
                                       &rawDataSize, metricData->data()));