Mini Shell

# Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.

"""
Tests for L{twisted.words.service}.
"""

import time

from twisted.cred import checkers, credentials, portal
from twisted.internet import address, defer, reactor
from twisted.internet.defer import Deferred, DeferredList, maybeDeferred, succeed
from twisted.spread import pb
from twisted.test import proto_helpers
from twisted.trial import unittest
from twisted.words import ewords, service
from twisted.words.protocols import irc


class RealmTests(unittest.TestCase):
    def _entityCreationTest(self, kind):
        # Kind is "user" or "group"
        realm = service.InMemoryWordsRealm("realmname")

        name = "test" + kind.lower()
        create = getattr(realm, "create" + kind.title())
        get = getattr(realm, "get" + kind.title())
        flag = "create" + kind.title() + "OnRequest"
        dupExc = getattr(ewords, "Duplicate" + kind.title())
        noSuchExc = getattr(ewords, "NoSuch" + kind.title())

        # Creating should succeed
        p = self.successResultOf(create(name))
        self.assertEqual(name, p.name)

        # Creating the same user again should not
        self.failureResultOf(create(name)).trap(dupExc)

        # Getting a non-existent user should succeed if createUserOnRequest is True
        setattr(realm, flag, True)
        p = self.successResultOf(get("new" + kind.lower()))
        self.assertEqual("new" + kind.lower(), p.name)

        # Getting that user again should return the same object
        newp = self.successResultOf(get("new" + kind.lower()))
        self.assertIdentical(p, newp)

        # Getting a non-existent user should fail if createUserOnRequest is False
        setattr(realm, flag, False)
        self.failureResultOf(get("another" + kind.lower())).trap(noSuchExc)

    def testUserCreation(self):
        return self._entityCreationTest("User")

    def testGroupCreation(self):
        return self._entityCreationTest("Group")

    def testUserRetrieval(self):
        realm = service.InMemoryWordsRealm("realmname")

        # Make a user to play around with
        user = self.successResultOf(realm.createUser("testuser"))

        # Make sure getting the user returns the same object
        retrieved = self.successResultOf(realm.getUser("testuser"))
        self.assertIdentical(user, retrieved)

        # Make sure looking up the user also returns the same object
        lookedUp = self.successResultOf(realm.lookupUser("testuser"))
        self.assertIdentical(retrieved, lookedUp)

        # Make sure looking up a user who does not exist fails
        (self.failureResultOf(realm.lookupUser("nosuchuser")).trap(ewords.NoSuchUser))

    def testUserAddition(self):
        realm = service.InMemoryWordsRealm("realmname")

        # Create and manually add a user to the realm
        p = service.User("testuser")
        user = self.successResultOf(realm.addUser(p))
        self.assertIdentical(p, user)

        # Make sure getting that user returns the same object
        retrieved = self.successResultOf(realm.getUser("testuser"))
        self.assertIdentical(user, retrieved)

        # Make sure looking up that user returns the same object
        lookedUp = self.successResultOf(realm.lookupUser("testuser"))
        self.assertIdentical(retrieved, lookedUp)

    def testGroupRetrieval(self):
        realm = service.InMemoryWordsRealm("realmname")

        group = self.successResultOf(realm.createGroup("testgroup"))

        retrieved = self.successResultOf(realm.getGroup("testgroup"))

        self.assertIdentical(group, retrieved)

        (self.failureResultOf(realm.getGroup("nosuchgroup")).trap(ewords.NoSuchGroup))

    def testGroupAddition(self):
        realm = service.InMemoryWordsRealm("realmname")

        p = service.Group("testgroup")
        self.successResultOf(realm.addGroup(p))
        group = self.successResultOf(realm.getGroup("testGroup"))
        self.assertIdentical(p, group)

    def testGroupUsernameCollision(self):
        """
        Try creating a group with the same name as an existing user and
        assert that it succeeds, since users and groups should not be in the
        same namespace and collisions should be impossible.
        """
        realm = service.InMemoryWordsRealm("realmname")

        self.successResultOf(realm.createUser("test"))
        self.successResultOf(realm.createGroup("test"))

    def testEnumeration(self):
        realm = service.InMemoryWordsRealm("realmname")
        self.successResultOf(realm.createGroup("groupone"))

        self.successResultOf(realm.createGroup("grouptwo"))

        groups = self.successResultOf(realm.itergroups())

        n = [g.name for g in groups]
        n.sort()
        self.assertEqual(n, ["groupone", "grouptwo"])


