Add at risk section

lib/extensions.js

@@ -0,0 +1,32 @@
+/*!
+ * Copyright (c) 2024 Digital Bazaar, Inc. All rights reserved.
+ */
+import {atRisk} from './utils.js';
+
+/**
+ * Extensions are functions that extend test data reports.
+ * Extensions maybe toggled off or on.
+ */
+export const extensions = {
+  templateData: {
+    addAtRisk({templateData}) {
+      if(templateData.matrices.length) {
+        templateData.matrices = templateData.matrices.flatMap(addAtRisk);
+      }
+    }
+  }
+};
+
+function addAtRisk(matrix) {
+  const {rows = [], columns} = matrix;
+  const atRiskRows = rows.filter(({cells}) => atRisk(cells));
+  if(atRiskRows.length) {
+    return [matrix, {
+      ...matrix,
+      title: matrix?.title + ' At Risk',
+      columns: [...columns],
+      rows: atRiskRows
+    }];
+  }
+  return [matrix];
+}

lib/generate.js

@@ -1,6 +1,7 @@
 /**!
  * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
 */
+import {extensions} from './extensions.js';
 import {makeTemplate} from './handlebars.js';
 import {getJson, getPartial, writeJSON} from './files.js';
 import {findReports, makeTemplateData} from './handlers.js';
@@ -20,6 +21,14 @@ export async function makeReport({suite, stats, config}) {
   const reports = findReports({suite});
   const {summary = new Set()} = suite.suites.find(s => s.summary) || {};
   const templateData = makeTemplateData({reports});
+  // seee if any template extensions have been registered
+  const templateExtensions = extensions.templateData;
+  if(templateExtensions) {
+    // run each registered extension on the templateData
+    for(const prop in templateExtensions) {
+      await templateExtensions[prop]({templateData});
+    }
+  }
   templateData.respecConfig = config.respecConfig = await getJson(respecConfig);
   templateData.title = title;
   templateData.stats = stats;

lib/handlebars.js

@@ -4,7 +4,7 @@
 import Handlebars from 'handlebars';
 import {statusMarks} from './statusMarks.js';
 import {formatJSON} from './files.js';
-import {UTCDateTime} from './utils.js';
+import {UTCDateTime, atRisk} from './utils.js';
 
 // helpersFile is a path to a project specific helpers file.
 const registerHelpers = ({config}) => {
@@ -25,6 +25,8 @@ const registerHelpers = ({config}) => {
 
   Handlebars.registerHelper(
     'getOptional', optional => optional ? 'optional' : 'not-optional');
+  // add a css class to rows that are at risk
+  Handlebars.registerHelper('atRisk', c => atRisk(c) ? 'at-risk' : 'confirmed');
   try {
     if(!helpersFile) {
       return;

lib/handlers.js

@@ -172,6 +172,7 @@ export function formatTest(test, parentSuite = '') {
     .trim();
   return {
     // optional means the test is non-normative
+    // FIXME remove this optional check in a major release
     optional: false,
     ...test,
     fullTitle,

lib/utils.js

@@ -40,3 +40,8 @@ export const UTCDateTime = (lang = 'en-AU') => {
     minute: 'numeric'
   });
 };
+
+// at risk statements have less than 2 conforming implementations
+export const atRisk = cells => !(cells.filter(
+  c => c.state === 'passed').length >= 2);
+

templates/head.hbs

@@ -32,5 +32,8 @@
   align-items: center;
   justify-content: center;
   width: fit-content;
+}
+.at-risk {
+  opacity: 0.6;
 }
     </style>