html

Author: Cadair

pytest_mpl/plugin.py

@@ -147,9 +147,10 @@ def pytest_addoption(parser):
     group.addoption('--mpl-hash-library',
                     help="json library of image hashes, relative to "
                     "location where py.test is run", action='store')
-    group.addoption('--mpl-generate-summary', action='store_true',
-                    help="Generate a summary HTML report of any failed tests"
-                    ", in --mpl-results-path")
+    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, the only format supported at the moment is `html`.")
 
     results_path_help = "directory for test results, relative to location where py.test is run"
     group.addoption('--mpl-results-path', help=results_path_help, action='store')
@@ -261,7 +262,7 @@ def __init__(self,
                  results_dir=None,
                  hash_library=None,
                  generate_hash_library=None,
-                 generate_summary=False
+                 generate_summary=None
                  ):
         self.config = config
         self.baseline_dir = baseline_dir
@@ -270,7 +271,9 @@ def __init__(self,
         self.results_dir = path_is_not_none(results_dir)
         self.hash_library = path_is_not_none(hash_library)
         self.generate_hash_library = path_is_not_none(generate_hash_library)
-        self.generate_summary = bool(generate_summary)
+        if generate_summary and generate_summary.lower() not in ("html",):
+            raise ValueError(f"The mpl summary type '{generate_summary}' is not supported.")
+        self.generate_summary = generate_summary
 
         # Generate the containing dir for all test results
         if not self.results_dir:
@@ -611,7 +614,7 @@ def pytest_unconfigure(self, config):
             with open(hash_library_path, "w") as fp:
                 json.dump(self._generated_hash_library, fp, indent=2)
 
-        if self.generate_summary:
+        if self.generate_summary and self.generate_summary.lower() == 'html':
             # Generate a list of test directories
             dir_list = [p.relative_to(self.results_dir)
                         for p in self.results_dir.iterdir() if p.is_dir()]

tests/test_pytest_mpl.py

@@ -292,7 +292,7 @@ def test_hash_fails(tmpdir):
     assert "Unable to find baseline image" not in output, output
 
     # Check that the summary path is printed and that it exists.
-    output = assert_pytest_fails_with(['--mpl', test_file, '--mpl-generate-summary'],
+    output = assert_pytest_fails_with(['--mpl', test_file, '--mpl-generate-summary=html'],
                                       "doesn't match hash FAIL in library")
     # We didn't specify a baseline dir so we shouldn't attempt to find one
     print_message = "A summary of the failed tests can be found at:"