ProtoBufMatcher import in proto not working #585

New Issue

adam · 2025-12-29T08:30:35+01:00

adam commented

2025-12-29 08:30:35 +01:00

Originally created by @vgoranski on GitHub (Mar 6, 2024).

Originally assigned to: @StefH on GitHub.

Describe the bug

I'm not sure if it's a bug or more of a feature request, but it seems that the current implmentation of ProtoBufMatcher is not supporting imports in proto.

Expected behavior:

Imports in proto work.

Test to reproduce

[Fact]
public async Task WireMockServer_WithBodyAsProtoBuf_InlineProtoDefinition_UsingGrpcGeneratedClient_UsingProtoImport()
{
    const string protoDefinition = """

                                   syntax = "proto3";

                                   import "google/protobuf/wrappers.proto";

                                   package greet;

                                   service Greeter {
                                       rpc SayHello (HelloRequest) returns (HelloReply);
                                   }

                                   message HelloRequest {
                                       string name = 1;
                                       google.protobuf.StringValue last_name = 2;
                                   }

                                   message HelloReply {
                                       string message = 1;
                                       google.protobuf.StringValue other = 2;
                                   }
                                   """;

    // Arrange
    using var server = WireMockServer.Start(useHttp2: true);

    var jsonMatcher = new JsonMatcher(new { name = "John" });

    server
        .Given(Request.Create()
                      .UsingPost()
                      .WithPath("/greet.Greeter/SayHello")
                      .WithBodyAsProtoBuf(protoDefinition, "greet.HelloRequest", jsonMatcher)
        )
        .RespondWith(Response.Create()
                             .WithHeader("Content-Type", "application/grpc")
                             .WithTrailingHeader("grpc-status", "0")
                             .WithBodyAsProtoBuf(protoDefinition, "greet.HelloReply",
                                 new
                                 {
                                     message = "hello John {{request.method}}",
                                     other = "other message"
                                 }
                             )
                             .WithTransformer()
        );

    // Act
    var channel = GrpcChannel.ForAddress(server.Url!);

    var client = new Greeter.GreeterClient(channel);

    var reply = await client.SayHelloAsync(new HelloRequest { Name = "John", LastName = "Doe" });

    // Assert
    reply.Message.Should().Be("hello John POST");
    reply.Other.Should().Be("other message");

    server.Stop();
}

Originally created by @vgoranski on GitHub (Mar 6, 2024). Originally assigned to: @StefH on GitHub. ### Describe the bug I'm not sure if it's a bug or more of a feature request, but it seems that the current implmentation of ProtoBufMatcher is not supporting imports in proto. ### Expected behavior: Imports in proto work. ### Test to reproduce ``` csharp [Fact] public async Task WireMockServer_WithBodyAsProtoBuf_InlineProtoDefinition_UsingGrpcGeneratedClient_UsingProtoImport() { const string protoDefinition = """ syntax = "proto3"; import "google/protobuf/wrappers.proto"; package greet; service Greeter { rpc SayHello (HelloRequest) returns (HelloReply); } message HelloRequest { string name = 1; google.protobuf.StringValue last_name = 2; } message HelloReply { string message = 1; google.protobuf.StringValue other = 2; } """; // Arrange using var server = WireMockServer.Start(useHttp2: true); var jsonMatcher = new JsonMatcher(new { name = "John" }); server .Given(Request.Create() .UsingPost() .WithPath("/greet.Greeter/SayHello") .WithBodyAsProtoBuf(protoDefinition, "greet.HelloRequest", jsonMatcher) ) .RespondWith(Response.Create() .WithHeader("Content-Type", "application/grpc") .WithTrailingHeader("grpc-status", "0") .WithBodyAsProtoBuf(protoDefinition, "greet.HelloReply", new { message = "hello John {{request.method}}", other = "other message" } ) .WithTransformer() ); // Act var channel = GrpcChannel.ForAddress(server.Url!); var client = new Greeter.GreeterClient(channel); var reply = await client.SayHelloAsync(new HelloRequest { Name = "John", LastName = "Doe" }); // Assert reply.Message.Should().Be("hello John POST"); reply.Other.Should().Be("other message"); server.Stop(); } ```

adam added the question label 2025-12-29 08:30:35 +01:00

adam closed this issue

2025-12-29 08:30:36 +01:00

adam commented

2025-12-29 08:30:36 +01:00

@StefH commented on GitHub (Mar 6, 2024):

Imports should work, see default example proto definition here:
https://protobuf.heyenrath.nl/

I think that the JsonMatcher will not match, I think in that case you need a https://github.com/WireMock-Net/WireMock.Net/wiki/Request-Matching-JsonPartialMatcher

@StefH commented on GitHub (Mar 6, 2024): Imports should work, see default example proto definition here: https://protobuf.heyenrath.nl/ I think that the JsonMatcher will not match, I think in that case you need a https://github.com/WireMock-Net/WireMock.Net/wiki/Request-Matching-JsonPartialMatcher

adam commented

2025-12-29 08:30:36 +01:00

