1
0
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git synced 2025-08-10 22:51:31 +02:00
Files
oauth2-proxy/pkg/middleware/request_logger_test.go
Nick Meves 602dac7852 Move Logging to Middleware Package (#1070)
* Use a specialized ResponseWriter in middleware

* Track User & Upstream in RequestScope

* Wrap responses in our custom ResponseWriter

* Add tests for logging middleware

* Inject upstream metadata into request scope

* Use custom ResponseWriter only in logging middleware

* Assume RequestScope is never nil
2021-03-06 17:27:16 +00:00

122 lines
4.7 KiB
Go

package middleware
import (
"bytes"
"net/http"
"net/http/httptest"
middlewareapi "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/middleware"
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/sessions"
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/logger"
. "github.com/onsi/ginkgo"
. "github.com/onsi/ginkgo/extensions/table"
. "github.com/onsi/gomega"
)
const RequestLoggingFormatWithoutTime = "{{.Client}} - {{.Username}} [TIMELESS] {{.Host}} {{.RequestMethod}} {{.Upstream}} {{.RequestURI}} {{.Protocol}} {{.UserAgent}} {{.StatusCode}} {{.ResponseSize}} {{.RequestDuration}}"
var _ = Describe("Request logger suite", func() {
type requestLoggerTableInput struct {
Format string
ExpectedLogMessage string
Path string
ExcludePaths []string
Upstream string
Session *sessions.SessionState
}
DescribeTable("when service a request",
func(in *requestLoggerTableInput) {
buf := bytes.NewBuffer(nil)
logger.SetOutput(buf)
logger.SetReqTemplate(in.Format)
logger.SetExcludePaths(in.ExcludePaths)
req, err := http.NewRequest("GET", in.Path, nil)
Expect(err).ToNot(HaveOccurred())
req.RemoteAddr = "127.0.0.1"
req.Host = "test-server"
scope := &middlewareapi.RequestScope{Session: in.Session}
req = middlewareapi.AddRequestScope(req, scope)
handler := NewRequestLogger()(testUpstreamHandler(in.Upstream))
handler.ServeHTTP(httptest.NewRecorder(), req)
Expect(buf.String()).To(Equal(in.ExpectedLogMessage))
},
Entry("standard request", &requestLoggerTableInput{
Format: RequestLoggingFormatWithoutTime,
ExpectedLogMessage: "127.0.0.1 - standard.user [TIMELESS] test-server GET standard \"/foo/bar\" HTTP/1.1 \"\" 200 4 0.000\n",
Path: "/foo/bar",
ExcludePaths: []string{},
Upstream: "standard",
Session: &sessions.SessionState{User: "standard.user"},
}),
Entry("with unrelated path excluded", &requestLoggerTableInput{
Format: RequestLoggingFormatWithoutTime,
ExpectedLogMessage: "127.0.0.1 - unrelated.exclusion [TIMELESS] test-server GET unrelated \"/foo/bar\" HTTP/1.1 \"\" 200 4 0.000\n",
Path: "/foo/bar",
ExcludePaths: []string{"/ping"},
Upstream: "unrelated",
Session: &sessions.SessionState{User: "unrelated.exclusion"},
}),
Entry("with path as the sole exclusion", &requestLoggerTableInput{
Format: RequestLoggingFormatWithoutTime,
ExpectedLogMessage: "",
Path: "/foo/bar",
ExcludePaths: []string{"/foo/bar"},
}),
Entry("ping path", &requestLoggerTableInput{
Format: RequestLoggingFormatWithoutTime,
ExpectedLogMessage: "127.0.0.1 - mr.ping [TIMELESS] test-server GET - \"/ping\" HTTP/1.1 \"\" 200 4 0.000\n",
Path: "/ping",
ExcludePaths: []string{},
Upstream: "",
Session: &sessions.SessionState{User: "mr.ping"},
}),
Entry("ping path but excluded", &requestLoggerTableInput{
Format: RequestLoggingFormatWithoutTime,
ExpectedLogMessage: "",
Path: "/ping",
ExcludePaths: []string{"/ping"},
Upstream: "",
Session: &sessions.SessionState{User: "mr.ping"},
}),
Entry("ping path and excluded in list", &requestLoggerTableInput{
Format: RequestLoggingFormatWithoutTime,
ExpectedLogMessage: "",
Path: "/ping",
ExcludePaths: []string{"/foo/bar", "/ping"},
}),
Entry("custom format", &requestLoggerTableInput{
Format: "{{.RequestMethod}} {{.Username}} {{.Upstream}}",
ExpectedLogMessage: "GET custom.format custom\n",
Path: "/foo/bar",
ExcludePaths: []string{""},
Upstream: "custom",
Session: &sessions.SessionState{User: "custom.format"},
}),
Entry("custom format with unrelated exclusion", &requestLoggerTableInput{
Format: "{{.RequestMethod}} {{.Username}} {{.Upstream}}",
ExpectedLogMessage: "GET custom.format custom\n",
Path: "/foo/bar",
ExcludePaths: []string{"/ping"},
Upstream: "custom",
Session: &sessions.SessionState{User: "custom.format"},
}),
Entry("custom format ping path", &requestLoggerTableInput{
Format: "{{.RequestMethod}}",
ExpectedLogMessage: "GET\n",
Path: "/ping",
ExcludePaths: []string{""},
}),
Entry("custom format ping path excluded", &requestLoggerTableInput{
Format: "{{.RequestMethod}}",
ExpectedLogMessage: "",
Path: "/ping",
ExcludePaths: []string{"/ping"},
}),
)
})