@sun-asterisk/sungen 3.2.27 → 3.2.29

package/src/exporters/matrix/render-testcase-sheet.ts

@@ -0,0 +1,178 @@
+/**
+ * One BM-2-901-13 testcase sheet of the matrix workbook (Auto or Manual).
+ *
+ * Layout is the company template, cell for cell: masthead rows 1-4, the summary
+ * band on rows 6/7/8, the `*: Mandatory` legend on row 12, the 16 column headers
+ * `A..P` on row 13, and data from row 14.
+ *
+ * Two row levels: one parent row per delivery item, each followed by its variant
+ * sub-rows on Excel outline level 1 — the sub-row is where source traceability
+ * (VP-id), test data and the manual result/evidence entry live (review B-05/B-06).
+ * Variant Result cells carry the state dropdown; the parent Result is a live
+ * formula over its children, so a parent can never contradict its variants even
+ * after QA edits results by hand.
+ */
+
+import * as ExcelJS from 'exceljs';
+import { renderReportHeaderBand, ARIAL_FONT } from '../xlsx-report-builder';
+import { redactSecrets } from '../api-testcase-formatter';
+import { clipNoteField } from '../playwright-report-parser';
+import { variantState } from './build';
+import { DeliveryItem, MatrixModel } from './types';
+import { SOFT_BLUE, DRAFT_RED, RESULT_STATES, dataCell, headerCell, draftBanner } from './xlsx-cells';
+import { addSummaryBand } from './testcase-summary-band';
+import {
+  coverageSummary, expectedWithVerification, isoDate, itemResultLabel, numbered, variantTypeLabel,
+} from './item-labels';
+
+/** Column headers on row 13 — `A..P`, matching the template exactly. */
+export const TESTCASE_HEADERS = [
+  'ID*', 'Target', 'Test Intent / Condition', 'Category', 'Priority', 'Precondition',
+  'Coverage / Test Data', 'Action / Trigger*', 'Expected results*', 'Trace', 'Testcase type',
+  'Test Result*', 'Executed Date*', 'Test Executor*', 'Test Environment',
+  'Note\n(Test evidence, DefectID, Actual result)',
+];
+
+/** Column widths `A..P`, from the template (H widened — Action / Trigger is the longest cell). */
+const COLUMN_WIDTHS = [20, 12.5, 15.38, 16.25, 17, 25.51, 24.88, 50, 41, 12, 13.5, 15.88, 13.5, 16.5, 23, 29];
+
+export const HEADER_ROW = 13;
+/** Column L — the one the band's COUNTIFs and the parent roll-ups read. */
+export const RESULT_COL = 12;
+
+/** Variant sub-row — only what distinguishes it from its parent (review GAP-01). */
+function variantValues(item: DeliveryItem, v: DeliveryItem['variants'][number], model: MatrixModel): ExcelJS.CellValue[] {
+  return [
+    v.ref,
+    '',
+    v.condition,
+    '', '',
+    numbered(item.preconditionDeltas[v.ref] ?? []),
+    numbered(v.data),
+    // Only the steps after the parent's shared prefix, numbered so the parent's
+    // steps + these read as one continuous procedure.
+    numbered(item.triggerDeltas[v.ref] ?? [], item.trigger.length + 1),
+    expectedWithVerification(v.oracle, v.verification),
+    v.traces.join(', '),
+    variantTypeLabel(v),
+    variantState(v),
+    isoDate(v.result?.startTime),
+    '',
+    '',
+    // Redact BEFORE clipping — same denylist as the testcases CSV Note column.
+    v.result?.error ? clipNoteField(redactSecrets(String(v.result.error), model.secretValues)) : '',
+  ];
+}
+
+/**
+ * Live parent roll-up over the child Result cells — precedence
+ * failed → blocked → pending → partial → passed. N/A variants leave the
+ * denominator (review GAP-06): eff = n − COUNTIF(N/A); all-N/A → "All N/A".
+ * The range covers only the children present in THIS sheet, so a mixed item's
+ * two parent rows legitimately report two different numbers.
+ */
+function rollUpFormula(n: number, firstChild: number, lastChild: number): string {
+  const rng = `L${firstChild}:L${lastChild}`;
+  const EFF = `(${n}-COUNTIF(${rng},"N/A"))`;
+  const NA = `IF(COUNTIF(${rng},"N/A")>0," · "&COUNTIF(${rng},"N/A")&" N/A","")`;
+  return (
+    `IF(COUNTIF(${rng},"Failed")>0,COUNTIF(${rng},"Passed")&"/"&${EFF}&" Passed · "&COUNTIF(${rng},"Failed")&" Failed"&${NA},` +
+    `IF(COUNTIF(${rng},"Blocked")>0,COUNTIF(${rng},"Passed")&"/"&${EFF}&" Passed · "&COUNTIF(${rng},"Blocked")&" Blocked"&${NA},` +
+    `IF(${EFF}=0,"All N/A",` +
+    `COUNTIF(${rng},"Passed")&"/"&${EFF}&" Passed"&${NA})))`
+  );
+}
+
+/** Parent row — only values genuinely COMMON to the whole item (review M-04). */
+function parentValues(item: DeliveryItem, formula: string): ExcelJS.CellValue[] {
+  return [
+    item.id,
+    item.target,
+    item.intent,
+    item.category,
+    item.priority,
+    numbered(item.precondition),
+    coverageSummary(item),
+    // The shared leading steps; each variant's remaining steps sit on its sub-row.
+    numbered(item.trigger),
+    item.oracle,
+    item.traces.join(', '),
+    // K (Testcase type) stays blank on a parent — it is not an executable case.
+    '',
+    { formula, result: itemResultLabel(item) } as ExcelJS.CellValue,
+    '',
+    '',
+    '',
+    item.review === 'proposed' ? 'REVIEW REQUIRED' : '',
+  ];
+}
+
+/**
+ * Append one testcase sheet holding `items` (already projected onto this sheet's
+ * execution mode). Always called for both Auto and Manual, even when one side is
+ * empty: Overview then always has exactly two rows, and QA has somewhere to add
+ * hand-written cases. An empty sheet's band reads 0 and its percentages resolve
+ * through IFERROR — never `#DIV/0!`.
+ */
+export function addTestcaseSheet(
+  wb: ExcelJS.Workbook,
+  sheetName: string,
+  model: MatrixModel,
+  items: DeliveryItem[],
+  sungenVersion?: string,
+): void {
+  const ws = wb.addWorksheet(sheetName);
+  ws.properties.outlineLevelRow = 1;
+  ws.columns = COLUMN_WIDTHS.map((width) => ({ width }));
+
+  renderReportHeaderBand(wb, ws, `${model.unit.toUpperCase()} TEST CASE & COVERAGE MATRIX`, sungenVersion, model.formNo);
+  draftBanner(ws, model);
+  addSummaryBand(ws, items);
+
+  const legend = ws.getCell('A12');
+  legend.value = '*: Mandatory';
+  legend.font = { italic: true, size: 10, name: ARIAL_FONT, color: { argb: 'FF808080' } };
+
+  const hr = ws.getRow(HEADER_ROW);
+  hr.height = 38;
+  TESTCASE_HEADERS.forEach((label, i) => headerCell(hr.getCell(1 + i), label));
+
+  let rowIdx = HEADER_ROW + 1;
+  for (const item of items) {
+    const parentRowIdx = rowIdx++;
+
+    // Variant sub-rows FIRST — the parent's formula needs their cell range.
+    const firstChild = rowIdx;
+    for (const v of item.variants) {
+      const vr = ws.getRow(rowIdx++);
+      vr.outlineLevel = 1;
+      variantValues(item, v, model).forEach((val, i) => dataCell(vr.getCell(1 + i), val, { center: i === 10 }));
+      // Manual-execution entry: constrain the Result cell to the known states.
+      vr.getCell(RESULT_COL).dataValidation = {
+        type: 'list', allowBlank: true, formulae: [`"${RESULT_STATES}"`],
+      };
+    }
+
+    const pr = ws.getRow(parentRowIdx);
+    const values = parentValues(item, rollUpFormula(item.variants.length, firstChild, rowIdx - 1));
+    values.forEach((v, i) => dataCell(pr.getCell(1 + i), v, {
+      bold: true,
+      fill: SOFT_BLUE,
+      center: i === 3 || i === 4,
+      ...(i === 15 && item.review === 'proposed' ? { color: DRAFT_RED } : {}),
+    }));
+  }
+
+  const lastRow = Math.max(rowIdx - 1, HEADER_ROW);
+  ws.autoFilter = { from: { row: HEADER_ROW, column: 1 }, to: { row: lastRow, column: 16 } };
+  ws.views = [{ state: 'frozen', xSplit: 0, ySplit: HEADER_ROW }];
+  // Print: landscape, fit width only (never squash all rows into one page),
+  // repeat the masthead + band + header rows on every page (review GAP-08).
+  ws.pageSetup = {
+    orientation: 'landscape',
+    fitToPage: true,
+    fitToWidth: 1,
+    fitToHeight: 0,
+    printTitlesRow: `1:${HEADER_ROW}`,
+  };
+}