Add MustGetDisplayName and MustSetDisplayName

Author: kegsay

client/client.go

@@ -492,6 +492,20 @@ func (c *CSAPI) MustGenerateOneTimeKeys(t ct.TestLike, otkCount uint) (deviceKey
 	return deviceKeys, oneTimeKeys
 }
 
+// MustSetDisplayName sets the global display name for this account or fails the test.
+func (c *CSAPI) MustSetDisplayName(t ct.TestLike, displayname string) {
+	c.MustDo(t, "PUT", []string{"_matrix", "client", "v3", "profile", c.UserID, "displayname"}, WithJSONBody(t, map[string]any{
+		"displayname": displayname,
+	}))
+}
+
+// MustGetDisplayName returns the global display name for this user or fails the test.
+func (c *CSAPI) MustGetDisplayName(t ct.TestLike, userID string) string {
+	res := c.MustDo(t, "GET", []string{"_matrix", "client", "v3", "profile", userID, "displayname"})
+	body := ParseJSON(t, res)
+	return GetJSONFieldStr(t, body, "displayname")
+}
+
 // WithRawBody sets the HTTP request body to `body`
 func WithRawBody(body []byte) RequestOpt {
 	return func(req *http.Request) {

tests/csapi/apidoc_profile_displayname_test.go

@@ -4,9 +4,7 @@ import (
 	"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"
 )
 
@@ -18,19 +16,11 @@ func TestProfileDisplayName(t *testing.T) {
 	displayName := "my_display_name"
 	// sytest: PUT /profile/:user_id/displayname sets my name
 	t.Run("PUT /profile/:user_id/displayname sets my name", func(t *testing.T) {
-		reqBody := client.WithJSONBody(t, map[string]interface{}{
-			"displayname": displayName,
-		})
-		_ = authedClient.MustDo(t, "PUT", []string{"_matrix", "client", "v3", "profile", authedClient.UserID, "displayname"}, reqBody)
+		authedClient.MustSetDisplayName(t, displayName)
 	})
 	// sytest: GET /profile/:user_id/displayname publicly accessible
 	t.Run("GET /profile/:user_id/displayname publicly accessible", func(t *testing.T) {
-		res := unauthedClient.Do(t, "GET", []string{"_matrix", "client", "v3", "profile", authedClient.UserID, "displayname"})
-		must.MatchResponse(t, res, match.HTTPResponse{
-			StatusCode: 200,
-			JSON: []match.JSON{
-				match.JSONKeyEqual("displayname", displayName),
-			},
-		})
+		gotDisplayName := unauthedClient.MustGetDisplayName(t, authedClient.UserID)
+		must.Equal(t, gotDisplayName, displayName, "display name mismatch")
 	})
 }

tests/csapi/user_directory_display_names_test.go

@@ -61,14 +61,7 @@ func setupUsers(t *testing.T) (*client.CSAPI, *client.CSAPI, *client.CSAPI, func
 	// Alice sets her profile displayname. This ensures that her
 	// public name, private name and userid localpart are all
 	// distinguishable, even case-insensitively.
-	alice.MustDo(
-		t,
-		"PUT",
-		[]string{"_matrix", "client", "v3", "profile", alice.UserID, "displayname"},
-		client.WithJSONBody(t, map[string]interface{}{
-			"displayname": alicePublicName,
-		}),
-	)
+	alice.MustSetDisplayName(t, alicePublicName)
 
 	// Alice creates a public room (so when Eve searches, she can see that Alice exists)
 	alice.MustCreateRoom(t, map[string]interface{}{"visibility": "public"})

tests/federation_query_profile_test.go

@@ -10,9 +10,8 @@ import (
 	"github.com/matrix-org/gomatrixserverlib/fclient"
 	"github.com/matrix-org/gomatrixserverlib/spec"
 
-	"github.com/matrix-org/complement/client"
-	"github.com/matrix-org/complement/helpers"
 	"github.com/matrix-org/complement/federation"
+	"github.com/matrix-org/complement/helpers"
 	"github.com/matrix-org/complement/match"
 	"github.com/matrix-org/complement/must"
 )
@@ -61,12 +60,8 @@ func TestOutboundFederationProfile(t *testing.T) {
 
 		// query the display name which should do an outbound federation hit
 		unauthedClient := deployment.UnauthenticatedClient(t, "hs1")
-		res := unauthedClient.MustDo(t, "GET", []string{"_matrix", "client", "v3", "profile", remoteUserID, "displayname"})
-		must.MatchResponse(t, res, match.HTTPResponse{
-			JSON: []match.JSON{
-				match.JSONKeyEqual("displayname", remoteDisplayName),
-			},
-		})
+		gotDisplayName := unauthedClient.MustGetDisplayName(t, remoteUserID)
+		must.Equal(t, gotDisplayName, remoteDisplayName, "display name mismatch")
 	})
 }
 
@@ -107,14 +102,7 @@ func TestInboundFederationProfile(t *testing.T) {
 	t.Run("Inbound federation can query profile data", func(t *testing.T) {
 		const alicePublicName = "Alice Cooper"
 
-		alice.MustDo(
-			t,
-			"PUT",
-			[]string{"_matrix", "client", "v3", "profile", alice.UserID, "displayname"},
-			client.WithJSONBody(t, map[string]interface{}{
-				"displayname": alicePublicName,
-			}),
-		)
+		alice.MustSetDisplayName(t, alicePublicName)
 
 		fedReq := fclient.NewFederationRequest(
 			"GET",

tests/msc3902/federation_room_join_partial_state_test.go

@@ -3597,13 +3597,7 @@ func TestPartialStateJoin(t *testing.T) {
 		)
 		defer removePDUHandler()
 
-		alice.MustDo(t,
-			"PUT",
-			[]string{"_matrix", "client", "v3", "profile", alice.UserID, "displayname"},
-			client.WithJSONBody(t, map[string]interface{}{
-				"displayname": "alice 2",
-			}),
-		)
+		alice.MustSetDisplayName(t, "alice 2")
 		t.Logf("Alice changed display name")
 
 		select {