Integrate interactive HTML

Author: ConorMacBride

pytest_mpl/plugin.py

@@ -43,7 +43,9 @@
 
 import pytest
 
-SUPPORTED_FORMATS = {'html', 'json'}
+from pytest_mpl.summary.html import generate_summary_html
+
+SUPPORTED_FORMATS = {'html', 'json', 'basic-html'}
 
 SHAPE_MISMATCH_ERROR = """Error: Image dimensions did not match.
   Expected shape: {expected_shape}
@@ -162,7 +164,7 @@ def pytest_addoption(parser):
     group.addoption('--mpl-generate-summary', action='store',
                     help="Generate a summary report of any failed tests"
                     ", in --mpl-results-path. The type of the report should be "
-                    "specified. Supported types are `html` and `json`. "
+                    "specified. Supported types are `html`, `json` and `basic-html`. "
                     "Multiple types can be specified separated by commas.")
 
     results_path_help = "directory for test results, relative to location where py.test is run"
@@ -732,11 +734,11 @@ def generate_stats(self):
                 raise ValueError(f"Unknown test status '{test['status']}'.")
         self._test_stats = stats
 
-    def generate_summary_html(self):
+    def generate_summary_basic_html(self):
         """
         Generate a simple HTML table of the failed test results
         """
-        html_file = self.results_dir / 'fig_comparison.html'
+        html_file = self.results_dir / 'fig_comparison_basic.html'
         with open(html_file, 'w') as f:
 
             passed = f"{self._test_stats['passed']} passed"
@@ -849,7 +851,10 @@ def pytest_unconfigure(self, config):
                 summary = self.generate_summary_json()
                 print(f"A JSON report can be found at: {summary}")
             if 'html' in self.generate_summary:
-                summary = self.generate_summary_html()
+                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()
                 print(f"A summary of the failed tests can be found at: {summary}")
 
 

setup.cfg

@@ -23,12 +23,14 @@ long_description_content_type = text/x-rst
 [options]
 zip_safe = True
 packages = find:
+include_package_data = True
 python_requires = >=3.6
 install_requires =
     pytest
     matplotlib
     importlib_resources;python_version<'3.8'
     packaging
+    Jinja2
 
 [options.entry_points]
 pytest11 =

tests/test_pytest_mpl.py

@@ -441,11 +441,16 @@ def test_results_always(tmpdir):
     code = call_pytest(['--mpl', test_file, '--mpl-results-always',
                         rf'--mpl-hash-library={hash_library}',
                         rf'--mpl-baseline-path={baseline_dir_abs}',
-                        '--mpl-generate-summary=html,json',
+                        '--mpl-generate-summary=html,json,basic-html',
                         rf'--mpl-results-path={results_path.strpath}'])
     assert code == 0  # hashes correct, so all should pass
 
-    comparison_file = results_path.join('fig_comparison.html')
+    # assert files for interactive HTML exist
+    assert results_path.join('fig_comparison.html').exists()
+    assert results_path.join('styles.css').exists()
+    assert results_path.join('extra.js').exists()
+
+    comparison_file = results_path.join('fig_comparison_basic.html')
     with open(comparison_file, 'r') as f:
         html = f.read()