2017-06-30 16:50:57 +00:00
|
|
|
// Copyright 2017 The Gitea Authors. All rights reserved.
|
2022-11-27 18:20:29 +00:00
|
|
|
// SPDX-License-Identifier: MIT
|
2017-06-30 16:50:57 +00:00
|
|
|
|
2022-09-02 19:18:23 +00:00
|
|
|
package integration
|
2017-06-30 16:50:57 +00:00
|
|
|
|
|
|
|
import (
|
2024-12-10 21:15:06 +00:00
|
|
|
"bytes"
|
|
|
|
"context"
|
2018-08-13 19:04:39 +00:00
|
|
|
"fmt"
|
2022-12-02 22:06:23 +00:00
|
|
|
"io"
|
2017-06-30 16:50:57 +00:00
|
|
|
"net/http"
|
|
|
|
"testing"
|
|
|
|
|
2023-01-17 21:46:03 +00:00
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
2022-11-19 08:12:33 +00:00
|
|
|
"code.gitea.io/gitea/models/db"
|
2022-06-13 09:37:59 +00:00
|
|
|
issues_model "code.gitea.io/gitea/models/issues"
|
2024-07-29 02:21:22 +00:00
|
|
|
"code.gitea.io/gitea/models/perm"
|
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"
|
2018-08-13 19:04:39 +00:00
|
|
|
"code.gitea.io/gitea/modules/setting"
|
2019-05-11 10:21:34 +00:00
|
|
|
api "code.gitea.io/gitea/modules/structs"
|
2021-04-06 19:44:05 +00:00
|
|
|
"code.gitea.io/gitea/services/forms"
|
2024-12-10 21:15:06 +00:00
|
|
|
"code.gitea.io/gitea/services/gitdiff"
|
2019-10-11 06:44:43 +00:00
|
|
|
issue_service "code.gitea.io/gitea/services/issue"
|
2022-09-02 19:18:23 +00:00
|
|
|
"code.gitea.io/gitea/tests"
|
2017-06-30 16:50:57 +00:00
|
|
|
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
)
|
|
|
|
|
|
|
|
func TestAPIViewPulls(t *testing.T) {
|
2022-09-02 19:18:23 +00:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2022-08-16 02:22:25 +00:00
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
2017-06-30 16:50:57 +00:00
|
|
|
|
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 18:57:16 +00:00
|
|
|
ctx := NewAPITestContext(t, "user2", repo.Name, auth_model.AccessTokenScopeReadRepository)
|
2022-09-29 02:27:20 +00:00
|
|
|
|
2023-12-21 23:59:59 +00:00
|
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/pulls?state=all", owner.Name, repo.Name).
|
|
|
|
AddTokenAuth(ctx.Token)
|
2022-09-29 02:27:20 +00:00
|
|
|
resp := ctx.Session.MakeRequest(t, req, http.StatusOK)
|
2017-06-30 16:50:57 +00:00
|
|
|
|
|
|
|
var pulls []*api.PullRequest
|
|
|
|
DecodeJSON(t, resp, &pulls)
|
2022-06-13 09:37:59 +00:00
|
|
|
expectedLen := unittest.GetCount(t, &issues_model.Issue{RepoID: repo.ID}, unittest.Cond("is_pull = ?", true))
|
2017-06-30 16:50:57 +00:00
|
|
|
assert.Len(t, pulls, expectedLen)
|
2022-09-29 02:27:20 +00:00
|
|
|
|
2024-12-10 21:15:06 +00:00
|
|
|
assert.Len(t, pulls, 3)
|
2022-09-29 02:27:20 +00:00
|
|
|
pull := pulls[0]
|
2024-12-10 21:15:06 +00:00
|
|
|
assert.EqualValues(t, 1, pull.Poster.ID)
|
|
|
|
assert.Len(t, pull.RequestedReviewers, 2)
|
2024-12-15 10:41:29 +00:00
|
|
|
assert.Empty(t, pull.RequestedReviewersTeams)
|
2024-12-10 21:15:06 +00:00
|
|
|
assert.EqualValues(t, 5, pull.RequestedReviewers[0].ID)
|
|
|
|
assert.EqualValues(t, 6, pull.RequestedReviewers[1].ID)
|
|
|
|
assert.EqualValues(t, 1, pull.ChangedFiles)
|
|
|
|
|
2022-09-29 02:27:20 +00:00
|
|
|
if assert.EqualValues(t, 5, pull.ID) {
|
|
|
|
resp = ctx.Session.MakeRequest(t, NewRequest(t, "GET", pull.DiffURL), http.StatusOK)
|
2024-12-10 21:15:06 +00:00
|
|
|
bs, err := io.ReadAll(resp.Body)
|
|
|
|
assert.NoError(t, err)
|
|
|
|
patch, err := gitdiff.ParsePatch(context.Background(), 1000, 5000, 10, bytes.NewReader(bs), "")
|
2022-09-29 02:27:20 +00:00
|
|
|
assert.NoError(t, err)
|
2024-12-10 21:15:06 +00:00
|
|
|
if assert.Len(t, patch.Files, pull.ChangedFiles) {
|
|
|
|
assert.Equal(t, "File-WoW", patch.Files[0].Name)
|
|
|
|
// FIXME: The old name should be empty if it's a file add type
|
|
|
|
assert.Equal(t, "File-WoW", patch.Files[0].OldName)
|
|
|
|
assert.EqualValues(t, pull.Additions, patch.Files[0].Addition)
|
|
|
|
assert.EqualValues(t, pull.Deletions, patch.Files[0].Deletion)
|
|
|
|
assert.Equal(t, gitdiff.DiffFileAdd, patch.Files[0].Type)
|
|
|
|
}
|
2022-09-29 02:27:20 +00:00
|
|
|
|
|
|
|
t.Run(fmt.Sprintf("APIGetPullFiles_%d", pull.ID),
|
|
|
|
doAPIGetPullFiles(ctx, pull, func(t *testing.T, files []*api.ChangedFile) {
|
2024-12-10 21:15:06 +00:00
|
|
|
if assert.Len(t, files, pull.ChangedFiles) {
|
2023-04-22 21:56:27 +00:00
|
|
|
assert.Equal(t, "File-WoW", files[0].Filename)
|
|
|
|
assert.Empty(t, files[0].PreviousFilename)
|
2024-12-10 21:15:06 +00:00
|
|
|
assert.EqualValues(t, pull.Additions, files[0].Additions)
|
|
|
|
assert.EqualValues(t, pull.Deletions, files[0].Deletions)
|
2023-04-22 21:56:27 +00:00
|
|
|
assert.Equal(t, "added", files[0].Status)
|
2022-09-29 02:27:20 +00:00
|
|
|
}
|
|
|
|
}))
|
|
|
|
}
|
2024-12-10 21:15:06 +00:00
|
|
|
|
|
|
|
pull = pulls[1]
|
|
|
|
assert.EqualValues(t, 1, pull.Poster.ID)
|
|
|
|
assert.Len(t, pull.RequestedReviewers, 4)
|
2024-12-15 10:41:29 +00:00
|
|
|
assert.Empty(t, pull.RequestedReviewersTeams)
|
2024-12-10 21:15:06 +00:00
|
|
|
assert.EqualValues(t, 3, pull.RequestedReviewers[0].ID)
|
|
|
|
assert.EqualValues(t, 4, pull.RequestedReviewers[1].ID)
|
|
|
|
assert.EqualValues(t, 2, pull.RequestedReviewers[2].ID)
|
|
|
|
assert.EqualValues(t, 5, pull.RequestedReviewers[3].ID)
|
|
|
|
assert.EqualValues(t, 1, pull.ChangedFiles)
|
|
|
|
|
|
|
|
if assert.EqualValues(t, 2, pull.ID) {
|
|
|
|
resp = ctx.Session.MakeRequest(t, NewRequest(t, "GET", pull.DiffURL), http.StatusOK)
|
|
|
|
bs, err := io.ReadAll(resp.Body)
|
|
|
|
assert.NoError(t, err)
|
|
|
|
patch, err := gitdiff.ParsePatch(context.Background(), 1000, 5000, 10, bytes.NewReader(bs), "")
|
|
|
|
assert.NoError(t, err)
|
|
|
|
if assert.Len(t, patch.Files, pull.ChangedFiles) {
|
|
|
|
assert.Equal(t, "README.md", patch.Files[0].Name)
|
|
|
|
assert.Equal(t, "README.md", patch.Files[0].OldName)
|
|
|
|
assert.EqualValues(t, pull.Additions, patch.Files[0].Addition)
|
|
|
|
assert.EqualValues(t, pull.Deletions, patch.Files[0].Deletion)
|
|
|
|
assert.Equal(t, gitdiff.DiffFileChange, patch.Files[0].Type)
|
|
|
|
}
|
|
|
|
|
|
|
|
t.Run(fmt.Sprintf("APIGetPullFiles_%d", pull.ID),
|
|
|
|
doAPIGetPullFiles(ctx, pull, func(t *testing.T, files []*api.ChangedFile) {
|
|
|
|
if assert.Len(t, files, pull.ChangedFiles) {
|
|
|
|
assert.Equal(t, "README.md", files[0].Filename)
|
|
|
|
// FIXME: The PreviousFilename name should be the same as Filename if it's a file change
|
|
|
|
assert.Equal(t, "", files[0].PreviousFilename)
|
|
|
|
assert.EqualValues(t, pull.Additions, files[0].Additions)
|
|
|
|
assert.EqualValues(t, pull.Deletions, files[0].Deletions)
|
|
|
|
assert.Equal(t, "changed", files[0].Status)
|
|
|
|
}
|
|
|
|
}))
|
|
|
|
}
|
|
|
|
|
|
|
|
pull = pulls[2]
|
|
|
|
assert.EqualValues(t, 1, pull.Poster.ID)
|
|
|
|
assert.Len(t, pull.RequestedReviewers, 1)
|
2024-12-15 10:41:29 +00:00
|
|
|
assert.Empty(t, pull.RequestedReviewersTeams)
|
2024-12-10 21:15:06 +00:00
|
|
|
assert.EqualValues(t, 1, pull.RequestedReviewers[0].ID)
|
|
|
|
assert.EqualValues(t, 0, pull.ChangedFiles)
|
|
|
|
|
|
|
|
if assert.EqualValues(t, 1, pull.ID) {
|
|
|
|
resp = ctx.Session.MakeRequest(t, NewRequest(t, "GET", pull.DiffURL), http.StatusOK)
|
|
|
|
bs, err := io.ReadAll(resp.Body)
|
|
|
|
assert.NoError(t, err)
|
|
|
|
patch, err := gitdiff.ParsePatch(context.Background(), 1000, 5000, 10, bytes.NewReader(bs), "")
|
|
|
|
assert.NoError(t, err)
|
|
|
|
assert.EqualValues(t, pull.ChangedFiles, patch.NumFiles)
|
|
|
|
|
|
|
|
t.Run(fmt.Sprintf("APIGetPullFiles_%d", pull.ID),
|
|
|
|
doAPIGetPullFiles(ctx, pull, func(t *testing.T, files []*api.ChangedFile) {
|
|
|
|
assert.Len(t, files, pull.ChangedFiles)
|
|
|
|
}))
|
|
|
|
}
|
2017-06-30 16:50:57 +00:00
|
|
|
}
|
2018-08-13 19:04:39 +00:00
|
|
|
|
2024-02-26 02:39:01 +00:00
|
|
|
func TestAPIViewPullsByBaseHead(t *testing.T) {
|
|
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
|
|
|
|
ctx := NewAPITestContext(t, "user2", repo.Name, auth_model.AccessTokenScopeReadRepository)
|
|
|
|
|
|
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/pulls/master/branch2", owner.Name, repo.Name).
|
|
|
|
AddTokenAuth(ctx.Token)
|
|
|
|
resp := ctx.Session.MakeRequest(t, req, http.StatusOK)
|
|
|
|
|
|
|
|
pull := &api.PullRequest{}
|
|
|
|
DecodeJSON(t, resp, pull)
|
|
|
|
assert.EqualValues(t, 3, pull.Index)
|
|
|
|
assert.EqualValues(t, 2, pull.ID)
|
|
|
|
|
|
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/pulls/master/branch-not-exist", owner.Name, repo.Name).
|
|
|
|
AddTokenAuth(ctx.Token)
|
|
|
|
ctx.Session.MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
}
|
|
|
|
|
2018-08-13 19:04:39 +00:00
|
|
|
// TestAPIMergePullWIP ensures that we can't merge a WIP pull request
|
|
|
|
func TestAPIMergePullWIP(t *testing.T) {
|
2022-09-02 19:18:23 +00:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2022-08-16 02:22:25 +00:00
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
pr := unittest.AssertExistsAndLoadBean(t, &issues_model.PullRequest{Status: issues_model.PullRequestStatusMergeable}, unittest.Cond("has_merged = ?", false))
|
2022-11-19 08:12:33 +00:00
|
|
|
pr.LoadIssue(db.DefaultContext)
|
2023-04-14 18:18:28 +00:00
|
|
|
issue_service.ChangeTitle(db.DefaultContext, pr.Issue, owner, setting.Repository.PullRequest.WorkInProgressPrefixes[0]+" "+pr.Issue.Title)
|
2018-08-13 19:04:39 +00:00
|
|
|
|
|
|
|
// force reload
|
2022-11-19 08:12:33 +00:00
|
|
|
pr.LoadAttributes(db.DefaultContext)
|
2018-08-13 19:04:39 +00:00
|
|
|
|
|
|
|
assert.Contains(t, pr.Issue.Title, setting.Repository.PullRequest.WorkInProgressPrefixes[0])
|
|
|
|
|
|
|
|
session := loginUser(t, owner.Name)
|
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 18:57:16 +00:00
|
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
2023-12-21 23:59:59 +00:00
|
|
|
req := NewRequestWithJSON(t, http.MethodPost, fmt.Sprintf("/api/v1/repos/%s/%s/pulls/%d/merge", owner.Name, repo.Name, pr.Index), &forms.MergePullRequestForm{
|
2018-08-13 19:04:39 +00:00
|
|
|
MergeMessageField: pr.Issue.Title,
|
2021-12-10 01:27:50 +00:00
|
|
|
Do: string(repo_model.MergeStyleMerge),
|
2023-12-21 23:59:59 +00:00
|
|
|
}).AddTokenAuth(token)
|
2018-08-13 19:04:39 +00:00
|
|
|
|
2022-12-02 03:39:42 +00:00
|
|
|
MakeRequest(t, req, http.StatusMethodNotAllowed)
|
2018-08-13 19:04:39 +00:00
|
|
|
}
|
2019-05-07 17:20:23 +00:00
|
|
|
|
2020-06-07 19:13:40 +00:00
|
|
|
func TestAPICreatePullSuccess(t *testing.T) {
|
2022-09-02 19:18:23 +00:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2022-08-16 02:22:25 +00:00
|
|
|
repo10 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 10})
|
2019-05-07 17:20:23 +00:00
|
|
|
// repo10 have code, pulls units.
|
2022-08-16 02:22:25 +00:00
|
|
|
repo11 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 11})
|
2019-05-07 17:20:23 +00:00
|
|
|
// repo11 only have code unit but should still create pulls
|
2022-08-16 02:22:25 +00:00
|
|
|
owner10 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo10.OwnerID})
|
|
|
|
owner11 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo11.OwnerID})
|
2019-05-07 17:20:23 +00:00
|
|
|
|
|
|
|
session := loginUser(t, owner11.Name)
|
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 18:57:16 +00:00
|
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
2023-12-21 23:59:59 +00:00
|
|
|
req := NewRequestWithJSON(t, http.MethodPost, fmt.Sprintf("/api/v1/repos/%s/%s/pulls", owner10.Name, repo10.Name), &api.CreatePullRequestOption{
|
2019-05-07 17:20:23 +00:00
|
|
|
Head: fmt.Sprintf("%s:master", owner11.Name),
|
|
|
|
Base: "master",
|
|
|
|
Title: "create a failure pr",
|
2023-12-21 23:59:59 +00:00
|
|
|
}).AddTokenAuth(token)
|
2022-12-02 03:39:42 +00:00
|
|
|
MakeRequest(t, req, http.StatusCreated)
|
|
|
|
MakeRequest(t, req, http.StatusUnprocessableEntity) // second request should fail
|
2021-03-13 18:06:52 +00:00
|
|
|
}
|
|
|
|
|
2024-07-29 02:21:22 +00:00
|
|
|
func TestAPICreatePullBasePermission(t *testing.T) {
|
|
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo10 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 10})
|
|
|
|
// repo10 have code, pulls units.
|
|
|
|
repo11 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 11})
|
|
|
|
// repo11 only have code unit but should still create pulls
|
|
|
|
owner10 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo10.OwnerID})
|
|
|
|
user4 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 4})
|
|
|
|
|
|
|
|
session := loginUser(t, user4.Name)
|
|
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
|
|
|
opts := &api.CreatePullRequestOption{
|
|
|
|
Head: fmt.Sprintf("%s:master", repo11.OwnerName),
|
|
|
|
Base: "master",
|
|
|
|
Title: "create a failure pr",
|
|
|
|
}
|
|
|
|
req := NewRequestWithJSON(t, http.MethodPost, fmt.Sprintf("/api/v1/repos/%s/%s/pulls", owner10.Name, repo10.Name), &opts).AddTokenAuth(token)
|
|
|
|
MakeRequest(t, req, http.StatusForbidden)
|
|
|
|
|
|
|
|
// add user4 to be a collaborator to base repo
|
|
|
|
ctx := NewAPITestContext(t, repo10.OwnerName, repo10.Name, auth_model.AccessTokenScopeWriteRepository)
|
|
|
|
t.Run("AddUser4AsCollaborator", doAPIAddCollaborator(ctx, user4.Name, perm.AccessModeRead))
|
|
|
|
|
|
|
|
// create again
|
|
|
|
req = NewRequestWithJSON(t, http.MethodPost, fmt.Sprintf("/api/v1/repos/%s/%s/pulls", owner10.Name, repo10.Name), &opts).AddTokenAuth(token)
|
|
|
|
MakeRequest(t, req, http.StatusCreated)
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestAPICreatePullHeadPermission(t *testing.T) {
|
|
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo10 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 10})
|
|
|
|
// repo10 have code, pulls units.
|
|
|
|
repo11 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 11})
|
|
|
|
// repo11 only have code unit but should still create pulls
|
|
|
|
owner10 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo10.OwnerID})
|
|
|
|
user4 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 4})
|
|
|
|
|
|
|
|
session := loginUser(t, user4.Name)
|
|
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
|
|
|
opts := &api.CreatePullRequestOption{
|
|
|
|
Head: fmt.Sprintf("%s:master", repo11.OwnerName),
|
|
|
|
Base: "master",
|
|
|
|
Title: "create a failure pr",
|
|
|
|
}
|
|
|
|
req := NewRequestWithJSON(t, http.MethodPost, fmt.Sprintf("/api/v1/repos/%s/%s/pulls", owner10.Name, repo10.Name), &opts).AddTokenAuth(token)
|
|
|
|
MakeRequest(t, req, http.StatusForbidden)
|
|
|
|
|
|
|
|
// add user4 to be a collaborator to head repo with read permission
|
|
|
|
ctx := NewAPITestContext(t, repo11.OwnerName, repo11.Name, auth_model.AccessTokenScopeWriteRepository)
|
|
|
|
t.Run("AddUser4AsCollaboratorWithRead", doAPIAddCollaborator(ctx, user4.Name, perm.AccessModeRead))
|
|
|
|
req = NewRequestWithJSON(t, http.MethodPost, fmt.Sprintf("/api/v1/repos/%s/%s/pulls", owner10.Name, repo10.Name), &opts).AddTokenAuth(token)
|
|
|
|
MakeRequest(t, req, http.StatusForbidden)
|
|
|
|
|
|
|
|
// add user4 to be a collaborator to head repo with write permission
|
|
|
|
t.Run("AddUser4AsCollaboratorWithWrite", doAPIAddCollaborator(ctx, user4.Name, perm.AccessModeWrite))
|
|
|
|
req = NewRequestWithJSON(t, http.MethodPost, fmt.Sprintf("/api/v1/repos/%s/%s/pulls", owner10.Name, repo10.Name), &opts).AddTokenAuth(token)
|
|
|
|
MakeRequest(t, req, http.StatusCreated)
|
|
|
|
}
|
|
|
|
|
2024-03-17 03:56:49 +00:00
|
|
|
func TestAPICreatePullSameRepoSuccess(t *testing.T) {
|
|
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
|
|
|
|
session := loginUser(t, owner.Name)
|
|
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
|
|
|
|
|
|
|
req := NewRequestWithJSON(t, http.MethodPost, fmt.Sprintf("/api/v1/repos/%s/%s/pulls", owner.Name, repo.Name), &api.CreatePullRequestOption{
|
|
|
|
Head: fmt.Sprintf("%s:pr-to-update", owner.Name),
|
|
|
|
Base: "master",
|
|
|
|
Title: "successfully create a PR between branches of the same repository",
|
|
|
|
}).AddTokenAuth(token)
|
|
|
|
MakeRequest(t, req, http.StatusCreated)
|
|
|
|
MakeRequest(t, req, http.StatusUnprocessableEntity) // second request should fail
|
|
|
|
}
|
|
|
|
|
2021-03-13 18:06:52 +00:00
|
|
|
func TestAPICreatePullWithFieldsSuccess(t *testing.T) {
|
2022-09-02 19:18:23 +00:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2021-03-13 18:06:52 +00:00
|
|
|
// repo10 have code, pulls units.
|
2022-08-16 02:22:25 +00:00
|
|
|
repo10 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 10})
|
|
|
|
owner10 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo10.OwnerID})
|
2021-03-13 18:06:52 +00:00
|
|
|
// repo11 only have code unit but should still create pulls
|
2022-08-16 02:22:25 +00:00
|
|
|
repo11 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 11})
|
|
|
|
owner11 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo11.OwnerID})
|
2021-03-13 18:06:52 +00:00
|
|
|
|
|
|
|
session := loginUser(t, owner11.Name)
|
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 18:57:16 +00:00
|
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
2021-03-13 18:06:52 +00:00
|
|
|
|
|
|
|
opts := &api.CreatePullRequestOption{
|
|
|
|
Head: fmt.Sprintf("%s:master", owner11.Name),
|
|
|
|
Base: "master",
|
|
|
|
Title: "create a failure pr",
|
|
|
|
Body: "foobaaar",
|
|
|
|
Milestone: 5,
|
|
|
|
Assignees: []string{owner10.Name},
|
|
|
|
Labels: []int64{5},
|
|
|
|
}
|
|
|
|
|
2023-12-21 23:59:59 +00:00
|
|
|
req := NewRequestWithJSON(t, http.MethodPost, fmt.Sprintf("/api/v1/repos/%s/%s/pulls", owner10.Name, repo10.Name), opts).
|
|
|
|
AddTokenAuth(token)
|
2021-03-13 18:06:52 +00:00
|
|
|
|
2022-12-02 03:39:42 +00:00
|
|
|
res := MakeRequest(t, req, http.StatusCreated)
|
2021-03-13 18:06:52 +00:00
|
|
|
pull := new(api.PullRequest)
|
|
|
|
DecodeJSON(t, res, pull)
|
|
|
|
|
|
|
|
assert.NotNil(t, pull.Milestone)
|
|
|
|
assert.EqualValues(t, opts.Milestone, pull.Milestone.ID)
|
|
|
|
if assert.Len(t, pull.Assignees, 1) {
|
|
|
|
assert.EqualValues(t, opts.Assignees[0], owner10.Name)
|
|
|
|
}
|
|
|
|
assert.NotNil(t, pull.Labels)
|
|
|
|
assert.EqualValues(t, opts.Labels[0], pull.Labels[0].ID)
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestAPICreatePullWithFieldsFailure(t *testing.T) {
|
2022-09-02 19:18:23 +00:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2021-03-13 18:06:52 +00:00
|
|
|
// repo10 have code, pulls units.
|
2022-08-16 02:22:25 +00:00
|
|
|
repo10 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 10})
|
|
|
|
owner10 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo10.OwnerID})
|
2021-03-13 18:06:52 +00:00
|
|
|
// repo11 only have code unit but should still create pulls
|
2022-08-16 02:22:25 +00:00
|
|
|
repo11 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 11})
|
|
|
|
owner11 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo11.OwnerID})
|
2021-03-13 18:06:52 +00:00
|
|
|
|
|
|
|
session := loginUser(t, owner11.Name)
|
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 18:57:16 +00:00
|
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
2021-03-13 18:06:52 +00:00
|
|
|
|
|
|
|
opts := &api.CreatePullRequestOption{
|
|
|
|
Head: fmt.Sprintf("%s:master", owner11.Name),
|
|
|
|
Base: "master",
|
|
|
|
}
|
|
|
|
|
2023-12-21 23:59:59 +00:00
|
|
|
req := NewRequestWithJSON(t, http.MethodPost, fmt.Sprintf("/api/v1/repos/%s/%s/pulls", owner10.Name, repo10.Name), opts).
|
|
|
|
AddTokenAuth(token)
|
2022-12-02 03:39:42 +00:00
|
|
|
MakeRequest(t, req, http.StatusUnprocessableEntity)
|
2021-03-13 18:06:52 +00:00
|
|
|
opts.Title = "is required"
|
|
|
|
|
|
|
|
opts.Milestone = 666
|
2022-12-02 03:39:42 +00:00
|
|
|
MakeRequest(t, req, http.StatusUnprocessableEntity)
|
2021-03-13 18:06:52 +00:00
|
|
|
opts.Milestone = 5
|
|
|
|
|
|
|
|
opts.Assignees = []string{"qweruqweroiuyqweoiruywqer"}
|
2022-12-02 03:39:42 +00:00
|
|
|
MakeRequest(t, req, http.StatusUnprocessableEntity)
|
2021-03-13 18:06:52 +00:00
|
|
|
opts.Assignees = []string{owner10.LoginName}
|
|
|
|
|
|
|
|
opts.Labels = []int64{55555}
|
2022-12-02 03:39:42 +00:00
|
|
|
MakeRequest(t, req, http.StatusUnprocessableEntity)
|
2021-03-13 18:06:52 +00:00
|
|
|
opts.Labels = []int64{5}
|
2019-05-07 17:20:23 +00:00
|
|
|
}
|
|
|
|
|
2020-06-07 19:13:40 +00:00
|
|
|
func TestAPIEditPull(t *testing.T) {
|
2022-09-02 19:18:23 +00:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2022-08-16 02:22:25 +00:00
|
|
|
repo10 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 10})
|
|
|
|
owner10 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo10.OwnerID})
|
2019-05-07 17:20:23 +00:00
|
|
|
|
|
|
|
session := loginUser(t, owner10.Name)
|
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 18:57:16 +00:00
|
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
2024-05-03 06:11:51 +00:00
|
|
|
title := "create a success pr"
|
2023-12-21 23:59:59 +00:00
|
|
|
req := NewRequestWithJSON(t, http.MethodPost, fmt.Sprintf("/api/v1/repos/%s/%s/pulls", owner10.Name, repo10.Name), &api.CreatePullRequestOption{
|
2019-05-07 17:20:23 +00:00
|
|
|
Head: "develop",
|
|
|
|
Base: "master",
|
2024-05-03 06:11:51 +00:00
|
|
|
Title: title,
|
2023-12-21 23:59:59 +00:00
|
|
|
}).AddTokenAuth(token)
|
2024-05-03 06:11:51 +00:00
|
|
|
apiPull := new(api.PullRequest)
|
2022-12-02 03:39:42 +00:00
|
|
|
resp := MakeRequest(t, req, http.StatusCreated)
|
2024-05-03 06:11:51 +00:00
|
|
|
DecodeJSON(t, resp, apiPull)
|
|
|
|
assert.EqualValues(t, "master", apiPull.Base.Name)
|
2020-06-07 19:13:40 +00:00
|
|
|
|
2024-05-03 06:11:51 +00:00
|
|
|
newTitle := "edit a this pr"
|
|
|
|
newBody := "edited body"
|
|
|
|
req = NewRequestWithJSON(t, http.MethodPatch, fmt.Sprintf("/api/v1/repos/%s/%s/pulls/%d", owner10.Name, repo10.Name, apiPull.Index), &api.EditPullRequestOption{
|
2020-06-07 19:13:40 +00:00
|
|
|
Base: "feature/1",
|
2024-05-03 06:11:51 +00:00
|
|
|
Title: newTitle,
|
|
|
|
Body: &newBody,
|
2023-12-21 23:59:59 +00:00
|
|
|
}).AddTokenAuth(token)
|
2022-12-02 03:39:42 +00:00
|
|
|
resp = MakeRequest(t, req, http.StatusCreated)
|
2024-05-03 06:11:51 +00:00
|
|
|
DecodeJSON(t, resp, apiPull)
|
|
|
|
assert.EqualValues(t, "feature/1", apiPull.Base.Name)
|
|
|
|
// check comment history
|
|
|
|
pull := unittest.AssertExistsAndLoadBean(t, &issues_model.PullRequest{ID: apiPull.ID})
|
|
|
|
err := pull.LoadIssue(db.DefaultContext)
|
|
|
|
assert.NoError(t, err)
|
|
|
|
unittest.AssertExistsAndLoadBean(t, &issues_model.Comment{IssueID: pull.Issue.ID, OldTitle: title, NewTitle: newTitle})
|
|
|
|
unittest.AssertExistsAndLoadBean(t, &issues_model.ContentHistory{IssueID: pull.Issue.ID, ContentText: newBody, IsFirstCreated: false})
|
2019-05-07 17:20:23 +00:00
|
|
|
|
2023-12-21 23:59:59 +00:00
|
|
|
req = NewRequestWithJSON(t, http.MethodPatch, fmt.Sprintf("/api/v1/repos/%s/%s/pulls/%d", owner10.Name, repo10.Name, pull.Index), &api.EditPullRequestOption{
|
2020-06-07 19:13:40 +00:00
|
|
|
Base: "not-exist",
|
2023-12-21 23:59:59 +00:00
|
|
|
}).AddTokenAuth(token)
|
2022-12-02 03:39:42 +00:00
|
|
|
MakeRequest(t, req, http.StatusNotFound)
|
2019-05-07 17:20:23 +00:00
|
|
|
}
|
2022-09-29 02:27:20 +00:00
|
|
|
|
|
|
|
func doAPIGetPullFiles(ctx APITestContext, pr *api.PullRequest, callback func(*testing.T, []*api.ChangedFile)) func(*testing.T) {
|
|
|
|
return func(t *testing.T) {
|
2023-12-21 23:59:59 +00:00
|
|
|
req := NewRequest(t, http.MethodGet, fmt.Sprintf("/api/v1/repos/%s/%s/pulls/%d/files", ctx.Username, ctx.Reponame, pr.Index)).
|
|
|
|
AddTokenAuth(ctx.Token)
|
2022-09-29 02:27:20 +00:00
|
|
|
if ctx.ExpectedCode == 0 {
|
|
|
|
ctx.ExpectedCode = http.StatusOK
|
|
|
|
}
|
|
|
|
resp := ctx.Session.MakeRequest(t, req, ctx.ExpectedCode)
|
|
|
|
|
|
|
|
files := make([]*api.ChangedFile, 0, 1)
|
|
|
|
DecodeJSON(t, resp, &files)
|
|
|
|
|
|
|
|
if callback != nil {
|
|
|
|
callback(t, files)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2024-09-24 01:00:09 +00:00
|
|
|
|
|
|
|
func TestAPICommitPullRequest(t *testing.T) {
|
|
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
|
|
|
|
ctx := NewAPITestContext(t, "user2", repo.Name, auth_model.AccessTokenScopeReadRepository)
|
|
|
|
|
|
|
|
mergedCommitSHA := "1a8823cd1a9549fde083f992f6b9b87a7ab74fb3"
|
|
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/commits/%s/pull", owner.Name, repo.Name, mergedCommitSHA).AddTokenAuth(ctx.Token)
|
|
|
|
ctx.Session.MakeRequest(t, req, http.StatusOK)
|
|
|
|
|
|
|
|
invalidCommitSHA := "abcd1234abcd1234abcd1234abcd1234abcd1234"
|
|
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/commits/%s/pull", owner.Name, repo.Name, invalidCommitSHA).AddTokenAuth(ctx.Token)
|
|
|
|
ctx.Session.MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
}
|