Return known failures without redundant checks

[onechat] / whatsapp_fake_helper_test.go

diff --git a/whatsapp_fake_helper_test.go b/whatsapp_fake_helper_test.go
index 9f80b382dfb096d91fe4cb18638e7faef45684f8..4f12a16f9699891029950e8403b56fc26557c890 100644 (file)
--- a/whatsapp_fake_helper_test.go
+++ b/whatsapp_fake_helper_test.go
@@ -3,7 +3,6 @@ package main
 import (
        "context"
        "fmt"
 import (
        "context"
        "fmt"

-       "log/slog"

        "os"
        "path/filepath"
        "slices"
        "os"
        "path/filepath"
        "slices"


@@ -84,6 +83,9 @@ type WhatsAppFake struct {
        logoutErr     error
        groups        []*types.GroupInfo
        sendErr       error
        logoutErr     error
        groups        []*types.GroupInfo
        sendErr       error

+       uploadErr     error
+       uploads       [][]byte
+       imageSends    []*waE2E.ImageMessage

        downloadData  []byte
        downloadErr   error
        downloadWait  time.Duration
        downloadData  []byte
        downloadErr   error
        downloadWait  time.Duration


@@ -94,6 +96,26 @@ type WhatsAppFake struct {
        connections   []context.Context
 }
 
        connections   []context.Context
 }
 

+// WhatsAppFakeSend is one send of the fake: the chat, the text, and the message
+// ID.
+type WhatsAppFakeSend struct {
+       to   string
+       text string
+       id   string
+}
+
+// WhatsAppRetryTest runs WhatsApp without a model or network client call. All
+// timers and channels belong to its synctest bubble, so backoff uses fake time.
+type WhatsAppRetryTest struct {
+       whatsapp *WhatsApp
+       fake     *WhatsAppFake
+       logs     *SyncBuffer
+       loop     *TurnLoop
+       events   *TurnEventRecorder
+       cancel   context.CancelFunc
+       done     chan error
+}
+

 // ConnectContext keeps ctx and tells the test that the daemon connected.
 func (f *WhatsAppFake) ConnectContext(ctx context.Context) error {
        f.mutex.Lock()
 // ConnectContext keeps ctx and tells the test that the daemon connected.
 func (f *WhatsAppFake) ConnectContext(ctx context.Context) error {
        f.mutex.Lock()


@@ -203,6 +225,46 @@ func (f *WhatsAppFake) Downloads() []whatsmeow.DownloadableMessage {
        return slices.Clone(f.downloads)
 }
 
        return slices.Clone(f.downloads)
 }
 

+// Upload records the pixels and returns made-up media metadata.
+func (f *WhatsAppFake) Upload(_ context.Context, data []byte, mediaType whatsmeow.MediaType) (whatsmeow.UploadResponse, error) {
+       f.mutex.Lock()
+       defer f.mutex.Unlock()
+
+       if mediaType != whatsmeow.MediaImage {
+               return whatsmeow.UploadResponse{}, fmt.Errorf("unexpected media type %q", mediaType)
+       }
+
+       f.uploads = append(f.uploads, slices.Clone(data))
+       if f.uploadErr != nil {
+               return whatsmeow.UploadResponse{}, f.uploadErr
+       }
+
+       return whatsmeow.UploadResponse{
+               URL:           "https://example.com/image",
+               DirectPath:    "/image",
+               MediaKey:      []byte("made-up key"),
+               FileSHA256:    []byte("made-up hash"),
+               FileEncSHA256: []byte("made-up encrypted hash"),
+               FileLength:    uint64(len(data)),
+       }, nil
+}
+
+// Uploads returns the pixels passed to Upload.
+func (f *WhatsAppFake) Uploads() [][]byte {
+       f.mutex.Lock()
+       defer f.mutex.Unlock()
+
+       return slices.Clone(f.uploads)
+}
+
+// ImageSends returns the outgoing image messages.
+func (f *WhatsAppFake) ImageSends() []*waE2E.ImageMessage {
+       f.mutex.Lock()
+       defer f.mutex.Unlock()
+
+       return slices.Clone(f.imageSends)
+}
+

 // GenerateMessageID returns a new message ID.
 func (f *WhatsAppFake) GenerateMessageID() types.MessageID {
        f.mutex.Lock()
 // GenerateMessageID returns a new message ID.
 func (f *WhatsAppFake) GenerateMessageID() types.MessageID {
        f.mutex.Lock()


@@ -216,6 +278,10 @@ func (f *WhatsAppFake) SendMessage(_ context.Context, to types.JID, message *waE
        f.mutex.Lock()
        defer f.mutex.Unlock()
 
        f.mutex.Lock()
        defer f.mutex.Unlock()
 

+       if message.GetImageMessage() != nil {
+               f.imageSends = append(f.imageSends, message.GetImageMessage())
+       }
+

        f.sent = append(f.sent, WhatsAppFakeSend{
                to:   to.String(),
                text: message.GetConversation(),
        f.sent = append(f.sent, WhatsAppFakeSend{
                to:   to.String(),
                text: message.GetConversation(),


@@ -275,26 +341,6 @@ func (f *WhatsAppFake) newClient(_ *store.Device, handle func(event any) bool) W
        return f
 }
 
        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
-}
-
-// WhatsAppRetryTest runs WhatsApp without a model or network client call. All
-// timers and channels belong to its synctest bubble, so backoff uses fake time.
-type WhatsAppRetryTest struct {
-       whatsapp *WhatsApp
-       fake     *WhatsAppFake
-       logs     *SyncBuffer
-       loop     *TurnLoop
-       events   *TurnEventRecorder
-       cancel   context.CancelFunc
-       done     chan error
-}
-

 func (r *WhatsAppRetryTest) start(t *testing.T) {
        t.Helper()
 
 func (r *WhatsAppRetryTest) start(t *testing.T) {
        t.Helper()
 


@@ -311,67 +357,6 @@ func (r *WhatsAppRetryTest) start(t *testing.T) {
        })
 }
 
        })
 }
 

-// 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.
-func whatsappStartTest(t *testing.T, dir string, clock *TestClock) (*WhatsApp, *WhatsAppFake, *SyncBuffer) {
-       t.Helper()
-
-       fake := &WhatsAppFake{
-               connects: make(chan struct{}, 16),
-               pairings: make(chan chan whatsmeow.QRChannelItem, 16),
-       }
-
-       logs := &SyncBuffer{}
-       whatsapp, err := openWhatsApp(t.Context(), dir, clock.Now, daemonTestLogger(logs), fake.newClient)
-       require.NoError(t, err)
-
-       t.Cleanup(func() {
-               require.NoError(t, whatsapp.Close())
-       })
-
-       return whatsapp, fake, logs
-}
-
-// whatsappTestSession writes a session database with mode 0600 to the data
-// directory dir. When linked is true, it holds a device linked to
-// whatsappTestNumber and whatsappTestLID, and else no device.
-func whatsappTestSession(t *testing.T, dir string, linked bool) {
-       t.Helper()
-
-       path := filepath.Join(dir, whatsappDirName, whatsappSessionFileName)
-       require.NoError(t, os.MkdirAll(filepath.Dir(path), 0o700))
-       require.NoError(t, os.WriteFile(path, nil, 0o600))
-
-       address, err := whatsappSessionAddress(path)
-       require.NoError(t, err)
-
-       container, err := sqlstore.New(t.Context(), "sqlite", address, waLog.Noop)
-       require.NoError(t, err)
-
-       if linked {
-               device := container.NewDevice()
-               jid := types.NewADJID(whatsappTestNumber, 0, 1)
-               device.ID = &jid
-               device.LID = types.NewADJID(whatsappTestLID, 0, 1)
-               device.LID.Server = types.HiddenUserServer
-               device.Account = &waAdv.ADVSignedDeviceIdentity{
-                       Details:             []byte{},
-                       AccountSignature:    make([]byte, 64),
-                       AccountSignatureKey: make([]byte, 32),
-                       DeviceSignature:     make([]byte, 64),
-               }
-               require.NoError(t, device.Save(t.Context()))
-       }
-
-       require.NoError(t, container.Close())
-}
-
-// 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 {
 // 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 {


@@ -426,6 +411,63 @@ func whatsappStartTestLinked(t *testing.T) (*WhatsApp, *WhatsAppFake) {
        return whatsapp, fake
 }
 
        return whatsapp, fake
 }
 

+// whatsappTestSession writes a session database with mode 0600 to the data
+// directory dir. When linked is true, it holds a device linked to
+// whatsappTestNumber and whatsappTestLID, and else no device.
+func whatsappTestSession(t *testing.T, dir string, linked bool) {
+       t.Helper()
+
+       path := filepath.Join(dir, whatsappDirName, whatsappSessionFileName)
+       require.NoError(t, os.MkdirAll(filepath.Dir(path), 0o700))
+       require.NoError(t, os.WriteFile(path, nil, 0o600))
+
+       address, err := whatsappSessionAddress(path)
+       require.NoError(t, err)
+
+       container, err := sqlstore.New(t.Context(), "sqlite", address, waLog.Noop)
+       require.NoError(t, err)
+
+       if linked {
+               device := container.NewDevice()
+               jid := types.NewADJID(whatsappTestNumber, 0, 1)
+               device.ID = &jid
+               device.LID = types.NewADJID(whatsappTestLID, 0, 1)
+               device.LID.Server = types.HiddenUserServer
+               device.Account = &waAdv.ADVSignedDeviceIdentity{
+                       Details:             []byte{},
+                       AccountSignature:    make([]byte, 64),
+                       AccountSignatureKey: make([]byte, 32),
+                       DeviceSignature:     make([]byte, 64),
+               }
+
+               require.NoError(t, device.Save(t.Context()))
+       }
+
+       require.NoError(t, container.Close())
+}
+
+// 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.
+func whatsappStartTest(t *testing.T, dir string, clock *TestClock) (*WhatsApp, *WhatsAppFake, *SyncBuffer) {
+       t.Helper()
+
+       fake := &WhatsAppFake{
+               connects: make(chan struct{}, 16),
+               pairings: make(chan chan whatsmeow.QRChannelItem, 16),
+       }
+
+       logs := &SyncBuffer{}
+       whatsapp, err := openWhatsApp(t.Context(), dir, clock.Now, daemonTestLogger(logs), fake.newClient)
+       require.NoError(t, err)
+
+       t.Cleanup(func() {
+               require.NoError(t, whatsapp.Close())
+       })
+
+       return whatsapp, fake, logs
+}
+

 // 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) {
 // 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) {