Merge 646bd698db into 7f9b4b315f

* Simplify RPL_NAMREPLY-on-join tests

* Simplify testMultiPrefix

* Add testNoMultiPrefix

irctest/irc_utils/ambiguities.py

@@ -1,23 +0,0 @@
-"""
-Handles ambiguities of RFCs.
-"""
-
-from typing import List
-
-
-def normalize_namreply_params(params: List[str]) -> List[str]:
-    # So… RFC 2812 says:
-    #       "( "=" / "*" / "@" ) <channel>
-    #       :[ "@" / "+" ] <nick> *( " " [ "@" / "+" ] <nick> )
-    # but spaces seem to be missing (eg. before the colon), so we
-    # don't know if there should be one before the <channel> and its
-    # prefix.
-    # So let's normalize this to “with space”, and strip spaces at the
-    # end of the nick list.
-    params = list(params)  # copy the list
-    if len(params) == 3:
-        assert params[1][0] in "=*@", params
-        params.insert(1, params[1][0])
-        params[2] = params[2][1:]
-    params[3] = params[3].rstrip()
-    return params

irctest/irc_utils/message_parser.py

@@ -15,7 +15,7 @@ TAG_ESCAPE = [
 unescape_tag_value = MultipleReplacer(dict(map(lambda x: (x[1], x[0]), TAG_ESCAPE)))
 
 # TODO: validate host
-tag_key_validator = re.compile(r"\+?(\S+/)?[a-zA-Z0-9-]+")
+tag_key_validator = re.compile(r"^\+?(\S+/)?[a-zA-Z0-9-]+$")
 
 
 def parse_tags(s: str) -> Dict[str, Optional[str]]:

irctest/patma.py

@@ -106,15 +106,15 @@ def match_string(got: Optional[str], expected: Union[str, Operator, None]) -> bo
     elif isinstance(expected, _AnyStr) and got is not None:
         return True
     elif isinstance(expected, StrRe):
-        if got is None or not re.match(expected.regexp, got):
+        if got is None or not re.match(expected.regexp + "$", got):
             return False
     elif isinstance(expected, OptStrRe):
         if got is None:
             return True
-        if not re.match(expected.regexp, got):
+        if not re.match(expected.regexp + "$", got):
             return False
     elif isinstance(expected, NotStrRe):
-        if got is None or re.match(expected.regexp, got):
+        if got is None or re.match(expected.regexp + "$", got):
             return False
     elif isinstance(expected, InsensitiveStr):
         if got is None or got.lower() != expected.string.lower():

irctest/server_tests/isupport.py

@@ -56,7 +56,8 @@ class IsupportTestCase(cases.BaseServerTestCase):
             return
 
         m = re.match(
-            r"\((?P<modes>[a-zA-Z]+)\)(?P<prefixes>\S+)", self.server_support["PREFIX"]
+            r"^\((?P<modes>[a-zA-Z]+)\)(?P<prefixes>\S+)$",
+            self.server_support["PREFIX"],
         )
         self.assertTrue(
             m,
@@ -117,5 +118,5 @@ class IsupportTestCase(cases.BaseServerTestCase):
         parts = self.server_support["TARGMAX"].split(",")
         for part in parts:
             self.assertTrue(
-                re.match("[A-Z]+:[0-9]*", part), "Invalid TARGMAX key:value: %r", part
+                re.match("^[A-Z]+:[0-9]*$", part), "Invalid TARGMAX key:value: %r", part
             )

irctest/server_tests/join.py

@@ -6,7 +6,6 @@ The JOIN command  (`RFC 1459
 """
 
 from irctest import cases, runner
-from irctest.irc_utils import ambiguities
 from irctest.numerics import (
     ERR_BADCHANMASK,
     ERR_FORBIDDENCHANNEL,
@@ -61,6 +60,7 @@ class JoinTestCase(cases.BaseServerTestCase):
             ),
         )
 
+    @cases.xfailIfSoftware(["Bahamut", "irc2"], "trailing space on RPL_NAMREPLY")
     @cases.mark_specifications("RFC2812")
     def testJoinNamreply(self):
         """“353    RPL_NAMREPLY
@@ -75,33 +75,23 @@ class JoinTestCase(cases.BaseServerTestCase):
 
         for m in self.getMessages(1):
             if m.command == "353":
-                self.assertIn(
-                    len(m.params),
-                    (3, 4),
-                    m,
-                    fail_msg="RPL_NAM_REPLY with number of arguments "
-                    "<3 or >4: {msg}",
+                self.assertMessageMatch(
+                    m, params=["foo", StrRe(r"[=\*@]"), "#chan", StrRe("[@+]?foo")]
                 )
-                params = ambiguities.normalize_namreply_params(m.params)
-                self.assertIn(
-                    params[1],
-                    "=*@",
+
+        self.connectClient("bar")
+        self.sendLine(2, "JOIN #chan")
+
+        for m in self.getMessages(2):
+            if m.command == "353":
+                self.assertMessageMatch(
                     m,
-                    fail_msg="Bad channel prefix: {item} not in {list}: {msg}",
-                )
-                self.assertEqual(
-                    params[2],
-                    "#chan",
-                    m,
-                    fail_msg="Bad channel name: {got} instead of " "{expects}: {msg}",
-                )
-                self.assertIn(
-                    params[3],
-                    {"foo", "@foo", "+foo"},
-                    m,
-                    fail_msg="Bad user list: should contain only user "
-                    '"foo" with an optional "+" or "@" prefix, but got: '
-                    "{msg}",
+                    params=[
+                        "bar",
+                        StrRe(r"[=\*@]"),
+                        "#chan",
+                        StrRe("([@+]?foo bar|bar [@+]?foo)"),
+                    ],
                 )
 
     def testJoinTwice(self):
@@ -115,34 +105,8 @@ class JoinTestCase(cases.BaseServerTestCase):
         # if the join is successful, or has an error among the given set.
         for m in self.getMessages(1):
             if m.command == "353":
-                self.assertIn(
-                    len(m.params),
-                    (3, 4),
-                    m,
-                    fail_msg="RPL_NAM_REPLY with number of arguments "
-                    "<3 or >4: {msg}",
-                )
-                params = ambiguities.normalize_namreply_params(m.params)
-                self.assertIn(
-                    params[1],
-                    "=*@",
-                    m,
-                    fail_msg="Bad channel prefix: {item} not in {list}: {msg}",
-                )
-                self.assertEqual(
-                    params[2],
-                    "#chan",
-                    m,
-                    fail_msg="Bad channel name: {got} instead of " "{expects}: {msg}",
-                )
-                self.assertIn(
-                    params[3],
-                    {"foo", "@foo", "+foo"},
-                    m,
-                    fail_msg='Bad user list after user "foo" joined twice '
-                    "the same channel: should contain only user "
-                    '"foo" with an optional "+" or "@" prefix, but got: '
-                    "{msg}",
+                self.assertMessageMatch(
+                    m, params=["foo", StrRe(r"[=\*@]"), "#chan", StrRe("[@+]?foo")]
                 )
 
     def testJoinPartiallyInvalid(self):

irctest/server_tests/multi_prefix.py

@@ -24,11 +24,6 @@ class MultiPrefixTestCase(cases.BaseServerTestCase):
 
         self.sendLine(1, "NAMES #chan")
         reply = self.getMessage(1)
-        self.assertMessageMatch(
-            reply,
-            command="353",
-            fail_msg="Expected NAMES response (353) with @+foo, got: {msg}",
-        )
         self.assertMessageMatch(
             reply,
             command="353",
@@ -47,9 +42,57 @@ class MultiPrefixTestCase(cases.BaseServerTestCase):
             8,
             "Expected WHO response (352) with 8 params, got: {msg}".format(msg=msg),
         )
-        self.assertTrue(
-            "@+" in msg.params[6],
+        self.assertIn(
+            "@+",
+            msg.params[6],
             'Expected WHO response (352) with "@+" in param 7, got: {msg}'.format(
                 msg=msg
             ),
         )
+
+    @cases.xfailIfSoftware(
+        ["irc2", "Bahamut"], "irc2 and Bahamut send a trailing space"
+    )
+    def testNoMultiPrefix(self):
+        """When not requested, only the highest prefix should be sent"""
+        self.connectClient("foo")
+        self.joinChannel(1, "#chan")
+        self.sendLine(1, "MODE #chan +v foo")
+        self.getMessages(1)
+
+        # TODO(dan): Make sure +v is voice
+
+        self.sendLine(1, "NAMES #chan")
+        reply = self.getMessage(1)
+        self.assertMessageMatch(
+            reply,
+            command="353",
+            params=["foo", ANYSTR, "#chan", "@foo"],
+            fail_msg="Expected NAMES response (353) with @foo, got: {msg}",
+        )
+        self.getMessages(1)
+
+        self.sendLine(1, "WHO #chan")
+        msg = self.getMessage(1)
+        self.assertEqual(
+            msg.command, "352", msg, fail_msg="Expected WHO response (352), got: {msg}"
+        )
+        self.assertGreaterEqual(
+            len(msg.params),
+            8,
+            "Expected WHO response (352) with 8 params, got: {msg}".format(msg=msg),
+        )
+        self.assertIn(
+            "@",
+            msg.params[6],
+            'Expected WHO response (352) with "@" in param 7, got: {msg}'.format(
+                msg=msg
+            ),
+        )
+        self.assertNotIn(
+            "+",
+            msg.params[6],
+            'Expected WHO response (352) with no "+" in param 7, got: {msg}'.format(
+                msg=msg
+            ),
+        )

irctest/server_tests/names.py

@@ -11,7 +11,7 @@ from irctest.patma import ANYSTR, StrRe
 
 
 class NamesTestCase(cases.BaseServerTestCase):
-    def _testNames(self, symbol):
+    def _testNames(self, symbol: bool, allow_trailing_space: bool):
         self.connectClient("nick1")
         self.sendLine(1, "JOIN #chan")
         self.getMessages(1)
@@ -31,7 +31,10 @@ class NamesTestCase(cases.BaseServerTestCase):
                 "nick1",
                 *(["="] if symbol else []),
                 "#chan",
-                StrRe("(nick2 @nick1|@nick1 nick2)"),
+                StrRe(
+                    "(nick2 @nick1|@nick1 nick2)"
+                    + (" ?" if allow_trailing_space else "")
+                ),
             ],
         )
 
@@ -44,20 +47,26 @@ class NamesTestCase(cases.BaseServerTestCase):
     @cases.mark_specifications("RFC1459", deprecated=True)
     def testNames1459(self):
         """
-        https://modern.ircdocs.horse/#names-message
         https://datatracker.ietf.org/doc/html/rfc1459#section-4.2.5
-        https://datatracker.ietf.org/doc/html/rfc2812#section-3.2.5
         """
-        self._testNames(symbol=False)
+        self._testNames(symbol=False, allow_trailing_space=True)
 
-    @cases.mark_specifications("RFC1459", "RFC2812", "Modern")
+    @cases.mark_specifications("RFC2812", "Modern")
     def testNames2812(self):
         """
-        https://modern.ircdocs.horse/#names-message
-        https://datatracker.ietf.org/doc/html/rfc1459#section-4.2.5
         https://datatracker.ietf.org/doc/html/rfc2812#section-3.2.5
         """
-        self._testNames(symbol=True)
+        self._testNames(symbol=True, allow_trailing_space=True)
+
+    @cases.mark_specifications("Modern")
+    @cases.xfailIfSoftware(
+        ["Bahamut", "irc2"], "Bahamut and irc2 send a trailing space in RPL_NAMREPLY"
+    )
+    def testNamesModern(self):
+        """
+        https://modern.ircdocs.horse/#names-message
+        """
+        self._testNames(symbol=True, allow_trailing_space=False)
 
     def _testNamesMultipleChannels(self, symbol):
         self.connectClient("nick1")

irctest/server_tests/whois.py

@@ -97,7 +97,9 @@ class _WhoisTestMixin(cases.BaseServerTestCase):
                     params=[
                         "nick1",
                         "nick2",
-                        StrRe("(@#chan1 @#chan2|@#chan2 @#chan1)"),
+                        # trailing space was required by the RFCs, and Modern explicitly
+                        # allows it
+                        StrRe("(@#chan1 @#chan2|@#chan2 @#chan1) ?"),
                     ],
                 )
             elif m.command == RPL_WHOISSPECIAL: