Merge pull request matplotlib#27470 from QuLogic/fix-test-viz

oscargus · web-flow · commit 8fa89d621f03 · 2023-12-08T16:50:06.000+01:00
Fix test visualization tool for non-PNG files
diff --git a/tools/triage_tests.py b/tools/triage_tests.py
@@ -241,7 +241,7 @@ def __init__(self, path, root, source):
             if basename.endswith(f'_{ext}'):
                 display_extension = f'_{ext}'
                 extension = ext
-                basename = basename[:-4]
+                basename = basename[:-len(display_extension)]
                 break
         else:
             display_extension = ''
diff --git a/tools/visualize_tests.py b/tools/visualize_tests.py
@@ -10,8 +10,14 @@
 import os
 from collections import defaultdict
 
-
-html_template = """<html><head><style media="screen" type="text/css">
+# Non-png image extensions
+NON_PNG_EXTENSIONS = ['pdf', 'svg', 'eps']
+
+html_template = """<!DOCTYPE html>
+<html lang="en"><head>
+<meta charset="utf-8">
+<title>Matplotlib test result visualization</title>
+<style media="screen">
 img{{
   width:100%;
   max-width:800px;
@@ -24,14 +30,18 @@
 """
 
 subdir_template = """<h2>{subdir}</h2><table>
-<thead><td>name</td><td>actual</td><td>expected</td><td>diff</td></thead>
+<thead><tr><th>name</th><th>actual</th><th>expected</th><th>diff</th></tr></thead>
+<tbody>
 {rows}
+</tbody>
 </table>
 """
 
 failed_template = """<h2>Only Failed</h2><table>
-<thead><td>name</td><td>actual</td><td>expected</td><td>diff</td></thead>
+<thead><tr><th>name</th><th>actual</th><th>expected</th><th>diff</th></tr></thead>
+<tbody>
 {rows}
+</tbody>
 </table>
 """
 
@@ -68,28 +78,41 @@ def run(show_browser=True):
             fn, fext = os.path.splitext(file)
             if fext != ".png":
                 continue
-            # Always use / for URLs.
             if "-failed-diff" in fn:
-                pictures[fn[:-12]]["f"] = "/".join((subdir, file))
+                file_type = 'diff'
+                test_name = fn[:-len('-failed-diff')]
             elif "-expected" in fn:
-                pictures[fn[:-9]]["e"] = "/".join((subdir, file))
+                for ext in NON_PNG_EXTENSIONS:
+                    if fn.endswith(f'_{ext}'):
+                        display_extension = f'_{ext}'
+                        extension = ext
+                        fn = fn[:-len(display_extension)]
+                        break
+                else:
+                    display_extension = ''
+                    extension = 'png'
+                file_type = 'expected'
+                test_name = fn[:-len('-expected')] + display_extension
             else:
-                pictures[fn]["c"] = "/".join((subdir, file))
+                file_type = 'actual'
+                test_name = fn
+            # Always use / for URLs.
+            pictures[test_name][file_type] = '/'.join((subdir, file))
 
         subdir_rows = []
         for name, test in sorted(pictures.items()):
-            expected_image = test.get('e', '')
-            actual_image = test.get('c', '')
+            expected_image = test.get('expected', '')
+            actual_image = test.get('actual', '')
 
-            if 'f' in test:
+            if 'diff' in test:
                 # A real failure in the image generation, resulting in
                 # different images.
                 status = " (failed)"
-                failed = f'<a href="{test["f"]}">diff</a>'
+                failed = f'<a href="{test["diff"]}">diff</a>'
                 current = linked_image_template.format(actual_image)
                 failed_rows.append(row_template.format(name, "", current,
                                                        expected_image, failed))
-            elif 'c' not in test:
+            elif 'actual' not in test:
                 # A failure in the test, resulting in no current image
                 status = " (failed)"
                 failed = '--'
