Open up more ServerRoom functions (#765)

* Open up more ServerRoom functions

This allows more experimentation because it allows
Complement to make ServerRoom structs for unknown room versions.

* Include AddRoom

Author: kegsay

federation/server.go

@@ -183,7 +183,7 @@ func (s *Server) MustMakeRoom(t ct.TestLike, roomVer gomatrixserverlib.RoomVersi
 	//  * prevents homeservers from getting confused when multiple test cases re-use the same homeserver deployment.
 	roomID := fmt.Sprintf("!%d-%s:%s", len(s.rooms), util.RandomString(18), s.serverName)
 	t.Logf("Creating room %s with version %s", roomID, roomVer)
-	room := newRoom(roomVer, roomID)
+	room := NewServerRoom(roomVer, roomID)
 
 	// sign all these events
 	for _, ev := range events {
@@ -425,9 +425,9 @@ func (s *Server) MustJoinRoom(t ct.TestLike, deployment FederationDeployment, re
 		ct.Fatalf(t, "MustJoinRoom: send_join failed: %v", err)
 	}
 	stateEvents := sendJoinResp.StateEvents.UntrustedEvents(roomVer)
-	room := newRoom(roomVer, roomID)
+	room := NewServerRoom(roomVer, roomID)
 	for _, ev := range stateEvents {
-		room.replaceCurrentState(ev)
+		room.ReplaceCurrentState(ev)
 	}
 	room.AddEvent(joinEvent)
 	s.rooms[roomID] = room
@@ -480,6 +480,11 @@ func (s *Server) MustLeaveRoom(t ct.TestLike, deployment FederationDeployment, r
 	t.Logf("Server.MustLeaveRoom left room ID %s", roomID)
 }
 
+// AddRoom is a low-level function to add a custom room to the server. Useful to mix custom logic with helper functions.
+func (s *Server) AddRoom(room *ServerRoom) {
+	s.rooms[room.RoomID] = room
+}
+
 // ValidFederationRequest is a wrapper around http.HandlerFunc which automatically validates the incoming
 // federation request and supports sending back JSON. Fails the test if the request is not valid.
 func (s *Server) ValidFederationRequest(t ct.TestLike, handler func(fr *fclient.FederationRequest, pathParams map[string]string) util.JSONResponse) http.HandlerFunc {

federation/server_room.go

@@ -45,8 +45,8 @@ type ServerRoom struct {
 	waitersMu          *sync.Mutex
 }
 
-// newRoom creates an empty room structure with no events
-func newRoom(roomVer gomatrixserverlib.RoomVersion, roomId string) *ServerRoom {
+// NewServerRoom creates an empty room structure with no events
+func NewServerRoom(roomVer gomatrixserverlib.RoomVersion, roomId string) *ServerRoom {
 	return &ServerRoom{
 		RoomID:             roomId,
 		Version:            roomVer,
@@ -61,7 +61,7 @@ func newRoom(roomVer gomatrixserverlib.RoomVersion, roomId string) *ServerRoom {
 // Updates depth and forward extremities.
 func (r *ServerRoom) AddEvent(ev gomatrixserverlib.PDU) {
 	if ev.StateKey() != nil {
-		r.replaceCurrentState(ev)
+		r.ReplaceCurrentState(ev)
 	}
 	r.TimelineMutex.Lock()
 	r.Timeline = append(r.Timeline, ev)
@@ -135,9 +135,9 @@ func (r *ServerRoom) AuthEvents(sn gomatrixserverlib.StateNeeded) (eventIDs []st
 	return
 }
 
-// replaceCurrentState inserts a new state event for this room or replaces current state depending
-// on the (type, state_key) provided.
-func (r *ServerRoom) replaceCurrentState(ev gomatrixserverlib.PDU) {
+// ReplaceCurrentState inserts a new state event for this room or replaces current state depending
+// on the (type, state_key) provided. The event provided must be a state event.
+func (r *ServerRoom) ReplaceCurrentState(ev gomatrixserverlib.PDU) {
 	tuple := fmt.Sprintf("%s\x1f%s", ev.Type(), *ev.StateKey())
 	r.StateMutex.Lock()
 	r.State[tuple] = ev