/* Copyright 2019 The Knative Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package tracing_test import ( "net/http" "net/url" "testing" . "knative.dev/pkg/tracing" "knative.dev/pkg/tracing/config" . "knative.dev/pkg/tracing/testing" ) type fakeWriter struct { lastWrite string } func (fw *fakeWriter) Header() http.Header { return http.Header{} } func (fw *fakeWriter) Write(data []byte) (int, error) { fw.lastWrite = string(data) return len(data), nil } func (fw *fakeWriter) WriteHeader(statusCode int) {} type benchWriter struct{} func (dw *benchWriter) Header() http.Header { return http.Header{} } func (dw *benchWriter) Write(data []byte) (int, error) { return 0, nil } func (dw *benchWriter) WriteHeader(statusCode int) {} type testHandler struct{} func (th *testHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { w.Write([]byte("fake")) } func TestHTTPSpanMiddleware(t *testing.T) { cfg := config.Config{ Backend: config.Zipkin, Debug: true, } // Create tracer with reporter recorder reporter, co := FakeZipkinExporter() oct := NewOpenCensusTracer(co) t.Cleanup(func() { reporter.Close() oct.Finish() }) if err := oct.ApplyConfig(&cfg); err != nil { t.Error("Failed to apply tracer config:", err) } next := testHandler{} middleware := HTTPSpanMiddleware(&next) fw := &fakeWriter{} req, err := http.NewRequest(http.MethodGet, "http://test.example.com", nil) if err != nil { t.Fatal("Failed to make fake request:", err) } const traceID = "821e0d50d931235a5ba3fa42eddddd8f" req.Header["X-B3-Traceid"] = []string{traceID} req.Header["X-B3-Spanid"] = []string{"b3bd5e1c4318c78a"} middleware.ServeHTTP(fw, req) // Assert our next handler was called if got, want := fw.lastWrite, "fake"; got != want { t.Errorf("HTTP Response: %q, want: %q", got, want) } spans := reporter.Flush() if len(spans) != 1 { t.Errorf("Got %d spans, expected 1: spans = %v", len(spans), spans) } if got := spans[0].TraceID.String(); got != traceID { t.Errorf("spans[0].TraceID = %s, want %s", got, traceID) } } func TestHTTPSpanIgnoringPaths(t *testing.T) { cfg := config.Config{ Backend: config.Zipkin, Debug: true, } // Create tracer with reporter recorder reporter, co := FakeZipkinExporter() oct := NewOpenCensusTracer(co) t.Cleanup(func() { reporter.Close() oct.Finish() }) if err := oct.ApplyConfig(&cfg); err != nil { t.Fatal("Failed to apply tracer config:", err) } paths := []string{"/readyz"} middleware := HTTPSpanIgnoringPaths(paths...)(&testHandler{}) testCases := []struct { name string path string traced bool }{{ name: "traced", path: "/", traced: true, }, { name: "ignored", path: paths[0], traced: false, }} for _, tc := range testCases { t.Run(tc.name, func(t *testing.T) { fw := &fakeWriter{} u := &url.URL{ Scheme: "http", Host: "test.example.com", Path: tc.path, } req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { t.Fatal("Failed to make fake request:", err) } const traceID = "821e0d50d931235a5ba3fa42eddddd8f" req.Header.Set("X-B3-Traceid", traceID) req.Header.Set("X-B3-Spanid", "b3bd5e1c4318c78a") middleware.ServeHTTP(fw, req) // Assert our next handler was called if got, want := fw.lastWrite, "fake"; got != want { t.Errorf("HTTP response: %q, want: %q", got, want) } spans := reporter.Flush() if tc.traced { if len(spans) != 1 { t.Errorf("Got %d spans, expected 1: spans = %v", len(spans), spans) } if got := spans[0].TraceID.String(); got != traceID { t.Errorf("spans[0].TraceID = %s, want %s", got, traceID) } } else if len(spans) != 0 { t.Errorf("Got %d spans, expected 0: spans = %v", len(spans), spans) } }) } } func BenchmarkSpanMiddleware(b *testing.B) { cfg := config.Config{ Backend: config.Zipkin, Debug: true, } // Create tracer with reporter recorder reporter, co := FakeZipkinExporter() oct := NewOpenCensusTracer(co) b.Cleanup(func() { reporter.Close() oct.Finish() }) if err := oct.ApplyConfig(&cfg); err != nil { b.Error("Failed to apply tracer config:", err) } next := testHandler{} middleware := HTTPSpanMiddleware(&next) bw := &benchWriter{} req, err := http.NewRequest(http.MethodGet, "http://test.example.com", nil) if err != nil { b.Fatal("Failed to make fake request:", err) } const traceID = "821e0d50d931235a5ba3fa42eddddd8f" req.Header["X-B3-Traceid"] = []string{traceID} req.Header["X-B3-Spanid"] = []string{"b3bd5e1c4318c78a"} b.Run("sequential", func(b *testing.B) { for j := 0; j < b.N; j++ { middleware.ServeHTTP(bw, req) } }) b.Run("parallel", func(b *testing.B) { b.RunParallel(func(pb *testing.PB) { for pb.Next() { middleware.ServeHTTP(bw, req) } }) }) }