Files
upstream-chi/tree_test.go
upstream-mirror 72c9f2ee75
Some checks failed
Test / test (1.24.x, ubuntu-latest) (push) Successful in 2m56s
Test / test (1.25.x, ubuntu-latest) (push) Successful in 2m15s
Test / test (1.26.x, ubuntu-latest) (push) Successful in 2m23s
Test / test (1.27.x, ubuntu-latest) (push) Failing after 3m56s
Test / test (1.24.x, windows-latest) (push) Has been cancelled
Test / test (1.25.x, windows-latest) (push) Has been cancelled
Test / test (1.26.x, windows-latest) (push) Has been cancelled
Test / test (1.27.x, windows-latest) (push) Has been cancelled
snapshot of https://github.com/go-chi/chi.git (master, 2026-09-15; blobs > 131072B omitted)
2026-09-15 21:48:17 +05:00

714 lines
27 KiB
Go

package chi
import (
"fmt"
"log"
"net/http"
"reflect"
"slices"
"testing"
)
func TestTree(t *testing.T) {
hStub := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hIndex := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hFavicon := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hArticleList := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hArticleNear := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hArticleShow := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hArticleShowRelated := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hArticleShowOpts := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hArticleSlug := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hArticleByUser := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hUserList := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hUserShow := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hAdminCatchall := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hAdminAppShow := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hAdminAppShowCatchall := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hUserProfile := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hUserSuper := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hUserAll := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hHubView1 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hHubView2 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hHubView3 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
tr := &node{}
tr.InsertRoute(mGET, "/", hIndex)
tr.InsertRoute(mGET, "/favicon.ico", hFavicon)
tr.InsertRoute(mGET, "/pages/*", hStub)
tr.InsertRoute(mGET, "/article", hArticleList)
tr.InsertRoute(mGET, "/article/", hArticleList)
tr.InsertRoute(mGET, "/article/near", hArticleNear)
tr.InsertRoute(mGET, "/article/{id}", hStub)
tr.InsertRoute(mGET, "/article/{id}", hArticleShow)
tr.InsertRoute(mGET, "/article/{id}", hArticleShow) // duplicate will have no effect
tr.InsertRoute(mGET, "/article/@{user}", hArticleByUser)
tr.InsertRoute(mGET, "/article/{sup}/{opts}", hArticleShowOpts)
tr.InsertRoute(mGET, "/article/{id}/{opts}", hArticleShowOpts) // overwrite above route, latest wins
tr.InsertRoute(mGET, "/article/{iffd}/edit", hStub)
tr.InsertRoute(mGET, "/article/{id}//related", hArticleShowRelated)
tr.InsertRoute(mGET, "/article/slug/{month}/-/{day}/{year}", hArticleSlug)
tr.InsertRoute(mGET, "/admin/user", hUserList)
tr.InsertRoute(mGET, "/admin/user/", hStub) // will get replaced by next route
tr.InsertRoute(mGET, "/admin/user/", hUserList)
tr.InsertRoute(mGET, "/admin/user//{id}", hUserShow)
tr.InsertRoute(mGET, "/admin/user/{id}", hUserShow)
tr.InsertRoute(mGET, "/admin/apps/{id}", hAdminAppShow)
tr.InsertRoute(mGET, "/admin/apps/{id}/*", hAdminAppShowCatchall)
tr.InsertRoute(mGET, "/admin/*", hStub) // catchall segment will get replaced by next route
tr.InsertRoute(mGET, "/admin/*", hAdminCatchall)
tr.InsertRoute(mGET, "/users/{userID}/profile", hUserProfile)
tr.InsertRoute(mGET, "/users/super/*", hUserSuper)
tr.InsertRoute(mGET, "/users/*", hUserAll)
tr.InsertRoute(mGET, "/hubs/{hubID}/view", hHubView1)
tr.InsertRoute(mGET, "/hubs/{hubID}/view/*", hHubView2)
sr := NewRouter()
sr.Get("/users", hHubView3)
tr.InsertRoute(mGET, "/hubs/{hubID}/*", sr)
tr.InsertRoute(mGET, "/hubs/{hubID}/users", hHubView3)
tests := []struct {
r string // input request path
h http.Handler // output matched handler
k []string // output param keys
v []string // output param values
}{
{r: "/", h: hIndex, k: []string{}, v: []string{}},
{r: "/favicon.ico", h: hFavicon, k: []string{}, v: []string{}},
{r: "/pages", h: nil, k: []string{}, v: []string{}},
{r: "/pages/", h: hStub, k: []string{"*"}, v: []string{""}},
{r: "/pages/yes", h: hStub, k: []string{"*"}, v: []string{"yes"}},
{r: "/article", h: hArticleList, k: []string{}, v: []string{}},
{r: "/article/", h: hArticleList, k: []string{}, v: []string{}},
{r: "/article/near", h: hArticleNear, k: []string{}, v: []string{}},
{r: "/article/neard", h: hArticleShow, k: []string{"id"}, v: []string{"neard"}},
{r: "/article/123", h: hArticleShow, k: []string{"id"}, v: []string{"123"}},
{r: "/article/123/456", h: hArticleShowOpts, k: []string{"id", "opts"}, v: []string{"123", "456"}},
{r: "/article/@peter", h: hArticleByUser, k: []string{"user"}, v: []string{"peter"}},
{r: "/article/22//related", h: hArticleShowRelated, k: []string{"id"}, v: []string{"22"}},
{r: "/article/111/edit", h: hStub, k: []string{"iffd"}, v: []string{"111"}},
{r: "/article/slug/sept/-/4/2015", h: hArticleSlug, k: []string{"month", "day", "year"}, v: []string{"sept", "4", "2015"}},
{r: "/article/:id", h: hArticleShow, k: []string{"id"}, v: []string{":id"}},
{r: "/admin/user", h: hUserList, k: []string{}, v: []string{}},
{r: "/admin/user/", h: hUserList, k: []string{}, v: []string{}},
{r: "/admin/user/1", h: hUserShow, k: []string{"id"}, v: []string{"1"}},
{r: "/admin/user//1", h: hUserShow, k: []string{"id"}, v: []string{"1"}},
{r: "/admin/hi", h: hAdminCatchall, k: []string{"*"}, v: []string{"hi"}},
{r: "/admin/lots/of/:fun", h: hAdminCatchall, k: []string{"*"}, v: []string{"lots/of/:fun"}},
{r: "/admin/apps/333", h: hAdminAppShow, k: []string{"id"}, v: []string{"333"}},
{r: "/admin/apps/333/woot", h: hAdminAppShowCatchall, k: []string{"id", "*"}, v: []string{"333", "woot"}},
{r: "/hubs/123/view", h: hHubView1, k: []string{"hubID"}, v: []string{"123"}},
{r: "/hubs/123/view/index.html", h: hHubView2, k: []string{"hubID", "*"}, v: []string{"123", "index.html"}},
{r: "/hubs/123/users", h: hHubView3, k: []string{"hubID"}, v: []string{"123"}},
{r: "/users/123/profile", h: hUserProfile, k: []string{"userID"}, v: []string{"123"}},
{r: "/users/super/123/okay/yes", h: hUserSuper, k: []string{"*"}, v: []string{"123/okay/yes"}},
{r: "/users/123/okay/yes", h: hUserAll, k: []string{"*"}, v: []string{"123/okay/yes"}},
}
// log.Println("~~~~~~~~~")
// log.Println("~~~~~~~~~")
// debugPrintTree(0, 0, tr, 0)
// log.Println("~~~~~~~~~")
// log.Println("~~~~~~~~~")
for i, tt := range tests {
rctx := NewRouteContext()
_, handlers, _ := tr.FindRoute(rctx, mGET, tt.r)
var handler http.Handler
if methodHandler, ok := handlers[mGET]; ok {
handler = methodHandler.handler
}
paramKeys := rctx.routeParams.Keys
paramValues := rctx.routeParams.Values
if fmt.Sprintf("%v", tt.h) != fmt.Sprintf("%v", handler) {
t.Errorf("input [%d]: find '%s' expecting handler:%v , got:%v", i, tt.r, tt.h, handler)
}
if !stringSliceEqual(tt.k, paramKeys) {
t.Errorf("input [%d]: find '%s' expecting paramKeys:(%d)%v , got:(%d)%v", i, tt.r, len(tt.k), tt.k, len(paramKeys), paramKeys)
}
if !stringSliceEqual(tt.v, paramValues) {
t.Errorf("input [%d]: find '%s' expecting paramValues:(%d)%v , got:(%d)%v", i, tt.r, len(tt.v), tt.v, len(paramValues), paramValues)
}
}
}
func TestTreeMoar(t *testing.T) {
hStub := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub1 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub2 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub3 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub4 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub5 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub6 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub7 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub8 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub9 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub10 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub11 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub12 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub13 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub14 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub15 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub16 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
// TODO: panic if we see {id}{x} because we're missing a delimiter, its not possible.
// also {:id}* is not possible.
tr := &node{}
tr.InsertRoute(mGET, "/articlefun", hStub5)
tr.InsertRoute(mGET, "/articles/{id}", hStub)
tr.InsertRoute(mDELETE, "/articles/{slug}", hStub8)
tr.InsertRoute(mGET, "/articles/search", hStub1)
tr.InsertRoute(mGET, "/articles/{id}:delete", hStub8)
tr.InsertRoute(mGET, "/articles/{iidd}!sup", hStub4)
tr.InsertRoute(mGET, "/articles/{id}:{op}", hStub3)
tr.InsertRoute(mGET, "/articles/{id}:{op}", hStub2) // this route sets a new handler for the above route
tr.InsertRoute(mGET, "/articles/{slug:^[a-z]+}/posts", hStub) // up to tail '/' will only match if contents match the rex
tr.InsertRoute(mGET, "/articles/{id}/posts/{pid}", hStub6) // /articles/123/posts/1
tr.InsertRoute(mGET, "/articles/{id}/posts/{month}/{day}/{year}/{slug}", hStub7) // /articles/123/posts/09/04/1984/juice
tr.InsertRoute(mGET, "/articles/{id}.json", hStub10)
tr.InsertRoute(mGET, "/articles/{id}/data.json", hStub11)
tr.InsertRoute(mGET, "/articles/files/{file}.{ext}", hStub12)
tr.InsertRoute(mPUT, "/articles/me", hStub13)
// TODO: make a separate test case for this one..
// tr.InsertRoute(mGET, "/articles/{id}/{id}", hStub1) // panic expected, we're duplicating param keys
tr.InsertRoute(mGET, "/pages/*", hStub)
tr.InsertRoute(mGET, "/pages/*", hStub9)
tr.InsertRoute(mGET, "/users/{id}", hStub14)
tr.InsertRoute(mGET, "/users/{id}/settings/{key}", hStub15)
tr.InsertRoute(mGET, "/users/{id}/settings/*", hStub16)
tests := []struct {
h http.Handler
r string
k []string
v []string
m methodTyp
}{
{m: mGET, r: "/articles/search", h: hStub1, k: []string{}, v: []string{}},
{m: mGET, r: "/articlefun", h: hStub5, k: []string{}, v: []string{}},
{m: mGET, r: "/articles/123", h: hStub, k: []string{"id"}, v: []string{"123"}},
{m: mDELETE, r: "/articles/123mm", h: hStub8, k: []string{"slug"}, v: []string{"123mm"}},
{m: mGET, r: "/articles/789:delete", h: hStub8, k: []string{"id"}, v: []string{"789"}},
{m: mGET, r: "/articles/789!sup", h: hStub4, k: []string{"iidd"}, v: []string{"789"}},
{m: mGET, r: "/articles/123:sync", h: hStub2, k: []string{"id", "op"}, v: []string{"123", "sync"}},
{m: mGET, r: "/articles/456/posts/1", h: hStub6, k: []string{"id", "pid"}, v: []string{"456", "1"}},
{m: mGET, r: "/articles/456/posts/09/04/1984/juice", h: hStub7, k: []string{"id", "month", "day", "year", "slug"}, v: []string{"456", "09", "04", "1984", "juice"}},
{m: mGET, r: "/articles/456.json", h: hStub10, k: []string{"id"}, v: []string{"456"}},
{m: mGET, r: "/articles/456/data.json", h: hStub11, k: []string{"id"}, v: []string{"456"}},
{m: mGET, r: "/articles/files/file.zip", h: hStub12, k: []string{"file", "ext"}, v: []string{"file", "zip"}},
{m: mGET, r: "/articles/files/photos.tar.gz", h: hStub12, k: []string{"file", "ext"}, v: []string{"photos", "tar.gz"}},
{m: mGET, r: "/articles/files/photos.tar.gz", h: hStub12, k: []string{"file", "ext"}, v: []string{"photos", "tar.gz"}},
{m: mPUT, r: "/articles/me", h: hStub13, k: []string{}, v: []string{}},
{m: mGET, r: "/articles/me", h: hStub, k: []string{"id"}, v: []string{"me"}},
{m: mGET, r: "/pages", h: nil, k: []string{}, v: []string{}},
{m: mGET, r: "/pages/", h: hStub9, k: []string{"*"}, v: []string{""}},
{m: mGET, r: "/pages/yes", h: hStub9, k: []string{"*"}, v: []string{"yes"}},
{m: mGET, r: "/users/1", h: hStub14, k: []string{"id"}, v: []string{"1"}},
{m: mGET, r: "/users/", h: nil, k: []string{}, v: []string{}},
{m: mGET, r: "/users/2/settings/password", h: hStub15, k: []string{"id", "key"}, v: []string{"2", "password"}},
{m: mGET, r: "/users/2/settings/", h: hStub16, k: []string{"id", "*"}, v: []string{"2", ""}},
}
// log.Println("~~~~~~~~~")
// log.Println("~~~~~~~~~")
// debugPrintTree(0, 0, tr, 0)
// log.Println("~~~~~~~~~")
// log.Println("~~~~~~~~~")
for i, tt := range tests {
rctx := NewRouteContext()
_, handlers, _ := tr.FindRoute(rctx, tt.m, tt.r)
var handler http.Handler
if methodHandler, ok := handlers[tt.m]; ok {
handler = methodHandler.handler
}
paramKeys := rctx.routeParams.Keys
paramValues := rctx.routeParams.Values
if fmt.Sprintf("%v", tt.h) != fmt.Sprintf("%v", handler) {
t.Errorf("input [%d]: find '%s' expecting handler:%v , got:%v", i, tt.r, tt.h, handler)
}
if !stringSliceEqual(tt.k, paramKeys) {
t.Errorf("input [%d]: find '%s' expecting paramKeys:(%d)%v , got:(%d)%v", i, tt.r, len(tt.k), tt.k, len(paramKeys), paramKeys)
}
if !stringSliceEqual(tt.v, paramValues) {
t.Errorf("input [%d]: find '%s' expecting paramValues:(%d)%v , got:(%d)%v", i, tt.r, len(tt.v), tt.v, len(paramValues), paramValues)
}
}
}
func TestTreeRegexp(t *testing.T) {
hStub1 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub2 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub3 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub4 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub5 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub6 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub7 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
tr := &node{}
tr.InsertRoute(mGET, "/articles/{rid:^[0-9]{5,6}}", hStub7)
tr.InsertRoute(mGET, "/articles/{zid:^0[0-9]+}", hStub3)
tr.InsertRoute(mGET, "/articles/{name:^@[a-z]+}/posts", hStub4)
tr.InsertRoute(mGET, "/articles/{op:^[0-9]+}/run", hStub5)
tr.InsertRoute(mGET, "/articles/{id:^[0-9]+}", hStub1)
tr.InsertRoute(mGET, "/articles/{id:^[1-9]+}-{aux}", hStub6)
tr.InsertRoute(mGET, "/articles/{slug}", hStub2)
// log.Println("~~~~~~~~~")
// log.Println("~~~~~~~~~")
// debugPrintTree(0, 0, tr, 0)
// log.Println("~~~~~~~~~")
// log.Println("~~~~~~~~~")
tests := []struct {
r string // input request path
h http.Handler // output matched handler
k []string // output param keys
v []string // output param values
}{
{r: "/articles", h: nil, k: []string{}, v: []string{}},
{r: "/articles/12345", h: hStub7, k: []string{"rid"}, v: []string{"12345"}},
{r: "/articles/123", h: hStub1, k: []string{"id"}, v: []string{"123"}},
{r: "/articles/how-to-build-a-router", h: hStub2, k: []string{"slug"}, v: []string{"how-to-build-a-router"}},
{r: "/articles/0456", h: hStub3, k: []string{"zid"}, v: []string{"0456"}},
{r: "/articles/@pk/posts", h: hStub4, k: []string{"name"}, v: []string{"@pk"}},
{r: "/articles/1/run", h: hStub5, k: []string{"op"}, v: []string{"1"}},
{r: "/articles/1122", h: hStub1, k: []string{"id"}, v: []string{"1122"}},
{r: "/articles/1122-yes", h: hStub6, k: []string{"id", "aux"}, v: []string{"1122", "yes"}},
}
for i, tt := range tests {
rctx := NewRouteContext()
_, handlers, _ := tr.FindRoute(rctx, mGET, tt.r)
var handler http.Handler
if methodHandler, ok := handlers[mGET]; ok {
handler = methodHandler.handler
}
paramKeys := rctx.routeParams.Keys
paramValues := rctx.routeParams.Values
if fmt.Sprintf("%v", tt.h) != fmt.Sprintf("%v", handler) {
t.Errorf("input [%d]: find '%s' expecting handler:%v , got:%v", i, tt.r, tt.h, handler)
}
if !stringSliceEqual(tt.k, paramKeys) {
t.Errorf("input [%d]: find '%s' expecting paramKeys:(%d)%v , got:(%d)%v", i, tt.r, len(tt.k), tt.k, len(paramKeys), paramKeys)
}
if !stringSliceEqual(tt.v, paramValues) {
t.Errorf("input [%d]: find '%s' expecting paramValues:(%d)%v , got:(%d)%v", i, tt.r, len(tt.v), tt.v, len(paramValues), paramValues)
}
}
}
func TestTreeRegexpRecursive(t *testing.T) {
hStub1 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub2 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
tr := &node{}
tr.InsertRoute(mGET, "/one/{firstId:[a-z0-9-]+}/{secondId:[a-z0-9-]+}/first", hStub1)
tr.InsertRoute(mGET, "/one/{firstId:[a-z0-9-_]+}/{secondId:[a-z0-9-_]+}/second", hStub2)
// log.Println("~~~~~~~~~")
// log.Println("~~~~~~~~~")
// debugPrintTree(0, 0, tr, 0)
// log.Println("~~~~~~~~~")
// log.Println("~~~~~~~~~")
tests := []struct {
r string // input request path
h http.Handler // output matched handler
k []string // output param keys
v []string // output param values
}{
{r: "/one/hello/world/first", h: hStub1, k: []string{"firstId", "secondId"}, v: []string{"hello", "world"}},
{r: "/one/hi_there/ok/second", h: hStub2, k: []string{"firstId", "secondId"}, v: []string{"hi_there", "ok"}},
{r: "/one///first", h: nil, k: []string{}, v: []string{}},
{r: "/one/hi/123/second", h: hStub2, k: []string{"firstId", "secondId"}, v: []string{"hi", "123"}},
}
for i, tt := range tests {
rctx := NewRouteContext()
_, handlers, _ := tr.FindRoute(rctx, mGET, tt.r)
var handler http.Handler
if methodHandler, ok := handlers[mGET]; ok {
handler = methodHandler.handler
}
paramKeys := rctx.routeParams.Keys
paramValues := rctx.routeParams.Values
if fmt.Sprintf("%v", tt.h) != fmt.Sprintf("%v", handler) {
t.Errorf("input [%d]: find '%s' expecting handler:%v , got:%v", i, tt.r, tt.h, handler)
}
if !stringSliceEqual(tt.k, paramKeys) {
t.Errorf("input [%d]: find '%s' expecting paramKeys:(%d)%v , got:(%d)%v", i, tt.r, len(tt.k), tt.k, len(paramKeys), paramKeys)
}
if !stringSliceEqual(tt.v, paramValues) {
t.Errorf("input [%d]: find '%s' expecting paramValues:(%d)%v , got:(%d)%v", i, tt.r, len(tt.v), tt.v, len(paramValues), paramValues)
}
}
}
func TestTreeRegexMatchWholeParam(t *testing.T) {
hStub1 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
rctx := NewRouteContext()
tr := &node{}
tr.InsertRoute(mGET, "/{id:[0-9]+}", hStub1)
tr.InsertRoute(mGET, "/{x:.+}/foo", hStub1)
tr.InsertRoute(mGET, "/{param:[0-9]*}/test", hStub1)
tests := []struct {
expectedHandler http.Handler
url string
}{
{url: "/13", expectedHandler: hStub1},
{url: "/a13", expectedHandler: nil},
{url: "/13.jpg", expectedHandler: nil},
{url: "/a13.jpg", expectedHandler: nil},
{url: "/a/foo", expectedHandler: hStub1},
{url: "//foo", expectedHandler: nil},
{url: "//test", expectedHandler: hStub1},
}
for _, tc := range tests {
_, _, handler := tr.FindRoute(rctx, mGET, tc.url)
if fmt.Sprintf("%v", tc.expectedHandler) != fmt.Sprintf("%v", handler) {
t.Errorf("url %v: expecting handler:%v , got:%v", tc.url, tc.expectedHandler, handler)
}
}
}
func TestTreeFindPattern(t *testing.T) {
hStub1 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub2 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
hStub3 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
tr := &node{}
tr.InsertRoute(mGET, "/pages/*", hStub1)
tr.InsertRoute(mGET, "/articles/{id}/*", hStub2)
tr.InsertRoute(mGET, "/articles/{slug}/{uid}/*", hStub3)
if tr.findPattern("/pages") != false {
t.Errorf("find /pages failed")
}
if tr.findPattern("/pages*") != false {
t.Errorf("find /pages* failed - should be nil")
}
if tr.findPattern("/pages/*") == false {
t.Errorf("find /pages/* failed")
}
if tr.findPattern("/articles/{id}/*") == false {
t.Errorf("find /articles/{id}/* failed")
}
if tr.findPattern("/articles/{something}/*") == false {
t.Errorf("find /articles/{something}/* failed")
}
if tr.findPattern("/articles/{slug}/{uid}/*") == false {
t.Errorf("find /articles/{slug}/{uid}/* failed")
}
}
func debugPrintTree(parent int, i int, n *node, label byte) bool {
numEdges := 0
for _, nds := range n.children {
numEdges += len(nds)
}
// if n.handlers != nil {
// log.Printf("[node %d parent:%d] typ:%d prefix:%s label:%s tail:%s numEdges:%d isLeaf:%v handler:%v pat:%s keys:%v\n", i, parent, n.typ, n.prefix, string(label), string(n.tail), numEdges, n.isLeaf(), n.handlers, n.pattern, n.paramKeys)
// } else {
// log.Printf("[node %d parent:%d] typ:%d prefix:%s label:%s tail:%s numEdges:%d isLeaf:%v pat:%s keys:%v\n", i, parent, n.typ, n.prefix, string(label), string(n.tail), numEdges, n.isLeaf(), n.pattern, n.paramKeys)
// }
if n.endpoints != nil {
log.Printf("[node %d parent:%d] typ:%d prefix:%s label:%s tail:%s numEdges:%d isLeaf:%v handler:%v\n", i, parent, n.typ, n.prefix, string(label), string(n.tail), numEdges, n.isLeaf(), n.endpoints)
} else {
log.Printf("[node %d parent:%d] typ:%d prefix:%s label:%s tail:%s numEdges:%d isLeaf:%v\n", i, parent, n.typ, n.prefix, string(label), string(n.tail), numEdges, n.isLeaf())
}
parent = i
for _, nds := range n.children {
for _, e := range nds {
i++
if debugPrintTree(parent, i, e, e.label) {
return true
}
}
}
return false
}
func stringSliceEqual(a, b []string) bool {
if len(a) != len(b) {
return false
}
for i := range a {
if b[i] != a[i] {
return false
}
}
return true
}
func BenchmarkTreeGet(b *testing.B) {
h1 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
h2 := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
tr := &node{}
tr.InsertRoute(mGET, "/", h1)
tr.InsertRoute(mGET, "/ping", h2)
tr.InsertRoute(mGET, "/pingall", h2)
tr.InsertRoute(mGET, "/ping/{id}", h2)
tr.InsertRoute(mGET, "/ping/{id}/woop", h2)
tr.InsertRoute(mGET, "/ping/{id}/{opt}", h2)
tr.InsertRoute(mGET, "/pinggggg", h2)
tr.InsertRoute(mGET, "/hello", h1)
mctx := NewRouteContext()
b.ReportAllocs()
for b.Loop() {
mctx.Reset()
tr.FindRoute(mctx, mGET, "/ping/123/456")
}
}
func TestWalker(t *testing.T) {
r := bigMux()
// Walk the muxBig router tree.
if err := Walk(r, func(method string, route string, handler http.Handler, middlewares ...func(http.Handler) http.Handler) error {
t.Logf("%v %v", method, route)
return nil
}); err != nil {
t.Error(err)
}
}
func TestWalkInlineMiddlewaresAcrossSubrouter(t *testing.T) {
mw := func(next http.Handler) http.Handler { return next }
handler := func(w http.ResponseWriter, r *http.Request) {}
tests := []struct {
name string
setup func() Router
expected int
}{
{
name: "With+Group wrapping Route+With",
setup: func() Router {
r := NewMux()
r.With(mw).Group(func(r Router) {
r.Route("/foo", func(r Router) {
r.With(mw).Post("/bar", handler)
})
})
return r
},
expected: 2,
},
{
name: "Use on subrouter combined with outer With",
setup: func() Router {
r := NewMux()
r.With(mw).Group(func(r Router) {
r.Route("/foo", func(r Router) {
r.Use(mw)
r.With(mw).Post("/bar", handler)
})
})
return r
},
expected: 3,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
r := tt.setup()
var middlewareCount int
err := Walk(r, func(method, route string, handler http.Handler, middlewares ...func(http.Handler) http.Handler) error {
middlewareCount = len(middlewares)
return nil
})
if err != nil {
t.Fatal(err)
}
if middlewareCount != tt.expected {
t.Fatalf("expected %d middlewares, got %d", tt.expected, middlewareCount)
}
})
}
}
// https://github.com/go-chi/chi/issues/830
func TestWalkRouteWithHandlerAndSubrouter(t *testing.T) {
r := NewRouter()
handler := func(w http.ResponseWriter, r *http.Request) {}
r.Route("/foo", func(r Router) {
r.Route("/bar", func(r Router) {
r.Get("/{id}", handler)
})
r.Get("/bar", handler)
})
routes := map[string]bool{}
if err := Walk(r, func(method, route string, handler http.Handler, middlewares ...func(http.Handler) http.Handler) error {
routes[method+" "+route] = true
return nil
}); err != nil {
t.Fatal(err)
}
for _, route := range []string{"GET /foo/bar", "GET /foo/bar/{id}"} {
if !routes[route] {
t.Fatalf("expected Walk to include %s, got %v", route, routes)
}
}
}
// https://github.com/go-chi/chi/issues/830
//
// Routes() must not leak the synthetic stub handler Mount() installs on
// its mount pattern: a plain Mount()/Route() should report exactly its
// "/pattern/*" entry, and a handler that collides with a mount pattern
// must be reported without also surfacing the internal stub under "*".
func TestRoutesHidesMountStub(t *testing.T) {
handler := func(w http.ResponseWriter, r *http.Request) {}
t.Run("plain mount reports a single subroute entry", func(t *testing.T) {
r := NewRouter()
r.Route("/api", func(r Router) {
r.Get("/{id}", handler)
})
// Routes() isn't recursive: /api mounts a separate subrouter, so only
// its "/api/*" connector shows here, not "/api/{id}". SubRoutes can be
// walked further, the same way Walk() does internally.
routes := r.Routes()
if len(routes) != 1 {
t.Fatalf("expected exactly 1 route, got %d: %+v", len(routes), routes)
}
if routes[0].Pattern != "/api/*" || routes[0].SubRoutes == nil {
t.Fatalf("expected the single route to be the /api/* subroute, got %+v", routes[0])
}
})
t.Run("handler colliding with a mount pattern hides the stub", func(t *testing.T) {
r := NewRouter()
r.Route("/bar", func(r Router) {
r.Get("/{id}", handler)
})
r.Get("/bar", handler)
for _, rt := range r.Routes() {
if rt.Pattern != "/bar" {
continue
}
if rt.SubRoutes != nil {
t.Fatalf("expected /bar to have no subroutes of its own, got %+v", rt)
}
if len(rt.Handlers) != 1 {
t.Fatalf("expected /bar to report exactly the GET handler, got %v", rt.Handlers)
}
if _, ok := rt.Handlers[http.MethodGet]; !ok {
t.Fatalf("expected /bar to report a GET handler, got %v", rt.Handlers)
}
}
})
}
// https://github.com/go-chi/chi/issues/750
//
// Middlewares registered on a Group must still reach handlers defined on a
// Route() mounted inside that group.
func TestWalkMiddlewaresAcrossGroupAndRoute(t *testing.T) {
requestID := func(next http.Handler) http.Handler { return next }
timeout := func(next http.Handler) http.Handler { return next }
handler := func(w http.ResponseWriter, r *http.Request) {}
r := NewRouter()
r.Use(requestID)
r.Get("/A", handler)
r.Group(func(r Router) {
r.Use(timeout)
r.Get("/B", handler)
r.Route("/C", func(r Router) {
r.Get("/D", handler)
})
})
mwName := func(f func(http.Handler) http.Handler) string {
switch reflect.ValueOf(f).Pointer() {
case reflect.ValueOf(requestID).Pointer():
return "requestID"
case reflect.ValueOf(timeout).Pointer():
return "timeout"
default:
return "unknown"
}
}
got := map[string][]string{}
if err := Walk(r, func(method, route string, handler http.Handler, mws ...func(http.Handler) http.Handler) error {
names := make([]string, len(mws))
for i, m := range mws {
names[i] = mwName(m)
}
got[method+" "+route] = names
return nil
}); err != nil {
t.Fatal(err)
}
want := map[string][]string{
"GET /A": {"requestID"},
"GET /B": {"requestID", "timeout"},
"GET /C/D": {"requestID", "timeout"},
}
for route, wantMws := range want {
if gotMws := got[route]; !slices.Equal(gotMws, wantMws) {
t.Fatalf("%s: expected middlewares %v, got %v", route, wantMws, gotMws)
}
}
}