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
|
// Copyright 2020 New Relic Corporation. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
package nrgorilla
import (
"errors"
"net/http"
"net/http/httptest"
"testing"
"github.com/gorilla/mux"
"github.com/newrelic/go-agent/v3/internal"
"github.com/newrelic/go-agent/v3/internal/integrationsupport"
newrelic "github.com/newrelic/go-agent/v3/newrelic"
)
func makeHandler(text string) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte(text))
})
}
func TestBasicRoute(t *testing.T) {
app := integrationsupport.NewBasicTestApp()
r := mux.NewRouter()
r.Handle("/alpha", makeHandler("alpha response"))
InstrumentRoutes(r, app.Application)
response := httptest.NewRecorder()
req, err := http.NewRequest("GET", "/alpha", nil)
if err != nil {
t.Fatal(err)
}
r.ServeHTTP(response, req)
if respBody := response.Body.String(); respBody != "alpha response" {
t.Error("wrong response body", respBody)
}
app.ExpectTxnMetrics(t, internal.WantTxn{
Name: "GET /alpha",
IsWeb: true,
})
}
func TestSubrouterRoute(t *testing.T) {
app := integrationsupport.NewBasicTestApp()
r := mux.NewRouter()
users := r.PathPrefix("/users").Subrouter()
users.Handle("/add", makeHandler("adding user"))
InstrumentRoutes(r, app.Application)
response := httptest.NewRecorder()
req, err := http.NewRequest("GET", "/users/add", nil)
if err != nil {
t.Fatal(err)
}
r.ServeHTTP(response, req)
if respBody := response.Body.String(); respBody != "adding user" {
t.Error("wrong response body", respBody)
}
app.ExpectTxnMetrics(t, internal.WantTxn{
Name: "GET /users/add",
IsWeb: true,
})
}
func TestNamedRoute(t *testing.T) {
app := integrationsupport.NewBasicTestApp()
r := mux.NewRouter()
r.Handle("/named", makeHandler("named route")).Name("special-name-route")
InstrumentRoutes(r, app.Application)
response := httptest.NewRecorder()
req, err := http.NewRequest("GET", "/named", nil)
if err != nil {
t.Fatal(err)
}
r.ServeHTTP(response, req)
if respBody := response.Body.String(); respBody != "named route" {
t.Error("wrong response body", respBody)
}
app.ExpectTxnMetrics(t, internal.WantTxn{
Name: "special-name-route",
IsWeb: true,
})
}
func TestRouteNotFound(t *testing.T) {
app := integrationsupport.NewBasicTestApp()
r := mux.NewRouter()
r.NotFoundHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(500)
w.Write([]byte("not found"))
})
// Tests that routes do not get double instrumented when
// InstrumentRoutes is called twice by expecting error metrics with a
// count of 1.
InstrumentRoutes(r, app.Application)
InstrumentRoutes(r, app.Application)
response := httptest.NewRecorder()
req, err := http.NewRequest("GET", "/foo", nil)
if err != nil {
t.Fatal(err)
}
r.ServeHTTP(response, req)
if respBody := response.Body.String(); respBody != "not found" {
t.Error("wrong response body", respBody)
}
if response.Code != 500 {
t.Error("wrong response code", response.Code)
}
// Error metrics test the 500 response code capture.
app.ExpectTxnMetrics(t, internal.WantTxn{
Name: "NotFoundHandler",
IsWeb: true,
NumErrors: 1,
})
}
func TestNilApp(t *testing.T) {
var app *newrelic.Application
r := mux.NewRouter()
r.Handle("/alpha", makeHandler("alpha response"))
InstrumentRoutes(r, app)
response := httptest.NewRecorder()
req, err := http.NewRequest("GET", "/alpha", nil)
if err != nil {
t.Fatal(err)
}
r.ServeHTTP(response, req)
if respBody := response.Body.String(); respBody != "alpha response" {
t.Error("wrong response body", respBody)
}
}
func TestMiddlewareBasicRoute(t *testing.T) {
app := integrationsupport.NewBasicTestApp()
r := mux.NewRouter()
r.Handle("/alpha", makeHandler("alpha response"))
r.Use(Middleware(app.Application))
r.Use(func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// ensure that the txn is added to the context and accessible by
// middlewares
newrelic.FromContext(r.Context()).NoticeError(errors.New("oops"))
next.ServeHTTP(w, r)
})
})
response := httptest.NewRecorder()
req, err := http.NewRequest("GET", "/alpha", nil)
if err != nil {
t.Fatal(err)
}
r.ServeHTTP(response, req)
if respBody := response.Body.String(); respBody != "alpha response" {
t.Error("wrong response body", respBody)
}
app.ExpectTxnMetrics(t, internal.WantTxn{
Name: "GET /alpha",
IsWeb: true,
NumErrors: 1,
})
}
func TestMiddlewareNilApp(t *testing.T) {
r := mux.NewRouter()
r.Handle("/alpha", makeHandler("alpha response"))
r.Use(Middleware(nil))
response := httptest.NewRecorder()
req, err := http.NewRequest("GET", "/alpha", nil)
if err != nil {
t.Fatal(err)
}
r.ServeHTTP(response, req)
if respBody := response.Body.String(); respBody != "alpha response" {
t.Error("wrong response body", respBody)
}
}
func TestMiddlewareAndInstrumentRoutes(t *testing.T) {
// Test that only one transaction is created when Middleware and
// InstrumentRoutes are used.
app := integrationsupport.NewBasicTestApp()
r := mux.NewRouter()
r.Handle("/alpha", makeHandler("alpha response"))
r.Use(Middleware(app.Application))
InstrumentRoutes(r, app.Application)
response := httptest.NewRecorder()
req, err := http.NewRequest("GET", "/alpha", nil)
if err != nil {
t.Fatal(err)
}
r.ServeHTTP(response, req)
if respBody := response.Body.String(); respBody != "alpha response" {
t.Error("wrong response body", respBody)
}
app.ExpectTxnEvents(t, []internal.WantEvent{
{},
})
}
func TestMiddlewareNotFoundHandler(t *testing.T) {
// This test will fail if gorilla ever decides to run the NotFoundHandler
// through the middleware.
app := integrationsupport.NewBasicTestApp()
r := mux.NewRouter()
r.NotFoundHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(404)
w.Write([]byte("not found"))
})
r.Use(Middleware(app.Application))
response := httptest.NewRecorder()
req, err := http.NewRequest("GET", "/foo", nil)
if err != nil {
t.Fatal(err)
}
r.ServeHTTP(response, req)
if respBody := response.Body.String(); respBody != "not found" {
t.Error("wrong response body", respBody)
}
if response.Code != 404 {
t.Error("wrong response code", response.Code)
}
// make sure no txn events were created
app.ExpectTxnEvents(t, []internal.WantEvent{})
}
func TestMiddlewareMethodNotAllowedHandler(t *testing.T) {
// This test will fail if gorilla ever decides to run the
// MethodNotAllowedHandler through the middleware.
app := integrationsupport.NewBasicTestApp()
r := mux.NewRouter()
r.MethodNotAllowedHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(405)
w.Write([]byte("method not allowed"))
})
r.Use(Middleware(app.Application))
r.Handle("/foo", makeHandler("index")).Methods("POST")
response := httptest.NewRecorder()
req, err := http.NewRequest("GET", "/foo", nil)
if err != nil {
t.Fatal(err)
}
r.ServeHTTP(response, req)
if respBody := response.Body.String(); respBody != "method not allowed" {
t.Error("wrong response body", respBody)
}
if response.Code != 405 {
t.Error("wrong response code", response.Code)
}
// make sure no txn events were created
app.ExpectTxnEvents(t, []internal.WantEvent{})
}
|