Add tests for server notices (#322)

* Add tests for server notices

* goimports to make the linter happy

* Enable server notices for synapse

* Use correct errcode

* Fix copy & paste error

* Update tests & add comment

* Use existing room

Author: S7evinK

dockerfiles/synapse/homeserver.yaml

@@ -112,3 +112,9 @@ experimental_features:
   msc2716_enabled: true
   # server-side support for partial state in /send_join
   msc3706_enabled: true
+
+server_notices:
+  system_mxid_localpart: _server
+  system_mxid_display_name: "Server Alert"
+  system_mxid_avatar_url: ""
+  room_name: "Server Alert"

dockerfiles/synapse/workers-shared.yaml

@@ -68,3 +68,9 @@ experimental_features:
   msc2716_enabled: true
   # Enable spaces support
   spaces_enabled: true
+
+server_notices:
+  system_mxid_localpart: _server
+  system_mxid_display_name: "Server Alert"
+  system_mxid_avatar_url: ""
+  room_name: "Server Alert"

tests/csapi/admin_test.go

@@ -1,9 +1,17 @@
 package csapi_tests
 
 import (
+	"fmt"
+	"net/http"
+	"net/url"
 	"testing"
 
+	"github.com/tidwall/gjson"
+
 	"github.com/matrix-org/complement/internal/b"
+	"github.com/matrix-org/complement/internal/client"
+	"github.com/matrix-org/complement/internal/match"
+	"github.com/matrix-org/complement/internal/must"
 )
 
 // Check if this homeserver supports Synapse-style admin registration.
@@ -13,3 +21,113 @@ func TestCanRegisterAdmin(t *testing.T) {
 	defer deployment.Destroy(t)
 	deployment.RegisterUser(t, "hs1", "admin", "adminpassword", true)
 }
+
+// Test if the implemented /_synapse/admin/v1/send_server_notice behaves as expected
+func TestServerNotices(t *testing.T) {
+	deployment := Deploy(t, b.BlueprintAlice)
+	defer deployment.Destroy(t)
+	admin := deployment.RegisterUser(t, "hs1", "admin", "adminpassword", true)
+	alice := deployment.Client(t, "hs1", "@alice:hs1")
+
+	reqBody := client.WithJSONBody(t, map[string]interface{}{
+		"user_id": "@alice:hs1",
+		"content": map[string]interface{}{
+			"msgtype": "m.text",
+			"body":    "hello from server notices!",
+		},
+	})
+	var (
+		eventID string
+		roomID  string
+	)
+	t.Run("/send_server_notice is not allowed as normal user", func(t *testing.T) {
+		res := alice.DoFunc(t, "POST", []string{"_synapse", "admin", "v1", "send_server_notice"})
+		must.MatchResponse(t, res, match.HTTPResponse{
+			StatusCode: http.StatusForbidden,
+			JSON: []match.JSON{
+				match.JSONKeyEqual("errcode", "M_FORBIDDEN"),
+			},
+		})
+	})
+	t.Run("/send_server_notice as an admin is allowed", func(t *testing.T) {
+		eventID = sendServerNotice(t, admin, reqBody, nil)
+	})
+	t.Run("Alice is invited to the server alert room", func(t *testing.T) {
+		roomID = syncUntilInvite(t, alice)
+	})
+	t.Run("Alice cannot reject the invite", func(t *testing.T) {
+		res := alice.DoFunc(t, "POST", []string{"_matrix", "client", "r0", "rooms", roomID, "leave"})
+		must.MatchResponse(t, res, match.HTTPResponse{
+			StatusCode: http.StatusForbidden,
+			JSON: []match.JSON{
+				match.JSONKeyEqual("errcode", "M_CANNOT_LEAVE_SERVER_NOTICE_ROOM"),
+			},
+		})
+	})
+	t.Run("Alice can join the alert room", func(t *testing.T) {
+		alice.JoinRoom(t, roomID, []string{})
+		queryParams := url.Values{}
+		queryParams.Set("dir", "b")
+		// check if we received the message
+		res := alice.DoFunc(t, "GET", []string{"_matrix", "client", "r0", "rooms", roomID, "messages"}, client.WithQueries(queryParams))
+		msgRes := &msgResult{}
+		must.MatchResponse(t, res, match.HTTPResponse{
+			StatusCode: http.StatusOK,
+			JSON: []match.JSON{
+				findMessageId(eventID, msgRes),
+			},
+		})
+		if !msgRes.found {
+			t.Errorf("did not find expected message from server notices")
+		}
+	})
+	t.Run("Alice can leave the alert room, after joining it", func(t *testing.T) {
+		alice.LeaveRoom(t, roomID)
+	})
+	t.Run("After leaving the alert room and on re-invitation, no new room is created", func(t *testing.T) {
+		sendServerNotice(t, admin, reqBody, nil)
+		newRoomID := syncUntilInvite(t, alice)
+		if roomID != newRoomID {
+			t.Errorf("expected a new room, but they are the same")
+		}
+	})
+	t.Run("Sending a notice with a transactionID is idempotent", func(t *testing.T) {
+		txnID := "1"
+		eventID1 := sendServerNotice(t, admin, reqBody, &txnID)
+		eventID2 := sendServerNotice(t, admin, reqBody, &txnID)
+		if eventID1 != eventID2 {
+			t.Errorf("expected event IDs to be the same, but got '%s' and '%s'", eventID1, eventID2)
+		}
+	})
+
+}
+
+func sendServerNotice(t *testing.T, admin *client.CSAPI, reqBody client.RequestOpt, txnID *string) (eventID string) {
+	var res *http.Response
+	if txnID != nil {
+		res = admin.MustDoFunc(t, "PUT", []string{"_synapse", "admin", "v1", "send_server_notice", *txnID}, reqBody)
+	} else {
+		res = admin.MustDoFunc(t, "POST", []string{"_synapse", "admin", "v1", "send_server_notice"}, reqBody)
+	}
+	body := must.MatchResponse(t, res, match.HTTPResponse{
+		StatusCode: http.StatusOK,
+		JSON: []match.JSON{
+			match.JSONKeyPresent("event_id"),
+		},
+	})
+	return gjson.GetBytes(body, "event_id").Str
+}
+
+// syncUntilInvite checks if we got an invitation from the server notice sender, as the roomID is unknown.
+// Returns the found roomID on success
+func syncUntilInvite(t *testing.T, alice *client.CSAPI) string {
+	var roomID string
+	alice.MustSyncUntil(t, client.SyncReq{}, func(userID string, res gjson.Result) error {
+		if res.Get("rooms.invite.*.invite_state.events.0.sender").Str == "@_server:hs1" {
+			roomID = res.Get("rooms.invite").Get("@keys.0").Str
+			return nil
+		}
+		return fmt.Errorf("invite not found")
+	})
+	return roomID
+}