From 20cd430936fa915066dc0fa95a8a535149d97e05 Mon Sep 17 00:00:00 2001 From: Nikos Filippakis Date: Thu, 2 Jul 2020 19:18:36 +0200 Subject: [PATCH] Integration tests (#327) * Integration test to confirm bot can join a room and respond to a command Signed-off-by: Nikos Filippakis * Integration test for receiving and sending encrypted messages Signed-off-by: Nikos Filippakis * Extract common integration test functionality in a new func Signed-off-by: Nikos Filippakis --- clients/bot_client.go | 2 +- goneb_services_test.go | 300 ++++++++++++++++++++++++++++++++++++++--- testutil_test.go | 20 ++- 3 files changed, 298 insertions(+), 24 deletions(-) diff --git a/clients/bot_client.go b/clients/bot_client.go index bcae08d..219f2ac 100644 --- a/clients/bot_client.go +++ b/clients/bot_client.go @@ -32,7 +32,7 @@ func (botClient *BotClient) InitOlmMachine(client *mautrix.Client, nebStore *mat if sdb, ok := database.GetServiceDB().(*database.ServiceDB); ok { // Create an SQL crypto store based on the ServiceDB used db, dialect := sdb.GetSQLDb() - sqlCryptoStore := crypto.NewSQLCryptoStore(db, dialect, client.DeviceID, []byte(client.DeviceID.String()), cryptoLogger) + sqlCryptoStore := crypto.NewSQLCryptoStore(db, dialect, client.DeviceID, []byte(client.DeviceID.String()+"pickle"), cryptoLogger) // Try to create the tables if they are missing if err = sqlCryptoStore.CreateTables(); err != nil { return diff --git a/goneb_services_test.go b/goneb_services_test.go index 3dcf5d9..14daa1f 100644 --- a/goneb_services_test.go +++ b/goneb_services_test.go @@ -2,16 +2,23 @@ package main import ( "bytes" + "fmt" + "io/ioutil" "net/http" "net/http/httptest" - "os" + "strings" "testing" -) -var mux = http.NewServeMux() -var mxTripper = newMatrixTripper() + "github.com/matrix-org/go-neb/clients" + "github.com/matrix-org/go-neb/database" + "maunium.net/go/mautrix/crypto" + "maunium.net/go/mautrix/crypto/olm" + mevt "maunium.net/go/mautrix/event" +) -func TestMain(m *testing.M) { +func setupMockServer() (*http.ServeMux, *matrixTripper, *httptest.ResponseRecorder, chan string) { + mux := http.NewServeMux() + mxTripper := newMatrixTripper() setup(envVars{ BaseURL: "http://go.neb", DatabaseType: "sqlite3", @@ -19,24 +26,25 @@ func TestMain(m *testing.M) { }, mux, &http.Client{ Transport: mxTripper, }) - exitCode := m.Run() - os.Exit(exitCode) -} -func TestConfigureClient(t *testing.T) { mxTripper.ClearHandlers() mockWriter := httptest.NewRecorder() - syncChan := make(chan string) + reqChan := make(chan string) mxTripper.HandlePOSTFilter("@link:hyrule") mxTripper.Handle("GET", "/_matrix/client/r0/sync", func(req *http.Request) (*http.Response, error) { - syncChan <- "sync" - return newResponse(200, `{ - "next_batch":"11_22_33_44", - "rooms": {} - }`), nil + if _, ok := req.URL.Query()["since"]; !ok { + return newResponse(200, `{"next_batch":"11_22_33_44", "rooms": {}}`), nil + } + reqBody := <-reqChan + return newResponse(200, reqBody), nil }, ) + return mux, mxTripper, mockWriter, reqChan +} + +func TestConfigureClient(t *testing.T) { + mux, _, mockWriter, _ := setupMockServer() mockReq, _ := http.NewRequest("POST", "http://go.neb/admin/configureClient", bytes.NewBufferString(` { @@ -51,6 +59,266 @@ func TestConfigureClient(t *testing.T) { if mockWriter.Code != expectCode { t.Errorf("TestConfigureClient wanted HTTP status %d, got %d", expectCode, mockWriter.Code) } +} + +func TestRespondToEcho(t *testing.T) { + mux, mxTripper, mockWriter, reqChan := setupMockServer() + + mxTripper.Handle("POST", "/_matrix/client/r0/keys/upload", func(req *http.Request) (*http.Response, error) { + return newResponse(200, `{}`), nil + }) + + var joinedRoom string + var joinedRoomBody []byte + mxTripper.Handle("POST", "/_matrix/client/r0/join/*", func(req *http.Request) (*http.Response, error) { + parts := strings.Split(req.URL.String(), "/") + joinedRoom = parts[len(parts)-1] + joinedRoomBody, _ = ioutil.ReadAll(req.Body) + return newResponse(200, `{}`), nil + }) + + var roomMsgBody []byte + mxTripper.Handle("PUT", "/_matrix/client/r0/rooms/!greatdekutree:hyrule/send/m.room.message/*", func(req *http.Request) (*http.Response, error) { + roomMsgBody, _ = ioutil.ReadAll(req.Body) + return newResponse(200, `{}`), nil + }) + + // configure the client + clientConfigReq, _ := http.NewRequest("POST", "http://go.neb/admin/configureClient", bytes.NewBufferString(` + { + "UserID":"@link:hyrule", + "HomeserverURL":"http://hyrule.loz", + "AccessToken":"dangeroustogoalone", + "Sync":true, + "AutoJoinRooms":true + }`)) + mux.ServeHTTP(mockWriter, clientConfigReq) + + // configure the echo service + serviceConfigReq, _ := http.NewRequest("POST", "http://go.neb/admin/configureService", bytes.NewBufferString(` + { + "Type": "echo", + "Id": "test_echo_service", + "UserID": "@link:hyrule", + "Config": {} + }`)) + mux.ServeHTTP(mockWriter, serviceConfigReq) + + // send neb an invite to a room + reqChan <- `{ + "next_batch":"11_22_33_44", + "rooms": { + "invite": { + "!greatdekutree:hyrule": {"invite_state": {"events": [{ + "type": "m.room.member", + "sender": "@navi:hyrule", + "content": {"membership": "invite"}, + "state_key": "@link:hyrule", + "origin_server_ts": 10000, + "unsigned": {"age": 100}, + "event_id": "evt123" + }]}}} + } + }` + + // wait for it to be processed + reqChan <- `{"next_batch":"11_22_33_44", "rooms": {}}` + + expectedRoom := "%21greatdekutree:hyrule" + if joinedRoom != expectedRoom { + t.Errorf("Expected join for room %v, got %v", expectedRoom, joinedRoom) + } + if expectedBody := `{"inviter":"@navi:hyrule"}`; string(joinedRoomBody) != expectedBody { + t.Errorf("Expected join message body to be %v, got %v", expectedBody, string(joinedRoomBody)) + } + + // send neb an !echo message + reqChan <- `{ + "next_batch":"11_22_33_44", + "rooms": { + "join": { + "!greatdekutree:hyrule": {"timeline": {"events": [{ + "type": "m.room.message", + "sender": "@navi:hyrule", + "content": {"body": "!echo save zelda", "msgtype": "m.text"}, + "origin_server_ts": 10000, + "unsigned": {"age": 100}, + "event_id": "evt124" + }]}}} + } + }` + + // wait for it to be processed + reqChan <- `{"next_batch":"11_22_33_44", "rooms": {}}` + + if expectedEchoResp := `{"msgtype":"m.notice","body":"save zelda"}`; string(roomMsgBody) != expectedEchoResp { + t.Errorf("Expected echo response to be `%v`, got `%v`", expectedEchoResp, string(roomMsgBody)) + } +} + +func TestEncryptedRespondToEcho(t *testing.T) { + mux, mxTripper, mockWriter, reqChan := setupMockServer() - <-syncChan + // create the two accounts, inbound and outbound sessions, both the bot and mock ones + accountMock := olm.NewAccount() + accountBot := olm.NewAccount() + signingKeyMock, identityKeyMock := accountMock.IdentityKeys() + signingKeyBot, identityKeyBot := accountBot.IdentityKeys() + ogsBot := crypto.NewOutboundGroupSession("!greatdekutree:hyrule") + ogsBot.Shared = true + igsMock, err := crypto.NewInboundGroupSession(identityKeyBot, signingKeyBot, "!greatdekutree:hyrule", ogsBot.Internal.Key()) + if err != nil { + t.Errorf("Error creating mock IGS: %v", err) + } + ogsMock := crypto.NewOutboundGroupSession("!greatdekutree:hyrule") + ogsMock.Shared = true + igsBot, err := crypto.NewInboundGroupSession(identityKeyMock, signingKeyMock, "!greatdekutree:hyrule", ogsMock.Internal.Key()) + if err != nil { + t.Errorf("Error creating bot IGS: %v", err) + } + + mxTripper.Handle("POST", "/_matrix/client/r0/keys/upload", func(req *http.Request) (*http.Response, error) { + return newResponse(200, `{}`), nil + }) + + var joinedRoom string + var joinedRoomBody []byte + mxTripper.Handle("POST", "/_matrix/client/r0/join/*", func(req *http.Request) (*http.Response, error) { + parts := strings.Split(req.URL.String(), "/") + joinedRoom = parts[len(parts)-1] + joinedRoomBody, _ = ioutil.ReadAll(req.Body) + return newResponse(200, `{}`), nil + }) + + var decryptedMsg string + mxTripper.Handle("PUT", "/_matrix/client/r0/rooms/!greatdekutree:hyrule/send/m.room.encrypted/*", func(req *http.Request) (*http.Response, error) { + encryptedMsg, _ := ioutil.ReadAll(req.Body) + var encryptedContent mevt.EncryptedEventContent + encryptedContent.UnmarshalJSON(encryptedMsg) + decryptedMsgBytes, _, err := igsMock.Internal.Decrypt(encryptedContent.MegolmCiphertext) + if err != nil { + t.Errorf("Error decrypting message sent by bot: %v", err) + } + decryptedMsg = string(decryptedMsgBytes) + return newResponse(200, `{}`), nil + }) + + // configure the client + clientConfigReq, _ := http.NewRequest("POST", "http://go.neb/admin/configureClient", bytes.NewBufferString(` + { + "UserID":"@link:hyrule", + "DeviceID":"mastersword", + "HomeserverURL":"http://hyrule.loz", + "AccessToken":"dangeroustogoalone", + "Sync":true, + "AutoJoinRooms":true + }`)) + mux.ServeHTTP(mockWriter, clientConfigReq) + + // configure the echo service + serviceConfigReq, _ := http.NewRequest("POST", "http://go.neb/admin/configureService", bytes.NewBufferString(` + { + "Type": "echo", + "Id": "test_echo_service", + "UserID": "@link:hyrule", + "Config": {} + }`)) + mux.ServeHTTP(mockWriter, serviceConfigReq) + + // send neb an invite to a room + reqChan <- `{ + "next_batch":"11_22_33_44", + "rooms": { + "invite": { + "!greatdekutree:hyrule": {"invite_state": {"events": [{ + "type": "m.room.member", + "sender": "@navi:hyrule", + "content": {"membership": "invite"}, + "state_key": "@link:hyrule", + "origin_server_ts": 10000, + "unsigned": {"age": 100}, + "event_id": "evt123" + }]}}} + } + }` + + // wait for it to be processed + reqChan <- `{"next_batch":"11_22_33_44", "rooms": {}}` + + expectedRoom := "%21greatdekutree:hyrule" + if joinedRoom != expectedRoom { + t.Errorf("Expected join for room %v, got %v", expectedRoom, joinedRoom) + } + if expectedBody := `{"inviter":"@navi:hyrule"}`; string(joinedRoomBody) != expectedBody { + t.Errorf("Expected join message body to be %v, got %v", expectedBody, string(joinedRoomBody)) + } + + // send neb the room state: encrypted with one member + reqChan <- `{ + "next_batch":"11_22_33_44", + "rooms": { + "join": {"!greatdekutree:hyrule": {"timeline": {"events": [{ + "type": "m.room.encryption", + "state_key": "", + "content": { + "algorithm": "m.megolm.v1.aes-sha2" + } + }, { + "type": "m.room.member", + "sender": "@navi:hyrule", + "content": {"membership": "join", "displayname": "Navi"}, + "state_key": "@navi:hyrule", + "origin_server_ts": 100, + "event_id": "evt124" + }]}}} + } + }` + + // wait for it to be processed + reqChan <- `{"next_batch":"11_22_33_44", "rooms": {}}` + + // DB is initialized, store the megolm sessions from before for the bot to be able to decrypt and encrypt + sqlDB, dialect := database.GetServiceDB().(*database.ServiceDB).GetSQLDb() + cryptoStore := crypto.NewSQLCryptoStore(sqlDB, dialect, "mastersword", []byte("masterswordpickle"), clients.CryptoMachineLogger{}) + if err := cryptoStore.AddOutboundGroupSession(ogsBot); err != nil { + t.Errorf("Error storing bot OGS: %v", err) + } + + if err := cryptoStore.PutGroupSession("!greatdekutree:hyrule", identityKeyMock, igsBot.ID(), igsBot); err != nil { + t.Errorf("Error storing bot IGS: %v", err) + } + + plaintext := `{"room_id":"!greatdekutree:hyrule","type":"m.room.message","content":{"body":"!echo save zelda","msgtype":"m.text"}}` + ciphertext, err := ogsMock.Encrypt([]byte(plaintext)) + if err != nil { + t.Errorf("Error encrypting bytes: %v", err) + } + + // send neb an !echo message, encrypted with our mock OGS which it has an IGS for + reqChan <- fmt.Sprintf(`{ + "next_batch":"11_22_33_44", + "rooms": { + "join": {"!greatdekutree:hyrule": {"timeline": {"events": [{ + "type": "m.room.encrypted", + "sender": "@navi:hyrule", + "content": { + "algorithm":"m.megolm.v1.aes-sha2", + "sender_key":"%s", + "ciphertext":"%s", + "session_id":"%s" + }, + "origin_server_ts": 10000, + "unsigned": {"age": 100}, + "event_id": "evt125" + }]}}} + } + }`, identityKeyMock, string(ciphertext), ogsMock.ID()) + + // wait for it to be processed + reqChan <- `{"next_batch":"11_22_33_44", "rooms": {}}` + + expectedDecryptedMsg := `{"room_id":"!greatdekutree:hyrule","type":"m.room.message","content":{"msgtype":"m.notice","body":"save zelda"}}` + if decryptedMsg != expectedDecryptedMsg { + t.Errorf("Expected decrypted message to be `%v`, got `%v`", expectedDecryptedMsg, decryptedMsg) + } } diff --git a/testutil_test.go b/testutil_test.go index d74f08b..cb9b209 100644 --- a/testutil_test.go +++ b/testutil_test.go @@ -5,6 +5,7 @@ import ( "fmt" "io/ioutil" "net/http" + "strings" "maunium.net/go/mautrix/id" ) @@ -30,14 +31,19 @@ func newMatrixTripper() *matrixTripper { func (rt *matrixTripper) RoundTrip(req *http.Request) (*http.Response, error) { key := req.Method + " " + req.URL.Path - h := rt.handlers[key] - if h == nil { - panic(fmt.Sprintf( - "RoundTrip: Unhandled request: %s\nHandlers: %d", - key, len(rt.handlers), - )) + if handler, ok := rt.handlers[key]; ok { + return handler(req) } - return h(req) + for strMatch, handler := range rt.handlers { + // try to match key with wildcard handlers + if strMatch[len(strMatch)-1] == '*' && strings.HasPrefix(key, strMatch[:len(strMatch)-1]) { + return handler(req) + } + } + panic(fmt.Sprintf( + "RoundTrip: Unhandled request: %s\nHandlers: %d", + key, len(rt.handlers), + )) } func (rt *matrixTripper) Handle(method, path string, handler func(req *http.Request) (*http.Response, error)) {