Updated coverage display for XPATH coverage report

Author: Kolea Plesco

ted_sws/notice_validator/adapters/xpath_coverage_runner.py

@@ -81,8 +81,13 @@ def xpath_coverage(self, report: XPATHCoverageReport, notice_xpaths: XPATH_TYPE,
         report.xpath_covered = list(self.conceptual_xpaths & unique_notice_xpaths)
         report.xpath_not_covered = list(unique_notice_xpaths - self.conceptual_xpaths)
         report.xpath_extra = list(self.conceptual_xpaths - unique_notice_xpaths)
-        if len(unique_notice_xpaths):
-            report.coverage = len(report.xpath_covered) / len(unique_notice_xpaths)
+        unique_notice_xpaths_len = len(unique_notice_xpaths)
+        xpath_covered_len = len(report.xpath_covered)
+        conceptual_xpaths_len = len(self.conceptual_xpaths)
+        if unique_notice_xpaths_len:
+            report.coverage = xpath_covered_len / unique_notice_xpaths_len
+        if conceptual_xpaths_len:
+            report.conceptual_coverage = xpath_covered_len / conceptual_xpaths_len
 
     @classmethod
     def based_xpaths(cls, xpaths: List[str], base_xpath: str) -> List[str]:

ted_sws/notice_validator/model/coverage_report.py

@@ -26,3 +26,4 @@ class XPATHCoverageReport(PropertyBaseModel):
     xpath_not_covered: Optional[List[str]]
     xpath_extra: Optional[List[str]]
     coverage: Optional[float]
+    conceptual_coverage: Optional[float]

ted_sws/notice_validator/resources/templates/xpath_coverage_report.jinja2

@@ -73,9 +73,17 @@
 <ul>
     <li>Date created: {{ created_at }}</li>
     <li>Mapping suite identifier: {{ mapping_suite_id }}</li>
-    <li>Coverage: <strong>{{ coverage }}</strong>
-    <div><hr></div></li>
-    <li>Notice identifier(s):
+    <li>
+        <div><hr></div>
+        <h4>Overall coverage</h4>
+        <h3>{{ "%.2f"|format((coverage|float * 100)) }}%</h3>
+        <p>(Number of Conceptual XPATHs found in notices) / (Total number of unique XPATHs in provided notices)</p>
+    <li><div><hr></div>
+        <h4>Conceptual coverage</h4>
+        <h3>{{ "%.2f"|format((conceptual_coverage|float * 100)) }}%</h3>
+        <p>(Number of Conceptual XPATHs found in notices) / (Total number of unique Conceptual XPATHs)</p>
+    </li>
+    <li><div><hr></div>Notice identifier(s):
         <div data-role="collapsible" data-state="{% if notice_id|length > 1 %}collapsed{% endif %}"
             class="collapsible-wrapper">
             <h4><a href="#"></a></h4>
@@ -97,16 +105,17 @@
     <tr>
         <th>Title</th>
         <th>XPATH</th>
-        <th>Count</th>
-        <th>Notice</th>
-        <th>Result</th>
+        <th>Found</th>
+        <th>Notice count</th>
+        <th>Notices</th>
     </tr>
     </thead>
     <tbody>
     {% for item in xpath_assertions %}
     <tr>
         <td>{{ item.title }}</td>
         <td>{{ item.xpath }}</td>
+        <td class="{% if item.query_result %}success{% else %}error{% endif %}">{{ item.query_result }}</td>
         <td>{{ item.count }}</td>
         <td class="notice-hit">{% if item.notice_hit %}
             <div data-role="collapsible" data-state="collapsed">
@@ -116,7 +125,6 @@
                 </div>
             </div>
         {% endif %}</td>
-        <td class="{% if item.query_result %}success{% else %}error{% endif %}">{{ item.query_result }}</td>
     </tr>
     {% endfor %}
     </tbody>