Improve hiding of irrelevant info

ConorMacBride · ConorMacBride · commit 39b8d8381062 · 2022-02-19T23:00:08.000Z
diff --git a/pytest_mpl/summary/html.py b/pytest_mpl/summary/html.py
@@ -26,26 +26,12 @@ class Results:
     def __init__(self, results, title="Image comparison"):
         self.title = title  # HTML <title>
 
-        # If any baseline images or baseline hashes are present,
-        # assume all results should have them
-        self.warn_missing = {'baseline_image': False, 'baseline_hash': False}
-        for key in self.warn_missing.keys():
-            for result in results.values():
-                if result[key] is not None:
-                    self.warn_missing[key] = True
-                    break
-
-        # Additional <body> classes
-        self.classes = []
-        if self.warn_missing['baseline_hash'] is False:
-            self.classes += ['no-hash-test']
-
         # Generate sorted list of results
         self.cards = []
         pad = len(str(len(results.items())))  # maximum length of a result index
         for collect_n, (name, item) in enumerate(results.items()):
             card_id = str(collect_n).zfill(pad)  # zero pad for alphanumerical sorting
-            self.cards += [Result(name, item, card_id, self.warn_missing)]
+            self.cards += [Result(name, item, card_id)]
         self.cards = sorted(self.cards, key=lambda i: i.indexes['status'], reverse=True)
 
     @cached_property
@@ -66,6 +52,22 @@ def statistics(self):
                 stats['skipped'] += 1
         return stats
 
+    @cached_property
+    def image_comparison(self):
+        """Whether at least one image comparison test or generation was performed."""
+        for result in self.cards:
+            if result.image_status:
+                return True
+        return False
+
+    @cached_property
+    def hash_comparison(self):
+        """Whether at least one hash comparison test or generation was performed."""
+        for result in self.cards:
+            if result.hash_status:
+                return True
+        return False
+
 
 class Result:
     """
@@ -81,20 +83,14 @@ class Result:
     id : str
         The test number in order collected. Numbers must be
         zero padded due to alphanumerical sorting.
-    warn_missing : dict
-        Whether to include relevant status badges for images and/or hashes.
-        Must have keys ``baseline_image`` and ``baseline_hash``.
     """
-    def __init__(self, name, item, id, warn_missing):
+    def __init__(self, name, item, id):
         # Make the summary dictionary available as attributes
         self.__dict__ = item
 
         # Sort index for collection order
         self.id = id
 
-        # Whether to show image and/or hash status badges
-        self.warn_missing = warn_missing
-
         # Name of test with module and test function together and separate
         self.full_name = name
         self.name = name.split('.')[-1]
@@ -154,8 +150,6 @@ def badges(self):
         """Additional badges to show beside overall status badge."""
         for test_type, status_getter in [('image', image_status_msg), ('hash', hash_status_msg)]:
             status = getattr(self, f'{test_type}_status')
