2019-04-02 22:54:29 +03:00
// Copyright 2019 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2022-09-02 22:18:23 +03:00
package integration
2019-04-02 22:54:29 +03:00
import (
"fmt"
"net/http"
2019-05-11 18:29:17 +03:00
"net/url"
2019-04-02 22:54:29 +03:00
"path"
2019-08-20 20:43:00 +03:00
"strings"
2019-04-02 22:54:29 +03:00
"testing"
2023-01-18 00:46:03 +03:00
auth_model "code.gitea.io/gitea/models/auth"
2024-04-12 04:41:50 +03:00
git_model "code.gitea.io/gitea/models/git"
repo_model "code.gitea.io/gitea/models/repo"
"code.gitea.io/gitea/models/unittest"
2019-05-11 13:21:34 +03:00
api "code.gitea.io/gitea/modules/structs"
2019-04-02 22:54:29 +03:00
"github.com/stretchr/testify/assert"
)
func TestPullCreate_CommitStatus ( t * testing . T ) {
2019-05-11 18:29:17 +03:00
onGiteaRun ( t , func ( t * testing . T , u * url . URL ) {
session := loginUser ( t , "user1" )
2024-05-21 20:00:35 +03:00
testRepoFork ( t , session , "user2" , "repo1" , "user1" , "repo1" , "" )
2019-05-11 18:29:17 +03:00
testEditFileToNewBranch ( t , session , "user1" , "repo1" , "master" , "status1" , "README.md" , "status1" )
url := path . Join ( "user1" , "repo1" , "compare" , "master...status1" )
req := NewRequestWithValues ( t , "POST" , url ,
map [ string ] string {
2024-10-10 06:48:21 +03:00
"_csrf" : GetUserCSRFToken ( t , session ) ,
2019-05-11 18:29:17 +03:00
"title" : "pull request from status1" ,
2019-04-02 22:54:29 +03:00
} ,
)
2023-06-19 11:25:36 +03:00
session . MakeRequest ( t , req , http . StatusOK )
2019-04-02 22:54:29 +03:00
2019-05-11 18:29:17 +03:00
req = NewRequest ( t , "GET" , "/user1/repo1/pulls" )
resp := session . MakeRequest ( t , req , http . StatusOK )
2021-11-18 04:33:06 +03:00
NewHTMLParser ( t , resp . Body )
2019-05-11 18:29:17 +03:00
// Request repository commits page
req = NewRequest ( t , "GET" , "/user1/repo1/pulls/1/commits" )
2019-04-02 22:54:29 +03:00
resp = session . MakeRequest ( t , req , http . StatusOK )
2021-11-18 04:33:06 +03:00
doc := NewHTMLParser ( t , resp . Body )
2019-04-02 22:54:29 +03:00
2019-05-11 18:29:17 +03:00
// Get first commit URL
commitURL , exists := doc . doc . Find ( "#commits-table tbody tr td.sha a" ) . Last ( ) . Attr ( "href" )
2019-04-02 22:54:29 +03:00
assert . True ( t , exists )
assert . NotEmpty ( t , commitURL )
2019-05-11 18:29:17 +03:00
commitID := path . Base ( commitURL )
2020-01-22 06:46:04 +03:00
statusList := [ ] api . CommitStatusState {
api . CommitStatusPending ,
api . CommitStatusError ,
api . CommitStatusFailure ,
api . CommitStatusSuccess ,
2023-10-09 01:16:06 +03:00
api . CommitStatusWarning ,
2019-05-11 18:29:17 +03:00
}
2020-01-22 06:46:04 +03:00
statesIcons := map [ api . CommitStatusState ] string {
2022-08-10 00:55:29 +03:00
api . CommitStatusPending : "octicon-dot-fill" ,
api . CommitStatusSuccess : "octicon-check" ,
api . CommitStatusError : "gitea-exclamation" ,
api . CommitStatusFailure : "octicon-x" ,
2023-10-09 01:16:06 +03:00
api . CommitStatusWarning : "gitea-exclamation" ,
2019-05-11 18:29: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
testCtx := NewAPITestContext ( t , "user1" , "repo1" , auth_model . AccessTokenScopeWriteRepository )
2022-05-07 20:05:52 +03:00
2019-05-11 18:29:17 +03:00
// Update commit status, and check if icon is updated as well
for _ , status := range statusList {
// Call API to add status for commit
2023-02-20 11:43:04 +03:00
t . Run ( "CreateStatus" , doAPICreateCommitStatus ( testCtx , commitID , api . CreateStatusOption {
State : status ,
TargetURL : "http://test.ci/" ,
Description : "" ,
Context : "testci" ,
} ) )
2019-05-11 18:29:17 +03:00
2023-12-22 02:59:59 +03:00
req = NewRequest ( t , "GET" , "/user1/repo1/pulls/1/commits" )
2019-05-11 18:29:17 +03:00
resp = session . MakeRequest ( t , req , http . StatusOK )
doc = NewHTMLParser ( t , resp . Body )
commitURL , exists = doc . doc . Find ( "#commits-table tbody tr td.sha a" ) . Last ( ) . Attr ( "href" )
assert . True ( t , exists )
assert . NotEmpty ( t , commitURL )
assert . EqualValues ( t , commitID , path . Base ( commitURL ) )
2022-08-10 00:55:29 +03:00
cls , ok := doc . doc . Find ( "#commits-table tbody tr td.message .commit-status" ) . Last ( ) . Attr ( "class" )
2019-05-11 18:29:17 +03:00
assert . True ( t , ok )
2022-08-10 00:55:29 +03:00
assert . Contains ( t , cls , statesIcons [ status ] )
2019-05-11 18:29:17 +03:00
}
2024-04-12 04:41:50 +03:00
repo1 := unittest . AssertExistsAndLoadBean ( t , & repo_model . Repository { OwnerName : "user1" , Name : "repo1" } )
css := unittest . AssertExistsAndLoadBean ( t , & git_model . CommitStatusSummary { RepoID : repo1 . ID , SHA : commitID } )
assert . EqualValues ( t , api . CommitStatusWarning , css . State )
2019-05-11 18:29:17 +03:00
} )
2019-04-02 22:54:29 +03:00
}
2019-08-20 20:43:00 +03:00
2023-02-20 11:43:04 +03:00
func doAPICreateCommitStatus ( ctx APITestContext , commitID string , data api . CreateStatusOption ) func ( * testing . T ) {
2022-05-07 20:05:52 +03:00
return func ( t * testing . T ) {
2023-02-20 11:43:04 +03:00
req := NewRequestWithJSON (
t ,
http . MethodPost ,
2023-12-22 02:59:59 +03:00
fmt . Sprintf ( "/api/v1/repos/%s/%s/statuses/%s" , ctx . Username , ctx . Reponame , commitID ) ,
2023-02-20 11:43:04 +03:00
data ,
2023-12-22 02:59:59 +03:00
) . AddTokenAuth ( ctx . Token )
2022-05-07 20:05:52 +03:00
if ctx . ExpectedCode != 0 {
ctx . Session . MakeRequest ( t , req , ctx . ExpectedCode )
return
}
ctx . Session . MakeRequest ( t , req , http . StatusCreated )
}
}
2022-07-13 11:22:51 +03:00
func TestPullCreate_EmptyChangesWithDifferentCommits ( t * testing . T ) {
// Merge must continue if commits SHA are different, even if content is same
Fix various typos (#21103)
Found via `codespell -q 3 -S
./options/locale,./options/license,./public/vendor,./web_src/fomantic -L
actived,allways,attachements,ba,befores,commiter,pullrequest,pullrequests,readby,splitted,te,unknwon`
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2022-09-07 21:40:36 +03:00
// Reason: gitflow and merging master back into develop, where is high possibility, there are no changes
2022-07-13 11:22:51 +03:00
// but just commit saying "Merge branch". And this meta commit can be also tagged,
// so we need to have this meta commit also in develop branch.
2019-08-20 20:43:00 +03:00
onGiteaRun ( t , func ( t * testing . T , u * url . URL ) {
session := loginUser ( t , "user1" )
2024-05-21 20:00:35 +03:00
testRepoFork ( t , session , "user2" , "repo1" , "user1" , "repo1" , "" )
2019-08-20 20:43:00 +03:00
testEditFileToNewBranch ( t , session , "user1" , "repo1" , "master" , "status1" , "README.md" , "status1" )
testEditFileToNewBranch ( t , session , "user1" , "repo1" , "status1" , "status1" , "README.md" , "# repo1\n\nDescription for repo1" )
url := path . Join ( "user1" , "repo1" , "compare" , "master...status1" )
req := NewRequestWithValues ( t , "POST" , url ,
map [ string ] string {
2024-10-10 06:48:21 +03:00
"_csrf" : GetUserCSRFToken ( t , session ) ,
2019-08-20 20:43:00 +03:00
"title" : "pull request from status1" ,
} ,
)
2023-06-19 11:25:36 +03:00
session . MakeRequest ( t , req , http . StatusOK )
2019-08-20 20:43:00 +03:00
req = NewRequest ( t , "GET" , "/user1/repo1/pulls/1" )
resp := session . MakeRequest ( t , req , http . StatusOK )
doc := NewHTMLParser ( t , resp . Body )
2020-11-15 23:58:16 +03:00
text := strings . TrimSpace ( doc . doc . Find ( ".merge-section" ) . Text ( ) )
2022-07-13 11:22:51 +03:00
assert . Contains ( t , text , "This pull request can be merged automatically." )
} )
}
func TestPullCreate_EmptyChangesWithSameCommits ( t * testing . T ) {
onGiteaRun ( t , func ( t * testing . T , u * url . URL ) {
session := loginUser ( t , "user1" )
2024-05-21 20:00:35 +03:00
testRepoFork ( t , session , "user2" , "repo1" , "user1" , "repo1" , "" )
2022-07-13 11:22:51 +03:00
testCreateBranch ( t , session , "user1" , "repo1" , "branch/master" , "status1" , http . StatusSeeOther )
url := path . Join ( "user1" , "repo1" , "compare" , "master...status1" )
req := NewRequestWithValues ( t , "POST" , url ,
map [ string ] string {
2024-10-10 06:48:21 +03:00
"_csrf" : GetUserCSRFToken ( t , session ) ,
2022-07-13 11:22:51 +03:00
"title" : "pull request from status1" ,
} ,
)
2023-06-19 11:25:36 +03:00
session . MakeRequest ( t , req , http . StatusOK )
2022-07-13 11:22:51 +03:00
req = NewRequest ( t , "GET" , "/user1/repo1/pulls/1" )
resp := session . MakeRequest ( t , req , http . StatusOK )
doc := NewHTMLParser ( t , resp . Body )
text := strings . TrimSpace ( doc . doc . Find ( ".merge-section" ) . Text ( ) )
assert . Contains ( t , text , "This branch is already included in the target branch. There is nothing to merge." )
2019-08-20 20:43:00 +03:00
} )
}