cases: Get rid of the subcommand/subparams nonsense

Tt was specific to the CAP command but pretended to be generic.

Instead, allow matching on the params argument using Ellipsis.

irctest/cases.py

@@ -75,8 +75,8 @@ class _IrcTestCase(unittest.TestCase):
         Takes the message as first arguments, and comparisons to be made
         as keyword arguments.
 
-        Deals with subcommands (eg. `CAP`) if any of `subcommand`,
+        Uses self.listMatch on the params argument.
-        `subparams`, and `target` are given."""
+        """
         error = self.messageDiffers(msg, **kwargs)
         if error:
             raise self.failureException(error)
@@ -89,8 +89,7 @@ class _IrcTestCase(unittest.TestCase):
     def messageDiffers(
         self,
         msg,
-        subcommand=None,
+        params=None,
-        subparams=None,
         target=None,
         nick=None,
         fail_msg=None,
@@ -111,6 +110,13 @@ class _IrcTestCase(unittest.TestCase):
                     param=key,
                     msg=msg,
                 )
+
+        if params and not self.listMatch(msg.params, params):
+            fail_msg = fail_msg or "params to be {expects}, got {got}: {msg}"
+            return fail_msg.format(
+                *extra_format, got=msg.params, expects=params, msg=msg
+            )
+
         if nick:
             got_nick = msg.prefix.split("!")[0]
             if msg.prefix is None:
@@ -121,42 +127,22 @@ class _IrcTestCase(unittest.TestCase):
                     *extra_format, got=got_nick, expects=nick, param=key, msg=msg
                 )
 
-        if subcommand is not None or subparams is not None:
-            self.assertGreater(len(msg.params), 2, fail_msg)
-            if len(msg.params) <= 2:
-                fail_msg = (
-                    fail_msg or "expected subcommand with params, got only {params}"
-                )
-                return fail_msg.format(
-                    *extra_format,
-                    got=msg.params,
-                    expects=[subcommand] + subparams,
-                    params=msg.params,
-                    msg=msg,
-                )
-
-            # msg_target = msg.params[0]
-            msg_subcommand = msg.params[1]
-            msg_subparams = msg.params[2:]
-            if subcommand:
-                if msg_subcommand != subcommand:
-                    fail_msg = (
-                        fail_msg or "expected subcommand {expects}, got {got}: {msg}"
-                    )
-                    return fail_msg.format(
-                        *extra_format, got=msg_subcommand, expects=subcommand, msg=msg
-                    )
-            if subparams is not None:
-                if msg_subparams != subparams:
-                    fail_msg = (
-                        fail_msg or "expected subparams {expects}, got {got}: {msg}"
-                    )
-                    return fail_msg.format(
-                        *extra_format, got=msg_subparams, expects=subparams, msg=msg
-                    )
-
         return None
 
+    def listMatch(self, got, expected):
+        """Returns True iff the list are equal.
+        The ellipsis (aka. "..." aka triple dots) can be used on the 'expected'
+        side as a wildcard, matching any *single* value."""
+        if len(got) != len(expected):
+            return False
+        for (got_value, expected_value) in zip(got, expected):
+            if expected_value is Ellipsis:
+                # wildcard
+                continue
+            if got_value != expected_value:
+                return False
+        return True
+
     def assertIn(self, item, list_, msg=None, fail_msg=None, extra_format=()):
         if fail_msg:
             fail_msg = fail_msg.format(*extra_format, item=item, list=list_, msg=msg)
@@ -436,7 +422,8 @@ class BaseServerTestCase(_IrcTestCase):
         caps = []
         while True:
             m = self.getRegistrationMessage(client)
-            self.assertMessageEqual(m, command="CAP", subcommand="LS")
+            self.assertMessageEqual(m, command="CAP")
+            self.assertEqual(m.params[1], "LS", fail_msg="Expected CAP * LS, got {got}")
             if m.params[2] == "*":
                 caps.extend(m.params[3].split())
             else:

irctest/server_tests/test_cap.py

