Changelog
Every ProtoTest package shares one version number, so this page lists releases, not packages. Each release that changes a public API lists the change under Breaking with what to write instead.
Work in progress is tracked in the repository CHANGELOG.md.
1.1.0 - 2026-09-30
ProtoTest 1.1 adds the agent evidence layer (the MCP server, diagnosis, verification, feedback and the CLI), the devices family (WebSocket and MQTT), the topology integrations (Aspire, WireMock, Testcontainers), the extended runner surface, and a rewritten documentation site with the Learn track. It ships 44 packages, 16 more than 1.0; the breaking changes are listed at the end. See Migrating from 1.0 for the renames and the deprecated surface; the docs cover the rest.
Features
Core
- readiness probes replace setup sleeps (
AddReadinessProbe,ProtoReadiness.Tcp/.Http). Infrastructure - one readiness policy (
ProtoTest:Readiness) tunes host probes and containers. Infrastructure - a per-test clock replaces sleeping (
ConfigureClock,Proto.Context.Clock,Advance/SetUtcNow). Time - targets resolve through ordered provider chains; losers record named skip reasons. Environment resolution
- applications, workers and containers declare one chain (
UseConfigured,UseInProcess). Environment resolution [RequiresTestClock]skips tests that need the test clock without a provider that bridges it. Skip conditionsIProtoTargetProvider.ConfigureServicesandResolveAfterare public. Environment resolution- infrastructure with every declared key configured is skipped, unless
AddInfrastructureAlways. Infrastructure- The old
AddInfrastructure(piece, keys)skip rule is deprecated; the provider chain replaces it. Migrating from 1.0
- The old
IProtoConfiguredInfrastructurehands infrastructure the run's settings as it starts. InfrastructureAddRunSetup(name, delegate)adds a run-scoped step after the pieces registered before it. Infrastructure- composite attributes expand recursively where attributes resolve, with cycles throwing the chain. Attributes
ProtoCapabilityDescriptor.Instancenames the instance a capability describes. Skip conditionsAddCapabilityWhenProvided/AddCapabilityUnlessConfiguredgate capabilities on keys. Skip conditions- one application-address precedence: a published address wins over configuration. Environment resolution
Proto.Context.UniqueName("tenant")derives a persistent-store-safe name from the test id. Execution contextProto.Context.Sql()is the primary accessor;Messaging(name)accepts a name. Execution context- typed skip gates (
[RequiresWorker<T>],[RequiresServer],[RequiresApplication]). Skip conditions AddCapabilityReasonstates a skip reason once for the suite, a kind or a name. Skip conditionsProtoHost.HasApplication(name)andHasCapability(kind, name, instance)answer the typed skip gates. Skip conditionsProtoResourceState.Releasingreports a resource while its release callback runs. LifecycleStartTestAsyncaccepts a cancellation token onProtoExecutionContext. Execution contextProtoTest.Jsonhosts the shared JSON read, failure diagnostics and observation capture. ExtendingIProtoConfigurableOptions.FallbackConfigurationSectionNamekeeps an old section working. ConfigurationProtoOptionsRegistration.ConfigureKeyedregisters keyed per-client options. Configuration- the extension points a third-party integration needs are public. Extending
- a bare client name resolves across applications; an ambiguous name names both candidates. Clients
- clients use protocol-scoped names and one registration path per integration. Clients
- one
Shouldassertion surface across protocols; request, message and reply assertions return their subject and chain, while Web element assertions are async. Assertions - shape matching lives under
Should.MatchShape; old spellings stay as shims. Shape matching - exhaustive shape mode (
exact: true) works on every shape surface through one matcher walk. Shape matching - OpenAPI and GraphQL collectors record the specification identity (
spec.source,spec.hash). Coverage ProtoProtocol.CoverageCategoryis optional and falls back to the protocol name. CoverageConfigureTracingcaptures CI facts withRunMetadataandRunMetadataEnvironmentVariables. ProtoTraceProtoApplication.ResolveSettingpublishes the settings-over-configuration precedence. Environment resolutionProtoAttributeOrdernames the setup order bands (Application,SessionDeclaration,Default). Hooks- suites name their own sensitive values (
ConfigureRedaction,ProtoTest:Redaction); state and findings redact them like the defaults. ProtoTrace
Hosting
AddWorkerHost<TProgram>()runs a background worker or generic host in-process with the suite. Hosting
ASP.NET Core
ProtoTestHost.For<TProgram>(builder)composes an in-process application in one line. ASP.NET CoreAddAspNetCoreServersteps aside whenBaseUrlis configured. ASP.NET CoreAddLoopbackApplicationhosts a hand-builtWebApplicationon loopback. ASP.NET Core- per-test service substitution (
Override,[ReplaceService]) builds a dedicated server. ASP.NET Core [SignedInAs]signs a test in;AddTestUserAuthentication()reads it app-side. AuthenticationProtoTestContextPropagationapplies the trace context and test id to raw requests. ASP.NET Core
REST and HTTP
- read one value by JSON path (
ReadAsJson<T>("$.id")), with the protocol's failure evidence. Responses ReadRequired<T>returnsTand fails naming the subject or path when the body is empty or null. ResponsesShould/ShouldNotassert content type, headers, cookies and redirect location. ResponsesPostAsync(...).ExpectAsync(shape)asserts the response shape where the call is made. ResponsesRestTrafficCoverageCollectorreports the fields no shape assertion mentioned. Coverage- protocol builders adopt the public authenticator, base-address and options resolvers. Extending
GraphQL
ReadDataAs<T>(jsonPath)andReadRequired<T>read data or fail naming the operation. Responses
gRPC
- client options bind
ProtoTest:Grpc:Client; the legacyProtoTest:Grpcsection still binds as a fallback. gRPC ProtoGrpcBuilder.ProtocolNamenames the protocol key. gRPC
Messaging
ProtoDestination.Queue(name)awaits a named queue; adapters without queues refuse it by name. MessagingDeclare(...)orProtoTest:Messaging:DeclaredDestinationsdeclares suite-owned destinations. Messaging- taps gain a code API (
AddMessaging(m => m.Tap(...))) that pre-binds destinations during setup. Messaging - messages carry a routing key, and
PublishAsync/AwaitAsyncaccept one. Messaging ProtoMessagereads are typed (ReadAsJson<T>,ReadRequired<T>). MessagingUseBroker(factory, addressKeys)gates the Broker capability on an address key. MessagingUseMassTransit<Program>()publishes and awaits over the app's MassTransit harness. MassTransitMassTransitEnvelope.Wrap/Unwrapbuild and read the wire envelope, addresses included. MassTransitProtoMessageConsumerBaseexposes the one await contract to adapters. Messaging- RabbitMQ taps prepare and release in parallel, cutting per-test setup and teardown. Messaging
Devices
ProtoTest.Devicestalks to simulators and hardware from the test context and trace. DevicesAddInProcessWebSocketDevicesroutes device clients through the in-process server. Devices- clients carry per-client transport settings (
WithSetting) filled intoDeviceEndpoint.Settings. Devices ProtoTest.Devices.Mqttspeaks MQTT 5;AddMqttClientdeclares the topics. DevicesProtoTest.Devices.Mqtt.Testcontainersowns a Mosquitto broker for the run. DevicesProtoDeviceConnectand its timeout live inProtoTest.Devices, shared by every transport. DevicesIProtoDeviceTransport.ConnectAsyncgains a default context overload for custom transports. Devices
Web
WebPageInventory.VisitedObservationKind/VerifiedObservationKindname the page observation kinds. Web- the backend building blocks are public (
WebBackendOptions,WebBackendErrors,WebBackendDefaults). Web PlaywrightWebOptions.MaxTraceBytescaps a browser trace; 0 turns the cap off. Web- sessions are created when requested and complete through the shared client lifecycle. Web
Sheets
model.Should.MatchHeaders()asserts the header row against the model in declaration order. Sheets- key-value sheets declare labels with
[Label]and read throughWorkbook.KeyValueModel<T>(). Sheets
SQL and Data
SqlOptions.AddressKeysdeclares the connection keys and gates the SQL and EF Core capabilities. SQLSqlAddressRulepublishes the declared-keys lookup for a sibling SQL provider. SQL- generated member defaults are deterministic per test. Defaults
Testcontainers
UseContainerandDockerProbe.IsAvailable()skip without a Docker runtime. InfrastructureApplicationContainerruns an application under test in its own image. Infrastructure
Aspire
AddAspireAppHost<TEntryPoint>()runs an AppHost when selected and publishes its resources' addresses. AspireUseAspireResourceserves an endpoint or connection string through the provider chain. Aspire- the AppHost receives the suite's configuration and the run's settings as arguments. Aspire
WireMock
AddWireMock(name)fakes HTTP dependencies per test, with stubs as coverage gaps until hit. WireMock
OpenAPI
- coverage reads specifications with
Microsoft.OpenApi3.x (JSON and YAML, including 3.1). OpenAPI
Runners and analyzers
- opt-in low-ceremony mode (
[assembly: ProtoTestAutoWrap]) wraps plain tests in the lifecycle. Runners - one outcome classifier (
ProtoTestResult) and row-name helper (ProtoTestName.ForRow). Runners - xUnit v3 and TUnit pass their per-test cancellation token into the lifecycle; MSTest's 4.0.2 floor exposes none. Execution context
dotnet new prototest --runner <name>(nunit, xunit, xunit3, tunit or mstest) writes a suite per runner. OverviewProtoTest.AnalyzersreportsPT0001andPT0002for intent the runtime cannot check. Analyzers
Agent workflows
prototest summaryprints the diagnosis document. CLIprototest index <folder>writes a static index and digest for a folder of runs. CLIprototest feedbackandprototest verifypost the channels and print a verdict. CLIprototest-mcpreads.prototracefiles over stdio (list_runs,get_failure,get_coverage). Setupget_diagnosisreturns the run digest or one failing test's context package. Diagnosis- the demo endpoint (
samples/ProtoTest.Mcp.DemoEndpoint) serves the same tools over the demo trace. Coding agents ProtoDiagnosis.Readbuilds a deterministic digest;ReadContextadds one test's context. DiagnosisProtoTest.Verificationcompares a baseline and a candidate report. VerificationProtoTest.Feedbackposts a failing run's digest to a PR comment, annotations or a webhook. Loop- the ProtoTest Feedback GitHub Action uploads the trace and posts the digest. CI
Traces and reporting
- run and test artifacts are declared and readable (
ProtoTraceArchive.Artifacts,ReadArtifact). ProtoTrace ProtoTest.Tracesreads the whole 2.0 archive and selects the viewer's failure. ProtoTraceProtoReport.ReadJsonreads the JSON report a sink wrote. Reporting- the HTML report ends with a quiet pointer to the viewer, naming the
.prototraceto drop there. Reporting
Viewer
- the walkthrough, ProtoTrace guide and viewer README describe Steps, Timeline, State and Evidence, diagnosis rules, untraced gaps and run selections, with updated demo excerpts. ProtoTrace
- State uses the same test clock and phase marks as Timeline, shades the selected operation's time across the lifelines, and highlights the items and changes it touched. The ruler stays visible on phones. ProtoTrace
- the run names attention with the diagnosis rules, marks untraced gaps on its timeline, lists every environment value and the run id, and opens run operations and tracked items in the inspector. ProtoTrace
- Evidence brings observations, files, findings and moments into time order with the operation that recorded each; details show their metadata and sections, a section index jumps through an operation, and binary bodies are marked instead of drawn as broken text (
#/test/<id>/fileslinks still open). ProtoTrace - one test list on every screen, led by the run, with one filter for every list and a path from the run to the open operation; each test is a link. ProtoTrace
- a test's Steps open on the test body: setup and teardown fold into one line that says what they did, time with no recorded operation gets its own row, and the verdict names the failure with the rule
prototest summaryuses (#/test/<id>/storylinks still open). ProtoTrace - the Timeline replaces Spans: every operation on the test's clock, zoomed per phase, with framework machinery dimmed or hidden, moments and evidence marked on their bars, and untraced time drawn through the rows (
#/test/<id>/spanslinks still open). ProtoTrace - the viewer stays responsive on a 1,000-test run; the benchmark page states the open and search times. Benchmarks
- a skipped test reads as planned in the run strip, keyboard focus and touch targets work across the viewer, and the run header's outcome pill moves under the title on narrow screens. Trace viewer
- each screen answers its question in order: failing rows name their reason, the failure names where in the test it started, step rows read stated observations inline, and an empty evidence list separates no files from no match. Trace viewer
Docs and samples
- a copy-in skill (
skills/prototest-evidence-loop) teaches agents the evidence loop and the CLI. Coding agents - the xUnit pages cover converting an existing suite and the Microsoft.Testing.Platform opt-in on SDK 10. Runners
- the integrations overview lists every
ProtoTest.Devices*package with a one-line purpose. Overview - the 44 packages are tiered into supported and preview sets, with the stability promise and the graduation path stated. Installation
- the web pages make the backend choice explicit (Playwright or Selenium), and the conversion order covers NUnit, MSTest and TUnit suites. Web
- the agent workflows document the feedback webhook payload, the configuration page lists every section's keys, and the template page shows what the scaffold creates. CLI
- the reference pages gain the recorded trace walks, the decision figures and the triage tables; the longest pages split into child pages (web page coverage, messaging adapters, gRPC calls, the ProtoTrace archive, the CI providers). Docs
- the home opens on the blueprint hero with the journey as test, composition and trace, then proves three claims with real artefacts: the plumbing each fixture stops writing, the failing check as the viewer shows it, and one model across integrations; the starter includes the working directory and runner options; the integration pages open with a shown test and keep reference detail below the tasks. Docs
- tab strips in code and the viewer walkthrough scroll with a plain mouse wheel, fade only where there is more, and keep the selected tab in view. Docs
- tabbed code keeps its copy button beside the tabs on a phone and fades the tab strip where it scrolls, and every figure in running text keeps a paragraph's distance to the text after it. Docs
- tables read on a phone: every docs table labels its cells with the column heading at build time, and below 700px a row becomes a short card with the first cell as its title; the Level 5 modes comparison does the same, and the failure tour labels its questions quietly and says what opening a card shows. Docs
- the package builder reads its choices from the integrations catalog, so it offers every shipped integration (Selenium, RabbitMQ, SQL and its containers, workers, Aspire, WireMock, devices, analyzers) grouped like the map, and a docs test keeps the catalog equal to the shipped packages. Integrations
- trace figures speak the viewer's language: the layer-by-layer trace marks each phase in its colour with quiet operation rows, and a pointer to a recorded test reads as a viewer test row with an Open in the viewer button; wrapped code keeps its first token beside the line number. ProtoTrace
- Start here opens with one paragraph and four starting points (try it, learn it, weigh it, use it) in two columns, and the sidebar narrows between tablet and wide screens so the text keeps its measure. Docs
- the READMEs follow one shape per kind, from the root to the package pages. Docs
- Northstar with the Learning demo suite is the in-repo sample. Learn
Packaging
- 44 packages pack in one version, 16 more than 1.0; the installation page lists the supported and preview tiers. Installation
Fixes
Core
- assertion messages across GraphQL, gRPC, messaging, REST and Sheets use a plain hyphen separator. Assertions
- ambient-context errors name the fix (
FindTraceWriter,SetContext, the runner setup). Lifecycle ReplaceClientwith the already-registered instance keeps its owner instead of double-disposing. Clients- trace snapshots can be read while other tests record observations, attachments and findings. ProtoTrace
- the test-clock lookup is scoped to its host, so two hosts sharing a prefix keep separate clocks. Time
ProtoClock.Advanceis atomic, so concurrent advances add up and each records its event. Time- capability conditions are evaluated per declaration; one server no longer skips another. Skip conditions
- a conditional declaration's key set compares by content, so a repeat leaves one declaration. Skip conditions
Build()is terminal; every public registration after it throws the single-build message. LifecycleAddHttpReadinessnames the later publishing piece instead of claiming in-process. InfrastructureAddHttpReadinessrejects a non-absolute address at run start, naming the configuration key. Infrastructure- shape mismatches with value constraints record every mismatch, not an internal type name. Shape matching
- malformed JSON bodies and report metadata are redacted with the same policy as the trace. Attachments
- resources restarted by a retry release with their new ownership period. Lifecycle
- a failed run start unwinds completed run hooks in reverse and keeps the trace silent. Lifecycle
- a scope disposed off its async flow records a
Lifecyclefinding and throws. Lifecycle - a throwing run gate keeps its exception and stack in the trace and report metadata. Hooks
- telemetry capture failures record one coalesced
telemetry.capture_failedevent. ProtoTrace [Application]runs before every other setup attribute. Attributes- a sink added directly to the service collection is exported once, like one added with
AddSink. Reporting - readiness waits ride the shared
ProtoPollingloop, with behavior and messages unchanged. Infrastructure - a readiness timeout names the probed URL and the last error. Infrastructure
- gRPC and messaging share one failure record and the
{protocol}.diagnostics.failedevent. ProtoTrace ResolveStatereturns only the state the[Application]attribute set during the lifecycle. ASP.NET Core- container starts and device connects are bounded on release and recorded as abandoned. Lifecycle
- a cancelled step in a collect-mode flow no longer skips the remaining steps; a cancelled flow token still stops the flow. Lifecycle
- an off-flow dispose releases the orphaned test's context before it throws. Lifecycle
Hosting
- a worker's
Program.Mainsees the run's configuration as--key=valuearguments. Hosting - a worker entry point always gets the run's
--contentRoot/--applicationName. Hosting AddWorkerHostthrows for a repeated name with another program. HostingProtoWorkerOptions.Set(key, null)delivers an empty setting. Hosting
ASP.NET Core
- the in-process HTTP client is owned by its test, fixing a teardown crash. ASP.NET Core
- a malformed
ProtoTest-Userheader leaves the request anonymous instead of a 500. ASP.NET Core - a repeated
AddAspNetCoreServername with another program throws naming both. ASP.NET Core - an unnamed
[ReplaceService]/[FailDependency]gates on the selected application. ASP.NET Core - a substituting test's dedicated server is owned before it starts. ASP.NET Core
- a method-level
[SignedInAs]keeps the class-level authenticators. Authentication
REST and HTTP
- a client bound to a configured or published address gets its own handler and cookie jar per test. Clients
- response and attachment defaults bind
ProtoTest:Http:Responses; attachments stay opt-in. Attachments - binary request and response bodies are traced as bytes with their media type. A binary response records its media type and length; it stores no decoded body, no JSON body block and no decoded text in a status assertion. Responses
GraphQL
- a null GraphQL execution result is tolerated, and subscription events are disposed as they advance. Subscriptions
- a rejected subscription names the server's errors. Subscriptions
- a fluent upload argument fails when the document is built instead of rendering as a literal. GraphQL
gRPC
- the built-in test user's metadata is redacted by default (
prototest-user). gRPC - a transport with no base address fails naming
AddClientand the application's keys. gRPC - client options are per named client; the shared section binds over each callback. gRPC
Messaging
- a null payload on a positional MassTransit contract fails naming the contract. MassTransit
- a MassTransit consumer re-baselines when a substituting test replaces the harness. MassTransit
- awaiting two destinations no longer misses the second destination's first delivery. Messaging
- awaits serialize and an unmatched delivery is kept for a later await, across brokers. Messaging
UseRabbitMqdeclares the Broker capability only when a connection string is available. MessagingAddMessagingdeclares Broker withUseBrokerWhenInProcess, replacingUseBrokerUnlessConfigured, and MassTransit's Broker follows its application's chain. MassTransit- a missing or non-amqp RabbitMQ connection string fails naming the configuration key. Messaging
UseRabbitMqruns its options callback once per registration. Messaging- RabbitMQ uses
RabbitMQ.Client7.x end to end (async connect, channel, publish, consume). Messaging - a tap with a missing exchange fails only the tests that await it, with the named error. Messaging
- publishing to a released broker throws instead of reopening, and a repeated release is a no-op. Messaging
- no coverage collector ships; destinations are deliberately not a coverage category. Coverage
Devices
- an in-process connect carries the test id, so the application resolves the test's clock. Devices
- a canceled connect is cleared, so the next send starts a fresh connect. Devices
- reusing a client name under a second application fails naming the client and both applications. Devices
- in-process transports are keyed by program and application; a path-only client fails naming the app. Devices
- the in-process transport validates its options and applies
ConnectTimeout. Devices DeviceSessionconnects single-flight and serializes sends. Devices- device resource and entity ids include the device type. Devices
- teardown disconnects and records
device.disconnect. Devices - the in-process transport declares its capability only while the application runs in-process. Devices
- a device capability needs a provided address;
ProtoDeviceClientBuilder.WithAddressKeysdeclares the keys, and the MQTT client is inert without its broker. Devices - an oversized frame fails naming the address and limit (
WebSocketDeviceOptions.MaxMessageBytes). Devices - an MQTT broker set through
configurekeeps the device capabilities, so gated tests no longer skip. Devices
Web
- a failed backend creation is no longer cached, so a session retries from a clean slate. Web
- only the backend that wins the first-wins registration declares the browser capability. Web
- Selenium
Check/SelectOptionverify the resulting state or fail within the action timeout. Interactions - assertions poll at
IWebBackend.PollInterval; over-cap traces and stuck pumps are recorded. Diagnostics - framework routes (
/_,/.well-known) are never page-inventoried. Web WebDownloadimplementsIProtoBinaryContent, so a download feedsProtoSheets.Openin one line. Web- sessions key by name and application, so the same name under two applications stays distinct. Web
Sheets
int/longreads accept only finite, integral, in-range values and fail naming the cell. Sheets- record models construct through their mapped primary constructor. Sheets
- a repeated
AddSheetscomposes its options callbacks instead of keeping the first. Sheets
SQL and Data
- optional constructor-parameter defaults win over generated values. Defaults
- a run whose declared keys are unprovided keeps the hooks inert and names the required gate. SQL
Testcontainers
- container readiness honors the run's readiness policy. Infrastructure
- a released container can be started again, and its connection string is cleared. Infrastructure
Aspire
- an AppHost for a partly configured topology publishes only the missing keys. Aspire
- a published connection string is recorded redacted, so credentials never reach the trace, while its address stays readable. Aspire
WireMock
- a run-scoped fake keeps its stubs and request log for the whole run;
Reset()clears it. WireMock - pinning Humanizer 3.0.10 avoids a
NU1608next to Aspire. WireMock WireMockAssertionExceptionderives fromProtoAssertionException. WireMock
Runners and analyzers
- an NUnit test body that throws is recorded failed with its exception and source location. NUnit
- a body
OperationCanceledExceptionrecordsCancelledunder xUnit v2 as under the other adapters. Runners - TUnit parameterized rows record their arguments in the trace name. TUnit
- the MSTest floor accepts the standard template's version, and every runner page states its framework minimum. Runners
Agent workflows
- output is written as UTF-8, so the middle-dot separator renders in a default Windows console. CLI
- the MCP host prints its usage on an unknown argument, like the CLI does. Coding agents
prototest summaryand the pull request comment print the failing operation once. Diagnosis- the shared failure selector prefers a failed operation over a deeper cancelled one that recorded an error, in the CLI, the MCP tools and the viewer. Diagnosis
Traces and reporting
- an unreadable archive under
TestResultsno longer hides readable runs elsewhere fromprototest indexand MCP discovery. Setup
Viewer
- the header keeps the brand, the path and the actions apart on a phone instead of drawing them over each other. ProtoTrace
- the tab strip is one tablist with a roving focus and arrow keys. ProtoTrace
- the run strip names each tick with the test it opens, and the inspector resizer takes arrow keys. ProtoTrace
- every key-value list in the details (an item's state, request and response fields, attributes, metadata, finding and moment facts) uses one property list: rows with a single line across both columns and keys aligned; state and fields sit in a card whose head names the namespace and the count. ProtoTrace
- a tracked item's details read as properties: the shared namespace once, short keys, values as text with their unit; its trail folds the creating change's values and shows later changes as before and after, one line each; a long path or id no longer pushes the details' head past the panel. ProtoTrace
- run operations keep their name on one line on a phone instead of breaking it letter by letter in the number column. ProtoTrace
- the run timeline reads one line per test, with the reason a hover away and the test list's filters named rather than repeated; State rows read two lines, with the change count on the ticks' hint. ProtoTrace
- the run splits into views instead of stacking every panel: Overview (Needs attention beside what the run could see, or a plain all-clear), Timeline, Operations, Details and Files, each at
#/run/<view>; a view with nothing in it has no tab, and the walkthrough shows the same shape. ProtoTrace - sideways strips (view tabs, the details' section index, workbook sheets) scroll with a plain mouse wheel while they have room, fade only on the sides that have more, and keep the selected entry in view. ProtoTrace
- fewer alarms at once: the run's Needs attention reads rule and reason on one line, the verdict bar names the rule as text and keeps its place in a tooltip, the test list's reasons are muted beside their red marks, and panel explanations move from a standing line to a styled hint beside the title, opened on hover or keyboard focus. ProtoTrace
- one Framework switch beside the view tabs shows, dims or hides framework operations in Steps and Timeline, and the machinery a test ran on in State; dim is the default, the choice is remembered, and a failing framework operation always stays. ProtoTrace
- Steps and Timeline rows name their kind as quiet text instead of a filled chip, passing checks drop their outline so only a failing one stands out, and duration bars lose the track behind them. ProtoTrace
- tertiary text on hover rows meets WCAG AA in both themes. ProtoTrace
- the inspector frames source, validated shapes, JSON bodies and code in one card with the same head, opens attached files from a row like the other links, and keeps its path and section index on one line. It leads with what went wrong: a comparison comes before the source, and the exception and check verdicts that repeat it fold to the end with the response and the attributes; the head keeps two lines. ProtoTrace
Docs and samples
- the home, Learn lessons, integration catalog and recipes use a clearer reading hierarchy; figures follow the reader theme, product previews retain blueprint, and code controls share accessible copying. Navigation and the API reference follow the existing design tokens. Home
- the sample and the template write a per-run trace, so a passing rerun cannot overwrite a failed run's evidence. Learn
- the ProtoTrace page states what
Enabled = falsedisables. ProtoTrace - the Devices page no longer lists the unshipped
device.replay. Devices - the site self-hosts its typefaces, and the viewer drops three unused Inter files. Design system
- the coverage page's viewer mock shows the shipped 44-test demo, and the home page's structured data names 1.1.0. Coverage
- the accessibility gate also covers the Learn track, the changelog, search and the 404 route. Design system
- the Learning demo's drill archives and lesson values are regenerated from the current code, and the sample README's counts match a fresh run. Learn
- every value quoted from a lesson archive matches the committed trace; the first-test walk, the readiness waits, the tenant ids and the artifact sizes were reconciled. Learn
- the teardown finding reads the same in the reporting, lifecycle and Learn pages, and the first test registers the report sink it promises. Reporting
- the viewer walkthrough carries the shipped demo's records and the viewer's own chrome, so the mocks and the real screens agree. Coverage
- the Learn track adds four lessons: the run's one host, signing in as a test user, findings and the run gate, and swapping a dependency for one test. Learn
- the home's command box offers every runner's commands, with a proof strip and a link to the conversion page. Home
- a vocabulary page for the foundation terms and the trace entities. Vocabulary
- a message-to-fix table in troubleshooting, built from the errors readers hit. Troubleshooting
- a where-your-evidence-goes map for the archive, the viewer, reports, OpenTelemetry, the CLI and MCP. Observability
- a which-runner chooser in the runner overview. Runners
- the navbar groups the API reference, trace viewer and changelog under Resources; the footer keeps focused entry points. Reference
- the reference pages lead with a runnable example, the real output and the resolution tables, and the obsolete shims move to the migration page. Docs
- the runner chooser, the observability first screens, the CI digest and the agent quickstart show real output. Runners
- the integration pages gain the sequence diagrams, the isolation table and the trace examples. Integrations
- the home leads with the task, the recipes end in trace anatomy, and the project pages lead with their verdict. Home
- the Learn track corrects the published case, the report claim and the decision tables, and names the sample consistently. Learn
- the package READMEs state the queue, container and runner semantics the code does, with one container contract. Runners
Packaging
- every package packs again (44), verified in one
eng/pack.ps1run. Installation
Breaking changes
These are the 1.0 to 1.1 migration changes; from 1.1 onward the 1.x surface stays additive.
Core
AddClientFromis removed from the REST and GraphQL builders.- Register clients under an application and configure its base URL or endpoints, or use an
AddClientresolver (Clients).
- Register clients under an application and configure its base URL or endpoints, or use an
- registration, observation and runner implementation types are internal; use the public APIs.
ProtoHostcan no longer be constructed from a service provider; useProtoHostBuilder(Lifecycle).ProtoFlowsteps declare their operation; unused retry and timeout options are gone.IProtoClientInitializer.TryInitializeAsyncno longer takes a cancellation token.- Pass one to
StartTestAsync, or use a run hook as the cancellable extension point (Lifecycle).
- Pass one to
ProtoExecutionContext.RegisterClient<T>takesProtoClientOwnershipinstead of abool.ProtoClientOwnership.Contextis a client the test owns;ProtoClientOwnership.Calleris one the caller owns (Clients).
ProtoDocumentSource.LoadTextis one method with optional parameters; the explicit overload is gone (Extending).- shape mismatches throw the protocol's assertion exception, with
JsonShapeMismatchExceptionas the inner.- Code that caught
JsonShapeMismatchExceptioncatchesProtoAssertionException(Migrating from 1.0).
- Code that caught
ProtoTest.OpenTelemetryis retired.- Subscribe to the
ProtoTestsource with.AddSource("ProtoTest")(OpenTelemetry).
- Subscribe to the
ASP.NET Core
- the package now depends on
ProtoTest.Web.Pagesinstead of the fullProtoTest.Web.
REST and HTTP
ProtoHttpAuthLifecycleHookis sealed and takes aProtoProtocolinstead of a string.ProtoHttpClientResolutionis a positional record withSourceName,SourceClientNameandDeconstructgone, andProtoHttpClientResolver.Resolvetakes the client name as an optional third argument (Extending).
- object request bodies serialize camelCase by default, matching GraphQL variables.
- Pass explicit
JsonSerializerOptionsto keep another naming policy (Migrating from 1.0).
- Pass explicit
gRPC
GrpcAttachmentOptionsno longer derives from the HTTP attachment options, soSensitiveHeadersandSensitiveQueryParametersare gone.- Metadata redaction uses the gRPC client's
SensitiveMetadataKeys(gRPC).
- Metadata redaction uses the gRPC client's
ProtoGrpcClient.ServerStreamingandDuplexStreamingmoved to the blocking facade,client.Blocking(gRPC).
Messaging
- a publish records the
messaging.publishedobservation; the operation staysmessaging.publish.- Update a collector that filtered the old observation kind (Migrating from 1.0).
RabbitMqOptions.PollIntervalis removed; awaits are event-driven andMessagingOptions.DefaultTimeoutbounds them (Messaging).
Web
ProtoTest:Web:Sessions:{name}settings no longer configure sessions.- Put addresses under
ProtoTest:Applications:{application}and select with[WebSession]orWeb()(Web).
- Put addresses under
- the reshape removed
IWebBackend.CurrentAddress, the oldWeb()overload and Selenium's download surface.- The web pages describe the replacements;
CompatibilitySuppressions.xmlrecords the removals.
- The web pages describe the replacements;
PlaywrightWebOptions.Contextis removed; configure the browser context withConfigureContext(Web).RequiresPlaywrightBrowserAttribute.Sessionis removed; the condition probes the configured browser or channel (Skip conditions).WebOperationContext.Resultis no longer public (Web).
1.0.1 - 2026-09-20
Fixed
- Preserve binary REST response artifacts byte-for-byte instead of converting them through text. This
keeps downloaded workbooks, PDFs, archives, images and other binary responses valid inside
.prototracefiles. - Correct API documentation links emitted from XML comments across the HTTP, Sheets and Web packages.
Added
- Preview
.xlsxartifacts directly in the ProtoTrace viewer, with worksheet tabs, dimensions, sticky row and column headers, typed cell values and bounded rendering for large workbooks. - Add focused, shareable recipe traces for REST-to-GraphQL, REST-to-database and workbook journeys.
- Publish a generated .NET API reference alongside the task-oriented documentation, with one command producing the complete uploadable site.
- Add documentation quality, link and API-reference workflows; contributor, support, security and code-of-conduct guidance; richer CI guidance; and interactive stack and trace examples.
Changed
- Improve the documentation landing page, navigation, SEO metadata, social preview and per-page feedback.
- Harden release validation: every ProtoTest package must share one version, every symbols package must match its DLL paths and portable-PDB identities, and a release tag must match the package version.
- Refuse duplicate NuGet versions during publishing so a rebuilt symbols package cannot be paired with an already immutable DLL from another commit.
1.0.0 - 2026-09-19
ProtoTest 1.0 is here. What began as a stubborn idea, that an integration test should read like the scenario it describes while the framework quietly owns everything around it, is now a stable foundation for .NET 8, 9 and 10. One host, one execution context and one explicit lifecycle; the test runner you already use; and every integration sharing the same assertions, evidence and coverage, all the way down to a portable trace you can open and read. Every package ships together at 1.0.0, documented, tested, and ready for production suites.
ProtoTest is a composable integration-testing foundation: compose capabilities onto a host, and each test runs through a recorded lifecycle of phases, operations, state changes, checks and findings.
Added
Host and lifecycle
- One
ProtoHostper test process and oneProtoExecutionContextper test, with run hooks and gates, test hooks, attributes, typed state, clients, attachments, findings and owned resources. - Skip conditions (
[RequiresCapability],[RequiresInProcess],[RequiresPlaywrightBrowser]) that stop a test before its lifecycle starts when the host cannot run it.
Integrations
- REST (
ProtoTest.Rest): HTTP clients,[Auth<T>], status and shape assertions, REST coverage. - GraphQL (
ProtoTest.GraphQL): queries, mutations, WebSocket/SSE subscriptions, uploads, schema coverage. - gRPC (
ProtoTest.Grpc): unary and streaming clients, metadata auth, method coverage. - Messaging (
ProtoTest.Messaging,ProtoTest.Messaging.RabbitMq): publish and await messages on an in-memory default broker or RabbitMQ. - SQL and EF Core (
ProtoTest.Sql,ProtoTest.Sql.EntityFrameworkCore): one database connection per test, optional transaction isolation, and aDbContextover the same connection. - Data (
ProtoTest.Data): deterministic builders, member defaults, provisioners and theRef<T>identity map. - ASP.NET Core in-process (
ProtoTest.AspNetCore): host the application inside the test process, with server DI access. - Browser sessions (
ProtoTest.Webwith Playwright and Selenium backends): sessions, page objects, flows, login and page coverage. - Spreadsheets (
ProtoTest.Sheets): cell, column, range, table and typed-model assertions for.xlsxfiles. - OpenAPI (
ProtoTest.OpenApi): contract coverage over REST response and shape observations. - Containers (
ProtoTest.Sql.Testcontainers,ProtoTest.Messaging.RabbitMq.Testcontainers,ProtoTest.Testcontainers): run-scoped PostgreSQL and RabbitMQ, or your ownProtoContainerResource<TContainer>.
Observability
- Coverage of REST endpoints, OpenAPI documents, GraphQL schemas, gRPC services, web pages and spreadsheet ranges.
- ProtoTrace format 2.0: a portable
.prototracebundle (spans.json,state.json) recording what ran and what existed and changed, read in the viewer. - Reports (
ProtoTest.Reporting): JSON and HTML report sinks. - OpenTelemetry bridge (
ProtoTest.OpenTelemetry): export ProtoTest operations as OpenTelemetry spans.
Runners and templates
- Adapters for NUnit, xUnit v2, xUnit v3, MSTest and TUnit, sharing one lifecycle and one set of outcomes.
ProtoTest.Templates:dotnet new prototestcreates an API and a suite for it, already composed, traced and reported.
Welcome to 1.0. Install a package, compose the capabilities your system actually has, and run the same suite in-process, in containers, or against a published environment. The trace will tell you the rest.