mirror of
https://codeberg.org/forgejo/forgejo
synced 2024-11-27 20:26:09 +01:00
de484e86bc
This PR adds the support for scopes of access tokens, mimicking the design of GitHub OAuth scopes. The changes of the core logic are in `models/auth` that `AccessToken` struct will have a `Scope` field. The normalized (no duplication of scope), comma-separated scope string will be stored in `access_token` table in the database. In `services/auth`, the scope will be stored in context, which will be used by `reqToken` middleware in API calls. Only OAuth2 tokens will have granular token scopes, while others like BasicAuth will default to scope `all`. A large amount of work happens in `routers/api/v1/api.go` and the corresponding `tests/integration` tests, that is adding necessary scopes to each of the API calls as they fit. - [x] Add `Scope` field to `AccessToken` - [x] Add access control to all API endpoints - [x] Update frontend & backend for when creating tokens - [x] Add a database migration for `scope` column (enable 'all' access to past tokens) I'm aiming to complete it before Gitea 1.19 release. Fixes #4300
195 lines
7.1 KiB
Go
195 lines
7.1 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"testing"
|
|
|
|
activities_model "code.gitea.io/gitea/models/activities"
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
|
"code.gitea.io/gitea/models/db"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/tests"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestAPINotification(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
repo1 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
thread5 := unittest.AssertExistsAndLoadBean(t, &activities_model.Notification{ID: 5})
|
|
assert.NoError(t, thread5.LoadAttributes(db.DefaultContext))
|
|
session := loginUser(t, user2.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeNotification)
|
|
|
|
// -- GET /notifications --
|
|
// test filter
|
|
since := "2000-01-01T00%3A50%3A01%2B00%3A00" // 946687801
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?since=%s&token=%s", since, token))
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var apiNL []api.NotificationThread
|
|
DecodeJSON(t, resp, &apiNL)
|
|
|
|
assert.Len(t, apiNL, 1)
|
|
assert.EqualValues(t, 5, apiNL[0].ID)
|
|
|
|
// test filter
|
|
before := "2000-01-01T01%3A06%3A59%2B00%3A00" // 946688819
|
|
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?all=%s&before=%s&token=%s", "true", before, token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
|
|
assert.Len(t, apiNL, 3)
|
|
assert.EqualValues(t, 4, apiNL[0].ID)
|
|
assert.True(t, apiNL[0].Unread)
|
|
assert.False(t, apiNL[0].Pinned)
|
|
assert.EqualValues(t, 3, apiNL[1].ID)
|
|
assert.False(t, apiNL[1].Unread)
|
|
assert.True(t, apiNL[1].Pinned)
|
|
assert.EqualValues(t, 2, apiNL[2].ID)
|
|
assert.False(t, apiNL[2].Unread)
|
|
assert.False(t, apiNL[2].Pinned)
|
|
|
|
// -- GET /repos/{owner}/{repo}/notifications --
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/notifications?status-types=unread&token=%s", user2.Name, repo1.Name, token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
|
|
assert.Len(t, apiNL, 1)
|
|
assert.EqualValues(t, 4, apiNL[0].ID)
|
|
|
|
// -- GET /repos/{owner}/{repo}/notifications -- multiple status-types
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/notifications?status-types=unread&status-types=pinned&token=%s", user2.Name, repo1.Name, token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
|
|
assert.Len(t, apiNL, 2)
|
|
assert.EqualValues(t, 4, apiNL[0].ID)
|
|
assert.True(t, apiNL[0].Unread)
|
|
assert.False(t, apiNL[0].Pinned)
|
|
assert.EqualValues(t, 3, apiNL[1].ID)
|
|
assert.False(t, apiNL[1].Unread)
|
|
assert.True(t, apiNL[1].Pinned)
|
|
|
|
// -- GET /notifications/threads/{id} --
|
|
// get forbidden
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications/threads/%d?token=%s", 1, token))
|
|
MakeRequest(t, req, http.StatusForbidden)
|
|
|
|
// get own
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications/threads/%d?token=%s", thread5.ID, token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
var apiN api.NotificationThread
|
|
DecodeJSON(t, resp, &apiN)
|
|
|
|
assert.EqualValues(t, 5, apiN.ID)
|
|
assert.False(t, apiN.Pinned)
|
|
assert.True(t, apiN.Unread)
|
|
assert.EqualValues(t, "issue4", apiN.Subject.Title)
|
|
assert.EqualValues(t, "Issue", apiN.Subject.Type)
|
|
assert.EqualValues(t, thread5.Issue.APIURL(), apiN.Subject.URL)
|
|
assert.EqualValues(t, thread5.Repository.HTMLURL(), apiN.Repository.HTMLURL)
|
|
|
|
new := struct {
|
|
New int64 `json:"new"`
|
|
}{}
|
|
|
|
// -- check notifications --
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications/new?token=%s", token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &new)
|
|
assert.True(t, new.New > 0)
|
|
|
|
// -- mark notifications as read --
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?status-types=unread&token=%s", token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
assert.Len(t, apiNL, 2)
|
|
|
|
lastReadAt := "2000-01-01T00%3A50%3A01%2B00%3A00" // 946687801 <- only Notification 4 is in this filter ...
|
|
req = NewRequest(t, "PUT", fmt.Sprintf("/api/v1/repos/%s/%s/notifications?last_read_at=%s&token=%s", user2.Name, repo1.Name, lastReadAt, token))
|
|
MakeRequest(t, req, http.StatusResetContent)
|
|
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?status-types=unread&token=%s", token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
assert.Len(t, apiNL, 1)
|
|
|
|
// -- PATCH /notifications/threads/{id} --
|
|
req = NewRequest(t, "PATCH", fmt.Sprintf("/api/v1/notifications/threads/%d?token=%s", thread5.ID, token))
|
|
MakeRequest(t, req, http.StatusResetContent)
|
|
|
|
assert.Equal(t, activities_model.NotificationStatusUnread, thread5.Status)
|
|
thread5 = unittest.AssertExistsAndLoadBean(t, &activities_model.Notification{ID: 5})
|
|
assert.Equal(t, activities_model.NotificationStatusRead, thread5.Status)
|
|
|
|
// -- check notifications --
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications/new?token=%s", token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &new)
|
|
assert.True(t, new.New == 0)
|
|
}
|
|
|
|
func TestAPINotificationPUT(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
thread5 := unittest.AssertExistsAndLoadBean(t, &activities_model.Notification{ID: 5})
|
|
assert.NoError(t, thread5.LoadAttributes(db.DefaultContext))
|
|
session := loginUser(t, user2.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeNotification)
|
|
|
|
// Check notifications are as expected
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?all=true&token=%s", token))
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var apiNL []api.NotificationThread
|
|
DecodeJSON(t, resp, &apiNL)
|
|
|
|
assert.Len(t, apiNL, 4)
|
|
assert.EqualValues(t, 5, apiNL[0].ID)
|
|
assert.True(t, apiNL[0].Unread)
|
|
assert.False(t, apiNL[0].Pinned)
|
|
assert.EqualValues(t, 4, apiNL[1].ID)
|
|
assert.True(t, apiNL[1].Unread)
|
|
assert.False(t, apiNL[1].Pinned)
|
|
assert.EqualValues(t, 3, apiNL[2].ID)
|
|
assert.False(t, apiNL[2].Unread)
|
|
assert.True(t, apiNL[2].Pinned)
|
|
assert.EqualValues(t, 2, apiNL[3].ID)
|
|
assert.False(t, apiNL[3].Unread)
|
|
assert.False(t, apiNL[3].Pinned)
|
|
|
|
//
|
|
// Notification ID 2 is the only one with status-type read & pinned
|
|
// change it to unread.
|
|
//
|
|
req = NewRequest(t, "PUT", fmt.Sprintf("/api/v1/notifications?status-types=read&status-type=pinned&to-status=unread&token=%s", token))
|
|
resp = MakeRequest(t, req, http.StatusResetContent)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
assert.Len(t, apiNL, 1)
|
|
assert.EqualValues(t, 2, apiNL[0].ID)
|
|
assert.True(t, apiNL[0].Unread)
|
|
assert.False(t, apiNL[0].Pinned)
|
|
|
|
//
|
|
// Now nofication ID 2 is the first in the list and is unread.
|
|
//
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?all=true&token=%s", token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
|
|
assert.Len(t, apiNL, 4)
|
|
assert.EqualValues(t, 2, apiNL[0].ID)
|
|
assert.True(t, apiNL[0].Unread)
|
|
assert.False(t, apiNL[0].Pinned)
|
|
}
|