Add more middleware tests
This commit is contained in:
Deluan
+187
-4
@@ -3,18 +3,27 @@ package server
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"net/url"
|
||||
"os"
|
||||
|
||||
"github.com/go-chi/chi/v5"
|
||||
"github.com/navidrome/navidrome/conf"
|
||||
"github.com/navidrome/navidrome/conf/configtest"
|
||||
"github.com/navidrome/navidrome/consts"
|
||||
"github.com/navidrome/navidrome/model/request"
|
||||
. "github.com/onsi/ginkgo/v2"
|
||||
. "github.com/onsi/gomega"
|
||||
)
|
||||
|
||||
var _ = Describe("middlewares", func() {
|
||||
var nextCalled bool
|
||||
next := func(w http.ResponseWriter, r *http.Request) {
|
||||
nextCalled = true
|
||||
}
|
||||
BeforeEach(func() {
|
||||
DeferCleanup(configtest.SetupConfig())
|
||||
})
|
||||
Describe("robotsTXT", func() {
|
||||
var nextCalled bool
|
||||
next := func(w http.ResponseWriter, r *http.Request) {
|
||||
nextCalled = true
|
||||
}
|
||||
BeforeEach(func() {
|
||||
nextCalled = false
|
||||
})
|
||||
@@ -144,4 +153,178 @@ var _ = Describe("middlewares", func() {
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
Describe("clientUniqueIDMiddleware", func() {
|
||||
var (
|
||||
nextHandler http.Handler
|
||||
middleware http.Handler
|
||||
req *http.Request
|
||||
nextReq *http.Request
|
||||
rec *httptest.ResponseRecorder
|
||||
)
|
||||
|
||||
BeforeEach(func() {
|
||||
nextHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusOK)
|
||||
nextReq = r
|
||||
})
|
||||
middleware = clientUniqueIDMiddleware(nextHandler)
|
||||
req, _ = http.NewRequest(http.MethodGet, "/", nil)
|
||||
rec = httptest.NewRecorder()
|
||||
})
|
||||
|
||||
Context("when the request header has the unique client ID", func() {
|
||||
BeforeEach(func() {
|
||||
req.Header.Set(consts.UIClientUniqueIDHeader, "123456")
|
||||
conf.Server.BasePath = "/music"
|
||||
})
|
||||
|
||||
It("sets the unique client ID as a cookie and adds it to the request context", func() {
|
||||
middleware.ServeHTTP(rec, req)
|
||||
|
||||
Expect(rec.Result().Cookies()).To(HaveLen(1))
|
||||
Expect(rec.Result().Cookies()[0].Name).To(Equal(consts.UIClientUniqueIDHeader))
|
||||
Expect(rec.Result().Cookies()[0].Value).To(Equal("123456"))
|
||||
Expect(rec.Result().Cookies()[0].MaxAge).To(Equal(consts.CookieExpiry))
|
||||
Expect(rec.Result().Cookies()[0].HttpOnly).To(BeTrue())
|
||||
Expect(rec.Result().Cookies()[0].Secure).To(BeTrue())
|
||||
Expect(rec.Result().Cookies()[0].SameSite).To(Equal(http.SameSiteStrictMode))
|
||||
Expect(rec.Result().Cookies()[0].Path).To(Equal("/music"))
|
||||
clientUniqueId, _ := request.ClientUniqueIdFrom(nextReq.Context())
|
||||
Expect(clientUniqueId).To(Equal("123456"))
|
||||
})
|
||||
})
|
||||
|
||||
Context("when the request header does not have the unique client ID", func() {
|
||||
Context("when the request has the unique client ID in a cookie", func() {
|
||||
BeforeEach(func() {
|
||||
req.AddCookie(&http.Cookie{
|
||||
Name: consts.UIClientUniqueIDHeader,
|
||||
Value: "123456",
|
||||
})
|
||||
})
|
||||
|
||||
It("adds the unique client ID to the request context", func() {
|
||||
middleware.ServeHTTP(rec, req)
|
||||
|
||||
Expect(rec.Result().Cookies()).To(HaveLen(0))
|
||||
|
||||
clientUniqueId, _ := request.ClientUniqueIdFrom(nextReq.Context())
|
||||
Expect(clientUniqueId).To(Equal("123456"))
|
||||
})
|
||||
})
|
||||
|
||||
Context("when the request does not have the unique client ID in a cookie", func() {
|
||||
It("does not add the unique client ID to the request context", func() {
|
||||
middleware.ServeHTTP(rec, req)
|
||||
|
||||
Expect(rec.Result().Cookies()).To(HaveLen(0))
|
||||
|
||||
clientUniqueId, _ := request.ClientUniqueIdFrom(nextReq.Context())
|
||||
Expect(clientUniqueId).To(BeEmpty())
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
Describe("URLParamsMiddleware", func() {
|
||||
var (
|
||||
router *chi.Mux
|
||||
middleware http.Handler
|
||||
recorder *httptest.ResponseRecorder
|
||||
testHandler http.HandlerFunc
|
||||
)
|
||||
|
||||
BeforeEach(func() {
|
||||
router = chi.NewRouter()
|
||||
recorder = httptest.NewRecorder()
|
||||
testHandler = func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = w.Write([]byte("OK"))
|
||||
}
|
||||
})
|
||||
|
||||
Context("when request has no query parameters", func() {
|
||||
It("adds URL parameters to the request", func() {
|
||||
middleware = URLParamsMiddleware(testHandler)
|
||||
router.Mount("/", middleware)
|
||||
|
||||
req, _ := http.NewRequest("GET", "/?user=1", nil)
|
||||
router.ServeHTTP(recorder, req)
|
||||
|
||||
Expect(recorder.Code).To(Equal(http.StatusOK))
|
||||
Expect(recorder.Body.String()).To(Equal("OK"))
|
||||
Expect(req.URL.RawQuery).To(ContainSubstring("user=1"))
|
||||
})
|
||||
})
|
||||
|
||||
Context("when request has query parameters", func() {
|
||||
It("merges URL parameters and query parameters", func() {
|
||||
router.Route("/{key}", func(r chi.Router) {
|
||||
r.Use(URLParamsMiddleware)
|
||||
r.Get("/", testHandler)
|
||||
})
|
||||
|
||||
req, _ := http.NewRequest("GET", "/test?key=value", nil)
|
||||
router.ServeHTTP(recorder, req)
|
||||
Expect(recorder.Code).To(Equal(http.StatusOK))
|
||||
Expect(recorder.Body.String()).To(Equal("OK"))
|
||||
Expect(req.URL.RawQuery).To(ContainSubstring("key=value"))
|
||||
Expect(req.URL.RawQuery).To(ContainSubstring("%3Akey=test"))
|
||||
})
|
||||
})
|
||||
|
||||
Context("when URL parameter has wildcard key", func() {
|
||||
It("does not include wildcard key in query parameters", func() {
|
||||
router.Route("/{t*}", func(r chi.Router) {
|
||||
r.Use(URLParamsMiddleware)
|
||||
r.Get("/", testHandler)
|
||||
})
|
||||
|
||||
req, _ := http.NewRequest("GET", "/test?key=value", nil)
|
||||
router.ServeHTTP(recorder, req)
|
||||
|
||||
Expect(recorder.Code).To(Equal(http.StatusOK))
|
||||
Expect(recorder.Body.String()).To(Equal("OK"))
|
||||
Expect(req.URL.RawQuery).To(ContainSubstring("key=value"))
|
||||
})
|
||||
})
|
||||
|
||||
Context("when URL parameters require encoding", func() {
|
||||
It("encodes URL parameters correctly", func() {
|
||||
router.Route("/{key}", func(r chi.Router) {
|
||||
r.Use(URLParamsMiddleware)
|
||||
r.Get("/", testHandler)
|
||||
})
|
||||
|
||||
req, _ := http.NewRequest("GET", "/test with space?key=another value", nil)
|
||||
router.ServeHTTP(recorder, req)
|
||||
|
||||
Expect(recorder.Code).To(Equal(http.StatusOK))
|
||||
Expect(recorder.Body.String()).To(Equal("OK"))
|
||||
queryValues, _ := url.ParseQuery(req.URL.RawQuery)
|
||||
Expect(queryValues.Get(":key")).To(Equal("test with space"))
|
||||
Expect(queryValues.Get("key")).To(Equal("another value"))
|
||||
})
|
||||
})
|
||||
|
||||
Context("when there are multiple URL parameters", func() {
|
||||
It("includes all URL parameters in the query string", func() {
|
||||
router.Route("/{key}/{value}", func(r chi.Router) {
|
||||
r.Use(URLParamsMiddleware)
|
||||
r.Get("/", testHandler)
|
||||
})
|
||||
|
||||
req, _ := http.NewRequest("GET", "/test/value?key=other_value", nil)
|
||||
router.ServeHTTP(recorder, req)
|
||||
|
||||
Expect(recorder.Code).To(Equal(http.StatusOK))
|
||||
Expect(recorder.Body.String()).To(Equal("OK"))
|
||||
|
||||
queryValues, _ := url.ParseQuery(req.URL.RawQuery)
|
||||
Expect(queryValues.Get(":key")).To(Equal("test"))
|
||||
Expect(queryValues.Get(":value")).To(Equal("value"))
|
||||
Expect(queryValues.Get("key")).To(Equal("other_value"))
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
Reference in New Issue
Block a user