2017-08-03 05:09:16 +00:00
|
|
|
// Copyright 2017 The Gitea Authors. All rights reserved.
|
2022-11-27 18:20:29 +00:00
|
|
|
// SPDX-License-Identifier: MIT
|
2017-08-03 05:09:16 +00:00
|
|
|
|
2023-09-01 11:26:07 +00:00
|
|
|
// Package contexttest provides utilities for testing Web/API contexts with models.
|
|
|
|
package contexttest
|
2017-08-03 05:09:16 +00:00
|
|
|
|
|
|
|
import (
|
2023-05-21 01:50:53 +00:00
|
|
|
gocontext "context"
|
2021-01-26 15:36:53 +00:00
|
|
|
"io"
|
2024-03-05 02:12:03 +00:00
|
|
|
"maps"
|
2017-08-03 05:09:16 +00:00
|
|
|
"net/http"
|
2019-03-27 09:33:00 +00:00
|
|
|
"net/http/httptest"
|
2017-08-03 05:09:16 +00:00
|
|
|
"net/url"
|
2023-06-18 07:59:09 +00:00
|
|
|
"strings"
|
2017-08-03 05:09:16 +00:00
|
|
|
"testing"
|
2024-03-04 01:02:51 +00:00
|
|
|
"time"
|
2017-08-03 05:09:16 +00:00
|
|
|
|
2024-04-04 12:27:11 +00:00
|
|
|
org_model "code.gitea.io/gitea/models/organization"
|
2022-05-11 10:09:36 +00:00
|
|
|
access_model "code.gitea.io/gitea/models/perm/access"
|
2021-12-10 01:27:50 +00:00
|
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
2021-11-16 08:53:21 +00:00
|
|
|
"code.gitea.io/gitea/models/unittest"
|
2021-11-24 09:49:20 +00:00
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
Simplify how git repositories are opened (#28937)
## Purpose
This is a refactor toward building an abstraction over managing git
repositories.
Afterwards, it does not matter anymore if they are stored on the local
disk or somewhere remote.
## What this PR changes
We used `git.OpenRepository` everywhere previously.
Now, we should split them into two distinct functions:
Firstly, there are temporary repositories which do not change:
```go
git.OpenRepository(ctx, diskPath)
```
Gitea managed repositories having a record in the database in the
`repository` table are moved into the new package `gitrepo`:
```go
gitrepo.OpenRepository(ctx, repo_model.Repo)
```
Why is `repo_model.Repository` the second parameter instead of file
path?
Because then we can easily adapt our repository storage strategy.
The repositories can be stored locally, however, they could just as well
be stored on a remote server.
## Further changes in other PRs
- A Git Command wrapper on package `gitrepo` could be created. i.e.
`NewCommand(ctx, repo_model.Repository, commands...)`. `git.RunOpts{Dir:
repo.RepoPath()}`, the directory should be empty before invoking this
method and it can be filled in the function only. #28940
- Remove the `RepoPath()`/`WikiPath()` functions to reduce the
possibility of mistakes.
---------
Co-authored-by: delvh <dev.lh@web.de>
2024-01-27 20:09:51 +00:00
|
|
|
"code.gitea.io/gitea/modules/gitrepo"
|
Make HTML template functions support context (#24056)
# Background
Golang template is not friendly for large projects, and Golang template
team is quite slow, related:
* `https://github.com/golang/go/issues/54450`
Without upstream support, we can also have our solution to make HTML
template functions support context.
It helps a lot, the above Golang template issue `#54450` explains a lot:
1. It makes `{{Locale.Tr}}` could be used in any template, without
passing unclear `(dict "root" . )` anymore.
2. More and more functions need `context`, like `avatar`, etc, we do not
need to do `(dict "Context" $.Context)` anymore.
3. Many request-related functions could be shared by parent&children
templates, like "user setting" / "system setting"
See the test `TestScopedTemplateSetFuncMap`, one template set, two
`Execute` calls with different `CtxFunc`.
# The Solution
Instead of waiting for upstream, this PR re-uses the escaped HTML
template trees, use `AddParseTree` to add related templates/trees to a
new template instance, then the new template instance can have its own
FuncMap , the function calls in the template trees will always use the
new template's FuncMap.
`template.New` / `template.AddParseTree` / `adding-FuncMap` are all
quite fast, so the performance is not affected.
The details:
1. Make a new `html/template/Template` for `all` templates
2. Add template code to the `all` template
3. Freeze the `all` template, reset its exec func map, it shouldn't
execute any template.
4. When a router wants to render a template by its `name`
1. Find the `name` in `all`
2. Find all its related sub templates
3. Escape all related templates (just like what the html template
package does)
4. Add the escaped parse-trees of related templates into a new (scoped)
`text/template/Template`
5. Add context-related func map into the new (scoped) text template
6. Execute the new (scoped) text template
7. To improve performance, the escaped templates are cached to `template
sets`
# FAQ
## There is a `unsafe` call, is this PR unsafe?
This PR is safe. Golang has strict language definition, it's safe to do
so: https://pkg.go.dev/unsafe#Pointer (1) Conversion of a *T1 to Pointer
to *T2
## What if Golang template supports such feature in the future?
The public structs/interfaces/functions introduced by this PR is quite
simple, the code of `HTMLRender` is not changed too much. It's very easy
to switch to the official mechanism if there would be one.
## Does this PR change the template execution behavior?
No, see the tests (welcome to design more tests if it's necessary)
---------
Co-authored-by: silverwind <me@silverwind.io>
Co-authored-by: Jason Song <i@wolfogre.com>
Co-authored-by: Giteabot <teabot@gitea.io>
2023-04-20 08:08:58 +00:00
|
|
|
"code.gitea.io/gitea/modules/templates"
|
2023-04-17 03:37:23 +00:00
|
|
|
"code.gitea.io/gitea/modules/translation"
|
2021-01-30 08:55:53 +00:00
|
|
|
"code.gitea.io/gitea/modules/web/middleware"
|
2024-02-27 07:12:22 +00:00
|
|
|
"code.gitea.io/gitea/services/context"
|
2018-04-29 06:21:33 +00:00
|
|
|
|
2023-09-01 11:26:07 +00:00
|
|
|
"github.com/go-chi/chi/v5"
|
2017-08-03 05:09:16 +00:00
|
|
|
"github.com/stretchr/testify/assert"
|
2024-07-30 19:41:10 +00:00
|
|
|
"github.com/stretchr/testify/require"
|
2017-08-03 05:09:16 +00:00
|
|
|
)
|
|
|
|
|
2023-06-18 07:59:09 +00:00
|
|
|
func mockRequest(t *testing.T, reqPath string) *http.Request {
|
|
|
|
method, path, found := strings.Cut(reqPath, " ")
|
|
|
|
if !found {
|
|
|
|
method = "GET"
|
|
|
|
path = reqPath
|
|
|
|
}
|
2023-05-21 01:50:53 +00:00
|
|
|
requestURL, err := url.Parse(path)
|
2024-07-30 19:41:10 +00:00
|
|
|
require.NoError(t, err)
|
2024-03-05 02:12:03 +00:00
|
|
|
req := &http.Request{Method: method, URL: requestURL, Form: maps.Clone(requestURL.Query()), Header: http.Header{}}
|
2023-06-18 07:59:09 +00:00
|
|
|
req = req.WithContext(middleware.WithContextData(req.Context()))
|
|
|
|
return req
|
|
|
|
}
|
2023-05-21 01:50:53 +00:00
|
|
|
|
2024-03-04 03:38:52 +00:00
|
|
|
type MockContextOption struct {
|
|
|
|
Render context.Render
|
|
|
|
}
|
|
|
|
|
2023-06-18 07:59:09 +00:00
|
|
|
// MockContext mock context for unit tests
|
2024-03-04 03:38:52 +00:00
|
|
|
func MockContext(t *testing.T, reqPath string, opts ...MockContextOption) (*context.Context, *httptest.ResponseRecorder) {
|
|
|
|
var opt MockContextOption
|
|
|
|
if len(opts) > 0 {
|
|
|
|
opt = opts[0]
|
|
|
|
}
|
|
|
|
if opt.Render == nil {
|
|
|
|
opt.Render = &MockRender{}
|
|
|
|
}
|
2023-06-18 07:59:09 +00:00
|
|
|
resp := httptest.NewRecorder()
|
|
|
|
req := mockRequest(t, reqPath)
|
2023-05-21 01:50:53 +00:00
|
|
|
base, baseCleanUp := context.NewBaseContext(resp, req)
|
2023-08-25 11:07:42 +00:00
|
|
|
_ = baseCleanUp // during test, it doesn't need to do clean up. TODO: this can be improved later
|
2023-06-18 07:59:09 +00:00
|
|
|
base.Data = middleware.GetContextData(req.Context())
|
2023-05-21 01:50:53 +00:00
|
|
|
base.Locale = &translation.MockLocale{}
|
2023-08-25 11:07:42 +00:00
|
|
|
|
2024-03-04 01:02:51 +00:00
|
|
|
ctx := context.NewWebContext(base, opt.Render, nil)
|
|
|
|
ctx.PageData = map[string]any{}
|
|
|
|
ctx.Data["PageStartTime"] = time.Now()
|
2023-05-21 01:50:53 +00:00
|
|
|
chiCtx := chi.NewRouteContext()
|
|
|
|
ctx.Base.AppendContextValue(chi.RouteCtxKey, chiCtx)
|
2023-06-18 07:59:09 +00:00
|
|
|
return ctx, resp
|
2023-05-21 01:50:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// MockAPIContext mock context for unit tests
|
2023-06-18 07:59:09 +00:00
|
|
|
func MockAPIContext(t *testing.T, reqPath string) (*context.APIContext, *httptest.ResponseRecorder) {
|
2023-05-21 01:50:53 +00:00
|
|
|
resp := httptest.NewRecorder()
|
2023-06-18 07:59:09 +00:00
|
|
|
req := mockRequest(t, reqPath)
|
2023-05-21 01:50:53 +00:00
|
|
|
base, baseCleanUp := context.NewBaseContext(resp, req)
|
2023-06-18 07:59:09 +00:00
|
|
|
base.Data = middleware.GetContextData(req.Context())
|
2023-05-21 01:50:53 +00:00
|
|
|
base.Locale = &translation.MockLocale{}
|
|
|
|
ctx := &context.APIContext{Base: base}
|
|
|
|
_ = baseCleanUp // during test, it doesn't need to do clean up. TODO: this can be improved later
|
|
|
|
|
2021-01-26 15:36:53 +00:00
|
|
|
chiCtx := chi.NewRouteContext()
|
2023-05-21 01:50:53 +00:00
|
|
|
ctx.Base.AppendContextValue(chi.RouteCtxKey, chiCtx)
|
2023-06-18 07:59:09 +00:00
|
|
|
return ctx, resp
|
2017-08-03 05:09:16 +00:00
|
|
|
}
|
|
|
|
|
2024-05-07 07:36:48 +00:00
|
|
|
func MockPrivateContext(t *testing.T, reqPath string) (*context.PrivateContext, *httptest.ResponseRecorder) {
|
|
|
|
resp := httptest.NewRecorder()
|
|
|
|
req := mockRequest(t, reqPath)
|
|
|
|
base, baseCleanUp := context.NewBaseContext(resp, req)
|
|
|
|
base.Data = middleware.GetContextData(req.Context())
|
|
|
|
base.Locale = &translation.MockLocale{}
|
|
|
|
ctx := &context.PrivateContext{Base: base}
|
|
|
|
_ = baseCleanUp // during test, it doesn't need to do clean up. TODO: this can be improved later
|
|
|
|
chiCtx := chi.NewRouteContext()
|
|
|
|
ctx.Base.AppendContextValue(chi.RouteCtxKey, chiCtx)
|
|
|
|
return ctx, resp
|
|
|
|
}
|
|
|
|
|
2017-11-30 15:52:15 +00:00
|
|
|
// LoadRepo load a repo into a test context.
|
2023-05-21 01:50:53 +00:00
|
|
|
func LoadRepo(t *testing.T, ctx gocontext.Context, repoID int64) {
|
|
|
|
var doer *user_model.User
|
|
|
|
repo := &context.Repository{}
|
|
|
|
switch ctx := ctx.(type) {
|
|
|
|
case *context.Context:
|
|
|
|
ctx.Repo = repo
|
|
|
|
doer = ctx.Doer
|
|
|
|
case *context.APIContext:
|
|
|
|
ctx.Repo = repo
|
|
|
|
doer = ctx.Doer
|
|
|
|
default:
|
2023-10-11 11:02:24 +00:00
|
|
|
assert.FailNow(t, "context is not *context.Context or *context.APIContext")
|
2023-05-21 01:50:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
repo.Repository = unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: repoID})
|
2018-11-28 11:26:14 +00:00
|
|
|
var err error
|
2023-05-21 01:50:53 +00:00
|
|
|
repo.Owner, err = user_model.GetUserByID(ctx, repo.Repository.OwnerID)
|
2024-07-30 19:41:10 +00:00
|
|
|
require.NoError(t, err)
|
2023-05-21 01:50:53 +00:00
|
|
|
repo.RepoLink = repo.Repository.Link()
|
|
|
|
repo.Permission, err = access_model.GetUserRepoPermission(ctx, repo.Repository, doer)
|
2024-07-30 19:41:10 +00:00
|
|
|
require.NoError(t, err)
|
2017-11-30 15:52:15 +00:00
|
|
|
}
|
|
|
|
|
2018-04-29 06:21:33 +00:00
|
|
|
// LoadRepoCommit loads a repo's commit into a test context.
|
2023-05-21 01:50:53 +00:00
|
|
|
func LoadRepoCommit(t *testing.T, ctx gocontext.Context) {
|
|
|
|
var repo *context.Repository
|
|
|
|
switch ctx := ctx.(type) {
|
|
|
|
case *context.Context:
|
|
|
|
repo = ctx.Repo
|
|
|
|
case *context.APIContext:
|
|
|
|
repo = ctx.Repo
|
|
|
|
default:
|
2023-10-11 11:02:24 +00:00
|
|
|
assert.FailNow(t, "context is not *context.Context or *context.APIContext")
|
2023-05-21 01:50:53 +00:00
|
|
|
}
|
|
|
|
|
2024-08-26 06:03:48 +00:00
|
|
|
if repo.GitRepo == nil {
|
|
|
|
assert.FailNow(t, "must call LoadGitRepo")
|
|
|
|
}
|
|
|
|
|
|
|
|
branch, err := repo.GitRepo.GetHEADBranch()
|
2024-07-30 19:41:10 +00:00
|
|
|
require.NoError(t, err)
|
2020-02-26 06:32:22 +00:00
|
|
|
assert.NotNil(t, branch)
|
|
|
|
if branch != nil {
|
2024-08-26 06:03:48 +00:00
|
|
|
repo.Commit, err = repo.GitRepo.GetBranchCommit(branch.Name)
|
2024-07-30 19:41:10 +00:00
|
|
|
require.NoError(t, err)
|
2020-02-26 06:32:22 +00:00
|
|
|
}
|
2018-04-29 06:21:33 +00:00
|
|
|
}
|
|
|
|
|
2023-09-01 11:26:07 +00:00
|
|
|
// LoadUser load a user into a test context
|
2023-05-21 01:50:53 +00:00
|
|
|
func LoadUser(t *testing.T, ctx gocontext.Context, userID int64) {
|
|
|
|
doer := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: userID})
|
|
|
|
switch ctx := ctx.(type) {
|
|
|
|
case *context.Context:
|
|
|
|
ctx.Doer = doer
|
|
|
|
case *context.APIContext:
|
|
|
|
ctx.Doer = doer
|
|
|
|
default:
|
2023-10-11 11:02:24 +00:00
|
|
|
assert.FailNow(t, "context is not *context.Context or *context.APIContext")
|
2023-05-21 01:50:53 +00:00
|
|
|
}
|
2017-11-30 15:52:15 +00:00
|
|
|
}
|
|
|
|
|
2024-04-04 12:27:11 +00:00
|
|
|
// LoadOrganization load an org into a test context
|
|
|
|
func LoadOrganization(t *testing.T, ctx gocontext.Context, orgID int64) {
|
|
|
|
org := unittest.AssertExistsAndLoadBean(t, &org_model.Organization{ID: orgID})
|
|
|
|
switch ctx := ctx.(type) {
|
|
|
|
case *context.Context:
|
|
|
|
ctx.Org.Organization = org
|
|
|
|
case *context.APIContext:
|
|
|
|
ctx.Org.Organization = org
|
|
|
|
default:
|
|
|
|
assert.FailNow(t, "context is not *context.Context or *context.APIContext")
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-12-08 05:22:02 +00:00
|
|
|
// LoadGitRepo load a git repo into a test context. Requires that ctx.Repo has
|
|
|
|
// already been populated.
|
2024-08-26 06:03:48 +00:00
|
|
|
func LoadGitRepo(t *testing.T, ctx gocontext.Context) {
|
|
|
|
var repo *context.Repository
|
|
|
|
switch ctx := ctx.(type) {
|
|
|
|
case *context.Context:
|
|
|
|
repo = ctx.Repo
|
|
|
|
case *context.APIContext:
|
|
|
|
repo = ctx.Repo
|
|
|
|
default:
|
|
|
|
assert.FailNow(t, "context is not *context.Context or *context.APIContext")
|
|
|
|
}
|
|
|
|
|
|
|
|
require.NoError(t, repo.Repository.LoadOwner(ctx))
|
2017-12-08 05:22:02 +00:00
|
|
|
var err error
|
2024-08-26 06:03:48 +00:00
|
|
|
repo.GitRepo, err = gitrepo.OpenRepository(ctx, repo.Repository)
|
2024-07-30 19:41:10 +00:00
|
|
|
require.NoError(t, err)
|
2017-12-08 05:22:02 +00:00
|
|
|
}
|
|
|
|
|
2023-08-25 11:07:42 +00:00
|
|
|
type MockRender struct{}
|
2017-08-03 05:09:16 +00:00
|
|
|
|
2023-08-25 11:07:42 +00:00
|
|
|
func (tr *MockRender) TemplateLookup(tmpl string, _ gocontext.Context) (templates.TemplateExecutor, error) {
|
2023-04-08 13:15:22 +00:00
|
|
|
return nil, nil
|
2017-08-03 05:09:16 +00:00
|
|
|
}
|
|
|
|
|
2023-08-25 11:07:42 +00:00
|
|
|
func (tr *MockRender) HTML(w io.Writer, status int, _ string, _ any, _ gocontext.Context) error {
|
2021-01-26 15:36:53 +00:00
|
|
|
if resp, ok := w.(http.ResponseWriter); ok {
|
|
|
|
resp.WriteHeader(status)
|
|
|
|
}
|
|
|
|
return nil
|
2017-08-03 05:09:16 +00:00
|
|
|
}
|