2017-08-03 10:39:16 +05:30
|
|
|
// Copyright 2017 The Gitea Authors. All rights reserved.
|
2022-11-27 23:50:29 +05:30
|
|
|
// SPDX-License-Identifier: MIT
|
2017-08-03 10:39:16 +05:30
|
|
|
|
|
|
|
package test
|
|
|
|
|
|
|
|
import (
|
2021-01-26 21:06:53 +05:30
|
|
|
scontext "context"
|
|
|
|
"io"
|
2017-08-03 10:39:16 +05:30
|
|
|
"net/http"
|
2019-03-27 15:03:00 +05:30
|
|
|
"net/http/httptest"
|
2017-08-03 10:39:16 +05:30
|
|
|
"net/url"
|
|
|
|
"testing"
|
|
|
|
|
2022-05-11 15:39:36 +05:30
|
|
|
access_model "code.gitea.io/gitea/models/perm/access"
|
2021-12-10 06:57:50 +05:30
|
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
2021-11-16 14:23:21 +05:30
|
|
|
"code.gitea.io/gitea/models/unittest"
|
2021-11-24 15:19:20 +05:30
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2017-08-03 10:39:16 +05:30
|
|
|
"code.gitea.io/gitea/modules/context"
|
2019-03-27 15:03:00 +05:30
|
|
|
"code.gitea.io/gitea/modules/git"
|
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 13:38:58 +05:30
|
|
|
"code.gitea.io/gitea/modules/templates"
|
2023-04-17 09:07:23 +05:30
|
|
|
"code.gitea.io/gitea/modules/translation"
|
2021-01-30 14:25:53 +05:30
|
|
|
"code.gitea.io/gitea/modules/web/middleware"
|
2018-04-29 11:51:33 +05:30
|
|
|
|
2021-10-14 08:20:23 +05:30
|
|
|
chi "github.com/go-chi/chi/v5"
|
2017-08-03 10:39:16 +05:30
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
)
|
|
|
|
|
|
|
|
// MockContext mock context for unit tests
|
2017-11-30 21:22:15 +05:30
|
|
|
func MockContext(t *testing.T, path string) *context.Context {
|
2022-01-20 23:16:10 +05:30
|
|
|
resp := &mockResponseWriter{}
|
|
|
|
ctx := context.Context{
|
2021-01-26 21:06:53 +05:30
|
|
|
Render: &mockRender{},
|
2023-05-04 12:06:34 +05:30
|
|
|
Data: make(middleware.ContextData),
|
2021-01-30 14:25:53 +05:30
|
|
|
Flash: &middleware.Flash{
|
2021-01-26 21:06:53 +05:30
|
|
|
Values: make(url.Values),
|
|
|
|
},
|
|
|
|
Resp: context.NewResponse(resp),
|
2023-04-17 09:07:23 +05:30
|
|
|
Locale: &translation.MockLocale{},
|
2021-01-26 21:06:53 +05:30
|
|
|
}
|
2022-05-05 19:43:23 +05:30
|
|
|
defer ctx.Close()
|
2021-01-26 21:06:53 +05:30
|
|
|
|
2017-11-30 21:22:15 +05:30
|
|
|
requestURL, err := url.Parse(path)
|
|
|
|
assert.NoError(t, err)
|
2022-01-20 23:16:10 +05:30
|
|
|
req := &http.Request{
|
2017-11-30 21:22:15 +05:30
|
|
|
URL: requestURL,
|
|
|
|
Form: url.Values{},
|
2017-08-03 10:39:16 +05:30
|
|
|
}
|
2021-01-26 21:06:53 +05:30
|
|
|
|
|
|
|
chiCtx := chi.NewRouteContext()
|
|
|
|
req = req.WithContext(scontext.WithValue(req.Context(), chi.RouteCtxKey, chiCtx))
|
|
|
|
ctx.Req = context.WithContext(req, &ctx)
|
|
|
|
return &ctx
|
2017-08-03 10:39:16 +05:30
|
|
|
}
|
|
|
|
|
2017-11-30 21:22:15 +05:30
|
|
|
// LoadRepo load a repo into a test context.
|
|
|
|
func LoadRepo(t *testing.T, ctx *context.Context, repoID int64) {
|
|
|
|
ctx.Repo = &context.Repository{}
|
2022-08-16 07:52:25 +05:30
|
|
|
ctx.Repo.Repository = unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: repoID})
|
2018-11-28 16:56:14 +05:30
|
|
|
var err error
|
2022-12-03 08:18:26 +05:30
|
|
|
ctx.Repo.Owner, err = user_model.GetUserByID(ctx, ctx.Repo.Repository.OwnerID)
|
Add Organization Wide Labels (#10814)
* Add organization wide labels
Implement organization wide labels similar to organization wide
webhooks. This lets you create individual labels for organizations that can be used
for all repos under that organization (so being able to reuse the same
label across multiple repos).
This makes it possible for small organizations with many repos to use
labels effectively.
Fixes #7406
* Add migration
* remove comments
* fix tests
* Update options/locale/locale_en-US.ini
Removed unused translation string
* show org labels in issue search label filter
* Use more clear var name
* rename migration after merge from master
* comment typo
* update migration again after rebase with master
* check for orgID <=0 per guillep2k review
* fmt
* Apply suggestions from code review
Co-Authored-By: guillep2k <18600385+guillep2k@users.noreply.github.com>
* remove unused code
* Make sure RepoID is 0 when searching orgID per code review
* more changes/code review requests
* More descriptive translation var per code review
* func description/delete comment when issue label deleted instead of hiding it
* remove comment
* only use issues in that repo when calculating number of open issues for org label on repo label page
* Add integration test for IssuesSearch API with labels
* remove unused function
* Update models/issue_label.go
Co-Authored-By: guillep2k <18600385+guillep2k@users.noreply.github.com>
* Use subquery in GetLabelIDsInReposByNames
* Fix tests to use correct orgID
* fix more tests
* IssuesSearch api now uses new BuildLabelNamesIssueIDsCondition. Add a few more tests as well
* update comment for clarity
* Revert previous code change now that we can use the new BuildLabelNamesIssueIDsCondition
* Don't sort repos by date in IssuesSearch API
After much debugging I've found a strange issue where in some cases MySQL will return a different result than other enigines if a query is sorted by a null collumn. For example with our integration test data where we don't set updated_unix in repository fixtures:
SELECT `id`, `owner_id`, `owner_name`, `lower_name`, `name`, `description`, `website`, `original_service_type`, `original_url`, `default_branch`, `num_watches`, `num_stars`, `num_forks`, `num_issues`, `num_closed_issues`, `num_pulls`, `num_closed_pulls`, `num_milestones`, `num_closed_milestones`, `is_private`, `is_empty`, `is_archived`, `is_mirror`, `status`, `is_fork`, `fork_id`, `is_template`, `template_id`, `size`, `is_fsck_enabled`, `close_issues_via_commit_in_any_branch`, `topics`, `avatar`, `created_unix`, `updated_unix` FROM `repository` ORDER BY updated_unix DESC LIMIT 15 OFFSET 45
Returns different results for MySQL than other engines. However, the similar query:
SELECT `id`, `owner_id`, `owner_name`, `lower_name`, `name`, `description`, `website`, `original_service_type`, `original_url`, `default_branch`, `num_watches`, `num_stars`, `num_forks`, `num_issues`, `num_closed_issues`, `num_pulls`, `num_closed_pulls`, `num_milestones`, `num_closed_milestones`, `is_private`, `is_empty`, `is_archived`, `is_mirror`, `status`, `is_fork`, `fork_id`, `is_template`, `template_id`, `size`, `is_fsck_enabled`, `close_issues_via_commit_in_any_branch`, `topics`, `avatar`, `created_unix`, `updated_unix` FROM `repository` ORDER BY updated_unix DESC LIMIT 15 OFFSET 30
Returns the same results.
This causes integration tests to fail on MySQL in certain cases but would never show up in a real installation. Since this API call always returns issues based on the optionally provided repo_priority_id or the issueID itself, there is no change to results by changing the repo sorting method used to get ids earlier in the function.
* linter is back!
* code review
* remove now unused option
* Fix newline at end of files
* more unused code
* update to master
* check for matching ids before query
* Update models/issue_label.go
Co-Authored-By: 6543 <6543@obermui.de>
* Update models/issue_label.go
* update comments
* Update routers/org/setting.go
Co-authored-by: Lauris BH <lauris@nix.lv>
Co-authored-by: guillep2k <18600385+guillep2k@users.noreply.github.com>
Co-authored-by: 6543 <6543@obermui.de>
2020-04-01 09:44:46 +05:30
|
|
|
assert.NoError(t, err)
|
|
|
|
ctx.Repo.RepoLink = ctx.Repo.Repository.Link()
|
2022-05-11 15:39:36 +05:30
|
|
|
ctx.Repo.Permission, err = access_model.GetUserRepoPermission(ctx, ctx.Repo.Repository, ctx.Doer)
|
2018-11-28 16:56:14 +05:30
|
|
|
assert.NoError(t, err)
|
2017-11-30 21:22:15 +05:30
|
|
|
}
|
|
|
|
|
2018-04-29 11:51:33 +05:30
|
|
|
// LoadRepoCommit loads a repo's commit into a test context.
|
|
|
|
func LoadRepoCommit(t *testing.T, ctx *context.Context) {
|
2022-03-30 00:43:41 +05:30
|
|
|
gitRepo, err := git.OpenRepository(ctx, ctx.Repo.Repository.RepoPath())
|
2018-04-29 11:51:33 +05:30
|
|
|
assert.NoError(t, err)
|
2019-11-13 12:31:19 +05:30
|
|
|
defer gitRepo.Close()
|
2018-04-29 11:51:33 +05:30
|
|
|
branch, err := gitRepo.GetHEADBranch()
|
|
|
|
assert.NoError(t, err)
|
2020-02-26 12:02:22 +05:30
|
|
|
assert.NotNil(t, branch)
|
|
|
|
if branch != nil {
|
|
|
|
ctx.Repo.Commit, err = gitRepo.GetBranchCommit(branch.Name)
|
|
|
|
assert.NoError(t, err)
|
|
|
|
}
|
2018-04-29 11:51:33 +05:30
|
|
|
}
|
|
|
|
|
2017-11-30 21:22:15 +05:30
|
|
|
// LoadUser load a user into a test context.
|
|
|
|
func LoadUser(t *testing.T, ctx *context.Context, userID int64) {
|
2022-08-16 07:52:25 +05:30
|
|
|
ctx.Doer = unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: userID})
|
2017-11-30 21:22:15 +05:30
|
|
|
}
|
|
|
|
|
2017-12-08 10:52:02 +05:30
|
|
|
// LoadGitRepo load a git repo into a test context. Requires that ctx.Repo has
|
|
|
|
// already been populated.
|
|
|
|
func LoadGitRepo(t *testing.T, ctx *context.Context) {
|
2023-02-18 17:41:03 +05:30
|
|
|
assert.NoError(t, ctx.Repo.Repository.LoadOwner(ctx))
|
2017-12-08 10:52:02 +05:30
|
|
|
var err error
|
2022-03-30 00:43:41 +05:30
|
|
|
ctx.Repo.GitRepo, err = git.OpenRepository(ctx, ctx.Repo.Repository.RepoPath())
|
2017-12-08 10:52:02 +05:30
|
|
|
assert.NoError(t, err)
|
|
|
|
}
|
|
|
|
|
2017-08-03 10:39:16 +05:30
|
|
|
type mockResponseWriter struct {
|
2017-12-16 02:41:02 +05:30
|
|
|
httptest.ResponseRecorder
|
|
|
|
size int
|
2017-08-03 10:39:16 +05:30
|
|
|
}
|
|
|
|
|
|
|
|
func (rw *mockResponseWriter) Write(b []byte) (int, error) {
|
|
|
|
rw.size += len(b)
|
2017-12-16 02:41:02 +05:30
|
|
|
return rw.ResponseRecorder.Write(b)
|
2017-08-03 10:39:16 +05:30
|
|
|
}
|
|
|
|
|
|
|
|
func (rw *mockResponseWriter) Status() int {
|
2017-12-16 02:41:02 +05:30
|
|
|
return rw.ResponseRecorder.Code
|
2017-08-03 10:39:16 +05:30
|
|
|
}
|
|
|
|
|
|
|
|
func (rw *mockResponseWriter) Written() bool {
|
2017-12-16 02:41:02 +05:30
|
|
|
return rw.ResponseRecorder.Code > 0
|
2017-08-03 10:39:16 +05:30
|
|
|
}
|
|
|
|
|
|
|
|
func (rw *mockResponseWriter) Size() int {
|
|
|
|
return rw.size
|
|
|
|
}
|
|
|
|
|
2020-08-28 08:17:17 +05:30
|
|
|
func (rw *mockResponseWriter) Push(target string, opts *http.PushOptions) error {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2022-01-20 23:16:10 +05:30
|
|
|
type mockRender struct{}
|
2017-08-03 10:39:16 +05:30
|
|
|
|
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 13:38:58 +05:30
|
|
|
func (tr *mockRender) TemplateLookup(tmpl string) (templates.TemplateExecutor, error) {
|
2023-04-08 18:45:22 +05:30
|
|
|
return nil, nil
|
2017-08-03 10:39:16 +05:30
|
|
|
}
|
|
|
|
|
2023-04-08 11:51:50 +05:30
|
|
|
func (tr *mockRender) HTML(w io.Writer, status int, _ string, _ interface{}) error {
|
2021-01-26 21:06:53 +05:30
|
|
|
if resp, ok := w.(http.ResponseWriter); ok {
|
|
|
|
resp.WriteHeader(status)
|
|
|
|
}
|
|
|
|
return nil
|
2017-08-03 10:39:16 +05:30
|
|
|
}
|