@vgoranski commented on GitHub (Mar 6, 2024):

Yes, imports actually work. In my example above the problem was eventually the JsonMatcher.

I also noticed that in case when none of the types are used from the import, then there will be an error. But usually, if you use an import you should use the types from it, so I guess it's not that big of a deal.

[Fact]
public async Task WireMockServer_WithBodyAsProtoBuf_InlineProtoDefinition_UsingGrpcGeneratedClient_UsingProtoImport()
{
    const string protoDefinition = """
                                   syntax = "proto3";

                                   import "google/protobuf/wrappers.proto";

                                   package greet;

                                   service Greeter {
                                       rpc SayHello (HelloRequest) returns (HelloReply);
                                   }

                                   message HelloRequest {
                                       string name = 1;
                                   }

                                   message HelloReply {
                                       string message = 1;
                                   }
                                   """;

    // Arrange
    using var server = WireMockServer.Start(useHttp2: true);

    server
        .Given(Request.Create()
                      .UsingPost()
                      .WithPath("/greet.Greeter/SayHello")
                      .WithBodyAsProtoBuf(protoDefinition, "greet.HelloRequest")
        )
        .RespondWith(Response.Create()
                             .WithHeader("Content-Type", "application/grpc")
                             .WithTrailingHeader("grpc-status", "0")
                             .WithBodyAsProtoBuf(protoDefinition, "greet.HelloReply",
                                 new
                                 {
                                     message = "hello John {{request.method}}"
                                 }
                             )
                             .WithTransformer()
        );

    // Act
    var channel = GrpcChannel.ForAddress(server.Url!);
    var client = new Greeter.GreeterClient(channel);

    var reply = await client.SayHelloAsync(new HelloRequest { Name = "John" });

    // Assert
    reply.Message.Should().Be("hello John POST");

    server.Stop();
}

If you remove the import form this example, everything will work fine.

@vgoranski commented on GitHub (Mar 6, 2024): Yes, imports actually work. In my example above the problem was eventually the JsonMatcher. I also noticed that in case when none of the types are used from the import, then there will be an error. But usually, if you use an import you should use the types from it, so I guess it's not that big of a deal. ``` csharp [Fact] public async Task WireMockServer_WithBodyAsProtoBuf_InlineProtoDefinition_UsingGrpcGeneratedClient_UsingProtoImport() { const string protoDefinition = """ syntax = "proto3"; import "google/protobuf/wrappers.proto"; package greet; service Greeter { rpc SayHello (HelloRequest) returns (HelloReply); } message HelloRequest { string name = 1; } message HelloReply { string message = 1; } """; // Arrange using var server = WireMockServer.Start(useHttp2: true); server .Given(Request.Create() .UsingPost() .WithPath("/greet.Greeter/SayHello") .WithBodyAsProtoBuf(protoDefinition, "greet.HelloRequest") ) .RespondWith(Response.Create() .WithHeader("Content-Type", "application/grpc") .WithTrailingHeader("grpc-status", "0") .WithBodyAsProtoBuf(protoDefinition, "greet.HelloReply", new { message = "hello John {{request.method}}" } ) .WithTransformer() ); // Act var channel = GrpcChannel.ForAddress(server.Url!); var client = new Greeter.GreeterClient(channel); var reply = await client.SayHelloAsync(new HelloRequest { Name = "John" }); // Assert reply.Message.Should().Be("hello John POST"); server.Stop(); } ``` If you remove the import form this example, everything will work fine.

adam commented

2025-12-29 08:30:36 +01:00

@StefH commented on GitHub (Mar 6, 2024):

also noticed that in case when none of the types are used from the import, then there will be an error.

This is very strange, I need to check that. can you maybe create a issue here : https://github.com/StefH/ProtoBufJsonConverter ?

@StefH commented on GitHub (Mar 6, 2024): > also noticed that in case when none of the types are used from the import, then there will be an error. This is very strange, I need to check that. can you maybe create a issue here : https://github.com/StefH/ProtoBufJsonConverter ?

adam commented

2025-12-29 08:30:37 +01:00

@StefH commented on GitHub (Mar 6, 2024):

Closing this one...

@StefH commented on GitHub (Mar 6, 2024): Closing this one...

adam referenced this issue

2025-12-29 08:34:15 +01:00

[PR #585] [MERGED] Fix response date header #985

Sign in to join this conversation.

Branches Tags

master

mime-part-matcher

version-2.x

MappingSerializer

1341-mapping-json

stef-aspire-tests-updates

bug/973-TinyMapper

bug/1149-AppendGuidToSavedMappingFile

feature/1150-DockerImageVersion

61

stef-1108

stef-1097

stef-1083-MessageOptions_Type_Conflict

stef-1062-logger

stef-IgnoreOpenApiErrors

stef-928-TypeLoadException-FluentAssertions-net472

nunit

stef-849

stef-847-regex-questionmark

http_verb

WireMockServerContext

webapp

ai

CommandLineArgumentsParser

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/WireMock.Net#585