Move basic HTML to Jinja

ConorMacBride · ConorMacBride · commit c315776c305e · 2022-02-02T11:04:42.000Z
diff --git a/pytest_mpl/plugin.py b/pytest_mpl/plugin.py
@@ -43,7 +43,7 @@
 
 import pytest
 
-from pytest_mpl.summary.html import generate_summary_html
+from pytest_mpl.summary.html import generate_summary_html, generate_summary_basic_html
 
 SUPPORTED_FORMATS = {'html', 'json', 'basic-html'}
 
@@ -53,37 +53,6 @@
   Actual shape: {actual_shape}
     {actual_path}"""
 
-HTML_INTRO = """
-<!DOCTYPE html>
-<html>
-<head>
-<style>
-table, th, td {
-    border: 1px solid black;
-}
-.summary > div {
-    padding: 0.5em;
-}
-tr.passed .status, .rms.passed, .hashes.passed {
-    color: green;
-}
-tr.failed .status, .rms.failed, .hashes.failed {
-    color: red;
-}
-</style>
-</head>
-<body>
-<h2>Image test comparison</h2>
-%summary%
-<table>
-  <tr>
-    <th>Test Name</th>
-    <th>Baseline image</th>
-    <th>Diff</th>
-    <th>New image</th>
-  </tr>
-"""
-
 
 def _download_file(baseline, filename):
     # Note that baseline can be a comma-separated list of URLs that we can
@@ -714,105 +683,6 @@ def item_function_wrapper(*args, **kwargs):
         else:
             item.obj = item_function_wrapper
 
-    def generate_stats(self):
-        """
-        Generate a dictionary of summary statistics.
-        """
-        stats = {'passed': 0, 'failed': 0, 'passed_baseline': 0, 'failed_baseline': 0, 'skipped': 0}
-        for test in self._test_results.values():
-            if test['status'] == 'passed':
-                stats['passed'] += 1
-                if test['rms'] is not None:
-                    stats['failed_baseline'] += 1
-            elif test['status'] == 'failed':
-                stats['failed'] += 1
-                if test['rms'] is None:
-                    stats['passed_baseline'] += 1
-            elif test['status'] == 'skipped':
-                stats['skipped'] += 1
-            else:
-                raise ValueError(f"Unknown test status '{test['status']}'.")
-        self._test_stats = stats
-
-    def generate_summary_basic_html(self):
-        """
-        Generate a simple HTML table of the failed test results
-        """
-        html_file = self.results_dir / 'fig_comparison_basic.html'
-        with open(html_file, 'w') as f:
-
-            passed = f"{self._test_stats['passed']} passed"
-            if self._test_stats['failed_baseline'] > 0:
-                passed += (" hash comparison, although "
-                           f"{self._test_stats['failed_baseline']} "
-                           "of those have a different baseline image")
-
-            failed = f"{self._test_stats['failed']} failed"
-            if self._test_stats['passed_baseline'] > 0:
-                failed += (" hash comparison, although "
-                           f"{self._test_stats['passed_baseline']} "
-                           "of those have a matching baseline image")
-
-            f.write(HTML_INTRO.replace('%summary%', f'<p>{passed}.</p><p>{failed}.</p>'))
-
-            for test_name in sorted(self._test_results.keys()):
-                summary = self._test_results[test_name]
-
-                if not self.results_always and summary['result_image'] is None:
-                    continue  # Don't show test if no result image
-
-                if summary['rms'] is None and summary['tolerance'] is not None:
-                    rms = (f'<div class="rms passed">\n'
-                           f'  <strong>RMS:</strong> '
-                           f'  &lt; <span class="tolerance">{summary["tolerance"]}</span>\n'
-                           f'</div>')
-                elif summary['rms'] is not None:
-                    rms = (f'<div class="rms failed">\n'
-                           f'  <strong>RMS:</strong> '
-                           f'  <span class="rms">{summary["rms"]}</span>\n'
-                           f'</div>')
-                else:
-                    rms = ''
-
-                hashes = ''
-                if summary['baseline_hash'] is not None:
-                    hashes += (f'  <div class="baseline">Baseline: '
-                               f'{summary["baseline_hash"]}</div>\n')
-                if summary['result_hash'] is not None:
-                    hashes += (f'  <div class="result">Result: '
-                               f'{summary["result_hash"]}</div>\n')
-                if len(hashes) > 0:
-                    if summary["baseline_hash"] == summary["result_hash"]:
-                        hash_result = 'passed'
-                    else:
-                        hash_result = 'failed'
-                    hashes = f'<div class="hashes {hash_result}">\n{hashes}</div>'
-
-                images = {}
-                for image_type in ['baseline_image', 'diff_image', 'result_image']:
-                    if summary[image_type] is not None:
-                        images[image_type] = f'<img src="{summary[image_type]}" />'
-                    else:
-                        images[image_type] = ''
-
-                f.write(f'<tr class="{summary["status"]}">\n'
-                        '  <td>\n'
-                        '    <div class="summary">\n'
-                        f'      <div class="test-name">{test_name}</div>\n'
-                        f'      <div class="status">{summary["status"]}</div>\n'
-                        f'      {rms}{hashes}\n'
-                        '  </td>\n'
-                        f'  <td>{images["baseline_image"]}</td>\n'
-                        f'  <td>{images["diff_image"]}</td>\n'
-                        f'  <td>{images["result_image"]}</td>\n'
-                        '</tr>\n\n')
-
-            f.write('</table>\n')
-            f.write('</body>\n')
-            f.write('</html>')
-
-        return html_file
-
     def generate_summary_json(self):
         json_file = self.results_dir / 'results.json'
         with open(json_file, 'w') as f:
@@ -845,16 +715,14 @@ def pytest_unconfigure(self, config):
                     if self._test_results[test_name][image_type] == '%EXISTS%':
                         self._test_results[test_name][image_type] = str(directory / filename)
 
-            self.generate_stats()
-
             if 'json' in self.generate_summary:
                 summary = self.generate_summary_json()
                 print(f"A JSON report can be found at: {summary}")
             if 'html' in self.generate_summary:
                 summary = generate_summary_html(self._test_results, self.results_dir)
                 print(f"A summary of the failed tests can be found at: {summary}")
             if 'basic-html' in self.generate_summary:
-                summary = self.generate_summary_basic_html()
+                summary = generate_summary_basic_html(self._test_results, self.results_dir)
                 print(f"A summary of the failed tests can be found at: {summary}")
 
 
diff --git a/pytest_mpl/summary/html.py b/pytest_mpl/summary/html.py
@@ -4,7 +4,7 @@
 
 from jinja2 import Environment, PackageLoader, select_autoescape
 
-__all__ = ['generate_summary_html']
+__all__ = ['generate_summary_html', 'generate_summary_basic_html']
 
 
 class Results:
@@ -43,6 +43,24 @@ def __init__(self, results, title="Image comparison"):
             self.cards += [Result(name, item, card_id, self.warn_missing)]
         self.cards = sorted(self.cards, key=lambda i: i.indexes['status'], reverse=True)
 
+    @cached_property
+    def statistics(self):
+        """Generate a dictionary of summary statistics."""
+        stats = {'passed': 0, 'failed': 0, 'passed_baseline': 0,
+                 'failed_baseline': 0, 'skipped': 0}
+        for test in self.cards:
+            if test.status == 'passed':
+                stats['passed'] += 1
+                if test.image_status != 'match':
+                    stats['failed_baseline'] += 1
+            elif test.status == 'failed':
+                stats['failed'] += 1
+                if test.image_status == 'match':
+                    stats['passed_baseline'] += 1
+            elif test.status == 'skipped':
+                stats['skipped'] += 1
+        return stats
+
 
 class Result:
     """
