Order functions by their first use

[onechat] / whatsapp_test.go

diff --git a/whatsapp_test.go b/whatsapp_test.go
index c1471e98e8f3c3aa2ad97daa69cd13795be3bd59..9da1537b58e69e97f53f8f58da0fd6510e049b0f 100644 (file)
--- a/whatsapp_test.go
+++ b/whatsapp_test.go
@@ -2,6 +2,7 @@ package main
 
 import (
        "errors"
 
 import (
        "errors"

+       "log/slog"

        "os"
        "path/filepath"
        "strings"
        "os"
        "path/filepath"
        "strings"


@@ -123,6 +124,7 @@ func TestWhatsAppLinkedPairRequestKeepsFirstConnectionRetries(t *testing.T) {
                test.whatsapp.Command("pair 15550001111", func(text string) {
                        answers <- text
                })
                test.whatsapp.Command("pair 15550001111", func(text string) {
                        answers <- text
                })

+

                require.Equal(t, "WhatsApp is linked already. Run /whatsapp unlink first.", <-answers)
                synctest.Wait()
                test.fake.mutex.Lock()
                require.Equal(t, "WhatsApp is linked already. Run /whatsapp unlink first.", <-answers)
                synctest.Wait()
                test.fake.mutex.Lock()


@@ -148,20 +150,20 @@ func TestWhatsAppFirstConnectionRetriesStopForLinkChanges(t *testing.T) {
                stop func(test *WhatsAppRetryTest)
        }{
                {
                stop func(test *WhatsAppRetryTest)
        }{
                {

-                       name: "unlink",
+                       name: "stops retrying after unlink",

                        stop: func(test *WhatsAppRetryTest) {
                                test.whatsapp.Command("unlink", func(_ string) {
                                })
                        },
                },
                {
                        stop: func(test *WhatsAppRetryTest) {
                                test.whatsapp.Command("unlink", func(_ string) {
                                })
                        },
                },
                {

-                       name: "logout",
+                       name: "stops retrying after logout",

                        stop: func(test *WhatsAppRetryTest) {
                                test.fake.Emit(&events.LoggedOut{})
                        },
                },
                {
                        stop: func(test *WhatsAppRetryTest) {
                                test.fake.Emit(&events.LoggedOut{})
                        },
                },
                {

-                       name: "permanent disconnect",
+                       name: "stops retrying after a permanent disconnect",

                        stop: func(test *WhatsAppRetryTest) {
                                test.fake.Emit(&events.StreamReplaced{})
                        },
                        stop: func(test *WhatsAppRetryTest) {
                                test.fake.Emit(&events.StreamReplaced{})
                        },


@@ -193,6 +195,7 @@ func TestWhatsAppPairsAfterFirstConnectionRetriesStop(t *testing.T) {
                synctest.Wait()
                test.whatsapp.Command("unlink", func(_ string) {
                })
                synctest.Wait()
                test.whatsapp.Command("unlink", func(_ string) {
                })

+

                synctest.Wait()
                require.False(t, test.whatsapp.isLinked())
 
                synctest.Wait()
                require.False(t, test.whatsapp.isLinked())
 


@@ -315,6 +318,7 @@ func TestWhatsAppLogsEachChangeOfTheConnectionOnce(t *testing.T) {
                "<4>disconnected, retrying",
                "<6>connected again after=1m25s",
        }, strings.Split(strings.TrimSuffix(logs.String(), "\n"), "\n"))
                "<4>disconnected, retrying",
                "<6>connected again after=1m25s",
        }, strings.Split(strings.TrimSuffix(logs.String(), "\n"), "\n"))

+

        require.NotContains(t, logs.String(), whatsappTestNumber)
        require.NotContains(t, logs.String(), whatsappTestLID)
 }
        require.NotContains(t, logs.String(), whatsappTestNumber)
        require.NotContains(t, logs.String(), whatsappTestLID)
 }


@@ -325,12 +329,12 @@ func TestWhatsAppIsNotLinkedWithoutALinkedDevice(t *testing.T) {
                session func(t *testing.T, dir string)
        }{
                {
                session func(t *testing.T, dir string)
        }{
                {

-                       name: "no session file",
+                       name: "stays unlinked without a session file",

                        session: func(_ *testing.T, _ string) {
                        },
                },
                {
                        session: func(_ *testing.T, _ string) {
                        },
                },
                {

-                       name: "a session of a pairing that did not end",
+                       name: "stays unlinked after incomplete pairing",

                        session: func(t *testing.T, dir string) {
                                whatsappTestSession(t, dir, false)
                        },
                        session: func(t *testing.T, dir string) {
                                whatsappTestSession(t, dir, false)
                        },


@@ -462,21 +466,21 @@ func TestWhatsAppPairingEnds(t *testing.T) {
                answer string
        }{
                {
                answer string
        }{
                {

-                       name: "the code expires",
+                       name: "ends pairing when the code expires",

                        end: func(items chan whatsmeow.QRChannelItem) {
                                items <- whatsmeow.QRChannelTimeout
                        },
                        answer: whatsappPairExpired,
                },
                {
                        end: func(items chan whatsmeow.QRChannelItem) {
                                items <- whatsmeow.QRChannelTimeout
                        },
                        answer: whatsappPairExpired,
                },
                {

-                       name: "the library closes the pairing",
+                       name: "ends pairing when the library closes it",

                        end: func(items chan whatsmeow.QRChannelItem) {
                                close(items)
                        },
                        answer: whatsappPairExpired,
                },
                {
                        end: func(items chan whatsmeow.QRChannelItem) {
                                close(items)
                        },
                        answer: whatsappPairExpired,
                },
                {

-                       name: "the pairing fails",
+                       name: "ends pairing when the library reports failure",

                        end: func(items chan whatsmeow.QRChannelItem) {
                                items <- whatsmeow.QRChannelItem{
                                        Event: whatsmeow.QRChannelEventError,
                        end: func(items chan whatsmeow.QRChannelItem) {
                                items <- whatsmeow.QRChannelItem{
                                        Event: whatsmeow.QRChannelEventError,


@@ -545,11 +549,11 @@ func TestWhatsAppUnlink(t *testing.T) {
                answer    string
        }{
                {
                answer    string
        }{
                {

-                       name:   "with a logout",
+                       name:   "logs out before removing the session",

                        answer: "WhatsApp is unlinked.",
                },
                {
                        answer: "WhatsApp is unlinked.",
                },
                {

-                       name:      "with no logout",
+                       name:      "removes an offline session without logout",

                        logoutErr: errors.New("not connected"),
                        answer:    "WhatsApp is unlinked here, but the phone did not get the logout. In WhatsApp on your phone, open Linked devices and remove the device.",
                },
                        logoutErr: errors.New("not connected"),
                        answer:    "WhatsApp is unlinked here, but the phone did not get the logout. In WhatsApp on your phone, open Linked devices and remove the device.",
                },


@@ -662,6 +666,7 @@ func TestWhatsAppLogsNoOwnNumber(t *testing.T) {
        require.Eventually(t, func() bool {
                return logs.String() != ""
        }, 10*time.Second, time.Millisecond)
        require.Eventually(t, func() bool {
                return logs.String() != ""
        }, 10*time.Second, time.Millisecond)

+

        require.Equal(t, "<4>first connect failed, retrying: no route for OWN@s.whatsapp.net and OWN@lid\n", logs.String())
 }
 
        require.Equal(t, "<4>first connect failed, retrying: no route for OWN@s.whatsapp.net and OWN@lid\n", logs.String())
 }
 


@@ -672,27 +677,27 @@ func TestWhatsAppPhone(t *testing.T) {
                valid bool
        }{
                {
                valid bool
        }{
                {

-                       name:  "a number with a plus and dashes",
+                       name:  "accepts a number with a plus and dashes",

                        phone: "+1-555-000-1111",
                        valid: true,
                },
                {
                        phone: "+1-555-000-1111",
                        valid: true,
                },
                {

-                       name:  "a number with no country code",
+                       name:  "refuses a number without a country code",

                        phone: "0115550001111",
                        valid: false,
                },
                {
                        phone: "0115550001111",
                        valid: false,
                },
                {

-                       name:  "a short number",
+                       name:  "refuses a number shorter than the minimum",

                        phone: "123456",
                        valid: false,
                },
                {
                        phone: "123456",
                        valid: false,
                },
                {

-                       name:  "a long number",
+                       name:  "refuses a number longer than the maximum",

                        phone: "1234567890123456",
                        valid: false,
                },
                {
                        phone: "1234567890123456",
                        valid: false,
                },
                {

-                       name:  "a number with letters",
+                       name:  "refuses a number with letters",

                        phone: "1555ABC1111",
                        valid: false,
                },
                        phone: "1555ABC1111",
                        valid: false,
                },


@@ -714,25 +719,25 @@ func TestWhatsAppCommandArgs(t *testing.T) {
                found bool
        }{
                {
                found bool
        }{
                {

-                       name:  "a command with its arguments",
+                       name:  "reads and trims the command arguments",

                        line:  " /whatsapp  pair +1 555 ",
                        args:  "pair +1 555",
                        found: true,
                },
                {
                        line:  " /whatsapp  pair +1 555 ",
                        args:  "pair +1 555",
                        found: true,
                },
                {

-                       name:  "the command alone",
+                       name:  "accepts the command without arguments",

                        line:  "/whatsapp",
                        args:  "",
                        found: true,
                },
                {
                        line:  "/whatsapp",
                        args:  "",
                        found: true,
                },
                {

-                       name:  "a word that starts with the command",
+                       name:  "leaves a joined command word as text",

                        line:  "/whatsappstatus",
                        args:  "",
                        found: false,
                },
                {
                        line:  "/whatsappstatus",
                        args:  "",
                        found: false,
                },
                {

-                       name:  "a message that names the command",
+                       name:  "leaves a mention of the command as text",

                        line:  "what does /whatsapp status do?",
                        args:  "",
                        found: false,
                        line:  "what does /whatsapp status do?",
                        args:  "",
                        found: false,


@@ -753,3 +758,8 @@ func TestSubagentHasNoWhatsAppTools(t *testing.T) {
        require.Equal(t, `error: unknown tool "whatsapp_find"`, box.run(t.Context(), "whatsapp_find", `{"name":"ana"}`))
        require.Equal(t, `error: unknown tool "whatsapp_send"`, box.run(t.Context(), "whatsapp_send", `{"id":"a","chat":"15550002222@s.whatsapp.net","text":"hi"}`))
 }
        require.Equal(t, `error: unknown tool "whatsapp_find"`, box.run(t.Context(), "whatsapp_find", `{"name":"ana"}`))
        require.Equal(t, `error: unknown tool "whatsapp_send"`, box.run(t.Context(), "whatsapp_send", `{"id":"a","chat":"15550002222@s.whatsapp.net","text":"hi"}`))
 }

+
+// whatsappDiscardLog is a logger for a WhatsApp whose log a test does not read.
+func whatsappDiscardLog() *slog.Logger {
+       return slog.New(slog.DiscardHandler)
+}