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
|
/*
Copyright 2014 The Kubernetes 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 httplog
import (
"net/http"
"net/http/httptest"
"reflect"
"testing"
"k8s.io/apiserver/pkg/endpoints/responsewriter"
)
func TestDefaultStacktracePred(t *testing.T) {
for _, x := range []int{101, 200, 204, 302, 400, 404} {
if DefaultStacktracePred(x) {
t.Fatalf("should not log on %v by default", x)
}
}
for _, x := range []int{500, 100} {
if !DefaultStacktracePred(x) {
t.Fatalf("should log on %v by default", x)
}
}
}
func TestStatusIsNot(t *testing.T) {
statusTestTable := []struct {
status int
statuses []int
want bool
}{
{http.StatusOK, []int{}, true},
{http.StatusOK, []int{http.StatusOK}, false},
{http.StatusCreated, []int{http.StatusOK, http.StatusAccepted}, true},
}
for _, tt := range statusTestTable {
sp := StatusIsNot(tt.statuses...)
got := sp(tt.status)
if got != tt.want {
t.Errorf("Expected %v, got %v", tt.want, got)
}
}
}
func TestWithLogging(t *testing.T) {
req, err := http.NewRequest("GET", "http://example.com", nil)
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
shouldLogRequest := func() bool { return true }
var handler http.Handler
handler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
handler = withLogging(withLogging(handler, DefaultStacktracePred, shouldLogRequest), DefaultStacktracePred, shouldLogRequest)
func() {
defer func() {
if r := recover(); r == nil {
t.Errorf("Expected newLogged to panic")
}
}()
w := httptest.NewRecorder()
handler.ServeHTTP(w, req)
}()
}
func TestLogOf(t *testing.T) {
tests := []struct {
name string
shouldLogRequest bool
want string
}{
{
name: "request is being logged",
shouldLogRequest: true,
want: "*httplog.respLogger",
},
{
name: "request is not being logged",
shouldLogRequest: false,
want: "*httplog.passthroughLogger",
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
req, err := http.NewRequest("GET", "http://example.com", nil)
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
var handler http.Handler
handler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
got := reflect.TypeOf(LogOf(r, w)).String()
if test.want != got {
t.Errorf("Expected %v, got %v", test.want, got)
}
})
handler = withLogging(handler, DefaultStacktracePred, func() bool { return test.shouldLogRequest })
w := httptest.NewRecorder()
handler.ServeHTTP(w, req)
})
}
}
func TestUnlogged(t *testing.T) {
unloggedTests := []bool{true, false}
for _, makeLogger := range unloggedTests {
req, err := http.NewRequest("GET", "http://example.com", nil)
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
origWriter := httptest.NewRecorder()
var handler http.Handler
handler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
got := Unlogged(r, w)
if origWriter != got {
t.Errorf("Expected origin writer, got %#v", got)
}
})
if makeLogger {
handler = WithLogging(handler, DefaultStacktracePred)
}
handler.ServeHTTP(origWriter, req)
}
}
func TestLoggedStatus(t *testing.T) {
req, err := http.NewRequest("GET", "http://example.com", nil)
if err != nil {
t.Errorf("unexpected error: %v", err)
}
var tw http.ResponseWriter = new(responsewriter.FakeResponseWriter)
logger := newLogged(req, tw)
logger.Write(nil)
if logger.status != http.StatusOK {
t.Errorf("expected status after write to be %v, got %v", http.StatusOK, logger.status)
}
tw = new(responsewriter.FakeResponseWriter)
logger = newLogged(req, tw)
logger.WriteHeader(http.StatusForbidden)
logger.Write(nil)
if logger.status != http.StatusForbidden {
t.Errorf("expected status after write to remain %v, got %v", http.StatusForbidden, logger.status)
}
}
func TestRespLoggerWithDecoratedResponseWriter(t *testing.T) {
tests := []struct {
name string
r func() http.ResponseWriter
hijackable bool
}{
{
name: "http2",
r: func() http.ResponseWriter {
return &responsewriter.FakeResponseWriterFlusherCloseNotifier{}
},
hijackable: false,
},
{
name: "http/1.x",
r: func() http.ResponseWriter {
return &responsewriter.FakeResponseWriterFlusherCloseNotifierHijacker{}
},
hijackable: true,
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
req, err := http.NewRequest("GET", "http://example.com", nil)
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
var handler http.Handler
handler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch v := w.(type) {
case *respLogger:
t.Errorf("Did not expect %v", reflect.TypeOf(v))
return
default:
}
//lint:file-ignore SA1019 Keep supporting deprecated http.CloseNotifier
if _, ok := w.(http.CloseNotifier); !ok {
t.Errorf("Expected the ResponseWriter object to implement http.CloseNotifier")
}
if _, ok := w.(http.Flusher); !ok {
t.Errorf("Expected the ResponseWriter object to implement http.Flusher")
}
if _, ok := w.(http.Hijacker); test.hijackable != ok {
t.Errorf("http.Hijacker does not match, want: %t, got: %t", test.hijackable, ok)
}
})
handler = withLogging(handler, DefaultStacktracePred, func() bool { return true })
handler.ServeHTTP(test.r(), req)
})
}
}
func TestResponseWriterDecorator(t *testing.T) {
decorator := &respLogger{
w: &responsewriter.FakeResponseWriter{},
}
var w http.ResponseWriter = decorator
if inner := w.(responsewriter.UserProvidedDecorator).Unwrap(); inner != decorator.w {
t.Errorf("Expected the decorator to return the inner http.ResponseWriter object")
}
}
|