ProtoTest.Grpc
1.0.1
dotnet add package ProtoTest.Grpc --version 1.0.1
NuGet\Install-Package ProtoTest.Grpc -Version 1.0.1
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.Grpc" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ProtoTest.Grpc" Version="1.0.1" />
<PackageReference Include="ProtoTest.Grpc" />
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.Grpc --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ProtoTest.Grpc, 1.0.1"
#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.Grpc@1.0.1
#: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.Grpc&version=1.0.1
#tool nuget:?package=ProtoTest.Grpc&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
ProtoTest.Grpc
Named gRPC channels with unary and streaming helpers, metadata authentication through [Auth<T>], shape and status assertions, and method coverage.
dotnet add package ProtoTest.Grpc
Quick start
builder.AddApplication("Api", app => app.AddGrpc(grpc => grpc.AddClient("Projects")));
[Application("Api", "Grpc:Projects")]
[Auth<BearerTokenAuthenticator>("token")]
public sealed class ProjectTests
{
[ProtoTest]
public async Task GetProject()
{
var reply = await Proto.Context.Grpc().UnaryAsync(
Projects.GetProject,
new GetProjectRequest { ProjectId = 42 });
reply.ShouldMatchShape(Proto.Context, new
{
id = 42,
status = "Active"
});
}
}
What it adds
- Client —
Proto.Context.Grpc(name?)resolves a named channel from the explicit address,ProtoTest:Applications:{app}:Grpc:Address, the application'sBaseUrl, or the in-process transport. - Call helpers —
UnaryAsync,ClientStreamingAsync,ServerStreamingAsyncand rawOpenServerStreamingAsync/OpenDuplexStreamingAsync(or the blockingServerStreaming/DuplexStreaming). - Authentication — the shared
[Auth<T>]authenticators write lowercase metadata;ProtoTest:Grpc:SensitiveMetadataKeyscontrols what is redacted in the trace. - Assertions —
ShouldMatchShape(context, shape)recordsassert.json.shape, andRpcException.ShouldHaveStatus/ShouldNotHaveStatusrecordassert.grpc.status. - Coverage —
.AddCollector<GrpcCoverageCollector>()counts{service}/{method}calls;grpc.responseobservations carry the status. - Tracing —
grpc.calloperations with protobuf request/response sections, redactedrpc.metadata.*andgrpc.attachment.failedevents when capture fails.
Configuration
| Key | Type | Default |
|---|---|---|
ProtoTest:Grpc:Metadata |
IDictionary<string, string> |
empty |
ProtoTest:Grpc:DefaultDeadline |
TimeSpan? |
null |
ProtoTest:Grpc:SensitiveMetadataKeys |
List<string> |
authorization, cookie, set-cookie, x-api-key, api-key, token, x-auth-token |
ProtoTest:Grpc:Attachments:CaptureRequestBodies |
bool |
true |
ProtoTest:Grpc:Attachments:CaptureResponses |
bool |
true |
ProtoTest:Grpc:Attachments:CaptureExpectedShapes |
bool |
true |
ProtoTest:Grpc:Attachments:RedactSensitiveData |
bool |
true |
ProtoTest:Grpc:Attachments:MaxDiagnosticBodyLength |
int |
65536 |
Attachment options inherit the shared ProtoHttpAttachmentOptions keys, including SensitiveHeaders, SensitiveQueryParameters and SensitiveJsonProperties. Streaming capture keeps only the first 10 messages, and the raw streaming helpers are untraced because the caller drives the call.
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
- Google.Protobuf (>= 3.31.1)
- Grpc.Net.Client (>= 2.70.0)
- ProtoTest.Core (>= 1.0.1)
- ProtoTest.Http (>= 1.0.1)
- ProtoTest.Json (>= 1.0.1)
-
net8.0
- Google.Protobuf (>= 3.31.1)
- Grpc.Net.Client (>= 2.70.0)
- ProtoTest.Core (>= 1.0.1)
- ProtoTest.Http (>= 1.0.1)
- ProtoTest.Json (>= 1.0.1)
-
net9.0
- Google.Protobuf (>= 3.31.1)
- Grpc.Net.Client (>= 2.70.0)
- ProtoTest.Core (>= 1.0.1)
- ProtoTest.Http (>= 1.0.1)
- ProtoTest.Json (>= 1.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.