class TestCaseUserAgg:
    def __init__(
        self,
        user,
        realm,
        factory,
        address=address.IPv4Address("TCP", "127.0.0.1", 54321),
    ):
        self.user = user
        self.transport = proto_helpers.StringTransportWithDisconnection()
        self.protocol = factory.buildProtocol(address)
        self.transport.protocol = self.protocol
        self.user.mind = self.protocol
        self.protocol.makeConnection(self.transport)

    def write(self, stuff):
        self.protocol.dataReceived(stuff)


class IRCProtocolTests(unittest.TestCase):
    STATIC_USERS = [
        "useruser",
        "otheruser",
        "someguy",
        "firstuser",
        "username",
        "userone",
        "usertwo",
        "userthree",
        "userfour",
        b"userfive",
        "someuser",
    ]

    def setUp(self):
        self.realm = service.InMemoryWordsRealm("realmname")
        self.checker = checkers.InMemoryUsernamePasswordDatabaseDontUse()
        self.portal = portal.Portal(self.realm, [self.checker])
        self.factory = service.IRCFactory(self.realm, self.portal)

        c = []
        for nick in self.STATIC_USERS:
            if isinstance(nick, bytes):
                nick = nick.decode("utf-8")
            c.append(self.realm.createUser(nick))
            self.checker.addUser(nick, nick + "_password")
        return DeferredList(c)

    def _assertGreeting(self, user):
        """
        The user has been greeted with the four messages that are (usually)
        considered to start an IRC session.

        Asserts that the required responses were received.
        """
        # Make sure we get 1-4 at least
        response = self._response(user)
        expected = [irc.RPL_WELCOME, irc.RPL_YOURHOST, irc.RPL_CREATED, irc.RPL_MYINFO]
        for (prefix, command, args) in response:
            if command in expected:
                expected.remove(command)
        self.assertFalse(expected, f"Missing responses for {expected!r}")

    def _login(self, user, nick, password=None):
        if password is None:
            password = nick + "_password"
        user.write(f"PASS {password}\r\n")
        user.write(f"NICK {nick} extrainfo\r\n")

    def _loggedInUser(self, name):
        user = self.successResultOf(self.realm.lookupUser(name))
        agg = TestCaseUserAgg(user, self.realm, self.factory)
        self._login(agg, name)
        return agg

    def _response(self, user, messageType=None):
        """
        Extracts the user's response, and returns a list of parsed lines.
        If messageType is defined, only messages of that type will be returned.
        """
        response = user.transport.value()
        if bytes != str and isinstance(response, bytes):
            response = response.decode("utf-8")
        response = response.splitlines()
        user.transport.clear()
        result = []
        for message in map(irc.parsemsg, response):
            if messageType is None or message[1] == messageType:
                result.append(message)
        return result

    def testPASSLogin(self):
        user = self._loggedInUser("firstuser")
        self._assertGreeting(user)

    def test_nickServLogin(self):
        """
        Sending NICK without PASS will prompt the user for their password.
        When the user sends their password to NickServ, it will respond with a
        Greeting.
        """
        firstuser = self.successResultOf(self.realm.lookupUser("firstuser"))

        user = TestCaseUserAgg(firstuser, self.realm, self.factory)
        user.write("NICK firstuser extrainfo\r\n")
        response = self._response(user, "PRIVMSG")
        self.assertEqual(len(response), 1)
        self.assertEqual(response[0][0], service.NICKSERV)
        self.assertEqual(response[0][1], "PRIVMSG")
        self.assertEqual(response[0][2], ["firstuser", "Password?"])
        user.transport.clear()

        user.write("PRIVMSG nickserv firstuser_password\r\n")
        self._assertGreeting(user)

    def testFailedLogin(self):
        firstuser = self.successResultOf(self.realm.lookupUser("firstuser"))

        user = TestCaseUserAgg(firstuser, self.realm, self.factory)
        self._login(user, "firstuser", "wrongpass")
        response = self._response(user, "PRIVMSG")
        self.assertEqual(len(response), 1)
        self.assertEqual(response[0][2], ["firstuser", "Login failed.  Goodbye."])

    def testLogout(self):
        logout = []
        firstuser = self.successResultOf(self.realm.lookupUser("firstuser"))

        user = TestCaseUserAgg(firstuser, self.realm, self.factory)
        self._login(user, "firstuser")
        user.protocol.logout = lambda: logout.append(True)
        user.write("QUIT\r\n")
        self.assertEqual(logout, [True])

    def testJoin(self):
        firstuser = self.successResultOf(self.realm.lookupUser("firstuser"))

        somechannel = self.successResultOf(self.realm.createGroup("somechannel"))

        somechannel.meta["topic"] = "some random topic"

        # Bring in one user, make sure he gets into the channel sanely
        user = TestCaseUserAgg(firstuser, self.realm, self.factory)
        self._login(user, "firstuser")
        user.transport.clear()
        user.write("JOIN #somechannel\r\n")

        response = self._response(user)
        self.assertEqual(len(response), 5)

        # Join message
        self.assertEqual(response[0][0], "firstuser!firstuser@realmname")
        self.assertEqual(response[0][1], "JOIN")
        self.assertEqual(response[0][2], ["#somechannel"])

        # User list
        self.assertEqual(response[1][1], "353")
        self.assertEqual(response[2][1], "366")

        # Topic (or lack thereof, as the case may be)
        self.assertEqual(response[3][1], "332")
        self.assertEqual(response[4][1], "333")

        # Hook up another client!  It is a CHAT SYSTEM!!!!!!!
        other = self._loggedInUser("otheruser")

        other.transport.clear()
        user.transport.clear()
        other.write("JOIN #somechannel\r\n")

        # At this point, both users should be in the channel
        response = self._response(other)

        event = self._response(user)
        self.assertEqual(len(event), 1)
        self.assertEqual(event[0][0], "otheruser!otheruser@realmname")
        self.assertEqual(event[0][1], "JOIN")
        self.assertEqual(event[0][2], ["#somechannel"])

        self.assertEqual(response[1][0], "realmname")
        self.assertEqual(response[1][1], "353")
        self.assertIn(
            response[1][2],
            [
                ["otheruser", "=", "#somechannel", "firstuser otheruser"],
                ["otheruser", "=", "#somechannel", "otheruser firstuser"],
            ],
        )

    def test_joinTopicless(self):
        """
        When a user joins a group without a topic, no topic information is
        sent to that user.
        """
        firstuser = self.successResultOf(self.realm.lookupUser("firstuser"))

        self.successResultOf(self.realm.createGroup("somechannel"))

        # Bring in one user, make sure he gets into the channel sanely
        user = TestCaseUserAgg(firstuser, self.realm, self.factory)
        self._login(user, "firstuser")
        user.transport.clear()
        user.write("JOIN #somechannel\r\n")

        response = self._response(user)
        responseCodes = [r[1] for r in response]
        self.assertNotIn("332", responseCodes)
        self.assertNotIn("333", responseCodes)

    def testLeave(self):
        user = self._loggedInUser("useruser")

        self.successResultOf(self.realm.createGroup("somechannel"))

        user.write("JOIN #somechannel\r\n")
        user.transport.clear()

        other = self._loggedInUser("otheruser")

        other.write("JOIN #somechannel\r\n")

        user.transport.clear()
        other.transport.clear()

        user.write("PART #somechannel\r\n")

        response = self._response(user)
        event = self._response(other)

        self.assertEqual(len(response), 1)
        self.assertEqual(response[0][0], "useruser!useruser@realmname")
        self.assertEqual(response[0][1], "PART")
        self.assertEqual(response[0][2], ["#somechannel", "leaving"])
        self.assertEqual(response, event)

        # Now again, with a part message
        user.write("JOIN #somechannel\r\n")

        user.transport.clear()
        other.transport.clear()

        user.write("PART #somechannel :goodbye stupidheads\r\n")

        response = self._response(user)
        event = self._response(other)

        self.assertEqual(len(response), 1)
        self.assertEqual(response[0][0], "useruser!useruser@realmname")
        self.assertEqual(response[0][1], "PART")
        self.assertEqual(response[0][2], ["#somechannel", "goodbye stupidheads"])
        self.assertEqual(response, event)

        user.write(b"JOIN #somechannel\r\n")

        user.transport.clear()
        other.transport.clear()

        user.write(b"PART #somechannel :goodbye stupidheads1\r\n")

        response = self._response(user)
        event = self._response(other)

        self.assertEqual(len(response), 1)
        self.assertEqual(response[0][0], "useruser!useruser@realmname")
        self.assertEqual(response[0][1], "PART")
        self.assertEqual(response[0][2], ["#somechannel", "goodbye stupidheads1"])
        self.assertEqual(response, event)

    def testGetTopic(self):
        user = self._loggedInUser("useruser")

        group = service.Group("somechannel")
        group.meta["topic"] = "This is a test topic."
        group.meta["topic_author"] = "some_fellow"
        group.meta["topic_date"] = 77777777

        self.successResultOf(self.realm.addGroup(group))

        user.transport.clear()
        user.write("JOIN #somechannel\r\n")

        response = self._response(user)

        self.assertEqual(response[3][0], "realmname")
        self.assertEqual(response[3][1], "332")

        # XXX Sigh.  irc.parsemsg() is not as correct as one might hope.
        self.assertEqual(
            response[3][2], ["useruser", "#somechannel", "This is a test topic."]
        )
        self.assertEqual(response[4][1], "333")
        self.assertEqual(
            response[4][2], ["useruser", "#somechannel", "some_fellow", "77777777"]
        )

        user.transport.clear()

        user.write("TOPIC #somechannel\r\n")

        response = self._response(user)

        self.assertEqual(response[0][1], "332")
        self.assertEqual(
            response[0][2], ["useruser", "#somechannel", "This is a test topic."]
        )
        self.assertEqual(response[1][1], "333")
        self.assertEqual(
            response[1][2], ["useruser", "#somechannel", "some_fellow", "77777777"]
        )

    def testSetTopic(self):
        user = self._loggedInUser("useruser")

        somechannel = self.successResultOf(self.realm.createGroup("somechannel"))

        user.write("JOIN #somechannel\r\n")

        other = self._loggedInUser("otheruser")

        other.write("JOIN #somechannel\r\n")

        user.transport.clear()
        other.transport.clear()

        other.write("TOPIC #somechannel :This is the new topic.\r\n")

        response = self._response(other)
        event = self._response(user)

        self.assertEqual(response, event)

        self.assertEqual(response[0][0], "otheruser!otheruser@realmname")
        self.assertEqual(response[0][1], "TOPIC")
        self.assertEqual(response[0][2], ["#somechannel", "This is the new topic."])

        other.transport.clear()

        somechannel.meta["topic_date"] = 12345
        other.write("TOPIC #somechannel\r\n")

        response = self._response(other)
        self.assertEqual(response[0][1], "332")
        self.assertEqual(
            response[0][2], ["otheruser", "#somechannel", "This is the new topic."]
        )
        self.assertEqual(response[1][1], "333")
        self.assertEqual(
            response[1][2], ["otheruser", "#somechannel", "otheruser", "12345"]
        )

        other.transport.clear()
        other.write("TOPIC #asdlkjasd\r\n")

        response = self._response(other)
        self.assertEqual(response[0][1], "403")

    def testGroupMessage(self):
        user = self._loggedInUser("useruser")

        self.successResultOf(self.realm.createGroup("somechannel"))

        user.write("JOIN #somechannel\r\n")

        other = self._loggedInUser("otheruser")

        other.write("JOIN #somechannel\r\n")

        user.transport.clear()
        other.transport.clear()

        user.write("PRIVMSG #somechannel :Hello, world.\r\n")

        response = self._response(user)
        event = self._response(other)

        self.assertFalse(response)
        self.assertEqual(len(event), 1)
        self.assertEqual(event[0][0], "useruser!useruser@realmname")
        self.assertEqual(event[0][1], "PRIVMSG", -1)
        self.assertEqual(event[0][2], ["#somechannel", "Hello, world."])

    def testPrivateMessage(self):
        user = self._loggedInUser("useruser")

        other = self._loggedInUser("otheruser")

        user.transport.clear()
        other.transport.clear()

        user.write("PRIVMSG otheruser :Hello, monkey.\r\n")

        response = self._response(user)
        event = self._response(other)

        self.assertFalse(response)
        self.assertEqual(len(event), 1)
        self.assertEqual(event[0][0], "useruser!useruser@realmname")
        self.assertEqual(event[0][1], "PRIVMSG")
        self.assertEqual(event[0][2], ["otheruser", "Hello, monkey."])

        user.write("PRIVMSG nousernamedthis :Hello, monkey.\r\n")

        response = self._response(user)

        self.assertEqual(len(response), 1)
        self.assertEqual(response[0][0], "realmname")
        self.assertEqual(response[0][1], "401")
        self.assertEqual(
            response[0][2], ["useruser", "nousernamedthis", "No such nick/channel."]
        )

    def testOper(self):
        user = self._loggedInUser("useruser")

        user.transport.clear()
        user.write("OPER user pass\r\n")
        response = self._response(user)

        self.assertEqual(len(response), 1)
        self.assertEqual(response[0][1], "491")

    def testGetUserMode(self):
        user = self._loggedInUser("useruser")

        user.transport.clear()
        user.write("MODE useruser\r\n")

        response = self._response(user)
        self.assertEqual(len(response), 1)
        self.assertEqual(response[0][0], "realmname")
        self.assertEqual(response[0][1], "221")
        self.assertEqual(response[0][2], ["useruser", "+"])

    def testSetUserMode(self):
        user = self._loggedInUser("useruser")

        user.transport.clear()
        user.write("MODE useruser +abcd\r\n")

        response = self._response(user)
        self.assertEqual(len(response), 1)
        self.assertEqual(response[0][1], "472")

    def testGetGroupMode(self):
        user = self._loggedInUser("useruser")

        self.successResultOf(self.realm.createGroup("somechannel"))

        user.write("JOIN #somechannel\r\n")

        user.transport.clear()
        user.write("MODE #somechannel\r\n")

        response = self._response(user)
        self.assertEqual(len(response), 1)
        self.assertEqual(response[0][1], "324")

    def testSetGroupMode(self):
        user = self._loggedInUser("useruser")

        self.successResultOf(self.realm.createGroup("groupname"))

        user.write("JOIN #groupname\r\n")

        user.transport.clear()
        user.write("MODE #groupname +abcd\r\n")

        response = self._response(user)
        self.assertEqual(len(response), 1)
        self.assertEqual(response[0][1], "472")

    def testWho(self):
        group = service.Group("groupname")
        self.successResultOf(self.realm.addGroup(group))

        users = []
        for nick in "userone", "usertwo", "userthree":
            u = self._loggedInUser(nick)
            users.append(u)
            users[-1].write("JOIN #groupname\r\n")
        for user in users:
            user.transport.clear()

        users[0].write("WHO #groupname\r\n")

        r = self._response(users[0])
        self.assertFalse(self._response(users[1]))
        self.assertFalse(self._response(users[2]))

        wantusers = ["userone", "usertwo", "userthree"]
        for (prefix, code, stuff) in r[:-1]:
            self.assertEqual(prefix, "realmname")
            self.assertEqual(code, "352")

            (
                myname,
                group,
                theirname,
                theirhost,
                theirserver,
                theirnick,
                flag,
                extra,
            ) = stuff
            self.assertEqual(myname, "userone")
            self.assertEqual(group, "#groupname")
            self.assertTrue(theirname in wantusers)
            self.assertEqual(theirhost, "realmname")
            self.assertEqual(theirserver, "realmname")
            wantusers.remove(theirnick)
            self.assertEqual(flag, "H")
            self.assertEqual(extra, "0 " + theirnick)
        self.assertFalse(wantusers)

        prefix, code, stuff = r[-1]
        self.assertEqual(prefix, "realmname")
        self.assertEqual(code, "315")
        myname, channel, extra = stuff
        self.assertEqual(myname, "userone")
        self.assertEqual(channel, "#groupname")
        self.assertEqual(extra, "End of /WHO list.")

    def testList(self):
        user = self._loggedInUser("someuser")
        user.transport.clear()

        somegroup = self.successResultOf(self.realm.createGroup("somegroup"))
        somegroup.size = lambda: succeed(17)
        somegroup.meta["topic"] = "this is the topic woo"

        # Test one group
        user.write("LIST #somegroup\r\n")

        r = self._response(user)
        self.assertEqual(len(r), 2)
        resp, end = r

        self.assertEqual(resp[0], "realmname")
        self.assertEqual(resp[1], "322")
        self.assertEqual(resp[2][0], "someuser")
        self.assertEqual(resp[2][1], "somegroup")
        self.assertEqual(resp[2][2], "17")
        self.assertEqual(resp[2][3], "this is the topic woo")

        self.assertEqual(end[0], "realmname")
        self.assertEqual(end[1], "323")
        self.assertEqual(end[2][0], "someuser")
        self.assertEqual(end[2][1], "End of /LIST")

        user.transport.clear()
        # Test all groups

        user.write("LIST\r\n")
        r = self._response(user)
        self.assertEqual(len(r), 2)

        fg1, end = r

        self.assertEqual(fg1[1], "322")
        self.assertEqual(fg1[2][1], "somegroup")
        self.assertEqual(fg1[2][2], "17")
        self.assertEqual(fg1[2][3], "this is the topic woo")

        self.assertEqual(end[1], "323")

    def testWhois(self):
        user = self._loggedInUser("someguy")

        otherguy = service.User("otherguy")
        otherguy.itergroups = lambda: iter(
            [service.Group("groupA"), service.Group("groupB")]
        )
        otherguy.signOn = 10
        otherguy.lastMessage = time.time() - 15

        self.successResultOf(self.realm.addUser(otherguy))

        user.transport.clear()
        user.write("WHOIS otherguy\r\n")
        r = self._response(user)

        self.assertEqual(len(r), 5)
        wuser, wserver, idle, channels, end = r

        self.assertEqual(wuser[0], "realmname")
        self.assertEqual(wuser[1], "311")
        self.assertEqual(wuser[2][0], "someguy")
        self.assertEqual(wuser[2][1], "otherguy")
        self.assertEqual(wuser[2][2], "otherguy")
        self.assertEqual(wuser[2][3], "realmname")
        self.assertEqual(wuser[2][4], "*")
        self.assertEqual(wuser[2][5], "otherguy")

        self.assertEqual(wserver[0], "realmname")
        self.assertEqual(wserver[1], "312")
        self.assertEqual(wserver[2][0], "someguy")
        self.assertEqual(wserver[2][1], "otherguy")
        self.assertEqual(wserver[2][2], "realmname")
        self.assertEqual(wserver[2][3], "Hi mom!")

        self.assertEqual(idle[0], "realmname")
        self.assertEqual(idle[1], "317")
        self.assertEqual(idle[2][0], "someguy")
        self.assertEqual(idle[2][1], "otherguy")
        self.assertEqual(idle[2][2], "15")
        self.assertEqual(idle[2][3], "10")
        self.assertEqual(idle[2][4], "seconds idle, signon time")

        self.assertEqual(channels[0], "realmname")
        self.assertEqual(channels[1], "319")
        self.assertEqual(channels[2][0], "someguy")
        self.assertEqual(channels[2][1], "otherguy")
        self.assertEqual(channels[2][2], "#groupA #groupB")

        self.assertEqual(end[0], "realmname")
        self.assertEqual(end[1], "318")
        self.assertEqual(end[2][0], "someguy")
        self.assertEqual(end[2][1], "otherguy")
        self.assertEqual(end[2][2], "End of WHOIS list.")


