Add Test for Matrix, Fix Scoreboard Typo

Author: iguessthislldo

.github/workflows/tests.yml

@@ -17,6 +17,6 @@ jobs:
       - name: Install Perl dependencies
         run: |
           sudo apt-get update
-          sudo apt-get install libwww-perl
+          sudo apt-get install libwww-perl libfile-copy-recursive-perl
       - name: Run Tests
         run: perl run_tests.pl

common/betterparser.pm

@@ -11,7 +11,7 @@ use File::Basename;
 use POSIX qw(strftime);
 use B qw(perlstring);
 
-use utility::common;
+use common::utility;
 
 ##############################################################################
 # Constructor

common/prettify.pm

@@ -974,7 +974,6 @@ sub Subsection ($)
     if ($self->{in_tests}) {
         my $test = {
             name => $name,
-            extra_name => undef,
             result => undef,
             time => undef,
             subsection => $subsec,
@@ -1008,9 +1007,6 @@ sub Normal ($)
             $test->{time} = $finished->[1];
             $test->{result} = $finished->[2];
         }
-        elsif ($line =~ /^The CMake name of this test is "(.*)"/) {
-            $test->{extra_name} = $1;
-        }
     }
 }
 

testmatrix/HTMLScoreboard.py

@@ -10,6 +10,7 @@
 import os
 import time
 import json
+import html
 from pathlib import Path
 from io import StringIO
 from contextlib import contextmanager
@@ -114,8 +115,9 @@ def begin(self):
         attrs = self._attrs.copy()
         if self._classes:
             attrs['class'] = ' '.join(self._classes)
-        if attrs:
-            rv += ' ' + ' '.join([f'{k}="{v}"' for k, v in attrs.items()])
+        for k, v in attrs.items():
+            v = html.escape(str(v))
+            rv += f' {k}="{html.escape(v)}"'
         return rv + '>'
 
     def end(self):
@@ -124,7 +126,8 @@ def end(self):
     def __str__(self):
         rv = self.begin()
         if self.text is not None:
-            rv += str(self.text) + self.end()
+            text = str(self.text) if type(self.text) is Tag else html.escape(str(self.text))
+            rv += text + self.end()
         return rv
 
 

testmatrix/matrix.js

