Show baseline image in HTML when generating

Author: ConorMacBride

pytest_mpl/plugin.py

@@ -390,11 +390,14 @@ def generate_baseline_image(self, item, fig):
         if not os.path.exists(self.generate_dir):
             os.makedirs(self.generate_dir)
 
-        fig.savefig(str((self.generate_dir / self.generate_filename(item)).absolute()),
-                    **savefig_kwargs)
+        baseline_filename = self.generate_filename(item)
+        baseline_path = (self.generate_dir / baseline_filename).absolute()
+        fig.savefig(str(baseline_path), **savefig_kwargs)
 
         close_mpl_figure(fig)
 
+        return baseline_path
+
     def generate_image_hash(self, item, fig):
         """
         For a `matplotlib.figure.Figure`, returns the SHA256 hash as a hexadecimal
@@ -597,6 +600,7 @@ def item_function_wrapper(*args, **kwargs):
                     remove_ticks_and_titles(fig)
 
                 test_name = self.generate_test_name(item)
+                result_dir = self.make_test_results_dir(item)
 
                 summary = {
                     'status': None,
@@ -615,20 +619,20 @@ def item_function_wrapper(*args, **kwargs):
                 if self.generate_dir is not None:
                     summary['status'] = 'skipped'
                     summary['status_msg'] = 'Skipped test, since generating image.'
-                    self.generate_baseline_image(item, fig)
-                    if self.generate_hash_library is None:
-                        self._test_results[str(pathify(test_name))] = summary
-                        pytest.skip("Skipping test, since generating image.")
+                    generate_image = self.generate_baseline_image(item, fig)
+                    if self.results_always:  # Make baseline image available in HTML
+                        result_image = (result_dir / "baseline.png").absolute()
+                        shutil.copy(generate_image, result_image)
+                        summary['baseline_image'] = \
+                            result_image.relative_to(self.results_dir).as_posix()
 
                 if self.generate_hash_library is not None:
                     image_hash = self.generate_image_hash(item, fig)
                     self._generated_hash_library[test_name] = image_hash
-                    summary['result_hash'] = image_hash
+                    summary['baseline_hash'] = image_hash
 
                 # Only test figures if not generating images
                 if self.generate_dir is None:
-                    result_dir = self.make_test_results_dir(item)
-
                     # Compare to hash library
                     if self.hash_library or compare.kwargs.get('hash_library', None):
                         msg = self.compare_image_to_hash_library(item, fig, result_dir, summary=summary)
@@ -645,12 +649,15 @@ def item_function_wrapper(*args, **kwargs):
                             for image_type in ['baseline_image', 'diff_image', 'result_image']:
                                 summary[image_type] = None  # image no longer exists
                     else:
-                        self._test_results[str(pathify(test_name))] = summary
+                        self._test_results[test_name] = summary
                         pytest.fail(msg, pytrace=False)
 
                 close_mpl_figure(fig)
 
-                self._test_results[str(pathify(test_name))] = summary
+                self._test_results[test_name] = summary
+
+                if summary['status'] == 'skipped':
+                    pytest.skip(summary['status_msg'])
 
         if item.cls is not None:
             setattr(item.cls, item.function.__name__, item_function_wrapper)

pytest_mpl/summary/html.py

@@ -117,14 +117,16 @@ def image_status(self):
         elif self.baseline_image is None:
             return 'missing'
         else:
-            raise ValueError('Unknown image result.')
+            return 'generated'
 
     @cached_property
     def hash_status(self):
         """Status of the hash comparison test."""
         if self.baseline_hash is not None or self.result_hash is not None:
             if self.baseline_hash is None:
                 return 'missing'
+            elif self.result_hash is None:
+                return 'generated'
             elif self.baseline_hash == self.result_hash:
                 return 'match'
             else:
@@ -198,6 +200,7 @@ def status_class(status):
         'match': 'success',
         'diff': 'danger',
         'missing': 'warning',
+        'generated': 'warning',
     }
     return classes[status]
 
@@ -208,6 +211,7 @@ def image_status_msg(status):
         'match': 'Baseline image matches',
         'diff': 'Baseline image differs',
         'missing': 'Baseline image not found',
+        'generated': 'Baseline image was generated',
     }
     return messages[status]
 
@@ -218,6 +222,7 @@ def hash_status_msg(status):
         'match': 'Baseline hash matches',
         'diff': 'Baseline hash differs',
         'missing': 'Baseline hash not found',
+        'generated': 'Baseline hash was generated',
     }
     return messages[status]
 

pytest_mpl/summary/templates/result.html

@@ -17,8 +17,10 @@
                     <img src="{{ r.result_image }}" class="card-img-top" alt="result image">
                 </div>
             </div>
-            {%- else -%}
+            {%- elif r.result_image -%}
             <img src="{{ r.result_image }}" class="card-img-top" alt="result image">
+            {%- elif r.baseline_image -%}
+            <img src="{{ r.baseline_image }}" class="card-img-top" alt="baseline image">
             {%- endif %}
         </a>
         {% filter indent(width=8) -%}

pytest_mpl/summary/templates/result_images.html

@@ -6,7 +6,7 @@ <h6><small class="text-muted">{{ r.module }}</small></h6>
     </div>
     <div class="offcanvas-body">
         <h5 class="card-title">{{ r.name }}</h5>
-        {% if results.warn_missing['baseline_image'] -%}
+        {% if results.warn_missing['baseline_image'] and r.image_status != 'generated' -%}
         <div class="row row-cols-1 row-cols-md-3 g-4 mt-3">
             {% macro image_card(file, name) -%}
             <div class="col py-3 m-0">