a669c750c8
* Remove Deployment.Client and change Deploy - `Deployment.Client` was used to get pre-registered clients. Now we want tests to register new users for each test, for dirty runs. So swap for `Deployment.Register` everywhere. - `Deploy` was used to deploy a blueprint. We don't want this to enable dirty runs. So replace it with the number of servers you need e.g `Deploy(t, 2)`. * Fix up more broken refactoring * unbreak tests; make user localpart look nicer * Alice and bob must share a room for presence * Fix user directory test * Fix race condition caused by making the room later than before
266 lines
8.1 KiB
Go
266 lines
8.1 KiB
Go
// This file contains tests for deleting account data as
|
|
// defined by MSC3391, which you can read here:
|
|
// https://github.com/matrix-org/matrix-doc/pull/3391
|
|
|
|
package tests
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/matrix-org/complement"
|
|
"github.com/matrix-org/complement/client"
|
|
"github.com/matrix-org/complement/helpers"
|
|
"github.com/matrix-org/complement/match"
|
|
"github.com/matrix-org/complement/must"
|
|
|
|
"github.com/tidwall/gjson"
|
|
)
|
|
|
|
const testAccountDataType = "org.example.test"
|
|
|
|
var testAccountDataContent = map[string]interface{}{"test_data": 1}
|
|
|
|
func TestRemovingAccountData(t *testing.T) {
|
|
deployment := complement.Deploy(t, 1)
|
|
defer deployment.Destroy(t)
|
|
|
|
// Create a user to manipulate the account data of
|
|
alice := deployment.Register(t, "hs1", helpers.RegistrationOpts{})
|
|
|
|
// And create a room with that user where we can store some room account data
|
|
roomID := alice.MustCreateRoom(t, map[string]interface{}{})
|
|
|
|
// Test deleting global account data.
|
|
t.Run("Deleting a user's account data via DELETE works", func(t *testing.T) {
|
|
createUserAccountData(t, alice)
|
|
deleteUserAccountData(t, alice, true)
|
|
})
|
|
t.Run("Deleting a user's account data via PUT works", func(t *testing.T) {
|
|
createUserAccountData(t, alice)
|
|
deleteUserAccountData(t, alice, false)
|
|
})
|
|
|
|
// Test deleting room account data.
|
|
t.Run("Deleting a user's room data via DELETE works", func(t *testing.T) {
|
|
createRoomAccountData(t, alice, roomID)
|
|
deleteRoomAccountData(t, alice, true, roomID)
|
|
})
|
|
t.Run("Deleting a user's room account data via PUT works", func(t *testing.T) {
|
|
createRoomAccountData(t, alice, roomID)
|
|
deleteRoomAccountData(t, alice, false, roomID)
|
|
})
|
|
}
|
|
|
|
// createUserAccountData creates some account data for a user and checks that it was
|
|
// created successfully by both querying the data afterwards, and ensuring it appears down /sync.
|
|
func createUserAccountData(t *testing.T, c *client.CSAPI) {
|
|
// Retrieve a sync token for this user
|
|
_, nextBatchToken := c.MustSync(
|
|
t,
|
|
client.SyncReq{},
|
|
)
|
|
|
|
// Set and check the account data
|
|
// Create user account data
|
|
c.MustSetGlobalAccountData(t, testAccountDataType, testAccountDataContent)
|
|
|
|
// Wait for the account data to appear down /sync
|
|
c.MustSyncUntil(
|
|
t,
|
|
client.SyncReq{
|
|
Since: nextBatchToken,
|
|
},
|
|
client.SyncGlobalAccountDataHas(checkAccountDataContent),
|
|
)
|
|
|
|
// Also check the account data content by querying the appropriate endpoint
|
|
res := c.MustGetGlobalAccountData(t, testAccountDataType)
|
|
must.MatchResponse(t, res, match.HTTPResponse{
|
|
JSON: []match.JSON{
|
|
match.JSONKeyEqual("", testAccountDataContent),
|
|
},
|
|
})
|
|
}
|
|
|
|
// createRoomAccountData creates some account data for a room and checks that it was
|
|
// created successfully by both querying the data afterwards, and ensuring it appears down /sync.
|
|
func createRoomAccountData(t *testing.T, c *client.CSAPI, roomID string) {
|
|
// Retrieve a sync token for this user
|
|
_, nextBatchToken := c.MustSync(
|
|
t,
|
|
client.SyncReq{},
|
|
)
|
|
|
|
// Create room account data
|
|
c.MustSetRoomAccountData(t, roomID, testAccountDataType, testAccountDataContent)
|
|
|
|
// Wait for the account data to appear down /sync
|
|
c.MustSyncUntil(
|
|
t,
|
|
client.SyncReq{
|
|
Since: nextBatchToken,
|
|
},
|
|
client.SyncRoomAccountDataHas(roomID, checkAccountDataContent),
|
|
)
|
|
|
|
// Also check the account data content by querying the appropriate endpoint
|
|
res := c.MustGetRoomAccountData(t, roomID, testAccountDataType)
|
|
must.MatchResponse(t, res, match.HTTPResponse{
|
|
JSON: []match.JSON{
|
|
match.JSONKeyEqual("", testAccountDataContent),
|
|
},
|
|
})
|
|
}
|
|
|
|
// deleteUserAccountData removes account data for a user.
|
|
//
|
|
// If viaDelete is true, a request is made to the DELETE endpoint for user
|
|
// account data. Otherwise, the PUT method is used with an empty content
|
|
// dictionary instead. MSC3391 specifies that a PUT with an empty content body
|
|
// is functionally equivalent to deleting an account data type directly.
|
|
func deleteUserAccountData(t *testing.T, c *client.CSAPI, viaDelete bool) {
|
|
// Retrieve a sync token for this user
|
|
_, nextBatchToken := c.MustSync(
|
|
t,
|
|
client.SyncReq{},
|
|
)
|
|
|
|
// Delete user account data
|
|
if viaDelete {
|
|
// Delete via the DELETE method
|
|
c.MustDo(
|
|
t,
|
|
"DELETE",
|
|
[]string{"_matrix", "client", "unstable", "org.matrix.msc3391", "user", c.UserID, "account_data", testAccountDataType},
|
|
)
|
|
} else {
|
|
// Delete via the PUT method. PUT'ing with an empty dictionary will delete
|
|
// the account data type for this user.
|
|
c.MustSetGlobalAccountData(t, testAccountDataType, map[string]interface{}{})
|
|
}
|
|
|
|
// Check that the content of the user account data for this type
|
|
// has been set to an empty dictionary.
|
|
c.MustSyncUntil(
|
|
t,
|
|
client.SyncReq{
|
|
Since: nextBatchToken,
|
|
},
|
|
client.SyncGlobalAccountDataHas(checkEmptyAccountData),
|
|
)
|
|
|
|
// Also check the account data item is no longer found
|
|
res := c.GetGlobalAccountData(t, testAccountDataType)
|
|
must.MatchResponse(t, res, match.HTTPResponse{
|
|
StatusCode: 404,
|
|
})
|
|
|
|
// Finally, check that the account data item does not appear at all in an initial sync
|
|
initialSyncResponse, _ := c.MustSync(
|
|
t,
|
|
client.SyncReq{},
|
|
)
|
|
must.MatchGJSON(
|
|
t,
|
|
initialSyncResponse,
|
|
match.JSONArrayEach(
|
|
"account_data.events",
|
|
checkAccountDataTypeNotPresent,
|
|
),
|
|
)
|
|
}
|
|
|
|
// deleteRoomAccountData removes account data for a user.
|
|
//
|
|
// If viaDelete is true, a request is made to the DELETE endpoint for room
|
|
// account data. Otherwise, the PUT method is used with an empty content
|
|
// dictionary instead. MSC3391 specifies that a PUT with an empty content body
|
|
// is functionally equivalent to deleting an account data type directly.
|
|
func deleteRoomAccountData(t *testing.T, c *client.CSAPI, viaDelete bool, roomID string) {
|
|
// Retrieve a sync token for this user
|
|
_, nextBatchToken := c.MustSync(
|
|
t,
|
|
client.SyncReq{},
|
|
)
|
|
|
|
// Delete room account data
|
|
if viaDelete {
|
|
// Delete via the DELETE method
|
|
c.MustDo(
|
|
t,
|
|
"DELETE",
|
|
[]string{"_matrix", "client", "unstable", "org.matrix.msc3391", "user", c.UserID, "rooms", roomID, "account_data", testAccountDataType},
|
|
)
|
|
} else {
|
|
// Delete via the PUT method. PUT'ing with an empty dictionary will delete
|
|
// the account data type for this room.
|
|
c.MustSetRoomAccountData(t, roomID, testAccountDataType, map[string]interface{}{})
|
|
}
|
|
|
|
// Check that the content of the room account data for this type
|
|
// has been set to an empty dictionary.
|
|
c.MustSyncUntil(
|
|
t,
|
|
client.SyncReq{
|
|
Since: nextBatchToken,
|
|
},
|
|
client.SyncRoomAccountDataHas(roomID, checkEmptyAccountData),
|
|
)
|
|
|
|
// Also check the account data item is no longer found
|
|
res := c.GetRoomAccountData(t, roomID, testAccountDataType)
|
|
must.MatchResponse(t, res, match.HTTPResponse{
|
|
StatusCode: 404,
|
|
})
|
|
|
|
// Finally, check that the account data item does not appear at all in an initial sync
|
|
initialSyncResponse, _ := c.MustSync(
|
|
t,
|
|
client.SyncReq{},
|
|
)
|
|
must.MatchGJSON(
|
|
t,
|
|
initialSyncResponse,
|
|
match.JSONArrayEach(
|
|
fmt.Sprintf("rooms.join.%s.account_data.events", roomID),
|
|
checkAccountDataTypeNotPresent,
|
|
),
|
|
)
|
|
}
|
|
|
|
// checkAccountDataContent checks that the content of a user or account data object
|
|
// matches our test content.
|
|
func checkAccountDataContent(r gjson.Result) bool {
|
|
// Only listen for our test type
|
|
if r.Get("type").Str != testAccountDataType {
|
|
return false
|
|
}
|
|
return match.JSONKeyEqual("content", testAccountDataContent)(r) == nil
|
|
}
|
|
|
|
// checkEmptyAccountData checks that the content of a user or account data object
|
|
// matches our test content.
|
|
func checkEmptyAccountData(r gjson.Result) bool {
|
|
// Only listen for our test type
|
|
if r.Get("type").Str != testAccountDataType {
|
|
return false
|
|
}
|
|
// Ensure the content of this account data type is an empty map.
|
|
// This means that it has been deleted.
|
|
return match.JSONKeyEqual("content", map[string]interface{}{})(r) == nil
|
|
}
|
|
|
|
// checkAccountDataTypeNotPresent checks that a given account data event type is not present
|
|
func checkAccountDataTypeNotPresent(r gjson.Result) error {
|
|
// If we see our test type, return a failure
|
|
if r.Get("type").Str == testAccountDataType {
|
|
return fmt.Errorf(
|
|
"Found unexpected account data type '%s' in sync response",
|
|
testAccountDataType,
|
|
)
|
|
}
|
|
|
|
// We did not see our test type.
|
|
return nil
|
|
}
|