qfai 1.2.2 → 1.2.3

package/assets/init/root/qfai.config.yaml

@@ -9,6 +9,11 @@ validation:
   failOn: error
   require:
     specSections: []
+  testStrategy:
+    requireLayerTags: false
+    requireSizeTags: false
+    maxE2eScenarioRatio: null
+    maxE2eScenarioCount: null
   traceability:
     brMustHaveSc: true
     scMustHaveTest: true

package/dist/cli/index.cjs

@@ -49,6 +49,12 @@ var defaultConfig = {
     require: {
       specSections: []
     },
+    testStrategy: {
+      requireLayerTags: false,
+      requireSizeTags: false,
+      maxE2eScenarioRatio: null,
+      maxE2eScenarioCount: null
+    },
     traceability: {
       brMustHaveSc: true,
       scMustHaveTest: true,
@@ -215,6 +221,20 @@ function normalizeValidation(raw, configPath, issues) {
     );
     traceabilityRaw = void 0;
   }
+  let testStrategyRaw;
+  if (raw.testStrategy === void 0) {
+    testStrategyRaw = void 0;
+  } else if (isRecord(raw.testStrategy)) {
+    testStrategyRaw = raw.testStrategy;
+  } else {
+    issues.push(
+      configIssue(
+        configPath,
+        "validation.testStrategy \u306F\u30AA\u30D6\u30B8\u30A7\u30AF\u30C8\u3067\u3042\u308B\u5FC5\u8981\u304C\u3042\u308A\u307E\u3059\u3002"
+      )
+    );
+    testStrategyRaw = void 0;
+  }
   return {
     failOn: readFailOn(
       raw.failOn,
@@ -232,6 +252,36 @@ function normalizeValidation(raw, configPath, issues) {
         issues
       )
     },
+    testStrategy: {
+      requireLayerTags: readBoolean(
+        testStrategyRaw?.requireLayerTags,
+        base.testStrategy.requireLayerTags,
+        "validation.testStrategy.requireLayerTags",
+        configPath,
+        issues
+      ),
+      requireSizeTags: readBoolean(
+        testStrategyRaw?.requireSizeTags,
+        base.testStrategy.requireSizeTags,
+        "validation.testStrategy.requireSizeTags",
+        configPath,
+        issues
+      ),
+      maxE2eScenarioRatio: readOptionalRatio(
+        testStrategyRaw?.maxE2eScenarioRatio,
+        base.testStrategy.maxE2eScenarioRatio,
+        "validation.testStrategy.maxE2eScenarioRatio",
+        configPath,
+        issues
+      ),
+      maxE2eScenarioCount: readOptionalNonNegativeInt(
+        testStrategyRaw?.maxE2eScenarioCount,
+        base.testStrategy.maxE2eScenarioCount,
+        "validation.testStrategy.maxE2eScenarioCount",
+        configPath,
+        issues
+      )
+    },
     traceability: {
       brMustHaveSc: readBoolean(
         traceabilityRaw?.brMustHaveSc,
@@ -317,6 +367,36 @@ function readString(value, fallback, label, configPath, issues) {
   }
   return fallback;
 }
+function readOptionalRatio(value, fallback, label, configPath, issues) {
+  if (value === void 0) {
+    return fallback;
+  }
+  if (value === null) {
+    return null;
+  }
+  if (typeof value === "number" && Number.isFinite(value) && value >= 0 && value <= 1) {
+    return value;
+  }
+  issues.push(
+    configIssue(configPath, `${label} \u306F 0\u301C1 \u306E\u6570\u5024\u3067\u3042\u308B\u5FC5\u8981\u304C\u3042\u308A\u307E\u3059\u3002`)
+  );
+  return fallback;
+}
+function readOptionalNonNegativeInt(value, fallback, label, configPath, issues) {
+  if (value === void 0) {
+    return fallback;
+  }
+  if (value === null) {
+    return null;
+  }
+  if (typeof value === "number" && Number.isFinite(value) && Number.isInteger(value) && value >= 0) {
+    return value;
+  }
+  issues.push(
+    configIssue(configPath, `${label} \u306F 0 \u4EE5\u4E0A\u306E\u6574\u6570\u3067\u3042\u308B\u5FC5\u8981\u304C\u3042\u308A\u307E\u3059\u3002`)
+  );
+  return fallback;
+}
 function readStringArray(value, fallback, label, configPath, issues) {
   if (Array.isArray(value) && value.every((item) => typeof item === "string")) {
     return value;
@@ -1073,8 +1153,8 @@ var import_promises7 = require("fs/promises");
 var import_node_path9 = __toESM(require("path"), 1);
 var import_node_url2 = require("url");
 async function resolveToolVersion() {
-  if ("1.2.2".length > 0) {
-    return "1.2.2";
+  if ("1.2.3".length > 0) {
+    return "1.2.3";
   }
   try {
     const packagePath = resolvePackageJsonPath();
@@ -3677,7 +3757,7 @@ async function validateScenarios(root, config) {
       ...collectStrategyCandidates(text, entry.scenarioPath)
     );
   }
-  issues.push(...buildStrategyIssues(strategyCandidates));
+  issues.push(...buildStrategyIssues(strategyCandidates, config));
   return issues;
 }
 function validateScenarioContent(text, file) {
@@ -3880,22 +3960,39 @@ function collectStrategyCandidates(text, file) {
       label: buildScenarioLabel(file, scenario.tags, scenario.name),
       hasAnyTag: strategy.hasAnyTag,
       adopted: strategy.isAdopted,
-      missing: !strategy.isAdopted
+      missing: !strategy.isAdopted,
+      layerBucket: classifyLayer(scenario.tags),
+      sizeBucket: classifySize(scenario.tags)
     };
   });
 }
-function buildStrategyIssues(candidates) {
+function buildStrategyIssues(candidates, config) {
   const totalScenarios = candidates.length;
   if (totalScenarios === 0) {
     return [];
   }
   const adoptedCount = candidates.filter((item) => item.adopted).length;
   const missingItems = candidates.filter((item) => item.missing);
+  const missingLayerItems = candidates.filter(
+    (item) => item.layerBucket === "none"
+  );
+  const missingSizeItems = candidates.filter(
+    (item) => item.sizeBucket === "none"
+  );
   const hasAnyStrategyTag = candidates.some((item) => item.hasAnyTag);
   const missingSamples = missingItems.map((item) => item.label).slice(0, STRATEGY_SAMPLE_LIMIT);
+  const missingLayerSamples = missingLayerItems.map((item) => item.label).slice(0, STRATEGY_SAMPLE_LIMIT);
+  const missingSizeSamples = missingSizeItems.map((item) => item.label).slice(0, STRATEGY_SAMPLE_LIMIT);
   const adoptionRate = totalScenarios === 0 ? "0%" : `${Math.round(adoptedCount / totalScenarios * 100)}%`;
+  const e2eCount = candidates.filter(
+    (item) => item.layerBucket === "e2e"
+  ).length;
+  const e2eRatio = totalScenarios === 0 ? 0 : e2eCount / totalScenarios;
+  const maxE2eRatio = config.validation.testStrategy.maxE2eScenarioRatio;
+  const maxE2eCount = config.validation.testStrategy.maxE2eScenarioCount;
+  const issues = [];
   if (!hasAnyStrategyTag) {
-    return [
+    issues.push(
       issue(
         "QFAI-TS-100",
         "\u5168\u3066\u306E Scenario \u306B layer/size \u30BF\u30B0\u304C\u3042\u308A\u307E\u305B\u3093\u3002\u5C0E\u5165\u306F\u4EFB\u610F\u3067\u3059\uFF08opt-in\uFF09\u3002",
@@ -3903,10 +4000,10 @@ function buildStrategyIssues(candidates) {
         void 0,
         "scenario.testStrategyAllMissing"
       )
-    ];
+    );
   }
-  if (adoptedCount < totalScenarios) {
-    return [
+  if (hasAnyStrategyTag && adoptedCount < totalScenarios) {
+    issues.push(
       issue(
         "QFAI-TS-101",
         `layer/size \u30BF\u30B0\u306E\u90E8\u5206\u5C0E\u5165\u3067\u3059: missing=${missingItems.length}, total=${totalScenarios}, adopted=${adoptedCount}, adoptionRate=${adoptionRate}, samples=${missingSamples.join(
@@ -3917,9 +4014,59 @@ function buildStrategyIssues(candidates) {
         "scenario.testStrategyPartialAdoption",
         missingSamples
       )
-    ];
+    );
   }
-  return [];
+  if (config.validation.testStrategy.requireLayerTags && missingLayerItems.length > 0) {
+    issues.push(
+      issue(
+        "QFAI-TS-102",
+        `layer \u30BF\u30B0\u304C\u672A\u8A2D\u5B9A\u3067\u3059: missing=${missingLayerItems.length}, total=${totalScenarios}, samples=${missingLayerSamples.join(
+          ", "
+        )}`,
+        "warning",
+        void 0,
+        "scenario.testStrategyRequireLayerTags",
+        missingLayerSamples
+      )
+    );
+  }
+  if (config.validation.testStrategy.requireSizeTags && missingSizeItems.length > 0) {
+    issues.push(
+      issue(
+        "QFAI-TS-103",
+        `size \u30BF\u30B0\u304C\u672A\u8A2D\u5B9A\u3067\u3059: missing=${missingSizeItems.length}, total=${totalScenarios}, samples=${missingSizeSamples.join(
+          ", "
+        )}`,
+        "warning",
+        void 0,
+        "scenario.testStrategyRequireSizeTags",
+        missingSizeSamples
+      )
+    );
+  }
+  if (maxE2eRatio !== null && e2eRatio > maxE2eRatio) {
+    issues.push(
+      issue(
+        "QFAI-TS-110",
+        `layer-e2e \u306E\u6BD4\u7387\u304C\u4E0A\u9650\u3092\u8D85\u904E\u3057\u3066\u3044\u307E\u3059: e2e=${e2eCount}, total=${totalScenarios}, ratio=${Math.round(e2eRatio * 1e3) / 10}% (max=${Math.round(maxE2eRatio * 1e3) / 10}%)`,
+        "warning",
+        void 0,
+        "scenario.testStrategyMaxE2eRatio"
+      )
+    );
+  }
+  if (maxE2eCount !== null && e2eCount > maxE2eCount) {
+    issues.push(
+      issue(
+        "QFAI-TS-111",
+        `layer-e2e \u306E\u4EF6\u6570\u304C\u4E0A\u9650\u3092\u8D85\u904E\u3057\u3066\u3044\u307E\u3059: e2e=${e2eCount} (max=${maxE2eCount})`,
+        "warning",
+        void 0,
+        "scenario.testStrategyMaxE2eCount"
+      )
+    );
+  }
+  return issues;
 }
 async function fileExists(target) {
   try {
@@ -4400,6 +4547,17 @@ async function validateTraceability(root, config) {
     }
     const specInfo = scenarioToSpec.get(file);
     if (specInfo && specInfo.contractRefs.lines.length > 0) {
+      if (!specInfo.contractRefs.hasNone && specInfo.contractRefs.ids.length > 0 && scenarioContractRefs.hasNone) {
+        issues.push(
+          issue(
+            "QFAI-TRACE-036",
+            `Spec \u304C\u5951\u7D04 ID \u3092\u5217\u6319\u3057\u3066\u3044\u307E\u3059\u304C Scenario \u304C none \u3092\u6307\u5B9A\u3057\u3066\u3044\u307E\u3059 (SPEC: ${specInfo.specId ?? "unknown"})`,
+            "warning",
+            file,
+            "traceability.scenarioContractRefNone"
+          )
+        );
+      }
       if (specInfo.contractRefs.hasNone && scenarioContractRefs.ids.length > 0) {
         issues.push(
           issue(
@@ -4857,6 +5015,7 @@ async function createReportData(root, validation, configResult) {
   const testStrategy = await collectTestStrategy(
     scenarioFiles,
     resolvedRoot,
+    config,
     REPORT_TEST_STRATEGY_SAMPLE_LIMIT
   );
   const {
@@ -5275,6 +5434,27 @@ function formatReportMarkdown(data, options = {}) {
     `- s: ${data.testStrategy.size.s} / m: ${data.testStrategy.size.m} / l: ${data.testStrategy.size.l} / none: ${data.testStrategy.size.none} / unknown: ${data.testStrategy.size.unknown}`
   );
   lines.push("");
+  const e2eHeading = data.testStrategy.e2e.ratioExceeded || data.testStrategy.e2e.countExceeded ? "### E2E guardrails (warning)" : "### E2E guardrails";
+  lines.push(e2eHeading);
+  lines.push("");
+  lines.push(
+    `- e2e: ${data.testStrategy.e2e.count} / ${data.testStrategy.totalScenarios} (ratio=${formatPercent(data.testStrategy.e2e.ratio)})`
+  );
+  lines.push(
+    `- maxRatio: ${formatOptionalPercent(data.testStrategy.e2e.maxRatio)}`
+  );
+  lines.push(
+    `- maxCount: ${formatOptionalNumber(data.testStrategy.e2e.maxCount)}`
+  );
+  if (data.testStrategy.e2e.ratioExceeded || data.testStrategy.e2e.countExceeded) {
+    if (data.testStrategy.e2e.ratioExceeded) {
+      lines.push("- warning: layer-e2e \u306E\u6BD4\u7387\u304C\u4E0A\u9650\u3092\u8D85\u904E\u3057\u3066\u3044\u307E\u3059\u3002");
+    }
+    if (data.testStrategy.e2e.countExceeded) {
+      lines.push("- warning: layer-e2e \u306E\u4EF6\u6570\u304C\u4E0A\u9650\u3092\u8D85\u904E\u3057\u3066\u3044\u307E\u3059\u3002");
+    }
+  }
+  lines.push("");
   lines.push("### Missing layer tags");
   lines.push("");
   lines.push(
@@ -5589,6 +5769,21 @@ function formatList(values) {
   }
   return values.join(", ");
 }
+function formatOptionalPercent(value) {
+  if (value === null) {
+    return "(unset)";
+  }
+  return formatPercent(value);
+}
+function formatOptionalNumber(value) {
+  if (value === null) {
+    return "(unset)";
+  }
+  return String(value);
+}
+function formatPercent(value) {
+  return `${Math.round(value * 1e3) / 10}%`;
+}
 function formatMarkdownTable(headers, rows) {
   const widths = headers.map((header, index) => {
     const candidates = rows.map((row) => row[index] ?? "");
@@ -5681,7 +5876,7 @@ async function countScenarios(scenarioFiles) {
   }
   return total;
 }
-async function collectTestStrategy(scenarioFiles, root, limit) {
+async function collectTestStrategy(scenarioFiles, root, config, limit) {
   const layerCounts = {
     unit: 0,
     component: 0,
@@ -5701,6 +5896,7 @@ async function collectTestStrategy(scenarioFiles, root, limit) {
   const missingLayer = [];
   const missingSize = [];
   let totalScenarios = 0;
+  let e2eCount = 0;
   for (const file of scenarioFiles) {
     const text = await (0, import_promises21.readFile)(file, "utf-8");
     const { document, errors } = parseScenarioDocument(text, file);
@@ -5720,6 +5916,9 @@ async function collectTestStrategy(scenarioFiles, root, limit) {
       if (layerBucket === "none") {
         missingLayer.push(label);
       }
+      if (layerBucket === "e2e") {
+        e2eCount += 1;
+      }
       const sizeBucket = classifySize(scenario.tags);
       sizeCounts[sizeBucket] += 1;
       if (sizeBucket === "none") {
@@ -5729,6 +5928,9 @@ async function collectTestStrategy(scenarioFiles, root, limit) {
   }
   const layerSamples = missingLayer.slice(0, limit);
   const sizeSamples = missingSize.slice(0, limit);
+  const ratio = totalScenarios === 0 ? 0 : e2eCount / totalScenarios;
+  const maxRatio = config.validation.testStrategy.maxE2eScenarioRatio;
+  const maxCount = config.validation.testStrategy.maxE2eScenarioCount;
   return {
     totalScenarios,
     limit,
@@ -5745,6 +5947,14 @@ async function collectTestStrategy(scenarioFiles, root, limit) {
         samples: sizeSamples,
         truncated: missingSize.length > sizeSamples.length
       }
+    },
+    e2e: {
+      count: e2eCount,
+      ratio,
+      maxRatio,
+      maxCount,
+      ratioExceeded: maxRatio !== null && ratio > maxRatio,
+      countExceeded: maxCount !== null && e2eCount > maxCount
     }
   };
 }