Set platform order from generation scripts (#502)

Craig Cornelius · web-flow · commit a6ee92f50616 · 2025-08-08T14:11:21.000-07:00
* Provide a way to reorder the executors in the summary table using command line of verifier

* Updating Summary Dashboard to handle platform_order options in verifier

* Minor fixes

* As per comments
diff --git a/genData100.sh b/genData100.sh
@@ -133,7 +133,10 @@ pushd verifier
 
 all_test_types=$(jq '.[].run.test_type' ../$source_file | jq -s '.' | jq 'add' | jq 'unique' | jq -r 'join(" ")')
 all_execs=$(jq -r 'join(" ")' <<< $all_execs_json)
-python3 verifier.py --file_base ../$TEMP_DIR --exec $all_execs --test_type $all_test_types
+
+# Specifies the arrangement of the columns in the summary dashboard
+platform_order='ICU4C ICU4J ICU4X NodeJS Dart_Web Dart_Native'
+python3 verifier.py --file_base ../$TEMP_DIR --exec $all_execs --test_type $all_test_types --platform_order $platform_order
 
 popd
 
diff --git a/generateDataAndRun.sh b/generateDataAndRun.sh
@@ -147,7 +147,10 @@ pushd verifier
 
 all_test_types=$(jq '.[].run.test_type' ../$source_file | jq -s '.' | jq 'add' | jq 'unique' | jq -r 'join(" ")')
 all_execs=$(jq -r 'join(" ")' <<< $all_execs_json)
-python3 verifier.py --file_base ../$TEMP_DIR --exec $all_execs --test_type $all_test_types
+
+# Specifies the arrangement of the columns in the summary dashboard
+platform_order='ICU4C ICU4J ICU4X NodeJS Dart_Web Dart_Native'
+python3 verifier.py --file_base ../$TEMP_DIR --exec $all_execs --test_type $all_test_types --platform_order $platform_order
 
 popd
 
diff --git a/testdriver/ddtargs.py b/testdriver/ddtargs.py
@@ -39,6 +39,11 @@ def __init__(self):
                 'segmenter',
                 'ALL']
 
+# Note that spaces in an executor name are replaced by '_' here.
+# component_count is an option to sort by number of test types present in test output, with largest cout at the left
+# TODO: when a new platform is added, put it in this option list.
+platform_order_options = ['alphabetic', 'component_count', 'ICU4C', 'ICU4J', 'ICU4X', 'NodeJS', 'Dart_Web', 'Dart_Native']
+
 class DdtArgs():
   def __init__(self, args):
     self.options = None  # A simple namespace with each field
@@ -98,7 +103,16 @@ def __init__(self, args):
     self.parser.add_argument('--run_serial', default=None,
                              help='Set if execution should be done serially. Parallel is the default.')
 
+    # Order the output columns
+    self.parser.add_argument(
+        '--platform_order',
+        action='extend', nargs='*',
+        choices=platform_order_options,
+        help='The order of the platforms in the Summary dashboard, e.g., NodeJS ICU4X Dart_Web',
+        default=None)
+
     self.options = self.parser.parse_args(args)
+
     return
 
   def getOptions(self):
diff --git a/verifier/summary_template.html b/verifier/summary_template.html
@@ -153,24 +153,70 @@
           // Sort output in alpha order by executor and by test_type
           const test_types = Object.keys(exec_summary_json);
           test_types.sort()
-          /* Get all the execs */
+          /* Get all the executed_platforms */
           let tests_by_type_and_exec = {};
 
           // Find all the kinds of executors
           let exec_set = new Set();
