2017-06-18 12:06:17 +03:00
|
|
|
// Copyright 2017 The Gitea Authors. All rights reserved.
|
2022-11-27 21:20:29 +03:00
|
|
|
// SPDX-License-Identifier: MIT
|
2017-06-18 12:06:17 +03:00
|
|
|
|
2022-09-02 22:18:23 +03:00
|
|
|
package integration
|
2017-06-18 12:06:17 +03:00
|
|
|
|
|
|
|
import (
|
2017-07-14 01:33:26 +03:00
|
|
|
"fmt"
|
2017-06-18 12:06:17 +03:00
|
|
|
"net/http"
|
2020-01-13 19:02:24 +03:00
|
|
|
"net/url"
|
2017-06-18 12:06:17 +03:00
|
|
|
"testing"
|
|
|
|
|
2023-01-18 00:46:03 +03:00
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
2022-11-19 11:12:33 +03:00
|
|
|
"code.gitea.io/gitea/models/db"
|
2022-06-13 12:37:59 +03:00
|
|
|
issues_model "code.gitea.io/gitea/models/issues"
|
2021-12-10 04:27:50 +03:00
|
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
2021-11-16 11:53:21 +03:00
|
|
|
"code.gitea.io/gitea/models/unittest"
|
2021-11-24 12:49:20 +03:00
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2019-05-11 13:21:34 +03:00
|
|
|
api "code.gitea.io/gitea/modules/structs"
|
2022-12-29 05:57:15 +03:00
|
|
|
"code.gitea.io/gitea/services/convert"
|
2022-09-02 22:18:23 +03:00
|
|
|
"code.gitea.io/gitea/tests"
|
2017-06-18 12:06:17 +03:00
|
|
|
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
)
|
|
|
|
|
2017-07-14 01:33:26 +03:00
|
|
|
func TestAPIListRepoComments(t *testing.T) {
|
2022-09-02 22:18:23 +03:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2017-07-14 01:33:26 +03:00
|
|
|
|
2022-06-13 12:37:59 +03:00
|
|
|
comment := unittest.AssertExistsAndLoadBean(t, &issues_model.Comment{},
|
2022-08-16 05:22:25 +03:00
|
|
|
unittest.Cond("type = ?", issues_model.CommentTypeComment))
|
|
|
|
issue := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: comment.IssueID})
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issue.RepoID})
|
|
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
2017-07-14 01:33:26 +03:00
|
|
|
|
2020-01-13 19:02:24 +03:00
|
|
|
link, _ := url.Parse(fmt.Sprintf("/api/v1/repos/%s/%s/issues/comments", repoOwner.Name, repo.Name))
|
|
|
|
req := NewRequest(t, "GET", link.String())
|
2022-12-02 06:39:42 +03:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
2017-07-14 01:33:26 +03:00
|
|
|
|
|
|
|
var apiComments []*api.Comment
|
|
|
|
DecodeJSON(t, resp, &apiComments)
|
2020-01-13 19:02:24 +03:00
|
|
|
assert.Len(t, apiComments, 2)
|
2017-07-14 01:33:26 +03:00
|
|
|
for _, apiComment := range apiComments {
|
2022-06-13 12:37:59 +03:00
|
|
|
c := &issues_model.Comment{ID: apiComment.ID}
|
2021-11-16 11:53:21 +03:00
|
|
|
unittest.AssertExistsAndLoadBean(t, c,
|
2022-06-13 12:37:59 +03:00
|
|
|
unittest.Cond("type = ?", issues_model.CommentTypeComment))
|
|
|
|
unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: c.IssueID, RepoID: repo.ID})
|
2017-07-14 01:33:26 +03:00
|
|
|
}
|
2020-01-13 19:02:24 +03:00
|
|
|
|
2022-01-20 20:46:10 +03:00
|
|
|
// test before and since filters
|
2020-01-13 19:02:24 +03:00
|
|
|
query := url.Values{}
|
2022-01-20 20:46:10 +03:00
|
|
|
before := "2000-01-01T00:00:11+00:00" // unix: 946684811
|
|
|
|
since := "2000-01-01T00:00:12+00:00" // unix: 946684812
|
2020-01-13 19:02:24 +03:00
|
|
|
query.Add("before", before)
|
|
|
|
link.RawQuery = query.Encode()
|
|
|
|
req = NewRequest(t, "GET", link.String())
|
2022-12-02 06:39:42 +03:00
|
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
2020-01-13 19:02:24 +03:00
|
|
|
DecodeJSON(t, resp, &apiComments)
|
|
|
|
assert.Len(t, apiComments, 1)
|
|
|
|
assert.EqualValues(t, 2, apiComments[0].ID)
|
|
|
|
|
|
|
|
query.Del("before")
|
|
|
|
query.Add("since", since)
|
|
|
|
link.RawQuery = query.Encode()
|
|
|
|
req = NewRequest(t, "GET", link.String())
|
2022-12-02 06:39:42 +03:00
|
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
2020-01-13 19:02:24 +03:00
|
|
|
DecodeJSON(t, resp, &apiComments)
|
|
|
|
assert.Len(t, apiComments, 1)
|
|
|
|
assert.EqualValues(t, 3, apiComments[0].ID)
|
2017-07-14 01:33:26 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
func TestAPIListIssueComments(t *testing.T) {
|
2022-09-02 22:18:23 +03:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2017-06-18 12:06:17 +03:00
|
|
|
|
2022-06-13 12:37:59 +03:00
|
|
|
comment := unittest.AssertExistsAndLoadBean(t, &issues_model.Comment{},
|
2022-08-16 05:22:25 +03:00
|
|
|
unittest.Cond("type = ?", issues_model.CommentTypeComment))
|
|
|
|
issue := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: comment.IssueID})
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issue.RepoID})
|
|
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
2017-06-18 12:06:17 +03: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 21:57:16 +03:00
|
|
|
token := getUserToken(t, repoOwner.Name, auth_model.AccessTokenScopeReadIssue)
|
2023-01-18 00:46:03 +03:00
|
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/issues/%d/comments?token=%s",
|
|
|
|
repoOwner.Name, repo.Name, issue.Index, token)
|
2022-12-02 06:39:42 +03:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
2017-06-18 12:06:17 +03:00
|
|
|
|
|
|
|
var comments []*api.Comment
|
|
|
|
DecodeJSON(t, resp, &comments)
|
2022-06-13 12:37:59 +03:00
|
|
|
expectedCount := unittest.GetCount(t, &issues_model.Comment{IssueID: issue.ID},
|
|
|
|
unittest.Cond("type = ?", issues_model.CommentTypeComment))
|
2023-04-23 00:56:27 +03:00
|
|
|
assert.Len(t, comments, expectedCount)
|
2017-06-18 12:06:17 +03:00
|
|
|
}
|
2017-07-14 01:33:26 +03:00
|
|
|
|
|
|
|
func TestAPICreateComment(t *testing.T) {
|
2022-09-02 22:18:23 +03:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2017-07-14 01:33:26 +03:00
|
|
|
const commentBody = "Comment body"
|
|
|
|
|
2022-08-16 05:22:25 +03:00
|
|
|
issue := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{})
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issue.RepoID})
|
|
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
2017-07-14 01:33:26 +03: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 21:57:16 +03:00
|
|
|
token := getUserToken(t, repoOwner.Name, auth_model.AccessTokenScopeWriteIssue)
|
2018-09-10 19:15:52 +03:00
|
|
|
urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/issues/%d/comments?token=%s",
|
|
|
|
repoOwner.Name, repo.Name, issue.Index, token)
|
2017-07-14 01:33:26 +03:00
|
|
|
req := NewRequestWithValues(t, "POST", urlStr, map[string]string{
|
|
|
|
"body": commentBody,
|
|
|
|
})
|
2022-12-02 06:39:42 +03:00
|
|
|
resp := MakeRequest(t, req, http.StatusCreated)
|
2017-07-14 01:33:26 +03:00
|
|
|
|
|
|
|
var updatedComment api.Comment
|
|
|
|
DecodeJSON(t, resp, &updatedComment)
|
|
|
|
assert.EqualValues(t, commentBody, updatedComment.Body)
|
2022-06-13 12:37:59 +03:00
|
|
|
unittest.AssertExistsAndLoadBean(t, &issues_model.Comment{ID: updatedComment.ID, IssueID: issue.ID, Content: commentBody})
|
2017-07-14 01:33:26 +03:00
|
|
|
}
|
|
|
|
|
2020-01-08 10:00:59 +03:00
|
|
|
func TestAPIGetComment(t *testing.T) {
|
2022-09-02 22:18:23 +03:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2020-01-08 10:00:59 +03:00
|
|
|
|
2022-08-16 05:22:25 +03:00
|
|
|
comment := unittest.AssertExistsAndLoadBean(t, &issues_model.Comment{ID: 2})
|
2022-11-19 11:12:33 +03:00
|
|
|
assert.NoError(t, comment.LoadIssue(db.DefaultContext))
|
2022-08-16 05:22:25 +03:00
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: comment.Issue.RepoID})
|
|
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
2020-01-08 10:00:59 +03: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 21:57:16 +03:00
|
|
|
token := getUserToken(t, repoOwner.Name, auth_model.AccessTokenScopeReadIssue)
|
2020-01-08 10:00:59 +03:00
|
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/issues/comments/%d", repoOwner.Name, repo.Name, comment.ID)
|
2022-12-02 06:39:42 +03:00
|
|
|
MakeRequest(t, req, http.StatusOK)
|
2020-01-08 10:00:59 +03:00
|
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/issues/comments/%d?token=%s", repoOwner.Name, repo.Name, comment.ID, token)
|
2022-12-02 06:39:42 +03:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
2020-01-08 10:00:59 +03:00
|
|
|
|
|
|
|
var apiComment api.Comment
|
|
|
|
DecodeJSON(t, resp, &apiComment)
|
|
|
|
|
2022-11-19 11:12:33 +03:00
|
|
|
assert.NoError(t, comment.LoadPoster(db.DefaultContext))
|
2023-07-10 12:31:19 +03:00
|
|
|
expect := convert.ToAPIComment(db.DefaultContext, repo, comment)
|
2020-01-08 10:00:59 +03:00
|
|
|
|
|
|
|
assert.Equal(t, expect.ID, apiComment.ID)
|
|
|
|
assert.Equal(t, expect.Poster.FullName, apiComment.Poster.FullName)
|
|
|
|
assert.Equal(t, expect.Body, apiComment.Body)
|
|
|
|
assert.Equal(t, expect.Created.Unix(), apiComment.Created.Unix())
|
|
|
|
}
|
|
|
|
|
2023-11-14 16:50:05 +03:00
|
|
|
func TestAPIGetSystemUserComment(t *testing.T) {
|
|
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
|
|
|
|
issue := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{})
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issue.RepoID})
|
|
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
|
|
|
|
for _, systemUser := range []*user_model.User{
|
|
|
|
user_model.NewGhostUser(),
|
|
|
|
user_model.NewActionsUser(),
|
|
|
|
} {
|
|
|
|
body := fmt.Sprintf("Hello %s", systemUser.Name)
|
|
|
|
comment, err := issues_model.CreateComment(db.DefaultContext, &issues_model.CreateCommentOptions{
|
|
|
|
Type: issues_model.CommentTypeComment,
|
|
|
|
Doer: systemUser,
|
|
|
|
Repo: repo,
|
|
|
|
Issue: issue,
|
|
|
|
Content: body,
|
|
|
|
})
|
|
|
|
assert.NoError(t, err)
|
|
|
|
|
|
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/issues/comments/%d", repoOwner.Name, repo.Name, comment.ID)
|
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
|
|
|
|
|
|
var apiComment api.Comment
|
|
|
|
DecodeJSON(t, resp, &apiComment)
|
|
|
|
|
|
|
|
if assert.NotNil(t, apiComment.Poster) {
|
|
|
|
if assert.Equal(t, systemUser.ID, apiComment.Poster.ID) {
|
|
|
|
assert.NoError(t, comment.LoadPoster(db.DefaultContext))
|
|
|
|
assert.Equal(t, systemUser.Name, apiComment.Poster.UserName)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
assert.Equal(t, body, apiComment.Body)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-07-14 01:33:26 +03:00
|
|
|
func TestAPIEditComment(t *testing.T) {
|
2022-09-02 22:18:23 +03:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2017-07-14 01:33:26 +03:00
|
|
|
const newCommentBody = "This is the new comment body"
|
|
|
|
|
2023-11-26 02:43:23 +03:00
|
|
|
comment := unittest.AssertExistsAndLoadBean(t, &issues_model.Comment{ID: 8},
|
2022-08-16 05:22:25 +03:00
|
|
|
unittest.Cond("type = ?", issues_model.CommentTypeComment))
|
|
|
|
issue := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: comment.IssueID})
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issue.RepoID})
|
|
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
2017-07-14 01:33:26 +03:00
|
|
|
|
2023-11-26 02:43:23 +03:00
|
|
|
t.Run("UnrelatedCommentID", func(t *testing.T) {
|
|
|
|
// Using the ID of a comment that does not belong to the repository must fail
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 4})
|
|
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
token := getUserToken(t, repoOwner.Name, auth_model.AccessTokenScopeWriteIssue)
|
|
|
|
urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/issues/comments/%d?token=%s",
|
|
|
|
repoOwner.Name, repo.Name, comment.ID, token)
|
|
|
|
req := NewRequestWithValues(t, "PATCH", urlStr, map[string]string{
|
|
|
|
"body": newCommentBody,
|
|
|
|
})
|
|
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
})
|
|
|
|
|
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 21:57:16 +03:00
|
|
|
token := getUserToken(t, repoOwner.Name, auth_model.AccessTokenScopeWriteIssue)
|
2018-09-10 19:15:52 +03:00
|
|
|
urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/issues/comments/%d?token=%s",
|
|
|
|
repoOwner.Name, repo.Name, comment.ID, token)
|
2017-07-14 01:33:26 +03:00
|
|
|
req := NewRequestWithValues(t, "PATCH", urlStr, map[string]string{
|
|
|
|
"body": newCommentBody,
|
|
|
|
})
|
2022-12-02 06:39:42 +03:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
2017-07-14 01:33:26 +03:00
|
|
|
|
|
|
|
var updatedComment api.Comment
|
|
|
|
DecodeJSON(t, resp, &updatedComment)
|
|
|
|
assert.EqualValues(t, comment.ID, updatedComment.ID)
|
|
|
|
assert.EqualValues(t, newCommentBody, updatedComment.Body)
|
2022-06-13 12:37:59 +03:00
|
|
|
unittest.AssertExistsAndLoadBean(t, &issues_model.Comment{ID: comment.ID, IssueID: issue.ID, Content: newCommentBody})
|
2017-07-14 01:33:26 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
func TestAPIDeleteComment(t *testing.T) {
|
2022-09-02 22:18:23 +03:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2017-07-14 01:33:26 +03:00
|
|
|
|
2023-11-26 02:43:23 +03:00
|
|
|
comment := unittest.AssertExistsAndLoadBean(t, &issues_model.Comment{ID: 8},
|
2022-08-16 05:22:25 +03:00
|
|
|
unittest.Cond("type = ?", issues_model.CommentTypeComment))
|
|
|
|
issue := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: comment.IssueID})
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issue.RepoID})
|
|
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
2017-07-14 01:33:26 +03:00
|
|
|
|
2023-11-26 02:43:23 +03:00
|
|
|
t.Run("UnrelatedCommentID", func(t *testing.T) {
|
|
|
|
// Using the ID of a comment that does not belong to the repository must fail
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 4})
|
|
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
token := getUserToken(t, repoOwner.Name, auth_model.AccessTokenScopeWriteIssue)
|
|
|
|
req := NewRequestf(t, "DELETE", "/api/v1/repos/%s/%s/issues/comments/%d?token=%s",
|
|
|
|
repoOwner.Name, repo.Name, comment.ID, token)
|
|
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
})
|
|
|
|
|
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 21:57:16 +03:00
|
|
|
token := getUserToken(t, repoOwner.Name, auth_model.AccessTokenScopeWriteIssue)
|
2018-09-10 19:15:52 +03:00
|
|
|
req := NewRequestf(t, "DELETE", "/api/v1/repos/%s/%s/issues/comments/%d?token=%s",
|
|
|
|
repoOwner.Name, repo.Name, comment.ID, token)
|
2022-12-02 06:39:42 +03:00
|
|
|
MakeRequest(t, req, http.StatusNoContent)
|
2017-07-14 01:33:26 +03:00
|
|
|
|
2022-06-13 12:37:59 +03:00
|
|
|
unittest.AssertNotExistsBean(t, &issues_model.Comment{ID: comment.ID})
|
2017-07-14 01:33:26 +03:00
|
|
|
}
|
2022-01-01 17:12:25 +03:00
|
|
|
|
|
|
|
func TestAPIListIssueTimeline(t *testing.T) {
|
2022-09-02 22:18:23 +03:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2022-01-01 17:12:25 +03:00
|
|
|
|
|
|
|
// load comment
|
2022-08-16 05:22:25 +03:00
|
|
|
issue := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: 1})
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issue.RepoID})
|
|
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
2022-01-01 17:12:25 +03:00
|
|
|
|
|
|
|
// make request
|
|
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/issues/%d/timeline",
|
|
|
|
repoOwner.Name, repo.Name, issue.Index)
|
2022-12-02 06:39:42 +03:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
2022-01-01 17:12:25 +03:00
|
|
|
|
|
|
|
// check if lens of list returned by API and
|
|
|
|
// lists extracted directly from DB are the same
|
|
|
|
var comments []*api.TimelineComment
|
|
|
|
DecodeJSON(t, resp, &comments)
|
2022-06-13 12:37:59 +03:00
|
|
|
expectedCount := unittest.GetCount(t, &issues_model.Comment{IssueID: issue.ID})
|
2023-04-23 00:56:27 +03:00
|
|
|
assert.Len(t, comments, expectedCount)
|
2022-01-01 17:12:25 +03:00
|
|
|
}
|