@@ -2,7 +2,6 @@ window.addEventListener('load', (event) => {
     document.querySelectorAll('.test_results td').forEach((td) => {
         var buildn = td.getAttribute('build');
         var build = build_info[buildn];
-        console.log(build);
         if (build) {
             // Put build name in tooltip
             td.setAttribute('title', `#${buildn} ${build.name}`);
@@ -18,7 +17,6 @@ window.addEventListener('load', (event) => {
                     url += 'Full';
                 }
                 a.href = `${url}.html#subsection_${test_subsec}`;
-                // a.textContent = td.textContent;
                 td.replaceChildren(a);
             }
         }

testmatrix/matrix.py

@@ -135,9 +135,6 @@ def __init__(self, name: str, result: int, time: timedelta, misc=None):
         if misc is None:
             misc = {}
         self.name = name
-        extra_name = misc.get('extra_name', None)
-        if extra_name:
-            self.name += ' ' + misc['extra_name']
         self.subsection = misc['subsection']
         self.result = result
         assert type(time) is timedelta

tests/scoreboard/MultiRun/run_test.pl

@@ -5,7 +5,11 @@
 use strict;
 use warnings;
 
+use File::Path qw(make_path remove_tree);
 use FindBin;
+
+use File::Copy::Recursive qw(dircopy fcopy);
+
 use constant autobuild_root => "$FindBin::Bin/../../../";
 $ENV{'PATH'} = "$ENV{'PATH'}:" . autobuild_root;
 use lib autobuild_root;
@@ -14,38 +18,30 @@
 use common::utility;
 use common::test_utils;
 
-use File::Path qw(make_path remove_tree);
-
 my $runs = "runs";
 my $run = "$runs/run";
 my $run1 = "$runs/run1";
 my $run2 = "$runs/run2";
 
 sub run_cmd {
-  my $cmd = shift;
-  print "$cmd\n";
-  return system($cmd);
-}
-
-sub copy_to ($;$) {
-  my $des_dir = shift;
-  my $src_dir = shift // $run;
-  run_cmd("cp -R $src_dir $des_dir");
+    my $cmd = shift();
+    print("RUN: $cmd\n");
+    die() if (!utility::run_command($cmd));
 }
 
 sub run_scoreboard {
-  run_cmd("scoreboard.pl -c -f ./test.xml -o test.html -d $run");
+    run_cmd("scoreboard.pl -c -f ./runs/test.xml -o test.html -d $run");
 }
 
 sub compare_runs {
-  my $r = 0;
-  my $index = "build1/index.html";
-  my $total = "build3/2021_03_09_17_33_Totals.html";
-  $r += compare_files("$run1/$index", "$run2/$index");
-  $r += compare_files("$run1/$index", "$run/$index");
-  $r += compare_files("$run1/$total", "$run2/$total");
-  $r += compare_files("$run1/$total", "$run/$total");
-  return $r;
+    my $r = 0;
+    my $index = "build1/index.html";
+    my $total = "build3/2021_03_09_17_33_Totals.html";
+    $r += compare_files("$run1/$index", "$run2/$index");
+    $r += compare_files("$run1/$index", "$run/$index");
+    $r += compare_files("$run1/$total", "$run2/$total");
+    $r += compare_files("$run1/$total", "$run/$total");
+    return $r;
 }
 
 remove_tree($runs);
@@ -55,21 +51,22 @@ sub compare_runs {
 }
 
 make_path($runs);
-copy_to($run, "../build_logs");
+fcopy("../build_logs/test.xml", $runs);
+dircopy("../build_logs", $run);
 
 run_scoreboard();
-copy_to($run1);
 
+dircopy($run, $run1);
 run_scoreboard();
-copy_to($run2);
 
+dircopy($run, $run2);
 run_scoreboard();
-my $exit_status = compare_runs();
 
+my $exit_status = compare_runs();
 if ($exit_status) {
-  print("Test Failed\n");
+    print("Test Failed\n");
 }
 else {
-  print("Test Passed\n");
+    print("Test Passed\n");
 }
 exit ($exit_status);

tests/scoreboard/MultiRun/test.xml tests/scoreboard/build_logs/test.xmltests/scoreboard/MultiRun/test.xml renamed to tests/scoreboard/build_logs/test.xml

@@ -1,4 +1,8 @@
 <scoreboard>
+  <prop matrix_title="This title has &lt;HTML&gt; entities &quot;&lt;"/>
+  <prop matrix_basename="test"/>
+  <prop source_link="https://github.com/OpenDDS/OpenDDS/blob/master/"/>
+
   <group>
     <name>Group 1</name>
     <build>

tests/scoreboard/matrix/.gitignore

@@ -0,0 +1 @@
+/builds

tests/scoreboard/matrix/run_test.pl

@@ -0,0 +1,42 @@
+eval '(exit $?0)' && eval 'exec perl -S $0 ${1+"$@"}'
+  & eval 'exec perl -S $0 $argv:q'
+  if 0;
+
+use strict;
+use warnings;
+
+use File::Path qw(make_path remove_tree);
+use FindBin;
+
+use File::Copy::Recursive qw(dircopy);
+
+use constant scoreboard_tests => "$FindBin::Bin/../";
+use constant build_logs => scoreboard_tests . "build_logs/";
+use constant autobuild_root => scoreboard_tests . "../../";
+$ENV{'PATH'} = "$ENV{'PATH'}:" . autobuild_root;
+use lib autobuild_root;
+chdir ($FindBin::Bin);
+
+use common::utility;
+use common::test_utils;
+
+sub run_cmd {
+    my $cmd = shift();
+    print("RUN: $cmd\n");
+    die() if (!utility::run_command($cmd));
+}
+
+sub run_scoreboard {
+    my $dest = shift() // 'builds';
+    my $src = shift() // build_logs;
+
+    my $name = 'test';
+    my $xml = "$src/$name.xml";
+    my $html = "$name.html";
+    remove_tree($dest);
+    dircopy($src, $dest);
+    run_cmd("scoreboard.pl -c -f $xml -o $html -d $dest");
+}
+
+run_scoreboard();
+run_cmd("matrix.py builds");