Download hash library in HTML

Author: ConorMacBride

pytest_mpl/plugin.py

@@ -700,14 +700,18 @@ def pytest_unconfigure(self, config):
                     json.dump(result_hashes, fp, indent=2)
 
         if self.generate_summary:
+            kwargs = {}
             if 'json' in self.generate_summary:
                 summary = self.generate_summary_json()
                 print(f"A JSON report can be found at: {summary}")
+            if result_hash_library.exists():  # link to it in the HTML
+                kwargs["hash_library"] = result_hash_library.name
             if 'html' in self.generate_summary:
-                summary = generate_summary_html(self._test_results, self.results_dir)
+                summary = generate_summary_html(self._test_results, self.results_dir, **kwargs)
                 print(f"A summary of the failed tests can be found at: {summary}")
             if 'basic-html' in self.generate_summary:
-                summary = generate_summary_basic_html(self._test_results, self.results_dir)
+                summary = generate_summary_basic_html(self._test_results, self.results_dir,
+                                                      **kwargs)
                 print(f"A summary of the failed tests can be found at: {summary}")
 
 

pytest_mpl/summary/html.py

@@ -227,7 +227,7 @@ def hash_status_msg(status):
     return messages[status]
 
 
-def generate_summary_html(results, results_dir):
+def generate_summary_html(results, results_dir, hash_library=None):
     """Generate the HTML summary.
 
     Parameters
@@ -236,6 +236,9 @@ def generate_summary_html(results, results_dir):
         The `pytest_mpl.plugin.ImageComparison._test_results` object.
     results_dir : Path
         Path to the output directory.
+    hash_library : str, optional, default=None
+        Filename of the generated hash library at the root of `results_dir`.
+        Will be linked to in HTML if not None.
     """
 
     # Initialize Jinja
@@ -251,7 +254,7 @@ def generate_summary_html(results, results_dir):
 
     # Render HTML starting from the base template
     template = env.get_template("base.html")
-    html = template.render(results=Results(results))
+    html = template.render(results=Results(results), hash_library=hash_library)
 
     # Write files
     for file in ['styles.css', 'extra.js', 'hash.svg', 'image.svg']:
@@ -264,7 +267,7 @@ def generate_summary_html(results, results_dir):
     return html_file
 
 
-def generate_summary_basic_html(results, results_dir):
+def generate_summary_basic_html(results, results_dir, hash_library=None):
     """Generate the basic HTML summary.
 
     Parameters
@@ -273,6 +276,9 @@ def generate_summary_basic_html(results, results_dir):
         The `pytest_mpl.plugin.ImageComparison._test_results` object.
     results_dir : Path
         Path to the output directory.
+    hash_library : str, optional, default=None
+        Filename of the generated hash library at the root of `results_dir`.
+        Will be linked to in HTML if not None.
     """
 
     # Initialize Jinja
@@ -283,7 +289,7 @@ def generate_summary_basic_html(results, results_dir):
 
     # Render HTML starting from the base template
     template = env.get_template("basic.html")
-    html = template.render(results=Results(results))
+    html = template.render(results=Results(results), hash_library=hash_library)
 
     # Write files
     html_file = results_dir / 'fig_comparison_basic.html'

pytest_mpl/summary/templates/basic.html

@@ -48,6 +48,11 @@ <h2>Image test comparison</h2>
     of those have a matching baseline image
     {%- endif %}
 </p>
+{% if hash_library -%}
+<p>
+    <a href="{{ hash_library }}" download>Download generated hash library</a>
+</p>
+{%- endif %}
 <table>
     <tr>
         <th></th>

pytest_mpl/summary/templates/filter.html

@@ -62,5 +62,12 @@ <h5>Show tests which have...</h5>
                 </div>
             </div>
         </form>
+        {% if hash_library -%}
+        <hr>
+        <a download="{{ hash_library }}" href="{{ hash_library }}" class="btn btn-light"
+           data-bs-toggle="tooltip" data-bs-placement="bottom" data-bs-html="true"
+           title="<pre>{{ hash_library }}</pre>"
+           role="button">Download generated hash library</a>
+        {%- endif %}
     </div>
 </div>

pytest_mpl/summary/templates/styles.css

@@ -35,6 +35,9 @@ body.no-hash-test .mpl-hash {
 pre {
     white-space: pre-line;
 }
+.tooltip-inner pre {
+    margin: 0;
+}
 div.result div.status-badge button img {
     vertical-align: sub;
 }