|
| 1 | +// Copyright The OpenTelemetry Authors |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +package configgrpc |
| 5 | + |
| 6 | +import ( |
| 7 | + "context" |
| 8 | + "errors" |
| 9 | + "fmt" |
| 10 | + "testing" |
| 11 | + |
| 12 | + "github.com/stretchr/testify/assert" |
| 13 | + "github.com/stretchr/testify/require" |
| 14 | + "google.golang.org/grpc" |
| 15 | + "google.golang.org/grpc/metadata" |
| 16 | + |
| 17 | + "go.opentelemetry.io/collector/component" |
| 18 | + "go.opentelemetry.io/collector/component/componenttest" |
| 19 | + "go.opentelemetry.io/collector/config/configmiddleware" |
| 20 | + "go.opentelemetry.io/collector/config/confignet" |
| 21 | + "go.opentelemetry.io/collector/config/configtls" |
| 22 | + "go.opentelemetry.io/collector/extension" |
| 23 | + "go.opentelemetry.io/collector/extension/extensionmiddleware" |
| 24 | + "go.opentelemetry.io/collector/extension/extensionmiddleware/extensionmiddlewaretest" |
| 25 | +) |
| 26 | + |
| 27 | +// testlientMiddleware is a mock implementation of a middleware extension |
| 28 | +type testClientMiddleware struct { |
| 29 | + extension.Extension |
| 30 | + extensionmiddleware.GetGRPCClientOptionsFunc |
| 31 | +} |
| 32 | + |
| 33 | +func newTestMiddlewareConfig(name string) configmiddleware.Config { |
| 34 | + return configmiddleware.Config{ |
| 35 | + ID: component.MustNewID(name), |
| 36 | + } |
| 37 | +} |
| 38 | + |
| 39 | +func newTestClientMiddleware(name string) extension.Extension { |
| 40 | + return &testClientMiddleware{ |
| 41 | + Extension: extensionmiddlewaretest.NewNop(), |
| 42 | + GetGRPCClientOptionsFunc: func() ([]grpc.DialOption, error) { |
| 43 | + return []grpc.DialOption{ |
| 44 | + grpc.WithChainUnaryInterceptor( |
| 45 | + func( |
| 46 | + ctx context.Context, |
| 47 | + method string, |
| 48 | + req, reply any, |
| 49 | + cc *grpc.ClientConn, |
| 50 | + invoker grpc.UnaryInvoker, |
| 51 | + opts ...grpc.CallOption, |
| 52 | + ) error { |
| 53 | + // Get existing metadata or create new metadata |
| 54 | + md, ok := metadata.FromOutgoingContext(ctx) |
| 55 | + if !ok { |
| 56 | + md = metadata.New(nil) |
| 57 | + } else { |
| 58 | + // Clone the metadata to avoid modifying the real metadata map |
| 59 | + md = md.Copy() |
| 60 | + } |
| 61 | + |
| 62 | + // Check if there's already a middleware sequence header |
| 63 | + sequence := "" |
| 64 | + if values := md.Get("middleware-sequence"); len(values) > 0 { |
| 65 | + sequence = values[0] |
| 66 | + } |
| 67 | + |
| 68 | + // Append this middleware's ID to the sequence |
| 69 | + if sequence == "" { |
| 70 | + sequence = name |
| 71 | + } else { |
| 72 | + sequence = fmt.Sprintf("%s,%s", sequence, name) |
| 73 | + } |
| 74 | + |
| 75 | + // Set the updated sequence |
| 76 | + md.Set("middleware-sequence", sequence) |
| 77 | + |
| 78 | + // Create a new context with the updated metadata |
| 79 | + newCtx := metadata.NewOutgoingContext(ctx, md) |
| 80 | + |
| 81 | + // Continue the call with our updated context |
| 82 | + return invoker(newCtx, method, req, reply, cc, opts...) |
| 83 | + }), |
| 84 | + }, nil |
| 85 | + }, |
| 86 | + } |
| 87 | +} |
| 88 | + |
| 89 | +// TestClientMiddlewareOrdering verifies that client middleware |
| 90 | +// interceptors are called in the right order. |
| 91 | +func TestClientMiddlewareOrdering(t *testing.T) { |
| 92 | + // Create a middleware tracking header that will be modified by our middleware interceptors |
| 93 | + const middlewareTrackingHeader = "middleware-sequence" |
| 94 | + |
| 95 | + // Create middleware extensions that will modify the metadata to track their execution order |
| 96 | + mockMiddleware1 := newTestClientMiddleware("middleware-1") |
| 97 | + mockMiddleware2 := newTestClientMiddleware("middleware-2") |
| 98 | + |
| 99 | + mockExt := map[component.ID]component.Component{ |
| 100 | + component.MustNewID("middleware1"): mockMiddleware1, |
| 101 | + component.MustNewID("middleware2"): mockMiddleware2, |
| 102 | + } |
| 103 | + |
| 104 | + // Start a gRPC server that will record the incoming metadata |
| 105 | + server := &grpcTraceServer{} |
| 106 | + srv, addr := server.startTestServer(t, ServerConfig{ |
| 107 | + NetAddr: confignet.AddrConfig{ |
| 108 | + Endpoint: "localhost:0", |
| 109 | + Transport: confignet.TransportTypeTCP, |
| 110 | + }, |
| 111 | + }) |
| 112 | + defer srv.Stop() |
| 113 | + |
| 114 | + // Create client config with middleware extensions |
| 115 | + clientConfig := ClientConfig{ |
| 116 | + Endpoint: addr, |
| 117 | + TLSSetting: configtls.ClientConfig{ |
| 118 | + Insecure: true, |
| 119 | + }, |
| 120 | + Middlewares: []configmiddleware.Config{ |
| 121 | + newTestMiddlewareConfig("middleware1"), |
| 122 | + newTestMiddlewareConfig("middleware2"), |
| 123 | + }, |
| 124 | + } |
| 125 | + |
| 126 | + // Create a test host with our mock extensions |
| 127 | + host := &mockHost{ext: mockExt} |
| 128 | + |
| 129 | + // Send a request using the client with middleware |
| 130 | + resp, err := sendTestRequestWithHost(t, clientConfig, host) |
| 131 | + require.NoError(t, err) |
| 132 | + assert.NotNil(t, resp) |
| 133 | + |
| 134 | + // Verify that the middleware order was respected as recorded in the metadata |
| 135 | + ictx, ok := metadata.FromIncomingContext(server.recordedContext) |
| 136 | + require.True(t, ok, "middleware tracking header not found in metadata") |
| 137 | + md := ictx[middlewareTrackingHeader] |
| 138 | + require.Len(t, md, 1, "expected exactly one middleware tracking header value") |
| 139 | + |
| 140 | + // The sequence should be "middleware-1,middleware-2" as that's the order they were registered |
| 141 | + expectedSequence := "middleware-1,middleware-2" |
| 142 | + assert.Equal(t, expectedSequence, md[0]) |
| 143 | +} |
| 144 | + |
| 145 | +// TestClientMiddlewareToClientErrors tests failure cases for the ToClient method |
| 146 | +// specifically related to middleware resolution and API calls. |
| 147 | +func TestClientMiddlewareToClientErrors(t *testing.T) { |
| 148 | + tests := []struct { |
| 149 | + name string |
| 150 | + host component.Host |
| 151 | + config ClientConfig |
| 152 | + errText string |
| 153 | + }{ |
| 154 | + { |
| 155 | + name: "extension_not_found", |
| 156 | + host: &mockHost{ |
| 157 | + ext: map[component.ID]component.Component{}, |
| 158 | + }, |
| 159 | + config: ClientConfig{ |
| 160 | + Endpoint: "localhost:1234", |
| 161 | + TLSSetting: configtls.ClientConfig{ |
| 162 | + Insecure: true, |
| 163 | + }, |
| 164 | + Middlewares: []configmiddleware.Config{ |
| 165 | + { |
| 166 | + ID: component.MustNewID("nonexistent"), |
| 167 | + }, |
| 168 | + }, |
| 169 | + }, |
| 170 | + errText: "failed to resolve middleware \"nonexistent\": middleware not found", |
| 171 | + }, |
| 172 | + { |
| 173 | + name: "get_client_options_fails", |
| 174 | + host: &mockHost{ |
| 175 | + ext: map[component.ID]component.Component{ |
| 176 | + component.MustNewID("errormw"): extensionmiddlewaretest.NewErr(errors.New("get options failed")), |
| 177 | + }, |
| 178 | + }, |
| 179 | + config: ClientConfig{ |
| 180 | + Endpoint: "localhost:1234", |
| 181 | + TLSSetting: configtls.ClientConfig{ |
| 182 | + Insecure: true, |
| 183 | + }, |
| 184 | + Middlewares: []configmiddleware.Config{ |
| 185 | + { |
| 186 | + ID: component.MustNewID("errormw"), |
| 187 | + }, |
| 188 | + }, |
| 189 | + }, |
| 190 | + errText: "get options failed", |
| 191 | + }, |
| 192 | + } |
| 193 | + |
| 194 | + for _, tc := range tests { |
| 195 | + t.Run(tc.name, func(t *testing.T) { |
| 196 | + // Test creating the client with middleware errors |
| 197 | + _, err := tc.config.ToClientConn(context.Background(), tc.host, componenttest.NewNopTelemetrySettings()) |
| 198 | + require.Error(t, err) |
| 199 | + assert.Contains(t, err.Error(), tc.errText) |
| 200 | + }) |
| 201 | + } |
| 202 | +} |
0 commit comments