ProtoTest.Reporting
1.0.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package ProtoTest.Reporting --version 1.0.0
NuGet\Install-Package ProtoTest.Reporting -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ProtoTest.Reporting" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ProtoTest.Reporting" Version="1.0.0" />
<PackageReference Include="ProtoTest.Reporting" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add ProtoTest.Reporting --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ProtoTest.Reporting, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package ProtoTest.Reporting@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=ProtoTest.Reporting&version=1.0.0
#tool nuget:?package=ProtoTest.Reporting&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
ProtoTest.Reporting
Exports the report items a run collected — coverage and the other report sources — as JSON or a self-contained HTML report.
dotnet add package ProtoTest.Reporting
Quick start
builder
.AddSink<JsonReportSink>(sink => sink.OutputPath = "TestResults/prototest.json")
.AddSink<HtmlReportSink>(sink =>
{
sink.OutputPath = "TestResults/prototest.html";
sink.Title = "Northstar Platform";
});
What it adds
- Sinks —
AddSink<JsonReportSink>()andAddSink<HtmlReportSink>()on the host builder, plus an instance overload for a prebuilt sink. - Output —
OutputPath(andIndentedfor JSON,Titlefor HTML); a missingOutputPaththrows when the sink exports. - Base type —
FileReportSink<TOptions>with protectedMediaType,ArtifactDescriptionandWriteAsyncfor your own file sink. - Lifecycle — export runs once at the end of the run, after run gates and before run-scoped resources are released; the output file becomes a run artifact in
.prototrace. - Input — items come from collectors that implement
IProtoReportSourceand fromIProtoReportSourceregistrations, deduplicated and sorted; observations are not a report source by themselves.
Configuration
| Key | Type | Default |
|---|---|---|
ProtoTest:Reporting:Json:OutputPath |
string |
TestResults/ProtoTest/report-{pid}.json |
ProtoTest:Reporting:Json:Indented |
bool |
true |
ProtoTest:Reporting:Html:OutputPath |
string |
TestResults/ProtoTest/report-{pid}.html |
ProtoTest:Reporting:Html:Title |
string |
ProtoTest Report |
The instance overload deliberately ignores configuration binding, and the report is a snapshot written before run-scoped resources are released, so a container still reads as registered.
Learn more
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- ProtoTest.Core (>= 1.0.0)
-
net8.0
- ProtoTest.Core (>= 1.0.0)
-
net9.0
- ProtoTest.Core (>= 1.0.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on ProtoTest.Reporting:
| Package | Downloads |
|---|---|
|
ProtoTest.Verification
Cross-run verification over ProtoTest reports and traces: coverage deltas, specification identity, run comparison and a verdict a PR gate can use. |
GitHub repositories
This package is not used by any popular GitHub repositories.