From 8d427c80c8016aaeea29e53c3e2549226fe84bee Mon Sep 17 00:00:00 2001
From: Shivaram Lingamneni <slingamn@cs.stanford.edu>
Date: Wed, 17 Feb 2021 23:27:48 -0500
Subject: [PATCH] fix stall on failed channel join

---
 irctest/cases.py    | 14 ++++++++++++--
 irctest/numerics.py |  1 +
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/irctest/cases.py b/irctest/cases.py
index 4d75eb5..61051c6 100644
--- a/irctest/cases.py
+++ b/irctest/cases.py
@@ -13,6 +13,15 @@ from .irc_utils.junkdrawer import normalizeWhitespace, random_name
 from .irc_utils.sasl import sasl_plain_blob
 from .exceptions import ConnectionClosed
 from .specifications import Specifications
+from .numerics import ERR_NOSUCHCHANNEL, ERR_TOOMANYCHANNELS, ERR_BADCHANNELKEY, ERR_INVITEONLYCHAN, ERR_BANNEDFROMCHAN, ERR_NEEDREGGEDNICK
+
+CHANNEL_JOIN_FAIL_NUMERICS = frozenset([ERR_NOSUCHCHANNEL, ERR_TOOMANYCHANNELS, ERR_BADCHANNELKEY, ERR_INVITEONLYCHAN, ERR_BANNEDFROMCHAN, ERR_NEEDREGGEDNICK])
+
+class ChannelJoinException(Exception):
+    def __init__(self, code, params):
+        super().__init__(f'Failed to join channel ({code}): {params}')
+        self.code = code
+        self.params = params
 
 class _IrcTestCase(unittest.TestCase):
     """Base class for test cases."""
@@ -388,10 +397,11 @@ class BaseServerTestCase(_IrcTestCase):
         joined = False
         while not joined:
             for msg in self.getMessages(client):
-                # todo: also respond to cannot join channel numeric
-                if msg.command.upper() == 'JOIN' and 0 < len(msg.params) and msg.params[0].lower() == channel.lower():
+                if msg.command == 'JOIN' and 0 < len(msg.params) and msg.params[0].lower() == channel.lower():
                     joined = True
                     break
+                elif msg.command in CHANNEL_JOIN_FAIL_NUMERICS:
+                    raise ChannelJoinException(msg.command, msg.params)
 
     def getISupport(self):
         cn = random_name('bar')
diff --git a/irctest/numerics.py b/irctest/numerics.py
index 5608c68..dbfa4b1 100644
--- a/irctest/numerics.py
+++ b/irctest/numerics.py
@@ -152,6 +152,7 @@ ERR_BANNEDFROMCHAN              = "474"
 ERR_BADCHANNELKEY               = "475"
 ERR_BADCHANMASK                 = "476"
 ERR_NOCHANMODES                 = "477"
+ERR_NEEDREGGEDNICK              = "477"
 ERR_BANLISTFULL                 = "478"
 ERR_NOPRIVILEGES                = "481"
 ERR_CHANOPRIVSNEEDED            = "482"