Sort tests by order collected by pytest

Author: ConorMacBride

pytest_mpl/summary/html.py

@@ -113,8 +113,7 @@ def get_status(item, card_id, warn_missing):
     return status, classes, badge
 
 
-def card(name, item, warn_missing=None):
-    card_id = name.replace('.', '-')
+def card(name, item, card_id, warn_missing=None):
     test_name = name.split('.')[-1]
     module = '.'.join(name.split('.')[:-1])
 
@@ -203,9 +202,11 @@ def generate_summary_html(results, results_dir):
         classes += ['no-hash-test']
 
     # Generate result cards
+    pad = len(str(len(results.items())))
     cards = []
-    for name, item in results.items():
-        cards += [card(name, item, warn_missing=warn_missing)]
+    for collect_n, (name, item) in enumerate(results.items()):
+        card_id = str(collect_n).zfill(pad)  # zero pad for alphanumerical sorting
+        cards += [card(name, item, card_id, warn_missing=warn_missing)]
     cards = [j[0] for j in sorted(cards, key=lambda i: i[1], reverse=True)]
 
     # Generate HTML

pytest_mpl/summary/templates/extra.js

@@ -13,7 +13,7 @@ var tooltipList = tooltipTriggerList.map(function (tooltipTriggerEl) {
 
 // Search, sort and filter
 var options = {
-    valueNames: ['test-name', 'status-sort', 'rms-sort', 'filter-classes',
+    valueNames: ['collected-sort', 'test-name', 'status-sort', 'rms-sort', 'filter-classes',
         'rms-value', 'baseline-hash-value', 'result-hash-value']
 };
 var resultsList = new List('results', options);

pytest_mpl/summary/templates/filter.html

@@ -10,6 +10,9 @@ <h5>Sort tests by...</h5>
                    id="sortstatus"
                    autocomplete="off" checked>
             <label class="btn btn-outline-secondary" for="sortstatus">status</label>
+            <input type="radio" class="btn-check sort" data-sort="collected-sort" data-order="asc" name="sort"
+                   id="sortcollected" autocomplete="off">
+            <label class="btn btn-outline-secondary" for="sortcollected">collected</label>
             <input type="radio" class="btn-check sort" data-sort="test-name" name="sort" id="sortname"
                    autocomplete="off">
             <label class="btn btn-outline-secondary" for="sortname">name</label>

pytest_mpl/summary/templates/result.html

@@ -1,4 +1,5 @@
 <div class="py-2 col-sm-6 col-lg-4 col-xxl-3 result {classes}">
+    <span class="collected-sort" style="display:none">{id}</span>
     <span class="test-name" style="display:none">{module}.{test_name}</span>
     <span class="status-sort" style="display:none">{status_sort}</span>
     <span class="rms-sort" style="display:none">{rms_sort}</span>