+          // And find how many tests are under each platform
+          let exec_test_counts = {};
           for (const test_type of test_types) {
               const tests = exec_summary_json[test_type];
               for (const node_version of tests) {
-                    exec_set.add(node_version['version']['platform'])
+                  let this_exec = node_version['version']['platform'];
+                  exec_set.add(this_exec);
+                  if (this_exec in exec_test_counts) {
+                      exec_test_counts[this_exec] += 1;
+                  } else {
+                      exec_test_counts[this_exec] = 1;
+                  }
+              }
+          }
+
+          // If platform/exec order is specified, use that.
+          let executed_platforms = [];
+          // exec_set includes all those that are represented in the data
+          const platform_order = ["$platform_order"];
+          if (platform_order.length <= 0 || platform_order[0] == 'alphabetic'
+             || platform_order[0] == "None") {
+              // Default is alphabetic sort
+              executed_platforms = Array.from(exec_set).sort();
+          } else {
+              // Provided by the test report
+              // Remove those that are not in the exec_set.
+              if (platform_order[0] == 'component_count') {
+                  // Use to set the order
+                  const entries = Object.entries(exec_test_counts);
+                  // Sort with largest first
+                  entries.sort((a, b) => b[1] - a[1]);
+                  for (const [key, value] of entries) {
+                      executed_platforms.push(key);
+                  }
+              } else {
+                  // Check for "alphabetic", "component_count", and other options.
+                  // Does this preserve order?
+                  // It should not exclude things that are in test results,
+                  // nor include things that are not there.
+                  let execs_missing_set =
+                      new Set(Array.from(exec_set));
+                  for (let platform of platform_order) {
+                      // remove the underscores, too.
+                      const pl2 = platform.replaceAll('_', ' ');
+                      if (exec_set.has(pl2)) {
+                          executed_platforms.push(pl2);
+                          execs_missing_set.delete(pl2);
+                      }
+                  }
+                  // Make sure all the items from exec set are there, too.
+                  execs_missing_set.forEach(platform => executed_platforms.push(platform));
               }
           }
 
-          const execs = Array.from(exec_set).sort();
           let th = table.insertRow();
           let td = th.insertCell();
           td.innerHTML = "Test Type";
 
-          for (const exec of execs) {
+          for (const exec of executed_platforms) {
               td = th.insertCell();
               td.innerHTML = exec;
               td.style.textAlign = 'center';
@@ -185,7 +231,7 @@
               td.innerHTML = test_type
 
               const tests = exec_summary_json[test_type];
-              for (const exec of execs) {
+              for (const exec of executed_platforms) {
                   // Get all the report info for this test and this exec
                   let reports = [];
                   let data = [data_groups];
diff --git a/verifier/testreport.py b/verifier/testreport.py
@@ -1165,6 +1165,9 @@ def __init__(self, file_base):
 
         self.templates = reportTemplate()
 
+        # Order left-to-right of platforms in summary dashboard
+        self.platform_order = []
+
         if self.debug > 1:
             logging.info('SUMMARY REPORT base = %s', self.file_base)
 
@@ -1290,12 +1293,19 @@ def summarize_reports(self):
     def create_summary_html(self):
         # Generate HTML page containing this information
         # Create the template
+
+        platform_string_for_template = None
+        if any(self.platform_order):
+            platform_string_for_template = '", "'.join(self.platform_order)
+
         html_map = {
             'all_platforms': ', '.join(list(self.exec_summary.keys())),
             'all_icu_versions': None,  # TEMP!!!
             'all_tests': ', '.join(list(self.type_summary.keys())),
             'datetime': datetime.now().strftime('%Y-%m-%d %H:%M:%S'),
+            'platform_order': platform_string_for_template
         }
+
         # Create header for each executor
         header_line = ''  # TODO
         html_map['header_line'] = header_line
diff --git a/verifier/verifier.py b/verifier/verifier.py
@@ -129,6 +129,7 @@ def setup_verify_plans(self):
             # Generates exec and test lists from the existing files in
             # testResults directories
             summary_report = SummaryReport(self.file_base)
+
             summary_report.summarize_reports()
             executor_list = summary_report.exec_summary.keys()
             test_list = summary_report.type_summary.keys()
@@ -307,6 +308,11 @@ def create_summary_reports(self):
         summary_report = SummaryReport(self.file_base)
         summary_report.setup_all_test_results()
 
+
+        if self.options.platform_order:
+            # Set the order of the platforms in the summary dashboard
+            summary_report.platform_order = self.options.platform_order
+
         # Get schema summary data to the testReport head
         schema_validation_list = self.schema_results()
 
