diff --git a/scripts/verify/architecture-guard-baselines.json b/scripts/verify/architecture-guard-baselines.json index 31509da61e..6f02daa57f 100644 --- a/scripts/verify/architecture-guard-baselines.json +++ b/scripts/verify/architecture-guard-baselines.json @@ -451,5 +451,70 @@ "tests/process-global/pwntoolsCliFinalization.test.ts": 4, "tests/process-global/pwntoolsCliRemediation.test.ts": 4, "tests/process-global/pwntoolsStageRetirement.test.ts": 4 + }, + "local-completeness-enum": { + "src/contracts/cutterToolContracts.ts": 1, + "src/contracts/rizinDebugToolContracts.ts": 1, + "src/cutter/CutterBridgeClient.ts": 2, + "src/domain/adb/adbDeviceAnalysis.ts": 10, + "src/domain/analysisView/analysisViewResult.ts": 1, + "src/domain/analysisView/browserScenarioViewSchemas.ts": 1, + "src/domain/analysisView/goBinaryView.ts": 1, + "src/domain/analysisView/rustBinaryView.ts": 1, + "src/domain/analysisView/webNetworkCaptureView.ts": 1, + "src/domain/android/androidAnalysis.ts": 1, + "src/domain/android/androidManifestComponents.ts": 3, + "src/domain/apiContract/graphqlContract.ts": 2, + "src/domain/apktool/apktoolResourceAnalysis.ts": 2, + "src/domain/apple/dylibResolution.ts": 1, + "src/domain/artifactFormatMetadata.ts": 3, + "src/domain/artifactGraph.ts": 2, + "src/domain/bridgeCandidateProjection.ts": 1, + "src/domain/commandObservation.ts": 2, + "src/domain/evidenceRecordSummary.ts": 1, + "src/domain/firmware/firmwareAnalysis.ts": 1, + "src/domain/flutter/flutterBuildAnalysis.ts": 4, + "src/domain/gpu/gpuCodeObjects.ts": 5, + "src/domain/javascript/electronActiveObservation.ts": 1, + "src/domain/javascript/javascriptApplicationVersionComparisonSchemas.ts": 2, + "src/domain/javascript/javascriptExportShapeComparisonSchemas.ts": 4, + "src/domain/javascript/javascriptFeatureTraceSchemas.ts": 2, + "src/domain/javascript/javascriptRecovery.ts": 1, + "src/domain/javascript/javascriptRouteInventory.ts": 2, + "src/domain/javascript/javascriptSemanticGraphSchemas.ts": 3, + "src/domain/javascript/javascriptSemanticQuerySchemas.ts": 1, + "src/domain/javascript/javascriptStaticCoverage.ts": 1, + "src/domain/javascript/sourceToBundleComparisonSchemas.ts": 1, + "src/domain/javascript/staticObservedEndpointSchemas.ts": 1, + "src/domain/jeb/jebAnalysis.ts": 1, + "src/domain/managed/managedArtifact.ts": 6, + "src/domain/managed/managedMemberComparison.ts": 3, + "src/domain/managed/managedNativeVerificationSchemas.ts": 2, + "src/domain/managed/managedReconstruction.ts": 1, + "src/domain/model/modelArtifact.ts": 6, + "src/domain/native/appleIps.ts": 1, + "src/domain/native/elfUnwindRanges.ts": 1, + "src/domain/native/kernelBuildConfig.ts": 1, + "src/domain/native/kernelModule.ts": 1, + "src/domain/native/nativeCallObservation.ts": 1, + "src/domain/native/nativeExports.ts": 1, + "src/domain/native/nativeInitializers.ts": 1, + "src/domain/native/nativeInvestigationGraph.ts": 1, + "src/domain/native/nativeMetadataRecovery.ts": 2, + "src/domain/native/objcSwiftMetadata.ts": 1, + "src/domain/native/peCertificates.ts": 1, + "src/domain/native/peImports.ts": 1, + "src/domain/native/windowsShortcut.ts": 1, + "src/domain/pcap/pcapAnalysis.ts": 1, + "src/domain/reconstructionObligationLedgerSchemas.ts": 1, + "src/domain/sqlite/sqliteDatabase.ts": 1, + "src/domain/wasm/wasmArtifact.ts": 2, + "src/domain/wasm/wasmInterface.ts": 1, + "src/domain/webBundleAnalysis.ts": 2, + "src/domain/webNetworkCapture.ts": 1, + "src/domain/windows/ntfsMftAttributes.ts": 1, + "src/ghidra/extensions/GhidraExtensions.ts": 1, + "src/ghidra/extensions/nativeaot/NativeAotReport.ts": 1, + "src/javascript/analysis/JavaScriptAnalysisWorkerSchemas.ts": 2 } } diff --git a/scripts/verify/architecture-guards.mjs b/scripts/verify/architecture-guards.mjs index 03e7a4db29..27c3ea27da 100644 --- a/scripts/verify/architecture-guards.mjs +++ b/scripts/verify/architecture-guards.mjs @@ -8,6 +8,7 @@ import { compareCountedBaseline, recordLoweredBaseline, } from "./counted-baseline.mjs"; +import { localCompletenessEnumCount } from "./completeness-enum-guard.mjs"; import { countKeyedFirstMatches } from "./keyed-first-match.mjs"; // Architecture guards for the strict-identity / best-effort-inference split. @@ -306,6 +307,17 @@ const checkCounted = (label, key, selected, pattern, owners) => { ); }; +// Coverage status has one vocabulary, coverageStatusSchema in +// src/domain/coverage.ts. A local enum that contains "complete" either copies +// it or drops `unknown`, which forces an unknown producer to pick a side. +checkCounted( + "local completeness enum (use coverageStatusSchema from src/domain/coverage)", + "local-completeness-enum", + files, + localCompletenessEnumCount, + ["src/domain/coverage.ts"], +); + // Cancellation reasons are required by `cancelledBy` in analysisErrorCore; a // direct construction can omit or replace the caller's reason. checkCounted( diff --git a/scripts/verify/completeness-enum-guard.d.mts b/scripts/verify/completeness-enum-guard.d.mts new file mode 100644 index 0000000000..825912cfb9 --- /dev/null +++ b/scripts/verify/completeness-enum-guard.d.mts @@ -0,0 +1 @@ +export function localCompletenessEnumCount(content: string): number; diff --git a/scripts/verify/completeness-enum-guard.mjs b/scripts/verify/completeness-enum-guard.mjs new file mode 100644 index 0000000000..1b8eaf2083 --- /dev/null +++ b/scripts/verify/completeness-enum-guard.mjs @@ -0,0 +1,16 @@ +// Counts local zod enums that spell a completeness vocabulary: their literal +// list contains "complete". A detail level (`"complete" | "summary"`) chooses +// how much to return, not what was examined, so a list with "summary" is not +// counted. Whitespace, including line breaks, may separate `z`, `.enum(` and +// `[`, so a formatter's chained layout (`z\n .enum([...])`) is counted like +// the inline one. +const zodEnumLiterals = /\bz\s*\.\s*enum\s*\(\s*\[([^\]]*)\]/gu; + +/** @param {string} content */ +export const localCompletenessEnumCount = (content) => { + let count = 0; + for (const [, literals] of content.matchAll(zodEnumLiterals)) + if (literals.includes('"complete"') && !literals.includes('"summary"')) + count += 1; + return count; +}; diff --git a/src/contracts/toolOutputSchemaGroups.ts b/src/contracts/toolOutputSchemaGroups.ts index 5560f9e4b7..19089b5838 100644 --- a/src/contracts/toolOutputSchemaGroups.ts +++ b/src/contracts/toolOutputSchemaGroups.ts @@ -1,3 +1,4 @@ +import { coverageStatusSchema } from "../domain/coverage.js"; import { procedureReferencesSchema } from "../domain/native/procedureReferences.js"; import { nativeAddressListSchema, @@ -279,7 +280,7 @@ const callPathTraceOutput = evidenceResultOf( goal_status: z.enum(["not_requested", "reached", "not_reached", "unknown"]), search_scope: z.object({ graph: z.literal("provider_observed_graph"), - discovery: z.enum(["complete", "partial", "unknown"]), + discovery: coverageStatusSchema, observed_goal_status: z.enum([ "not_requested", "reached", diff --git a/src/domain/analysisView/protobufCaptureView.ts b/src/domain/analysisView/protobufCaptureView.ts index 163dc48657..d24c236e78 100644 --- a/src/domain/analysisView/protobufCaptureView.ts +++ b/src/domain/analysisView/protobufCaptureView.ts @@ -1,3 +1,4 @@ +import { coverageStatusSchema } from "../coverage.js"; import { isImmutableJsonSnapshot } from "../immutableJson.js"; import { z } from "zod"; import { @@ -103,7 +104,7 @@ export const protobufViewItemsSchema = z.union([ ), ]); export const protobufViewContextSchema = z.strictObject({ - source_status: z.enum(["complete", "partial", "unknown"]), + source_status: coverageStatusSchema, retained_decoded_bodies: z.number().int().nonnegative(), }); type Request = z.output; diff --git a/src/domain/android/androidJniBindings.ts b/src/domain/android/androidJniBindings.ts index e33cd5e3e5..fabc53b6be 100644 --- a/src/domain/android/androidJniBindings.ts +++ b/src/domain/android/androidJniBindings.ts @@ -1,3 +1,4 @@ +import { coverageStatusSchema } from "../coverage.js"; import { createHash } from "node:crypto"; import { z } from "zod"; import { @@ -18,7 +19,7 @@ import { dexDescriptorSchema } from "./dexTypes.js"; const count = z.int().nonnegative(); const digest = z.string().regex(/^[a-f0-9]{64}$/u); const address = z.string().regex(/^0x[0-9a-f]+$/u); -const status = z.enum(["complete", "partial", "unknown"]); +const status = coverageStatusSchema; const ABI_LAYOUTS = new Map([ ["arm64-v8a", ["arm64", 64]], ["armeabi-v7a", ["arm", 32]], diff --git a/src/domain/android/androidJniLibraryFacts.ts b/src/domain/android/androidJniLibraryFacts.ts index 324c3d7a31..88097f38fb 100644 --- a/src/domain/android/androidJniLibraryFacts.ts +++ b/src/domain/android/androidJniLibraryFacts.ts @@ -1,9 +1,10 @@ +import { coverageStatusSchema } from "../coverage.js"; import { z } from "zod"; import { dexDescriptorSchema } from "./dexTypes.js"; const address = z.string().regex(/^0x[0-9a-f]+$/u); const index = z.number().int().nonnegative(); -const status = z.enum(["complete", "partial", "unknown"]); +const status = coverageStatusSchema; /** The exact source record that established a link-time pointer value. */ export const androidJniRelocationSourceSchema = z.strictObject({ diff --git a/src/domain/android/androidNativeDeclarations.ts b/src/domain/android/androidNativeDeclarations.ts index 41a53d12dc..057f8be212 100644 --- a/src/domain/android/androidNativeDeclarations.ts +++ b/src/domain/android/androidNativeDeclarations.ts @@ -1,3 +1,4 @@ +import { coverageStatusSchema } from "../coverage.js"; import { z } from "zod"; import { dexDescriptorSchema } from "./dexTypes.js"; @@ -33,7 +34,7 @@ export const androidNativeDeclarationsSchema = z.strictObject({ scope: z.literal("apk-root-dex-declarations"), methods: z.array(androidNativeDeclarationSchema), coverage: z.strictObject({ - status: z.enum(["complete", "partial", "unknown"]), + status: coverageStatusSchema, dex_entries: count, examined_dex_entries: count, examined_classes: count, diff --git a/src/domain/apple/appleAssetCatalog.ts b/src/domain/apple/appleAssetCatalog.ts index 9c70549d08..d0d7584dea 100644 --- a/src/domain/apple/appleAssetCatalog.ts +++ b/src/domain/apple/appleAssetCatalog.ts @@ -1,3 +1,4 @@ +import { coverageStatusSchema } from "../coverage.js"; import { z } from "zod"; import { bundleResourceBoundResultSchema } from "./bundleResourceRoot.js"; @@ -72,7 +73,7 @@ const resourceKeyMatchSchema = z.strictObject({ }); const analysisCoverageSchema = z.strictObject({ - status: z.enum(["complete", "partial", "unknown"]), + status: coverageStatusSchema, reason: z.string().nullable(), }); export type AppleAssetAnalysisCoverage = z.infer; diff --git a/src/domain/callPathSchemas.ts b/src/domain/callPathSchemas.ts index ec83360a58..429e549e40 100644 --- a/src/domain/callPathSchemas.ts +++ b/src/domain/callPathSchemas.ts @@ -1,3 +1,4 @@ +import { coverageStatusSchema } from "./coverage.js"; import { z } from "zod"; import { emptyArraySchema } from "./emptyArraySchema.js"; @@ -62,7 +63,7 @@ const resultContextShape = { }; const searchScope = { graph: z.literal("supplied_evidence"), - discovery: z.enum(["complete", "partial", "unknown"]), + discovery: coverageStatusSchema, observed_status: z.enum(["found", "not_found", "unknown"]), }; diff --git a/src/domain/coverage.ts b/src/domain/coverage.ts new file mode 100644 index 0000000000..27319eb270 --- /dev/null +++ b/src/domain/coverage.ts @@ -0,0 +1,25 @@ +import { z } from "zod"; + +/** + * How much of an examined universe a producer covered. `complete` is a claim + * the producer establishes from what it examined; `partial` records a known + * gap; `unknown` means the producer could not tell. Absence of a report is + * `unknown`, never `complete`. + */ +export const coverageStatusSchema = z.enum(["complete", "partial", "unknown"]); +export type CoverageStatus = z.infer; + +/** + * Fold the coverage of the inputs a result depends on. Unknown wins: one input + * that cannot tell makes the whole unknown, even beside a known gap. Otherwise + * any partial input makes the whole partial. Only all-complete inputs are + * complete. + */ +export const joinCoverageStatus = ( + parts: readonly [CoverageStatus, ...CoverageStatus[]], +): CoverageStatus => + parts.includes("unknown") + ? "unknown" + : parts.includes("partial") + ? "partial" + : "complete"; diff --git a/src/domain/functionComparisonSchemas.ts b/src/domain/functionComparisonSchemas.ts index 1ec68c4adb..143eea2ea5 100644 --- a/src/domain/functionComparisonSchemas.ts +++ b/src/domain/functionComparisonSchemas.ts @@ -1,6 +1,7 @@ import { z } from "zod"; import { overallStatus, summarize } from "./functionComparisonResults.js"; import { canonicalJson } from "./comparisonSemantics.js"; +import { coverageStatusSchema } from "./coverage.js"; import { evidenceInputSchema } from "./evidenceReference.js"; import { digestSchema, prefixedDigestSchema } from "./../domain/digests.js"; import { nativeAddressSchema } from "./native/nativeAddress.js"; @@ -36,8 +37,7 @@ const functionDimensionContextShape = { right_count: z.int().min(0).nullable(), evidence_links: z.array(evidenceIdSchema).min(2), limitations: z.array(z.string()), - discovery_status: z - .enum(["complete", "partial", "unknown"]) + discovery_status: coverageStatusSchema .describe( "Static call discovery coverage for the compared observations; omission means unreported.", ) diff --git a/src/domain/javascript/javascriptRouteInventory.ts b/src/domain/javascript/javascriptRouteInventory.ts index e78d57ba4c..6d6c8262c1 100644 --- a/src/domain/javascript/javascriptRouteInventory.ts +++ b/src/domain/javascript/javascriptRouteInventory.ts @@ -1,3 +1,4 @@ +import { coverageStatusSchema } from "../coverage.js"; import { javascriptSourceRangeSchema } from "./javascriptSourceCoordinates.js"; import { digestCanonicalValue } from "../canonicalDigest.js"; import { z } from "zod"; @@ -102,7 +103,7 @@ const inventoryShape = z.strictObject({ unknowns: z.array(javaScriptRouteGapSchema), coverage: z.strictObject({ scope: z.literal("provided-code-sources"), - source_parsing: z.enum(["complete", "partial", "unknown"]), + source_parsing: coverageStatusSchema, candidate_enumeration: z.enum(["complete", "partial"]), application_routes: z.literal("unknown"), }), diff --git a/src/domain/javascript/sourceToBundleComparison.test.ts b/src/domain/javascript/sourceToBundleComparison.test.ts index de688284b8..9f02c255fa 100644 --- a/src/domain/javascript/sourceToBundleComparison.test.ts +++ b/src/domain/javascript/sourceToBundleComparison.test.ts @@ -174,6 +174,35 @@ describe("historical source to bundle comparison", () => { }); }); +describe("source to bundle coverage", () => { + it.each([ + ["unknown", "complete"], + ["complete", "unknown"], + ["complete", "unavailable"], + ["partial", "unknown"], + ["unknown", "partial"], + ] as const)( + "keeps coverage unknown when the source inventory is %s and the graph is %s", + (inventory, graphCoverage) => { + const result = compareSourceToBundle({ + reference: historicalGraph(inventory, ["src/removed.ts"]), + application: { + evidenceId: EVIDENCE_ID, + rootArtifactSha256: HASH.artifact, + graph: applicationGraph(graphCoverage), + }, + }); + + expect(result.coverage).toMatchObject({ + status: "unknown", + reference_inventory_state: inventory, + application_graph_status: graphCoverage, + }); + expect(result.items[0]).toMatchObject({ status: "unknown" }); + }, + ); +}); + describe("source to bundle candidate evaluation", () => { it("evaluates all indexed candidates for each source file", () => { const result = compareSourceToBundle({ @@ -596,7 +625,7 @@ const comparePathToNodes = ( }); const historicalGraph = ( - inventoryState: "complete" | "partial", + inventoryState: "complete" | "partial" | "unknown", paths = [ "src/duplicated.ts", "src/merged-a.ts", @@ -621,7 +650,7 @@ const historicalGraph = ( limitations: inventoryState === "complete" ? [] - : ["Fixture inventory is partial."], + : [`Fixture inventory is ${inventoryState}.`], }, ...paths.map((path) => ({ path, @@ -646,10 +675,14 @@ const historicalGraph = ( caller: "source-to-bundle-test", }, limitations: - inventoryState === "complete" ? [] : ["Fixture inventory is partial."], + inventoryState === "complete" + ? [] + : [`Fixture inventory is ${inventoryState}.`], }); -const applicationGraph = (coverage: "complete" | "partial") => { +const applicationGraph = ( + coverage: "complete" | "partial" | "unknown" | "unavailable", +) => { const nodes = [ moduleNode("duplicated-a", { path: "bundle-a.js", @@ -699,14 +732,21 @@ const applicationGraph = (coverage: "complete" | "partial") => { omitted_count: 0, limits: [], } - : { - status: "partial", - truncated: true, - omitted_count: 1, - limits: [{ name: "fixture", value: 5, unit: "items" }], - }, + : coverage === "partial" + ? { + status: "partial", + truncated: true, + omitted_count: 1, + limits: [{ name: "fixture", value: 5, unit: "items" }], + } + : { + status: coverage, + truncated: false, + omitted_count: null, + limits: [], + }, limitations: - coverage === "complete" ? [] : ["Fixture graph coverage is partial."], + coverage === "complete" ? [] : [`Fixture graph coverage is ${coverage}.`], }); }; diff --git a/src/domain/javascript/sourceToBundleComparison.ts b/src/domain/javascript/sourceToBundleComparison.ts index 1a3de58760..f956097ae7 100644 --- a/src/domain/javascript/sourceToBundleComparison.ts +++ b/src/domain/javascript/sourceToBundleComparison.ts @@ -1,6 +1,7 @@ import { uniqueSorted } from "../canonicalOrdering.js"; import { compareUnicodeCodePoints } from "../unicodeCodePointOrder.js"; import { absenceClaimable } from "../comparisonSemantics.js"; +import { joinCoverageStatus } from "../coverage.js"; import { digestCanonicalValue } from "../canonicalDigest.js"; import type { JavaScriptApplicationGraph } from "./javascriptApplicationGraph.js"; @@ -365,13 +366,16 @@ interface CoverageFactors { readonly input: SourceToBundleComparisonInput; } +/** Unknown or unavailable input coverage keeps the comparison unknown. */ const coverageStatus = ( factors: CoverageFactors, ): SourceToBundleComparisonResult["coverage"]["status"] => { - return factors.input.reference.inventory_state === "complete" && - factors.input.application.graph.coverage.status === "complete" - ? "complete-within-inputs" - : "partial"; + const graph = factors.input.application.graph.coverage.status; + const status = joinCoverageStatus([ + factors.input.reference.inventory_state, + graph === "unavailable" ? "unknown" : graph, + ]); + return status === "complete" ? "complete-within-inputs" : status; }; const comparisonLimitations = (factors: CoverageFactors): string[] => diff --git a/src/domain/javascript/sourceToBundleComparisonSchemas.ts b/src/domain/javascript/sourceToBundleComparisonSchemas.ts index 3a82413d2d..a68a5ca2bd 100644 --- a/src/domain/javascript/sourceToBundleComparisonSchemas.ts +++ b/src/domain/javascript/sourceToBundleComparisonSchemas.ts @@ -1,3 +1,4 @@ +import { coverageStatusSchema } from "../coverage.js"; import { z } from "zod"; import { javaScriptFileOccurrenceSchema } from "./javascriptArtifactFiles.js"; @@ -78,7 +79,7 @@ export const sourceToBundleComparisonResultSchema = z.strictObject({ comparison_id: prefixedDigestSchema("stbc"), reference: z.strictObject({ root_sha256: digestSchema, - inventory_state: z.enum(["complete", "partial", "unknown"]), + inventory_state: coverageStatusSchema, }), application: z.strictObject({ evidence_id: evidenceIdSchema, @@ -107,8 +108,12 @@ export const sourceToBundleComparisonResultSchema = z.strictObject({ items: z.array(sourceToBundleItemSchema), unmapped_current_node_ids: z.array(nodeIdSchema), coverage: z.strictObject({ - status: z.enum(["complete-within-inputs", "partial"]), - reference_inventory_state: z.enum(["complete", "partial", "unknown"]), + status: z + .enum(["complete-within-inputs", "partial", "unknown"]) + .describe( + "complete-within-inputs only when the source inventory and graph coverage are both complete; unknown when either could not tell.", + ), + reference_inventory_state: coverageStatusSchema, application_graph_status: z.enum([ "complete", "partial", diff --git a/src/domain/protobufWire.ts b/src/domain/protobufWire.ts index e8c63a91e8..1ee2cc63c9 100644 --- a/src/domain/protobufWire.ts +++ b/src/domain/protobufWire.ts @@ -1,3 +1,4 @@ +import { coverageStatusSchema } from "./coverage.js"; import { z } from "zod"; import { absoluteLocalPathStringSchema } from "./localPath.js"; @@ -70,7 +71,7 @@ export const protobufFrameSchema = z.strictObject({ payload_offset: index, bytes: index, compressed: z.boolean(), - status: z.enum(["complete", "partial", "unknown"]), + status: coverageStatusSchema, examined_bytes: index, error: issueSchema.exactOptional(), trailers: z @@ -87,7 +88,7 @@ export const protobufDecodingObjectSchema = z.strictObject({ framing: z.enum(["raw", "grpc", "grpc-web", "grpc-web-text"]), offset_basis: z.enum(["retained-body", "base64-decoded-body"]), decoded_bytes: index, - status: z.enum(["complete", "partial", "unknown"]), + status: coverageStatusSchema, examined_bytes: index, frames: z.array(protobufFrameSchema), fields: z.array(protobufFieldSchema), diff --git a/src/domain/referenceSourceGraph.ts b/src/domain/referenceSourceGraph.ts index 625ac74921..70bb7eb1f6 100644 --- a/src/domain/referenceSourceGraph.ts +++ b/src/domain/referenceSourceGraph.ts @@ -1,3 +1,4 @@ +import { coverageStatusSchema } from "./coverage.js"; import { posix } from "node:path"; import { z } from "zod"; @@ -176,7 +177,7 @@ const graphShape = { authority: z.literal("historical-reference"), root_alias: z.literal("$REFERENCE_ROOT"), root_sha256: digestSchema, - inventory_state: z.enum(["complete", "partial", "unknown"]), + inventory_state: coverageStatusSchema, entries: z.array(sourceEntrySchema), relationships: z.array(sourceRelationshipSchema), parse_failures: z.array(parseFailureSchema), @@ -222,7 +223,7 @@ const historicalSourceManifestBaseSchema = z.strictObject({ manifest_id: prefixedDigestSchema("hsm"), graph_sha256: digestSchema, root_sha256: digestSchema, - inventory_state: z.enum(["complete", "partial", "unknown"]), + inventory_state: coverageStatusSchema, entry_count: z.int().min(0).max(Number.MAX_SAFE_INTEGER), relationship_count: z.int().min(0).max(Number.MAX_SAFE_INTEGER), }); diff --git a/src/domain/relationshipCoverage.ts b/src/domain/relationshipCoverage.ts index 27006357a7..705f165d8e 100644 --- a/src/domain/relationshipCoverage.ts +++ b/src/domain/relationshipCoverage.ts @@ -1,3 +1,4 @@ +import { coverageStatusSchema } from "./coverage.js"; import { z } from "zod"; import { fixedTupleSchema } from "./fixedTupleSchema.js"; @@ -5,7 +6,7 @@ import { fixedTupleSchema } from "./fixedTupleSchema.js"; const diagnostics = z.array(z.string().min(1)).min(1).exactOptional(); /** Discovery describes possible static calls beyond the returned provider graph. */ export const relationshipDiscoveryDirectionSchema = z.strictObject({ - status: z.enum(["complete", "partial", "unknown"]), + status: coverageStatusSchema, reason: z.string().min(1).exactOptional(), }); export const relationshipDiscoverySchema = z.strictObject({ diff --git a/tests/evaluation/completenessEnumGuard.test.ts b/tests/evaluation/completenessEnumGuard.test.ts new file mode 100644 index 0000000000..11d58bf9ae --- /dev/null +++ b/tests/evaluation/completenessEnumGuard.test.ts @@ -0,0 +1,30 @@ +import { expect, it } from "vitest"; +import { localCompletenessEnumCount } from "../../scripts/verify/completeness-enum-guard.mjs"; + +it("counts inline and chained local completeness enums", () => { + expect(localCompletenessEnumCount('z.enum(["complete", "partial"])')).toBe(1); + expect( + localCompletenessEnumCount( + 'note_coverage: z\n .enum(["complete", "partial"])\n .describe("x")', + ), + ).toBe(1); + expect( + localCompletenessEnumCount('z.enum([\n "complete",\n "partial",\n])'), + ).toBe(1); +}); + +it("ignores enums without a complete literal", () => { + expect(localCompletenessEnumCount('z.enum(["partial", "unknown"])')).toBe(0); + expect(localCompletenessEnumCount('z.enum(["completed"])')).toBe(0); +}); + +it("does not count a detail level", () => { + expect( + localCompletenessEnumCount('detail: z\n .enum(["complete", "summary"])'), + ).toBe(0); + expect( + localCompletenessEnumCount( + 'z.enum(["complete", "summary", "records", "links"])', + ), + ).toBe(0); +});