mirror of
https://github.com/go-gitea/gitea
synced 2025-07-03 09:07:19 +00:00
Move macaron to chi (#14293)
Use [chi](https://github.com/go-chi/chi) instead of the forked [macaron](https://gitea.com/macaron/macaron). Since macaron and chi have conflicts with session share, this big PR becomes a have-to thing. According my previous idea, we can replace macaron step by step but I'm wrong. :( Below is a list of big changes on this PR. - [x] Define `context.ResponseWriter` interface with an implementation `context.Response`. - [x] Use chi instead of macaron, and also a customize `Route` to wrap chi so that the router usage is similar as before. - [x] Create different routers for `web`, `api`, `internal` and `install` so that the codes will be more clear and no magic . - [x] Use https://github.com/unrolled/render instead of macaron's internal render - [x] Use https://github.com/NYTimes/gziphandler instead of https://gitea.com/macaron/gzip - [x] Use https://gitea.com/go-chi/session which is a modified version of https://gitea.com/macaron/session and removed `nodb` support since it will not be maintained. **BREAK** - [x] Use https://gitea.com/go-chi/captcha which is a modified version of https://gitea.com/macaron/captcha - [x] Use https://gitea.com/go-chi/cache which is a modified version of https://gitea.com/macaron/cache - [x] Use https://gitea.com/go-chi/binding which is a modified version of https://gitea.com/macaron/binding - [x] Use https://github.com/go-chi/cors instead of https://gitea.com/macaron/cors - [x] Dropped https://gitea.com/macaron/i18n and make a new one in `code.gitea.io/gitea/modules/translation` - [x] Move validation form structs from `code.gitea.io/gitea/modules/auth` to `code.gitea.io/gitea/modules/forms` to avoid dependency cycle. - [x] Removed macaron log service because it's not need any more. **BREAK** - [x] All form structs have to be get by `web.GetForm(ctx)` in the route function but not as a function parameter on routes definition. - [x] Move Git HTTP protocol implementation to use routers directly. - [x] Fix the problem that chi routes don't support trailing slash but macaron did. - [x] `/api/v1/swagger` now will be redirect to `/api/swagger` but not render directly so that `APIContext` will not create a html render. Notices: - Chi router don't support request with trailing slash - Integration test `TestUserHeatmap` maybe mysql version related. It's failed on my macOS(mysql 5.7.29 installed via brew) but succeed on CI. Co-authored-by: 6543 <6543@obermui.de>
This commit is contained in:
@ -5,6 +5,9 @@
|
||||
package test
|
||||
|
||||
import (
|
||||
scontext "context"
|
||||
"html/template"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"net/url"
|
||||
@ -13,32 +16,37 @@ import (
|
||||
"code.gitea.io/gitea/models"
|
||||
"code.gitea.io/gitea/modules/context"
|
||||
"code.gitea.io/gitea/modules/git"
|
||||
"code.gitea.io/gitea/modules/middlewares"
|
||||
|
||||
"gitea.com/macaron/macaron"
|
||||
"gitea.com/macaron/session"
|
||||
"github.com/go-chi/chi"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/unrolled/render"
|
||||
)
|
||||
|
||||
// MockContext mock context for unit tests
|
||||
func MockContext(t *testing.T, path string) *context.Context {
|
||||
var macaronContext macaron.Context
|
||||
macaronContext.ReplaceAllParams(macaron.Params{})
|
||||
macaronContext.Locale = &mockLocale{}
|
||||
requestURL, err := url.Parse(path)
|
||||
assert.NoError(t, err)
|
||||
macaronContext.Req = macaron.Request{Request: &http.Request{
|
||||
URL: requestURL,
|
||||
Form: url.Values{},
|
||||
}}
|
||||
macaronContext.Resp = &mockResponseWriter{}
|
||||
macaronContext.Render = &mockRender{ResponseWriter: macaronContext.Resp}
|
||||
macaronContext.Data = map[string]interface{}{}
|
||||
return &context.Context{
|
||||
Context: &macaronContext,
|
||||
Flash: &session.Flash{
|
||||
var resp = &mockResponseWriter{}
|
||||
var ctx = context.Context{
|
||||
Render: &mockRender{},
|
||||
Data: make(map[string]interface{}),
|
||||
Flash: &middlewares.Flash{
|
||||
Values: make(url.Values),
|
||||
},
|
||||
Resp: context.NewResponse(resp),
|
||||
Locale: &mockLocale{},
|
||||
}
|
||||
|
||||
requestURL, err := url.Parse(path)
|
||||
assert.NoError(t, err)
|
||||
var req = &http.Request{
|
||||
URL: requestURL,
|
||||
Form: url.Values{},
|
||||
}
|
||||
|
||||
chiCtx := chi.NewRouteContext()
|
||||
req = req.WithContext(scontext.WithValue(req.Context(), chi.RouteCtxKey, chiCtx))
|
||||
ctx.Req = context.WithContext(req, &ctx)
|
||||
return &ctx
|
||||
}
|
||||
|
||||
// LoadRepo load a repo into a test context.
|
||||
@ -113,77 +121,20 @@ func (rw *mockResponseWriter) Size() int {
|
||||
return rw.size
|
||||
}
|
||||
|
||||
func (rw *mockResponseWriter) Before(b macaron.BeforeFunc) {
|
||||
b(rw)
|
||||
}
|
||||
|
||||
func (rw *mockResponseWriter) Push(target string, opts *http.PushOptions) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
type mockRender struct {
|
||||
http.ResponseWriter
|
||||
}
|
||||
|
||||
func (tr *mockRender) SetResponseWriter(rw http.ResponseWriter) {
|
||||
tr.ResponseWriter = rw
|
||||
func (tr *mockRender) TemplateLookup(tmpl string) *template.Template {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (tr *mockRender) JSON(status int, _ interface{}) {
|
||||
tr.Status(status)
|
||||
}
|
||||
|
||||
func (tr *mockRender) JSONString(interface{}) (string, error) {
|
||||
return "", nil
|
||||
}
|
||||
|
||||
func (tr *mockRender) RawData(status int, _ []byte) {
|
||||
tr.Status(status)
|
||||
}
|
||||
|
||||
func (tr *mockRender) PlainText(status int, _ []byte) {
|
||||
tr.Status(status)
|
||||
}
|
||||
|
||||
func (tr *mockRender) HTML(status int, _ string, _ interface{}, _ ...macaron.HTMLOptions) {
|
||||
tr.Status(status)
|
||||
}
|
||||
|
||||
func (tr *mockRender) HTMLSet(status int, _ string, _ string, _ interface{}, _ ...macaron.HTMLOptions) {
|
||||
tr.Status(status)
|
||||
}
|
||||
|
||||
func (tr *mockRender) HTMLSetString(string, string, interface{}, ...macaron.HTMLOptions) (string, error) {
|
||||
return "", nil
|
||||
}
|
||||
|
||||
func (tr *mockRender) HTMLString(string, interface{}, ...macaron.HTMLOptions) (string, error) {
|
||||
return "", nil
|
||||
}
|
||||
|
||||
func (tr *mockRender) HTMLSetBytes(string, string, interface{}, ...macaron.HTMLOptions) ([]byte, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (tr *mockRender) HTMLBytes(string, interface{}, ...macaron.HTMLOptions) ([]byte, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (tr *mockRender) XML(status int, _ interface{}) {
|
||||
tr.Status(status)
|
||||
}
|
||||
|
||||
func (tr *mockRender) Error(status int, _ ...string) {
|
||||
tr.Status(status)
|
||||
}
|
||||
|
||||
func (tr *mockRender) Status(status int) {
|
||||
tr.ResponseWriter.WriteHeader(status)
|
||||
}
|
||||
|
||||
func (tr *mockRender) SetTemplatePath(string, string) {
|
||||
}
|
||||
|
||||
func (tr *mockRender) HasTemplateSet(string) bool {
|
||||
return true
|
||||
func (tr *mockRender) HTML(w io.Writer, status int, _ string, _ interface{}, _ ...render.HTMLOptions) error {
|
||||
if resp, ok := w.(http.ResponseWriter); ok {
|
||||
resp.WriteHeader(status)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
Reference in New Issue
Block a user