-            if not self.warn_missing[f'baseline_{test_type}']:
-                continue  # not expected to exist
             if (
                     (status == 'missing') or
                     (self.status == 'failed' and status == 'match') or
diff --git a/pytest_mpl/summary/templates/base.html b/pytest_mpl/summary/templates/base.html
@@ -8,7 +8,7 @@
           integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
     <title>{{ results.title }}</title>
 </head>
-<body{% if results.classes | length %} class="{{ results.classes | join(' ') }}"{% endif %} id="results">
+<body id="results">
 {% include 'navbar.html' %}
 <div class="album bg-light">
     <div class="container-fluid">
diff --git a/pytest_mpl/summary/templates/extra.js b/pytest_mpl/summary/templates/extra.js
@@ -1,10 +1,3 @@
-// Remove all elements of class mpl-hash if hash test not run
-if (document.body.classList[0] == 'no-hash-test') {
-    document.querySelectorAll('.mpl-hash').forEach(function (elem) {
-        elem.parentElement.removeChild(elem);
-    });
-}
-
 // Enable tooltips
 var tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]'))
 var tooltipList = tooltipTriggerList.map(function (tooltipTriggerEl) {
diff --git a/pytest_mpl/summary/templates/filter.html b/pytest_mpl/summary/templates/filter.html
@@ -16,7 +16,7 @@ <h5>Sort tests by...</h5>
             {{ sort_option('status-sort', 'status', 'desc', default=true) }}
             {{ sort_option('collected-sort', 'collected', 'asc') }}
             {{ sort_option('test-name', 'name') }}
-            {% if results.warn_missing['baseline_image'] -%}
+            {% if results.image_comparison -%}
             {{ sort_option('rms-sort', 'RMS', 'desc') }}
             {%- endif %}
         </div>
@@ -34,15 +34,15 @@ <h5>Show tests which have...</h5>
                 {{ filter_option('overall-failed', 'failed') }}
                 {{ filter_option('overall-skipped', 'skipped') }}
             </div>
-            {% if results.warn_missing['baseline_image'] -%}
+            {% if results.image_comparison -%}
             <div class="list-group m-2">
                 {{ filter_option('image-match', 'matching images') }}
                 {{ filter_option('image-diff', 'differing images') }}
                 {{ filter_option('image-missing', 'no baseline image') }}
             </div>
             {%- endif %}
-            {% if results.warn_missing['baseline_hash'] -%}
-            <div class="list-group m-2 mpl-hash">
+            {% if results.hash_comparison -%}
+            <div class="list-group m-2">
                 {{ filter_option('hash-match', 'matching hashes') }}
                 {{ filter_option('hash-diff', 'differing hashes') }}
                 {{ filter_option('hash-missing', 'no baseline hash') }}
diff --git a/pytest_mpl/summary/templates/result_images.html b/pytest_mpl/summary/templates/result_images.html
@@ -6,14 +6,14 @@ <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'] and r.image_status != 'generated' -%}
+        {% if r.image_status 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">
                 <div class="card h-100">
                     <div class="card-header">{{ name }}</div>
                     {% if file -%}
-                    <img src="{{ file }}" class="card-img-top" alt="">
+                    <img src="{{ file }}" class="card-img-top" alt="{{ name }}">
                     {%- endif %}
                 </div>
             </div>
@@ -41,21 +41,25 @@ <h5 class="card-title">{{ r.name }}</h5>
                 </div>
                 {%- endfilter %}
                 {%- endmacro -%}
-                {% if results.warn_missing['baseline_image'] -%}
-                <div class="card text-white bg-{{ r.image_status | status_class }} mb-3 mpl-image">
+                {% if r.image_status -%}
+                <div class="card text-white bg-{{ r.image_status | status_class }} mb-3">
                     <div class="card-header">{{ r.image_status | image_status_msg }}</div>
+                    {% if r.image_status == 'match' or r.image_status == 'diff' -%}
                     <div class="card-body">
                         {{ pre_data('rms', r.rms_str, 'RMS') }}
                         {{ pre_data('tolerance', r.tolerance, 'Tolerance') }}
                     </div>
+                    {%- endif %}
                 </div>
                 {%- endif %}
-                {% if results.warn_missing['baseline_hash'] -%}
-                <div class="card text-white bg-{{ r.hash_status | status_class }} mb-3 mpl-hash">
+                {% if r.hash_status -%}
+                <div class="card text-white bg-{{ r.hash_status | status_class }} mb-3">
                     <div class="card-header">{{ r.hash_status | hash_status_msg }}</div>
                     <div class="card-body">
                         {{ pre_data('baseline_hash', r.baseline_hash, 'Baseline') }}
+                        {% if r.hash_status != 'generated' -%}
                         {{ pre_data('result_hash', r.result_hash, 'Result') }}
+                        {%- endif %}
                     </div>
                 </div>
                 {%- endif %}
diff --git a/pytest_mpl/summary/templates/styles.css b/pytest_mpl/summary/templates/styles.css
@@ -1,6 +1,3 @@
-body.no-hash-test .mpl-hash {
-    display: none;
-}
 .navbar-brand span.repo {
     font-weight: bold;
 }
@@ -29,9 +26,6 @@ body.no-hash-test .mpl-hash {
         max-width: 400px;
     }
 }
-.image-missing .mpl-image .card-body {
-    display: none;
-}
 pre {
     white-space: pre-line;
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,3 @@`
`1`		`-body.no-hash-test .mpl-hash {`
`2`		`- display: none;`
`3`		`-}`
`4`	`1`	`.navbar-brand span.repo {`
`5`	`2`	`font-weight: bold;`
`6`	`3`	`}`
`@@ -29,9 +26,6 @@ body.no-hash-test .mpl-hash {`
`29`	`26`	`max-width: 400px;`
`30`	`27`	`}`
`31`	`28`	`}`
`32`		`-.image-missing .mpl-image .card-body {`
`33`		`- display: none;`
`34`		`-}`
`35`	`29`	`pre {`
`36`	`30`	`white-space: pre-line;`
`37`	`31`	`}`