1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
|
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package otelhttp
import (
"bytes"
"context"
"errors"
"io"
"net/http"
"net/http/httptest"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/otel/codes"
"go.opentelemetry.io/otel/propagation"
"go.opentelemetry.io/otel/trace"
)
func TestTransportFormatter(t *testing.T) {
httpMethods := []struct {
name string
method string
expected string
}{
{
"GET method",
http.MethodGet,
"HTTP GET",
},
{
"HEAD method",
http.MethodHead,
"HTTP HEAD",
},
{
"POST method",
http.MethodPost,
"HTTP POST",
},
{
"PUT method",
http.MethodPut,
"HTTP PUT",
},
{
"PATCH method",
http.MethodPatch,
"HTTP PATCH",
},
{
"DELETE method",
http.MethodDelete,
"HTTP DELETE",
},
{
"CONNECT method",
http.MethodConnect,
"HTTP CONNECT",
},
{
"OPTIONS method",
http.MethodOptions,
"HTTP OPTIONS",
},
{
"TRACE method",
http.MethodTrace,
"HTTP TRACE",
},
}
for _, tc := range httpMethods {
t.Run(tc.name, func(t *testing.T) {
r, err := http.NewRequest(tc.method, "http://localhost/", nil)
if err != nil {
t.Fatal(err)
}
formattedName := "HTTP " + r.Method
if formattedName != tc.expected {
t.Fatalf("unexpected name: got %s, expected %s", formattedName, tc.expected)
}
})
}
}
func TestTransportBasics(t *testing.T) {
prop := propagation.TraceContext{}
content := []byte("Hello, world!")
ctx := context.Background()
sc := trace.NewSpanContext(trace.SpanContextConfig{
TraceID: trace.TraceID{0x01},
SpanID: trace.SpanID{0x01},
})
ctx = trace.ContextWithRemoteSpanContext(ctx, sc)
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctx := prop.Extract(r.Context(), propagation.HeaderCarrier(r.Header))
span := trace.SpanContextFromContext(ctx)
if span.SpanID() != sc.SpanID() {
t.Fatalf("testing remote SpanID: got %s, expected %s", span.SpanID(), sc.SpanID())
}
if _, err := w.Write(content); err != nil {
t.Fatal(err)
}
}))
defer ts.Close()
r, err := http.NewRequestWithContext(ctx, http.MethodGet, ts.URL, nil)
if err != nil {
t.Fatal(err)
}
tr := NewTransport(http.DefaultTransport, WithPropagators(prop))
c := http.Client{Transport: tr}
res, err := c.Do(r)
if err != nil {
t.Fatal(err)
}
defer func() {
if err := res.Body.Close(); err != nil {
t.Errorf("close response body: %v", err)
}
}()
body, err := io.ReadAll(res.Body)
if err != nil {
t.Fatal(err)
}
if !bytes.Equal(body, content) {
t.Fatalf("unexpected content: got %s, expected %s", body, content)
}
}
func TestNilTransport(t *testing.T) {
prop := propagation.TraceContext{}
content := []byte("Hello, world!")
ctx := context.Background()
sc := trace.NewSpanContext(trace.SpanContextConfig{
TraceID: trace.TraceID{0x01},
SpanID: trace.SpanID{0x01},
})
ctx = trace.ContextWithRemoteSpanContext(ctx, sc)
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctx := prop.Extract(r.Context(), propagation.HeaderCarrier(r.Header))
span := trace.SpanContextFromContext(ctx)
if span.SpanID() != sc.SpanID() {
t.Fatalf("testing remote SpanID: got %s, expected %s", span.SpanID(), sc.SpanID())
}
if _, err := w.Write(content); err != nil {
t.Fatal(err)
}
}))
defer ts.Close()
r, err := http.NewRequestWithContext(ctx, http.MethodGet, ts.URL, nil)
if err != nil {
t.Fatal(err)
}
tr := NewTransport(nil, WithPropagators(prop))
c := http.Client{Transport: tr}
res, err := c.Do(r)
if err != nil {
t.Fatal(err)
}
defer func() {
if err := res.Body.Close(); err != nil {
t.Errorf("close response body: %v", err)
}
}()
body, err := io.ReadAll(res.Body)
if err != nil {
t.Fatal(err)
}
if !bytes.Equal(body, content) {
t.Fatalf("unexpected content: got %s, expected %s", body, content)
}
}
const readSize = 42
type readCloser struct {
readErr, closeErr error
}
func (rc readCloser) Read(p []byte) (n int, err error) {
return readSize, rc.readErr
}
func (rc readCloser) Close() error {
return rc.closeErr
}
type span struct {
trace.Span
ended bool
recordedErr error
statusCode codes.Code
statusDesc string
}
func (s *span) End(...trace.SpanEndOption) {
s.ended = true
}
func (s *span) RecordError(err error, _ ...trace.EventOption) {
s.recordedErr = err
}
func (s *span) SetStatus(c codes.Code, d string) {
s.statusCode, s.statusDesc = c, d
}
func (s *span) assert(t *testing.T, ended bool, err error, c codes.Code, d string) { // nolint: revive // ended is not a control flag.
if ended {
assert.True(t, s.ended, "not ended")
} else {
assert.False(t, s.ended, "ended")
}
if err == nil {
assert.NoError(t, s.recordedErr, "recorded an error")
} else {
assert.Equal(t, err, s.recordedErr)
}
assert.Equal(t, c, s.statusCode, "status codes not equal")
assert.Equal(t, d, s.statusDesc, "status description not equal")
}
func TestWrappedBodyRead(t *testing.T) {
s := new(span)
called := false
record := func(numBytes int64) { called = true }
wb := newWrappedBody(s, record, readCloser{})
n, err := wb.Read([]byte{})
assert.Equal(t, readSize, n, "wrappedBody returned wrong bytes")
assert.NoError(t, err)
s.assert(t, false, nil, codes.Unset, "")
assert.False(t, called, "record should not have been called")
}
func TestWrappedBodyReadEOFError(t *testing.T) {
s := new(span)
called := false
numRecorded := int64(0)
record := func(numBytes int64) {
called = true
numRecorded = numBytes
}
wb := newWrappedBody(s, record, readCloser{readErr: io.EOF})
n, err := wb.Read([]byte{})
assert.Equal(t, readSize, n, "wrappedBody returned wrong bytes")
assert.Equal(t, io.EOF, err)
s.assert(t, true, nil, codes.Unset, "")
assert.True(t, called, "record should have been called")
assert.Equal(t, int64(readSize), numRecorded, "record recorded wrong number of bytes")
}
func TestWrappedBodyReadError(t *testing.T) {
s := new(span)
called := false
record := func(int64) { called = true }
expectedErr := errors.New("test")
wb := newWrappedBody(s, record, readCloser{readErr: expectedErr})
n, err := wb.Read([]byte{})
assert.Equal(t, readSize, n, "wrappedBody returned wrong bytes")
assert.Equal(t, expectedErr, err)
s.assert(t, false, expectedErr, codes.Error, expectedErr.Error())
assert.False(t, called, "record should not have been called")
}
func TestWrappedBodyClose(t *testing.T) {
s := new(span)
called := false
record := func(int64) { called = true }
wb := newWrappedBody(s, record, readCloser{})
assert.NoError(t, wb.Close())
s.assert(t, true, nil, codes.Unset, "")
assert.True(t, called, "record should have been called")
}
func TestWrappedBodyClosePanic(t *testing.T) {
s := new(span)
var body io.ReadCloser
wb := newWrappedBody(s, func(n int64) {}, body)
assert.NotPanics(t, func() { wb.Close() }, "nil body should not panic on close")
}
func TestWrappedBodyCloseError(t *testing.T) {
s := new(span)
called := false
record := func(int64) { called = true }
expectedErr := errors.New("test")
wb := newWrappedBody(s, record, readCloser{closeErr: expectedErr})
assert.Equal(t, expectedErr, wb.Close())
s.assert(t, true, nil, codes.Unset, "")
assert.True(t, called, "record should have been called")
}
type readWriteCloser struct {
readCloser
writeErr error
}
const writeSize = 1
func (rwc readWriteCloser) Write([]byte) (int, error) {
return writeSize, rwc.writeErr
}
func TestNewWrappedBodyReadWriteCloserImplementation(t *testing.T) {
wb := newWrappedBody(nil, func(n int64) {}, readWriteCloser{})
assert.Implements(t, (*io.ReadWriteCloser)(nil), wb)
}
func TestNewWrappedBodyReadCloserImplementation(t *testing.T) {
wb := newWrappedBody(nil, func(n int64) {}, readCloser{})
assert.Implements(t, (*io.ReadCloser)(nil), wb)
_, ok := wb.(io.ReadWriteCloser)
assert.False(t, ok, "wrappedBody should not implement io.ReadWriteCloser")
}
func TestWrappedBodyWrite(t *testing.T) {
s := new(span)
var rwc io.ReadWriteCloser
assert.NotPanics(t, func() {
rwc = newWrappedBody(s, func(n int64) {}, readWriteCloser{}).(io.ReadWriteCloser)
})
n, err := rwc.Write([]byte{})
assert.Equal(t, writeSize, n, "wrappedBody returned wrong bytes")
assert.NoError(t, err)
s.assert(t, false, nil, codes.Unset, "")
}
func TestWrappedBodyWriteError(t *testing.T) {
s := new(span)
expectedErr := errors.New("test")
var rwc io.ReadWriteCloser
assert.NotPanics(t, func() {
rwc = newWrappedBody(s,
func(n int64) {},
readWriteCloser{
writeErr: expectedErr,
}).(io.ReadWriteCloser)
})
n, err := rwc.Write([]byte{})
assert.Equal(t, writeSize, n, "wrappedBody returned wrong bytes")
assert.ErrorIs(t, err, expectedErr)
s.assert(t, false, expectedErr, codes.Error, expectedErr.Error())
}
func TestTransportProtocolSwitch(t *testing.T) {
// This test validates the fix to #1329.
// Simulate a "101 Switching Protocols" response from the test server.
response := []byte(strings.Join([]string{
"HTTP/1.1 101 Switching Protocols",
"Upgrade: WebSocket",
"Connection: Upgrade",
"", "", // Needed for extra CRLF.
}, "\r\n"))
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
conn, buf, err := w.(http.Hijacker).Hijack()
assert.NoError(t, err)
_, err = buf.Write(response)
assert.NoError(t, err)
assert.NoError(t, buf.Flush())
assert.NoError(t, conn.Close())
}))
defer ts.Close()
ctx := context.Background()
r, err := http.NewRequestWithContext(ctx, http.MethodGet, ts.URL, http.NoBody)
require.NoError(t, err)
c := http.Client{Transport: NewTransport(http.DefaultTransport)}
res, err := c.Do(r)
require.NoError(t, err)
t.Cleanup(func() { require.NoError(t, res.Body.Close()) })
assert.Implements(t, (*io.ReadWriteCloser)(nil), res.Body, "invalid body returned for protocol switch")
}
func TestTransportOriginRequestNotModify(t *testing.T) {
prop := propagation.TraceContext{}
ctx := context.Background()
sc := trace.NewSpanContext(trace.SpanContextConfig{
TraceID: trace.TraceID{0x01},
SpanID: trace.SpanID{0x01},
})
ctx = trace.ContextWithRemoteSpanContext(ctx, sc)
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusOK)
}))
defer ts.Close()
r, err := http.NewRequestWithContext(ctx, http.MethodGet, ts.URL, http.NoBody)
require.NoError(t, err)
expectedRequest := r.Clone(r.Context())
c := http.Client{Transport: NewTransport(http.DefaultTransport, WithPropagators(prop))}
res, err := c.Do(r)
require.NoError(t, err)
t.Cleanup(func() { require.NoError(t, res.Body.Close()) })
assert.Equal(t, expectedRequest, r)
}
|