@@ -39,8 +39,7 @@ class CapTestCase(cases.BaseServerTestCase, cases.OptionalityHelper):
         self.assertMessageEqual(
             m,
             command="CAP",
-            subcommand="NAK",
+            params=[..., "NAK", "foo"],
-            subparams=["foo"],
             fail_msg="Expected CAP NAK after requesting non-existing "
             "capability, got {msg}.",
         )
@@ -67,8 +66,7 @@ class CapTestCase(cases.BaseServerTestCase, cases.OptionalityHelper):
         self.assertMessageEqual(
             m,
             command="CAP",
-            subcommand="NAK",
+            params=[..., "NAK", "foo qux bar baz qux quux"],
-            subparams=["foo qux bar baz qux quux"],
             fail_msg="Expected “CAP NAK :foo qux bar baz qux quux” after "
             "sending “CAP REQ :foo qux bar baz qux quux”, but got {msg}.",
         )
@@ -87,8 +85,7 @@ class CapTestCase(cases.BaseServerTestCase, cases.OptionalityHelper):
         self.assertMessageEqual(
             m,
             command="CAP",
-            subcommand="NAK",
+            params=[..., "NAK", "foo multi-prefix bar"],
-            subparams=["foo multi-prefix bar"],
             fail_msg="Expected “CAP NAK :foo multi-prefix bar” after "
             "sending “CAP REQ :foo multi-prefix bar”, but got {msg}.",
         )
@@ -97,8 +94,7 @@ class CapTestCase(cases.BaseServerTestCase, cases.OptionalityHelper):
         self.assertMessageEqual(
             m,
             command="CAP",
-            subcommand="NAK",
+            params=[..., "NAK", "multi-prefix bar"],
-            subparams=["multi-prefix bar"],
             fail_msg="Expected “CAP NAK :multi-prefix bar” after "
             "sending “CAP REQ :multi-prefix bar”, but got {msg}.",
         )
@@ -107,8 +103,7 @@ class CapTestCase(cases.BaseServerTestCase, cases.OptionalityHelper):
         self.assertMessageEqual(
             m,
             command="CAP",
-            subcommand="NAK",
+            params=[..., "NAK", "foo multi-prefix"],
-            subparams=["foo multi-prefix"],
             fail_msg="Expected “CAP NAK :foo multi-prefix” after "
             "sending “CAP REQ :foo multi-prefix”, but got {msg}.",
         )
@@ -118,8 +113,7 @@ class CapTestCase(cases.BaseServerTestCase, cases.OptionalityHelper):
         self.assertMessageEqual(
             m,
             command="CAP",
-            subcommand="ACK",
+            params=[..., "ACK", "multi-prefix"],
-            subparams=["multi-prefix"],
             fail_msg="Expected “CAP ACK :multi-prefix” after "
             "sending “CAP REQ :multi-prefix”, but got {msg}.",
         )
@@ -139,7 +133,7 @@ class CapTestCase(cases.BaseServerTestCase, cases.OptionalityHelper):
         self.sendLine(1, "user user 0 * realname")
         self.sendLine(1, "CAP END")
         m = self.getRegistrationMessage(1)
-        self.assertMessageEqual(m, command="CAP", subcommand="ACK")
+        self.assertMessageEqual(m, command="CAP", params=[..., "ACK", ...])
         self.assertEqual(
             set(m.params[2].split()), {cap1, cap2}, "Didn't ACK both REQed caps"
         )
@@ -157,12 +151,8 @@ class CapTestCase(cases.BaseServerTestCase, cases.OptionalityHelper):
         self.sendLine(1, f"CAP REQ :-{cap2}")
         m = self.getMessage(1)
         # Must be either ACK or NAK
-        if self.messageDiffers(
+        if self.messageDiffers(m, command="CAP", params=[..., "ACK", f"-{cap2}"]):
-            m, command="CAP", subcommand="ACK", subparams=[f"-{cap2}"]
+            self.assertMessageEqual(m, command="CAP", params=[..., "NAK", f"-{cap2}"])
-        ):
-            self.assertMessageEqual(
-                m, command="CAP", subcommand="NAK", subparams=[f"-{cap2}"]
-            )
             raise ImplementationChoice(f"Does not support CAP REQ -{cap2}")
 
         # server-time should be disabled