2020-01-17 01:03:40 -05:00
|
|
|
// Copyright 2020 The Gitea Authors. All rights reserved.
|
2022-11-27 13:20:29 -05:00
|
|
|
// SPDX-License-Identifier: MIT
|
2020-01-17 01:03:40 -05:00
|
|
|
|
2022-09-02 15:18:23 -04:00
|
|
|
package integration
|
2020-01-17 01:03:40 -05:00
|
|
|
|
|
|
|
import (
|
2020-08-04 16:55:22 -04:00
|
|
|
"net/http"
|
2020-01-17 01:03:40 -05:00
|
|
|
"net/url"
|
2023-07-18 14:14:47 -04:00
|
|
|
"strings"
|
2020-01-17 01:03:40 -05:00
|
|
|
"testing"
|
|
|
|
"time"
|
|
|
|
|
2023-01-17 16:46:03 -05:00
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
2022-05-20 10:08:52 -04:00
|
|
|
"code.gitea.io/gitea/models/db"
|
2022-06-13 05:37:59 -04:00
|
|
|
issues_model "code.gitea.io/gitea/models/issues"
|
2021-11-16 03:53:21 -05:00
|
|
|
"code.gitea.io/gitea/models/unittest"
|
2021-11-24 04:49:20 -05:00
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2022-01-19 18:26:57 -05:00
|
|
|
"code.gitea.io/gitea/modules/git"
|
2020-01-17 01:03:40 -05:00
|
|
|
pull_service "code.gitea.io/gitea/services/pull"
|
|
|
|
repo_service "code.gitea.io/gitea/services/repository"
|
2021-11-24 02:56:24 -05:00
|
|
|
files_service "code.gitea.io/gitea/services/repository/files"
|
2020-01-17 01:03:40 -05:00
|
|
|
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
)
|
|
|
|
|
2020-08-04 16:55:22 -04:00
|
|
|
func TestAPIPullUpdate(t *testing.T) {
|
2020-01-17 01:03:40 -05:00
|
|
|
onGiteaRun(t, func(t *testing.T, giteaURL *url.URL) {
|
2022-01-20 12:46:10 -05:00
|
|
|
// Create PR to test
|
2022-08-15 22:22:25 -04:00
|
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
|
|
org26 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 26})
|
2020-01-17 01:03:40 -05:00
|
|
|
pr := createOutdatedPR(t, user, org26)
|
|
|
|
|
2022-01-20 12:46:10 -05:00
|
|
|
// Test GetDiverging
|
2022-01-19 18:26:57 -05:00
|
|
|
diffCount, err := pull_service.GetDiverging(git.DefaultContext, pr)
|
2020-01-17 01:03:40 -05:00
|
|
|
assert.NoError(t, err)
|
|
|
|
assert.EqualValues(t, 1, diffCount.Behind)
|
|
|
|
assert.EqualValues(t, 1, diffCount.Ahead)
|
2022-11-19 03:12:33 -05:00
|
|
|
assert.NoError(t, pr.LoadBaseRepo(db.DefaultContext))
|
|
|
|
assert.NoError(t, pr.LoadIssue(db.DefaultContext))
|
2020-01-17 01:03:40 -05:00
|
|
|
|
2020-08-04 16:55:22 -04:00
|
|
|
session := loginUser(t, "user2")
|
Redesign Scoped Access Tokens (#24767)
## Changes
- Adds the following high level access scopes, each with `read` and
`write` levels:
- `activitypub`
- `admin` (hidden if user is not a site admin)
- `misc`
- `notification`
- `organization`
- `package`
- `issue`
- `repository`
- `user`
- Adds new middleware function `tokenRequiresScopes()` in addition to
`reqToken()`
- `tokenRequiresScopes()` is used for each high-level api section
- _if_ a scoped token is present, checks that the required scope is
included based on the section and HTTP method
- `reqToken()` is used for individual routes
- checks that required authentication is present (but does not check
scope levels as this will already have been handled by
`tokenRequiresScopes()`
- Adds migration to convert old scoped access tokens to the new set of
scopes
- Updates the user interface for scope selection
### User interface example
<img width="903" alt="Screen Shot 2023-05-31 at 1 56 55 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/654766ec-2143-4f59-9037-3b51600e32f3">
<img width="917" alt="Screen Shot 2023-05-31 at 1 56 43 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/1ad64081-012c-4a73-b393-66b30352654c">
## tokenRequiresScopes Design Decision
- `tokenRequiresScopes()` was added to more reliably cover api routes.
For an incoming request, this function uses the given scope category
(say `AccessTokenScopeCategoryOrganization`) and the HTTP method (say
`DELETE`) and verifies that any scoped tokens in use include
`delete:organization`.
- `reqToken()` is used to enforce auth for individual routes that
require it. If a scoped token is not present for a request,
`tokenRequiresScopes()` will not return an error
## TODO
- [x] Alphabetize scope categories
- [x] Change 'public repos only' to a radio button (private vs public).
Also expand this to organizations
- [X] Disable token creation if no scopes selected. Alternatively, show
warning
- [x] `reqToken()` is missing from many `POST/DELETE` routes in the api.
`tokenRequiresScopes()` only checks that a given token has the correct
scope, `reqToken()` must be used to check that a token (or some other
auth) is present.
- _This should be addressed in this PR_
- [x] The migration should be reviewed very carefully in order to
minimize access changes to existing user tokens.
- _This should be addressed in this PR_
- [x] Link to api to swagger documentation, clarify what
read/write/delete levels correspond to
- [x] Review cases where more than one scope is needed as this directly
deviates from the api definition.
- _This should be addressed in this PR_
- For example:
```go
m.Group("/users/{username}/orgs", func() {
m.Get("", reqToken(), org.ListUserOrgs)
m.Get("/{org}/permissions", reqToken(), org.GetUserOrgsPermissions)
}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser,
auth_model.AccessTokenScopeCategoryOrganization),
context_service.UserAssignmentAPI())
```
## Future improvements
- [ ] Add required scopes to swagger documentation
- [ ] Redesign `reqToken()` to be opt-out rather than opt-in
- [ ] Subdivide scopes like `repository`
- [ ] Once a token is created, if it has no scopes, we should display
text instead of an empty bullet point
- [ ] If the 'public repos only' option is selected, should read
categories be selected by default
Closes #24501
Closes #24799
Co-authored-by: Jonathan Tran <jon@allspice.io>
Co-authored-by: Kyle D <kdumontnu@gmail.com>
Co-authored-by: silverwind <me@silverwind.io>
2023-06-04 14:57:16 -04:00
|
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
2023-12-21 18:59:59 -05:00
|
|
|
req := NewRequestf(t, "POST", "/api/v1/repos/%s/%s/pulls/%d/update", pr.BaseRepo.OwnerName, pr.BaseRepo.Name, pr.Issue.Index).
|
|
|
|
AddTokenAuth(token)
|
2020-08-04 16:55:22 -04:00
|
|
|
session.MakeRequest(t, req, http.StatusOK)
|
2020-01-17 01:03:40 -05:00
|
|
|
|
2022-01-20 12:46:10 -05:00
|
|
|
// Test GetDiverging after update
|
2022-01-19 18:26:57 -05:00
|
|
|
diffCount, err = pull_service.GetDiverging(git.DefaultContext, pr)
|
2020-01-17 01:03:40 -05:00
|
|
|
assert.NoError(t, err)
|
|
|
|
assert.EqualValues(t, 0, diffCount.Behind)
|
|
|
|
assert.EqualValues(t, 2, diffCount.Ahead)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2021-08-31 10:03:45 -04:00
|
|
|
func TestAPIPullUpdateByRebase(t *testing.T) {
|
|
|
|
onGiteaRun(t, func(t *testing.T, giteaURL *url.URL) {
|
2022-01-20 12:46:10 -05:00
|
|
|
// Create PR to test
|
2022-08-15 22:22:25 -04:00
|
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
|
|
org26 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 26})
|
2021-08-31 10:03:45 -04:00
|
|
|
pr := createOutdatedPR(t, user, org26)
|
|
|
|
|
2022-01-20 12:46:10 -05:00
|
|
|
// Test GetDiverging
|
2022-01-19 18:26:57 -05:00
|
|
|
diffCount, err := pull_service.GetDiverging(git.DefaultContext, pr)
|
2021-08-31 10:03:45 -04:00
|
|
|
assert.NoError(t, err)
|
|
|
|
assert.EqualValues(t, 1, diffCount.Behind)
|
|
|
|
assert.EqualValues(t, 1, diffCount.Ahead)
|
2022-11-19 03:12:33 -05:00
|
|
|
assert.NoError(t, pr.LoadBaseRepo(db.DefaultContext))
|
|
|
|
assert.NoError(t, pr.LoadIssue(db.DefaultContext))
|
2021-08-31 10:03:45 -04:00
|
|
|
|
|
|
|
session := loginUser(t, "user2")
|
Redesign Scoped Access Tokens (#24767)
## Changes
- Adds the following high level access scopes, each with `read` and
`write` levels:
- `activitypub`
- `admin` (hidden if user is not a site admin)
- `misc`
- `notification`
- `organization`
- `package`
- `issue`
- `repository`
- `user`
- Adds new middleware function `tokenRequiresScopes()` in addition to
`reqToken()`
- `tokenRequiresScopes()` is used for each high-level api section
- _if_ a scoped token is present, checks that the required scope is
included based on the section and HTTP method
- `reqToken()` is used for individual routes
- checks that required authentication is present (but does not check
scope levels as this will already have been handled by
`tokenRequiresScopes()`
- Adds migration to convert old scoped access tokens to the new set of
scopes
- Updates the user interface for scope selection
### User interface example
<img width="903" alt="Screen Shot 2023-05-31 at 1 56 55 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/654766ec-2143-4f59-9037-3b51600e32f3">
<img width="917" alt="Screen Shot 2023-05-31 at 1 56 43 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/1ad64081-012c-4a73-b393-66b30352654c">
## tokenRequiresScopes Design Decision
- `tokenRequiresScopes()` was added to more reliably cover api routes.
For an incoming request, this function uses the given scope category
(say `AccessTokenScopeCategoryOrganization`) and the HTTP method (say
`DELETE`) and verifies that any scoped tokens in use include
`delete:organization`.
- `reqToken()` is used to enforce auth for individual routes that
require it. If a scoped token is not present for a request,
`tokenRequiresScopes()` will not return an error
## TODO
- [x] Alphabetize scope categories
- [x] Change 'public repos only' to a radio button (private vs public).
Also expand this to organizations
- [X] Disable token creation if no scopes selected. Alternatively, show
warning
- [x] `reqToken()` is missing from many `POST/DELETE` routes in the api.
`tokenRequiresScopes()` only checks that a given token has the correct
scope, `reqToken()` must be used to check that a token (or some other
auth) is present.
- _This should be addressed in this PR_
- [x] The migration should be reviewed very carefully in order to
minimize access changes to existing user tokens.
- _This should be addressed in this PR_
- [x] Link to api to swagger documentation, clarify what
read/write/delete levels correspond to
- [x] Review cases where more than one scope is needed as this directly
deviates from the api definition.
- _This should be addressed in this PR_
- For example:
```go
m.Group("/users/{username}/orgs", func() {
m.Get("", reqToken(), org.ListUserOrgs)
m.Get("/{org}/permissions", reqToken(), org.GetUserOrgsPermissions)
}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser,
auth_model.AccessTokenScopeCategoryOrganization),
context_service.UserAssignmentAPI())
```
## Future improvements
- [ ] Add required scopes to swagger documentation
- [ ] Redesign `reqToken()` to be opt-out rather than opt-in
- [ ] Subdivide scopes like `repository`
- [ ] Once a token is created, if it has no scopes, we should display
text instead of an empty bullet point
- [ ] If the 'public repos only' option is selected, should read
categories be selected by default
Closes #24501
Closes #24799
Co-authored-by: Jonathan Tran <jon@allspice.io>
Co-authored-by: Kyle D <kdumontnu@gmail.com>
Co-authored-by: silverwind <me@silverwind.io>
2023-06-04 14:57:16 -04:00
|
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
2023-12-21 18:59:59 -05:00
|
|
|
req := NewRequestf(t, "POST", "/api/v1/repos/%s/%s/pulls/%d/update?style=rebase", pr.BaseRepo.OwnerName, pr.BaseRepo.Name, pr.Issue.Index).
|
|
|
|
AddTokenAuth(token)
|
2021-08-31 10:03:45 -04:00
|
|
|
session.MakeRequest(t, req, http.StatusOK)
|
|
|
|
|
2022-01-20 12:46:10 -05:00
|
|
|
// Test GetDiverging after update
|
2022-01-19 18:26:57 -05:00
|
|
|
diffCount, err = pull_service.GetDiverging(git.DefaultContext, pr)
|
2021-08-31 10:03:45 -04:00
|
|
|
assert.NoError(t, err)
|
|
|
|
assert.EqualValues(t, 0, diffCount.Behind)
|
|
|
|
assert.EqualValues(t, 1, diffCount.Ahead)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2022-06-13 05:37:59 -04:00
|
|
|
func createOutdatedPR(t *testing.T, actor, forkOrg *user_model.User) *issues_model.PullRequest {
|
2024-01-12 05:53:14 -05:00
|
|
|
baseRepo, _, _ := CreateDeclarativeRepo(t, actor, "repo-pr-update", nil, nil, nil)
|
2020-01-17 01:03:40 -05:00
|
|
|
|
2022-03-29 15:13:41 -04:00
|
|
|
headRepo, err := repo_service.ForkRepository(git.DefaultContext, actor, forkOrg, repo_service.ForkRepoOptions{
|
2021-08-28 04:37:14 -04:00
|
|
|
BaseRepo: baseRepo,
|
|
|
|
Name: "repo-pr-update",
|
|
|
|
Description: "desc",
|
|
|
|
})
|
2020-01-17 01:03:40 -05:00
|
|
|
assert.NoError(t, err)
|
|
|
|
assert.NotEmpty(t, headRepo)
|
|
|
|
|
2022-01-20 12:46:10 -05:00
|
|
|
// create a commit on base Repo
|
2023-05-29 05:41:35 -04:00
|
|
|
_, err = files_service.ChangeRepoFiles(git.DefaultContext, baseRepo, actor, &files_service.ChangeRepoFilesOptions{
|
|
|
|
Files: []*files_service.ChangeRepoFile{
|
|
|
|
{
|
2023-07-18 14:14:47 -04:00
|
|
|
Operation: "create",
|
|
|
|
TreePath: "File_A",
|
|
|
|
ContentReader: strings.NewReader("File A"),
|
2023-05-29 05:41:35 -04:00
|
|
|
},
|
|
|
|
},
|
2020-01-17 01:03:40 -05:00
|
|
|
Message: "Add File A",
|
2024-01-12 05:53:14 -05:00
|
|
|
OldBranch: "main",
|
|
|
|
NewBranch: "main",
|
2021-11-24 02:56:24 -05:00
|
|
|
Author: &files_service.IdentityOptions{
|
2020-01-17 01:03:40 -05:00
|
|
|
Name: actor.Name,
|
|
|
|
Email: actor.Email,
|
|
|
|
},
|
2021-11-24 02:56:24 -05:00
|
|
|
Committer: &files_service.IdentityOptions{
|
2020-01-17 01:03:40 -05:00
|
|
|
Name: actor.Name,
|
|
|
|
Email: actor.Email,
|
|
|
|
},
|
2021-11-24 02:56:24 -05:00
|
|
|
Dates: &files_service.CommitDateOptions{
|
2020-01-17 01:03:40 -05:00
|
|
|
Author: time.Now(),
|
|
|
|
Committer: time.Now(),
|
|
|
|
},
|
|
|
|
})
|
|
|
|
assert.NoError(t, err)
|
|
|
|
|
2022-01-20 12:46:10 -05:00
|
|
|
// create a commit on head Repo
|
2023-05-29 05:41:35 -04:00
|
|
|
_, err = files_service.ChangeRepoFiles(git.DefaultContext, headRepo, actor, &files_service.ChangeRepoFilesOptions{
|
|
|
|
Files: []*files_service.ChangeRepoFile{
|
|
|
|
{
|
2023-07-18 14:14:47 -04:00
|
|
|
Operation: "create",
|
|
|
|
TreePath: "File_B",
|
|
|
|
ContentReader: strings.NewReader("File B"),
|
2023-05-29 05:41:35 -04:00
|
|
|
},
|
|
|
|
},
|
2020-01-17 01:03:40 -05:00
|
|
|
Message: "Add File on PR branch",
|
2024-01-12 05:53:14 -05:00
|
|
|
OldBranch: "main",
|
2020-01-17 01:03:40 -05:00
|
|
|
NewBranch: "newBranch",
|
2021-11-24 02:56:24 -05:00
|
|
|
Author: &files_service.IdentityOptions{
|
2020-01-17 01:03:40 -05:00
|
|
|
Name: actor.Name,
|
|
|
|
Email: actor.Email,
|
|
|
|
},
|
2021-11-24 02:56:24 -05:00
|
|
|
Committer: &files_service.IdentityOptions{
|
2020-01-17 01:03:40 -05:00
|
|
|
Name: actor.Name,
|
|
|
|
Email: actor.Email,
|
|
|
|
},
|
2021-11-24 02:56:24 -05:00
|
|
|
Dates: &files_service.CommitDateOptions{
|
2020-01-17 01:03:40 -05:00
|
|
|
Author: time.Now(),
|
|
|
|
Committer: time.Now(),
|
|
|
|
},
|
|
|
|
})
|
|
|
|
assert.NoError(t, err)
|
|
|
|
|
2022-01-20 12:46:10 -05:00
|
|
|
// create Pull
|
2022-06-13 05:37:59 -04:00
|
|
|
pullIssue := &issues_model.Issue{
|
2020-01-17 01:03:40 -05:00
|
|
|
RepoID: baseRepo.ID,
|
|
|
|
Title: "Test Pull -to-update-",
|
|
|
|
PosterID: actor.ID,
|
|
|
|
Poster: actor,
|
|
|
|
IsPull: true,
|
|
|
|
}
|
2022-06-13 05:37:59 -04:00
|
|
|
pullRequest := &issues_model.PullRequest{
|
2020-01-17 01:03:40 -05:00
|
|
|
HeadRepoID: headRepo.ID,
|
|
|
|
BaseRepoID: baseRepo.ID,
|
|
|
|
HeadBranch: "newBranch",
|
2024-01-12 05:53:14 -05:00
|
|
|
BaseBranch: "main",
|
2020-01-17 01:03:40 -05:00
|
|
|
HeadRepo: headRepo,
|
|
|
|
BaseRepo: baseRepo,
|
2022-06-13 05:37:59 -04:00
|
|
|
Type: issues_model.PullRequestGitea,
|
2020-01-17 01:03:40 -05:00
|
|
|
}
|
2022-01-19 18:26:57 -05:00
|
|
|
err = pull_service.NewPullRequest(git.DefaultContext, baseRepo, pullIssue, nil, nil, pullRequest, nil)
|
2020-01-17 01:03:40 -05:00
|
|
|
assert.NoError(t, err)
|
|
|
|
|
2022-08-15 22:22:25 -04:00
|
|
|
issue := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{Title: "Test Pull -to-update-"})
|
2022-06-13 05:37:59 -04:00
|
|
|
pr, err := issues_model.GetPullRequestByIssueID(db.DefaultContext, issue.ID)
|
2020-01-17 01:03:40 -05:00
|
|
|
assert.NoError(t, err)
|
|
|
|
|
|
|
|
return pr
|
|
|
|
}
|