mirror of
https://github.com/superseriousbusiness/gotosocial
synced 2025-06-05 21:59:39 +02:00
[feature] Implement Mastodon-compatible roles (#3136)
* Implement Mastodon-compatible roles - `Account.role` should only be available through verify_credentials for checking current user's permissions - `Account.role` now carries a Mastodon-compatible permissions bitmap and a marker for whether it should be shown to the public - `Account.roles` added for *public* display roles (undocumented but stable since Mastodon 4.1) - Web template now uses only public display roles (no user-visible change here, we already special-cased the `user` role) * Handle verify_credentials case for default role * Update JSON exact-match tests * Address review comments * Add blocks bit to admin permissions bitmap
This commit is contained in:
@@ -19,30 +19,35 @@ package accounts_test
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"io/ioutil"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/suite"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/api/client/accounts"
|
||||
apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/oauth"
|
||||
)
|
||||
|
||||
type AccountVerifyTestSuite struct {
|
||||
AccountStandardTestSuite
|
||||
}
|
||||
|
||||
func (suite *AccountVerifyTestSuite) TestAccountVerifyGet() {
|
||||
testAccount := suite.testAccounts["local_account_1"]
|
||||
|
||||
// accountVerifyGet calls the verify_credentials API method for a given account fixture name.
|
||||
// Assumes token and user fixture names are the same as the account fixture name.
|
||||
func (suite *AccountVerifyTestSuite) accountVerifyGet(fixtureName string) *apimodel.Account {
|
||||
// set up the request
|
||||
recorder := httptest.NewRecorder()
|
||||
ctx := suite.newContext(recorder, http.MethodGet, nil, accounts.VerifyPath, "")
|
||||
|
||||
// override the account that we're authenticated as
|
||||
ctx.Set(oauth.SessionAuthorizedAccount, suite.testAccounts[fixtureName])
|
||||
ctx.Set(oauth.SessionAuthorizedToken, oauth.DBTokenToToken(suite.testTokens[fixtureName]))
|
||||
ctx.Set(oauth.SessionAuthorizedUser, suite.testUsers[fixtureName])
|
||||
|
||||
// call the handler
|
||||
suite.accountsModule.AccountVerifyGETHandler(ctx)
|
||||
|
||||
@@ -54,13 +59,27 @@ func (suite *AccountVerifyTestSuite) TestAccountVerifyGet() {
|
||||
defer result.Body.Close()
|
||||
|
||||
// check the response
|
||||
b, err := ioutil.ReadAll(result.Body)
|
||||
assert.NoError(suite.T(), err)
|
||||
b, err := io.ReadAll(result.Body)
|
||||
if err != nil {
|
||||
suite.FailNow(err.Error())
|
||||
}
|
||||
|
||||
// unmarshal the returned account
|
||||
apimodelAccount := &apimodel.Account{}
|
||||
err = json.Unmarshal(b, apimodelAccount)
|
||||
suite.NoError(err)
|
||||
if err != nil {
|
||||
suite.FailNow(err.Error())
|
||||
}
|
||||
|
||||
return apimodelAccount
|
||||
}
|
||||
|
||||
// We should see public account information and profile source for a normal user.
|
||||
func (suite *AccountVerifyTestSuite) TestAccountVerifyGet() {
|
||||
fixtureName := "local_account_1"
|
||||
testAccount := suite.testAccounts[fixtureName]
|
||||
|
||||
apimodelAccount := suite.accountVerifyGet(fixtureName)
|
||||
|
||||
createdAt, err := time.Parse(time.RFC3339, apimodelAccount.CreatedAt)
|
||||
suite.NoError(err)
|
||||
@@ -85,6 +104,43 @@ func (suite *AccountVerifyTestSuite) TestAccountVerifyGet() {
|
||||
suite.Equal(testAccount.NoteRaw, apimodelAccount.Source.Note)
|
||||
}
|
||||
|
||||
// testAccountVerifyGetRole calls the verify_credentials API method for a given account fixture name,
|
||||
// and checks the response for permissions appropriate to the role.
|
||||
func (suite *AccountVerifyTestSuite) testAccountVerifyGetRole(fixtureName string) {
|
||||
testUser := suite.testUsers[fixtureName]
|
||||
|
||||
apimodelAccount := suite.accountVerifyGet(fixtureName)
|
||||
|
||||
if suite.NotNil(apimodelAccount.Role) {
|
||||
switch {
|
||||
case *testUser.Admin:
|
||||
suite.Equal("admin", string(apimodelAccount.Role.Name))
|
||||
suite.NotZero(apimodelAccount.Role.Permissions)
|
||||
suite.True(apimodelAccount.Role.Highlighted)
|
||||
|
||||
case *testUser.Moderator:
|
||||
suite.Equal("moderator", string(apimodelAccount.Role.Name))
|
||||
suite.Zero(apimodelAccount.Role.Permissions)
|
||||
suite.True(apimodelAccount.Role.Highlighted)
|
||||
|
||||
default:
|
||||
suite.Equal("user", string(apimodelAccount.Role.Name))
|
||||
suite.Zero(apimodelAccount.Role.Permissions)
|
||||
suite.False(apimodelAccount.Role.Highlighted)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// We should see a role for a normal user, and that role should not have any permissions.
|
||||
func (suite *AccountVerifyTestSuite) TestAccountVerifyGetRoleUser() {
|
||||
suite.testAccountVerifyGetRole("local_account_1")
|
||||
}
|
||||
|
||||
// We should see a role for an admin user, and that role should have some permissions.
|
||||
func (suite *AccountVerifyTestSuite) TestAccountVerifyGetRoleAdmin() {
|
||||
suite.testAccountVerifyGetRole("admin_account")
|
||||
}
|
||||
|
||||
func TestAccountVerifyTestSuite(t *testing.T) {
|
||||
suite.Run(t, new(AccountVerifyTestSuite))
|
||||
}
|
||||
|
Reference in New Issue
Block a user