@@ -234,3 +252,32 @@ def generate_summary_html(results, results_dir):
         f.write(html + '\n')
 
     return html_file
+
+
+def generate_summary_basic_html(results, results_dir):
+    """Generate the basic HTML summary.
+
+    Parameters
+    ----------
+    results : dict
+        The `pytest_mpl.plugin.ImageComparison._test_results` object.
+    results_dir : Path
+        Path to the output directory.
+    """
+
+    # Initialize Jinja
+    env = Environment(
+        loader=PackageLoader("pytest_mpl.summary.html"),
+        autoescape=select_autoescape()
+    )
+
+    # Render HTML starting from the base template
+    template = env.get_template("basic.html")
+    html = template.render(results=Results(results))
+
+    # Write files
+    html_file = results_dir / 'fig_comparison_basic.html'
+    with open(html_file, 'w') as f:
+        f.write(html + '\n')
+
+    return html_file
diff --git a/pytest_mpl/summary/templates/basic.html b/pytest_mpl/summary/templates/basic.html
@@ -0,0 +1,81 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <style>
+        table, th, td {
+            border: 1px solid black;
+        }
+
+        td:first-child {
+            padding: 1em;
+        }
+
+        td div {
+            padding: 0.15em 0;
+            max-width: 20rem;
+            overflow-wrap: break-word;
+        }
+
+        .test-name {
+            font-size: 1.5em;
+        }
+
+        .status {
+            padding: 0.8em 0;
+        }
+
+        img {
+            width: 100%;
+        }
+    </style>
+    <title>{{ results.title }}</title>
+</head>
+<body>
+<h2>Image test comparison</h2>
+<p>
+    {{ results.statistics['passed'] }} passed
+    {% if results.statistics['failed_baseline'] > 0 -%}
+    hash comparison, although {{ results.statistics['failed_baseline'] }}
+    of those have a different baseline image
+    {%- endif %}
+</p>
+<p>
+    {{ results.statistics['failed'] }} failed
+    {% if results.statistics['passed_baseline'] > 0 -%}
+    hash comparison, although {{ results.statistics['passed_baseline'] }}
+    of those have a matching baseline image
+    {%- endif %}
+</p>
+<table>
+    <tr>
+        <th></th>
+        <th>Baseline</th>
+        <th>Diff</th>
+        <th>Result</th>
+    </tr>
+    {% for result in results.cards -%}
+    {% if result.result_image -%}
+    <tr>
+        <td>
+            <div>{{ result.module }}</div>
+            <div class="test-name">{{ result.name }}</div>
+            <div class="status">{{ result.status | upper }}</div>
+            <div>RMS: {{ result.rms_str }} ({{ result.image_status }})</div>
+            {% if result.result_hash -%}
+            <div>Result hash: {{ result.result_hash }} ({{ result.hash_status}})</div>
+            {%- endif %}
+        </td>
+        {% macro image(file) -%}
+        <td>{% if file %}<img src="{{ file }}">{% endif %}</td>
+        {%- endmacro -%}
+        {{ image(result.baseline_image) }}
+        {{ image(result.diff_image) }}
+        {{ image(result.result_image) }}
+    </tr>
+    {%- endif %}
+    {%- endfor %}
+</table>
+</body>
+</html>
diff --git a/tests/test_pytest_mpl.py b/tests/test_pytest_mpl.py
@@ -467,7 +467,7 @@ def test_results_always(tmpdir):
 
         test_name = f'test.{test}'
 
-        summary = f'<div class="test-name">{test_name}</div>'
+        summary = f'<div class="test-name">{test_name.split(".")[-1]}</div>'
         assert summary in html
 
         assert test_name in json_results.keys()
