Describes a normalized changed path used for deterministic policy resolution.
Path
Kind
PreviousPath
null
.Declares one artifact slot that a producer is allowed to return.
LogicalName
RelativeRoot
MediaType
Required
MaximumBytes
Captures bounded metadata for one declared artifact without serializing its raw content.
LogicalName
RelativePath
MediaType
LengthBytes
Sha256
Binds a coverage producer's declared assertion to the existing AppSurface coverage gate thresholds.
MinLinePercent
MinBranchPercent
MinPatchLinePercent
MinPatchBranchPercent
PatchLineMode
measurable
or codecov
.TolerancePercent
Declares a producer selected by an evidence profile.
Id
Kind
coverage
or browser-e2e
.Version
RequiredResources
AssertionIds
ArtifactSlots
TimeoutSeconds
CoverageGate
EvidenceCoverageExecutionOptions? CoverageExecution { get; init; }
Source
Gets the optional built-in coverage execution envelope, defaulting to Debug, no managed test results, and serial execution.
Only coverage producers interpret this value. It does not change coverage filters, gates, or source scope.
string CoverageArtifactRetention { get; init; }
Source
Gets the optional coverage artifact retention mode, managed by default or full to retain raw duplicate XML.
Only coverage producers interpret this value. Exactly managed
and full
are supported; neither changes collection or coverage gates. The existing positional constructor remains unchanged. See the coverageArtifactRetention
reference in the coverage storage guide.
Declares an evidence resource required by a profile.
Id
Readiness
aspire_health
or completion
.DeadlineSeconds
Requires
Captures bounded terminal readiness metadata for one declared resource.
ResourceId
Outcome
ElapsedMilliseconds
Diagnostic
Defines a changed-risk requirement that must be closed before a claim is complete.
Id
RiskClass
Rationale
RequiredProducerIds
RequiredAssertionId
Defines a closed profile of resources, producers, and obligations.
Id
Scope
Resources
Producers
Obligations
Defines the shared v1 limits for one EvidenceHost profile declaration.
Maps exact paths or segment globs to a single named evidence profile.
Id
Pattern
ProfileId
Precedence
Represents a versioned, checked-in evidence policy.
Id
Version
ConservativeProfileId
Profiles
Rules
bool CombineProfiles { get; init; }
Source
Combines distinct profiles selected by matched paths into one closed profile.
Defaults to false
, preserving the conservative fallback for multi-profile selections and omitting the property from canonical JSON.
Captures the immutable result of policy resolution before resource or producer execution.
ContractVersion
PolicyId
PolicyDigest
DiffDigest
Profile
ChangedPaths
MatchedRuleIds
PlanDigest
PolicySnapshot
Captures a bounded producer result returned to the EvidenceHost.
ProducerId
Outcome
SatisfiedAssertionIds
Diagnostic
Artifacts
ElapsedMilliseconds
Captures bounded, secret-free lifecycle timing and cleanup status for one evidence execution.
PlanningMilliseconds
ResourceReadinessMilliseconds
ProducerMilliseconds
CleanupMilliseconds
TotalMilliseconds
CleanupCompleted
CleanupDiagnostic
Captures the immutable claim and execution result of an evidence run.
ContractVersion
PlanDigest
ExecutionVerdict
ClaimKind
Eligibility
EnvelopeStatus
ResourceResults
SelectedObligationIds
ClosedObligationIds
UnmediatedObligationIds
ProducerResults
Metrics
ManifestDigest
Supplies the immutable execution context exposed to a registered evidence producer.
Plan
Producer
TimeProvider
Artifacts
Represents an explicitly registered typed evidence producer.
ValueTask<EvidenceProducerResult> ProduceAsync(EvidenceProducerContext context, CancellationToken cancellationToken)
Produces bounded assertions and diagnostics for one resolved declaration.
context
cancellationToken
A terminal producer result.
string Id { get; }
Source
Gets the stable declaration identifier handled by this producer.
Writes only declared producer artifacts beneath a consumer-selected evidence root.
ValueTask<EvidenceArtifactResult> WriteAsync(string logicalName, string relativePath, ReadOnlyMemory<byte> contents, CancellationToken cancellationToken = default)
Writes one declared artifact and returns only its bounded metadata.
logicalName
relativePath
contents
cancellationToken
Hash and metadata for the written artifact.
ValueTask<EvidenceArtifactResult> WriteAsync(string logicalName, string relativePath, Stream contents, CancellationToken cancellationToken = default)
Streams one declared artifact to disk while hashing and enforcing its slot and aggregate limits.
logicalName
relativePath
contents
cancellationToken
Hash and metadata for the written artifact.
Task<bool> VerifyWrittenArtifactsAsync(CancellationToken cancellationToken = default)
Revalidates the final on-disk bytes for every artifact written through this writer.
cancellationToken
true
when every artifact still has its declared length and digest.
IReadOnlyList<EvidenceArtifactResult> WrittenArtifacts { get; }
Source
Gets completed artifact metadata emitted through this writer in ordinal logical-name order.
Validates declared evidence artifact metadata and containment without reading raw artifact contents into manifests.
bool AreValid(EvidenceProducerDeclaration producer, IReadOnlyList<EvidenceArtifactResult>? artifacts)
Validates producer artifact metadata against its closed declaration set.
producer
artifacts
true
when every artifact is declared, bounded, and valid.
string NormalizeRelativePath(string relativePath)
Normalizes an artifact-root-relative path or throws when it escapes the artifact boundary.
relativePath
Normalized forward-slash path.
void ValidatePathForSlot(EvidenceArtifactSlot slot, string relativePath)
Validates that an artifact path remains beneath the declared slot root.
slot
relativePath
string GetContainedPath(string rootPath, string relativePath)
Returns an absolute path contained beneath a controlled artifact root.
rootPath
relativePath
Contained absolute destination path.
Serializes contract objects deterministically for evidence identity and verification.
byte[] Serialize<TValue>(TValue value)
Serializes a value as canonical UTF-8 JSON with ordinal object-property order.
TValue
value
Canonical UTF-8 JSON bytes.
TValue Deserialize<TValue>(ReadOnlySpan<byte> utf8Json)
Deserializes a JSON document using the contract serializer options.
TValue
utf8Json
The deserialized value.
Builds and verifies manifest claims from a resolved plan and bounded producer results.
EvidenceManifest Build(EvidencePlan plan, IReadOnlyList<EvidenceProducerResult> producerResults, bool observationOnly = false, EvidenceEnvelopeStatus envelopeStatus = EvidenceEnvelopeStatus.NotRequired, IReadOnlyList<EvidenceResourceResult>? resourceResults = null, EvidenceExecutionMetrics? metrics = null)
Produces a manifest and closes obligations only when every declared producer and assertion requirement passed.
plan
producerResults
observationOnly
envelopeStatus
resourceResults
metrics
A digest-bound manifest.
bool Verify(EvidencePlan plan, EvidenceManifest manifest)
Validates that a manifest still binds to a supplied plan and canonical manifest content. This detects inconsistent or edited claim fields, but does not authenticate the origin of a plan or manifest. Gates must obtain both values through a trusted CI channel.
plan
manifest
true
when the binding and digest are valid.
Computes SHA-256 evidence identities from canonical bytes.
string Sha256(ReadOnlySpan<byte> bytes)
Computes a lower-case hexadecimal SHA-256 digest.
bytes
The digest.
string CanonicalSha256<TValue>(TValue value)
Computes a canonical-object digest.
TValue
value
The canonical SHA-256 digest.
Configures the bounded execution envelope for a built-in Evidence coverage producer.
Configuration
Debug
.TestResults
EvidenceCoverageTestResultFormat.None
.Parallelism
1
.This configuration selects an execution envelope; it does not change the producer's coverage filters, coverage gate thresholds, or source scope. The planner accepts simple identifiers only so a configuration value cannot inject command-line arguments. Validated values are forwarded exactly to the coverage engine.
Defines the scope selected by a versioned evidence policy.
Describes whether a resolved evidence execution satisfied its declared contract.
Defines the machine-readable claim that a manifest may make.
Defines the allowed downstream consumers of an evidence claim.
Describes the constrained status of the CI execution envelope bound to an evidence run.
Defines a terminal producer outcome.
Defines the terminal readiness outcome for one declared evidence resource.
Defines the managed test-result artifact formats available to the built-in coverage producer.