X-Git-Url: https://git.giacomolli.uk/onechat/blobdiff_plain/0018014ab36f3de61a4b8a5515009dab803d6c38..5a93b6124068c2a8748fc0bfbb2a2d151815bcf0:/whatsapp_fake_helper_test.go diff --git a/whatsapp_fake_helper_test.go b/whatsapp_fake_helper_test.go index 1a7130c..d8bb9bb 100644 --- a/whatsapp_fake_helper_test.go +++ b/whatsapp_fake_helper_test.go @@ -2,19 +2,23 @@ package main import ( "context" - "io" - "log" + "fmt" + "log/slog" "os" "path/filepath" + "slices" "sync" "testing" + "time" "github.com/stretchr/testify/require" "go.mau.fi/whatsmeow" waAdv "go.mau.fi/whatsmeow/proto/waAdv" + "go.mau.fi/whatsmeow/proto/waE2E" "go.mau.fi/whatsmeow/store" "go.mau.fi/whatsmeow/store/sqlstore" "go.mau.fi/whatsmeow/types" + "go.mau.fi/whatsmeow/types/events" waLog "go.mau.fi/whatsmeow/util/log" ) @@ -30,39 +34,106 @@ const ( whatsappTestCode = "ABCD-EFGH" ) +var ( + // whatsappTestOwn is the own account in the tests. + whatsappTestOwn = types.NewJID(whatsappTestNumber, types.DefaultUserServer) + + // whatsappTestAna is a contact in the tests. + whatsappTestAna = types.NewJID("15550002222", types.DefaultUserServer) + + // whatsappTestBruno is a member of the test group. + whatsappTestBruno = types.NewJID("15550003333", types.DefaultUserServer) + + // whatsappTestFamily is the test group. + whatsappTestFamily = types.NewJID("120363000000000001", types.GroupServer) + + // whatsappTestChat is the private chat with whatsappTestAna. + whatsappTestChat = WhatsAppChat{ + ID: whatsappTestAna.String(), + Name: "Ana Souza", + } + + // whatsappTestSendTime is the time of the sends of the fake. + whatsappTestSendTime = time.Date(2026, 1, 1, 12, 5, 0, 0, time.UTC) + + // whatsappTestGroup is the chat of whatsappTestFamily. + whatsappTestGroup = WhatsAppChat{ + ID: whatsappTestFamily.String(), + Name: "Family", + Group: true, + } +) + // WhatsAppFake is a fake WhatsApp client. It keeps the event handler that the // daemon gives it, and Emit gives events to the handler, as the library does. -// Each connection sends to connects, and each pairing sends its channel to -// pairings, so that the test gives the items of the pairing. A connection -// fails with connectErr, and a logout with logoutErr. +// Each connection keeps its context and sends to connects, and each pairing +// sends its channel to pairings, so that the test gives the items of the +// pairing. A connection takes its error from connectErrors, then connectErr. A +// logout fails with logoutErr, and a send with sendErr. groups are the groups +// of the account. A send that does not fail gets the time whatsappTestSendTime. type WhatsAppFake struct { connects chan struct{} pairings chan chan whatsmeow.QRChannelItem - mutex sync.Mutex - handle func(event any) bool - connectErr error - logoutErr error - phones []string - logouts int + mutex sync.Mutex + handle func(event any) bool + connectErr error + connectErrors []error + connectTimes []time.Time + logoutErr error + groups []*types.GroupInfo + sendErr error + phones []string + logouts int + sent []WhatsAppFakeSend + connections []context.Context } -// ConnectContext tells the test that the daemon connected. +// ConnectContext keeps ctx and tells the test that the daemon connected. func (f *WhatsAppFake) ConnectContext(ctx context.Context) error { + f.mutex.Lock() + + f.connections = append(f.connections, ctx) + f.connectTimes = append(f.connectTimes, time.Now()) + f.mutex.Unlock() + f.connects <- struct{}{} f.mutex.Lock() defer f.mutex.Unlock() + if len(f.connectErrors) > 0 { + err := f.connectErrors[0] + f.connectErrors = f.connectErrors[1:] + + return err + } + return f.connectErr } +// Connections returns the contexts of the connections, in order. +func (f *WhatsAppFake) Connections() []context.Context { + f.mutex.Lock() + defer f.mutex.Unlock() + + return slices.Clone(f.connections) +} + +// ConnectionTimes returns the time of each connection call, in order. +func (f *WhatsAppFake) ConnectionTimes() []time.Time { + f.mutex.Lock() + defer f.mutex.Unlock() + + return slices.Clone(f.connectTimes) +} + // Disconnect does nothing. func (f *WhatsAppFake) Disconnect() { } // GetQRChannel gives a new channel of pairing items to the test. -func (f *WhatsAppFake) GetQRChannel(ctx context.Context) (<-chan whatsmeow.QRChannelItem, error) { +func (f *WhatsAppFake) GetQRChannel(_ context.Context) (<-chan whatsmeow.QRChannelItem, error) { items := make(chan whatsmeow.QRChannelItem, 8) f.pairings <- items @@ -70,7 +141,7 @@ func (f *WhatsAppFake) GetQRChannel(ctx context.Context) (<-chan whatsmeow.QRCha } // PairPhone keeps phone and returns whatsappTestCode. -func (f *WhatsAppFake) PairPhone(ctx context.Context, phone string, showPushNotification bool, clientType whatsmeow.PairClientType, clientDisplayName string) (string, error) { +func (f *WhatsAppFake) PairPhone(_ context.Context, phone string, _ bool, _ whatsmeow.PairClientType, _ string) (string, error) { f.mutex.Lock() defer f.mutex.Unlock() @@ -80,7 +151,7 @@ func (f *WhatsAppFake) PairPhone(ctx context.Context, phone string, showPushNoti } // Logout counts the logouts and returns logoutErr. -func (f *WhatsAppFake) Logout(ctx context.Context) error { +func (f *WhatsAppFake) Logout(_ context.Context) error { f.mutex.Lock() defer f.mutex.Unlock() @@ -89,6 +160,50 @@ func (f *WhatsAppFake) Logout(ctx context.Context) error { return f.logoutErr } +// GetJoinedGroups returns groups. +func (f *WhatsAppFake) GetJoinedGroups(_ context.Context) ([]*types.GroupInfo, error) { + f.mutex.Lock() + defer f.mutex.Unlock() + + return f.groups, nil +} + +// GenerateMessageID returns a new message ID. +func (f *WhatsAppFake) GenerateMessageID() types.MessageID { + f.mutex.Lock() + defer f.mutex.Unlock() + + return fmt.Sprintf("MSG%d", len(f.sent)+1) +} + +// SendMessage keeps the send and returns sendErr. +func (f *WhatsAppFake) SendMessage(_ context.Context, to types.JID, message *waE2E.Message, extra ...whatsmeow.SendRequestExtra) (whatsmeow.SendResponse, error) { + f.mutex.Lock() + defer f.mutex.Unlock() + + f.sent = append(f.sent, WhatsAppFakeSend{ + to: to.String(), + text: message.GetConversation(), + id: extra[0].ID, + }) + + if f.sendErr != nil { + return whatsmeow.SendResponse{}, f.sendErr + } + + return whatsmeow.SendResponse{ + Timestamp: whatsappTestSendTime, + }, nil +} + +// Sent returns the sends. +func (f *WhatsAppFake) Sent() []WhatsAppFakeSend { + f.mutex.Lock() + defer f.mutex.Unlock() + + return slices.Clone(f.sent) +} + // Phones returns the phone numbers of the pairings. func (f *WhatsAppFake) Phones() []string { f.mutex.Lock() @@ -108,6 +223,7 @@ func (f *WhatsAppFake) Logouts() int { // Emit gives event to the handler of the daemon and returns its answer. func (f *WhatsAppFake) Emit(event any) bool { f.mutex.Lock() + handle := f.handle f.mutex.Unlock() @@ -115,7 +231,7 @@ func (f *WhatsAppFake) Emit(event any) bool { } // newClient keeps handle and returns the fake as the client of device. -func (f *WhatsAppFake) newClient(device *store.Device, handle func(event any) bool) WhatsAppClient { +func (f *WhatsAppFake) newClient(_ *store.Device, handle func(event any) bool) WhatsAppClient { f.mutex.Lock() defer f.mutex.Unlock() @@ -124,6 +240,14 @@ func (f *WhatsAppFake) newClient(device *store.Device, handle func(event any) bo return f } +// WhatsAppFakeSend is one send of the fake: the chat, the text, and the message +// ID. +type WhatsAppFakeSend struct { + to string + text string + id string +} + // whatsappStartTest opens the WhatsApp of the data directory dir with a fake // client and the test clock, and closes it at the end of the test. The daemon // log goes to the returned buffer. @@ -136,7 +260,7 @@ func whatsappStartTest(t *testing.T, dir string, clock *TestClock) (*WhatsApp, * } logs := &SyncBuffer{} - whatsapp, err := openWhatsApp(t.Context(), dir, clock.Now, log.New(logs, "", 0), fake.newClient) + whatsapp, err := openWhatsApp(t.Context(), dir, clock.Now, daemonTestLogger(logs), fake.newClient) require.NoError(t, err) t.Cleanup(func() { @@ -180,8 +304,86 @@ func whatsappTestSession(t *testing.T, dir string, linked bool) { require.NoError(t, container.Close()) } -// whatsappDiscardLog is a logger for a WhatsApp whose log a test does not -// read. -func whatsappDiscardLog() *log.Logger { - return log.New(io.Discard, "", 0) +// whatsappDiscardLog is a logger for a WhatsApp whose log a test does not read. +func whatsappDiscardLog() *slog.Logger { + return slog.New(slog.DiscardHandler) +} + +// whatsappTestMessage returns the event of the text message id of sender in +// chat at the time at. A sender with whatsappTestNumber is the user. +func whatsappTestMessage(chat, sender types.JID, id, text string, at time.Time) *events.Message { + return &events.Message{ + Info: types.MessageInfo{ + MessageSource: types.MessageSource{ + Chat: chat, + Sender: sender, + IsFromMe: sender.User == whatsappTestNumber, + IsGroup: chat.Server == types.GroupServer, + }, + ID: id, + Timestamp: at, + }, + Message: &waE2E.Message{ + Conversation: new(text), + }, + } +} + +// whatsappTestLogTexts returns the texts of the messages in the log of memory, +// after the log holds at least one message. +func whatsappTestLogTexts(t *testing.T, memory *Memory) []string { + t.Helper() + + require.Eventually(t, func() bool { + return memory.Len() > 0 + }, 10*time.Second, time.Millisecond) + + var texts []string + + for id := range memory.Len() { + message, err := memory.Message(id) + require.NoError(t, err) + + texts = append(texts, message.Text) + } + + return texts +} + +// whatsappStartTestLinked opens a WhatsApp with a linked device in a temporary +// directory, with a quiet time of 50 ms for its batches. +func whatsappStartTestLinked(t *testing.T) (*WhatsApp, *WhatsAppFake) { + t.Helper() + + dir := t.TempDir() + whatsappTestSession(t, dir, true) + + whatsapp, fake, _ := whatsappStartTest(t, dir, newTestClock()) + whatsapp.state.quiet = 50 * time.Millisecond + + return whatsapp, fake +} + +// whatsappTestConnect waits for the connection of the daemon and gives it the +// events of a connection with an empty catch-up. +func whatsappTestConnect(t *testing.T, fake *WhatsAppFake) { + t.Helper() + + <-fake.connects + require.True(t, fake.Emit(&events.Connected{})) + require.True(t, fake.Emit(&events.OfflineSyncCompleted{})) +} + +// whatsappTestContacts puts the contacts of the tests into the session of +// whatsapp: Ana Souza, Joao Silva with an accent, a business, and the user. +func whatsappTestContacts(t *testing.T, whatsapp *WhatsApp) { + t.Helper() + + contacts := whatsapp.device.Contacts + require.NoError(t, contacts.PutContactName(t.Context(), whatsappTestAna, "Ana", "Ana Souza")) + require.NoError(t, contacts.PutContactName(t.Context(), types.NewJID("15550004444", types.DefaultUserServer), "João", "João Silva")) + + _, _, err := contacts.PutBusinessName(t.Context(), types.NewJID("15550005555", types.DefaultUserServer), "Corner Bakery") + require.NoError(t, err) + require.NoError(t, contacts.PutContactName(t.Context(), whatsappTestOwn, "Me", "Me Souza")) }