class TestMind(service.PBMind):
    def __init__(self, *a, **kw):
        self.joins = []
        self.parts = []
        self.messages = []
        self.meta = []

    def remote_userJoined(self, user, group):
        self.joins.append((user, group))

    def remote_userLeft(self, user, group, reason):
        self.parts.append((user, group, reason))

    def remote_receive(self, sender, recipient, message):
        self.messages.append((sender, recipient, message))

    def remote_groupMetaUpdate(self, group, meta):
        self.meta.append((group, meta))


pb.setUnjellyableForClass(TestMind, service.PBMindReference)


class PBProtocolTests(unittest.TestCase):
    def setUp(self):
        self.realm = service.InMemoryWordsRealm("realmname")
        self.checker = checkers.InMemoryUsernamePasswordDatabaseDontUse()
        self.portal = portal.Portal(self.realm, [self.checker])
        self.serverFactory = pb.PBServerFactory(self.portal)
        self.serverFactory.protocol = self._protocolFactory
        self.serverFactory.unsafeTracebacks = True
        self.clientFactory = pb.PBClientFactory()
        self.clientFactory.unsafeTracebacks = True
        self.serverPort = reactor.listenTCP(0, self.serverFactory)
        self.clientConn = reactor.connectTCP(
            "127.0.0.1", self.serverPort.getHost().port, self.clientFactory
        )

    def _protocolFactory(self, *args, **kw):
        self._serverProtocol = pb.Broker(0)
        return self._serverProtocol

    def tearDown(self):
        d3 = Deferred()
        self._serverProtocol.notifyOnDisconnect(lambda: d3.callback(None))
        return DeferredList(
            [
                maybeDeferred(self.serverPort.stopListening),
                maybeDeferred(self.clientConn.disconnect),
                d3,
            ]
        )

    def _loggedInAvatar(self, name, password, mind):
        nameBytes = name
        if isinstance(name, str):
            nameBytes = name.encode("ascii")
        creds = credentials.UsernamePassword(nameBytes, password)
        self.checker.addUser(nameBytes, password)
        d = self.realm.createUser(name)
        d.addCallback(lambda ign: self.clientFactory.login(creds, mind))
        return d

    @defer.inlineCallbacks
    def testGroups(self):
        mindone = TestMind()
        one = yield self._loggedInAvatar("one", b"p1", mindone)

        mindtwo = TestMind()
        two = yield self._loggedInAvatar("two", b"p2", mindtwo)

        mindThree = TestMind()
        three = yield self._loggedInAvatar(b"three", b"p3", mindThree)

        yield self.realm.createGroup("foobar")
        yield self.realm.createGroup(b"barfoo")

        groupone = yield one.join("foobar")
        grouptwo = yield two.join(b"barfoo")

        yield two.join("foobar")
        yield two.join(b"barfoo")
        yield three.join("foobar")

        yield groupone.send({b"text": b"hello, monkeys"})

        yield groupone.leave()
        yield grouptwo.leave()