Changeset 160:33ef849a77d8

Timestamp:

Jan 8, 2012, 9:26:02 AM (9 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Use symbolic constants instead of integers MUC status code.

Instead of using normal constant values for representing MUC status codes,
UserPresence now uses twisted.python.constants to define these. This
makes code better to understand and helps debugging.

If a user presence includes one or more status codes, they are stored in the
mucStatuses attribute, as an instance of Statuses. This replaces the
former statusCodes attribute.

Location:

wokkel

Files:

• compat.py (modified) (2 diffs)
• iwokkel.py (modified) (2 diffs)
• muc.py (modified) (7 diffs)
• test/test_compat.py (modified) (3 diffs)
• test/test_muc.py (modified) (9 diffs)

wokkel/compat.py

@@ -3 +3 @@
 # Copyright (c) Twisted Matrix Laboratories.
 # See LICENSE for details.
+
+"""
+Compatibility module to provide backwards compatibility with Twisted features.
+"""
+
+__all__ = ['BootstrapMixin', 'XmlStreamServerFactory', 'IQ',
+           'NamedConstant', 'ValueConstant', 'Names', 'Values']
+
+from itertools import count
 
 from twisted.internet import protocol
@@ -116 +125 @@
             # Patch the XmlStream instance so that it has a _callLater
             self._xmlstream._callLater = reactor.callLater
+
+
+
+_unspecified = object()
+_constantOrder = count().next
+
+
+class _Constant(object):
+    """
+    @ivar _index: A C{int} allocated from a shared counter in order to keep
+        track of the order in which L{_Constant}s are instantiated.
+
+    @ivar name: A C{str} giving the name of this constant; only set once the
+        constant is initialized by L{_ConstantsContainer}.
+
+    @ivar _container: The L{_ConstantsContainer} subclass this constant belongs
+        to; only set once the constant is initialized by that subclass.
+    """
+    def __init__(self):
+        self._index = _constantOrder()
+
+
+    def __get__(self, oself, cls):
+        """
+        Ensure this constant has been initialized before returning it.
+        """
+        cls._initializeEnumerants()
+        return self
+
+
+    def __repr__(self):
+        """
+        Return text identifying both which constant this is and which collection
+        it belongs to.
+        """
+        return "<%s=%s>" % (self._container.__name__, self.name)
+
+
+    def _realize(self, container, name, value):
+        """
+        Complete the initialization of this L{_Constant}.
+
+        @param container: The L{_ConstantsContainer} subclass this constant is
+            part of.
+
+        @param name: The name of this constant in its container.
+
+        @param value: The value of this constant; not used, as named constants
+            have no value apart from their identity.
+        """
+        self._container = container
+        self.name = name
+
+
+
+class _EnumerantsInitializer(object):
+    """
+    L{_EnumerantsInitializer} is a descriptor used to initialize a cache of
+    objects representing named constants for a particular L{_ConstantsContainer}
+    subclass.
+    """
+    def __get__(self, oself, cls):
+        """
+        Trigger the initialization of the enumerants cache on C{cls} and then
+        return it.
+        """
+        cls._initializeEnumerants()
+        return cls._enumerants
+
+
+
+class _ConstantsContainer(object):
+    """
+    L{_ConstantsContainer} is a class with attributes used as symbolic
+    constants.  It is up to subclasses to specify what kind of constants are
+    allowed.
+
+    @cvar _constantType: Specified by a L{_ConstantsContainer} subclass to
+        specify the type of constants allowed by that subclass.
+
+    @cvar _enumerantsInitialized: A C{bool} tracking whether C{_enumerants} has
+        been initialized yet or not.
+
+    @cvar _enumerants: A C{dict} mapping the names of constants (eg
+        L{NamedConstant} instances) found in the class definition to those
+        instances.  This is initialized via the L{_EnumerantsInitializer}
+        descriptor the first time it is accessed.
+    """
+    _constantType = None
+
+    _enumerantsInitialized = False
+    _enumerants = _EnumerantsInitializer()
+
+    def __new__(cls):
+        """
+        Classes representing constants containers are not intended to be
+        instantiated.
+
+        The class object itself is used directly.
+        """
+        raise TypeError("%s may not be instantiated." % (cls.__name__,))
+
+
+    def _initializeEnumerants(cls):
+        """
+        Find all of the L{NamedConstant} instances in the definition of C{cls},
+        initialize them with constant values, and build a mapping from their
+        names to them to attach to C{cls}.
+        """
+        if not cls._enumerantsInitialized:
+            constants = []
+            for (name, descriptor) in cls.__dict__.iteritems():
+                if isinstance(descriptor, cls._constantType):
+                    constants.append((descriptor._index, name, descriptor))
+            enumerants = {}
+            for (index, enumerant, descriptor) in constants:
+                value = cls._constantFactory(enumerant)
+                descriptor._realize(cls, enumerant, value)
+                enumerants[enumerant] = descriptor
+            # Replace the _enumerants descriptor with the result so future
+            # access will go directly to the values.  The _enumerantsInitialized
+            # flag is still necessary because NamedConstant.__get__ may also
+            # call this method.
+            cls._enumerants = enumerants
+            cls._enumerantsInitialized = True
+    _initializeEnumerants = classmethod(_initializeEnumerants)
+
+
+    def _constantFactory(cls, name):
+        """
+        Construct the value for a new constant to add to this container.
+
+        @param name: The name of the constant to create.
+
+        @return: L{NamedConstant} instances have no value apart from identity,
+            so return a meaningless dummy value.
+        """
+        return _unspecified
+    _constantFactory = classmethod(_constantFactory)
+
+
+    def lookupByName(cls, name):
+        """
+        Retrieve a constant by its name or raise a C{ValueError} if there is no
+        constant associated with that name.
+
+        @param name: A C{str} giving the name of one of the constants defined by
+            C{cls}.
+
+        @raise ValueError: If C{name} is not the name of one of the constants
+            defined by C{cls}.
+
+        @return: The L{NamedConstant} associated with C{name}.
+        """
+        if name in cls._enumerants:
+            return getattr(cls, name)
+        raise ValueError(name)
+    lookupByName = classmethod(lookupByName)
+
+
+    def iterconstants(cls):
+        """
+        Iteration over a L{Names} subclass results in all of the constants it
+        contains.
+
+        @return: an iterator the elements of which are the L{NamedConstant}
+            instances defined in the body of this L{Names} subclass.
+        """
+        constants = cls._enumerants.values()
+        constants.sort(key=lambda descriptor: descriptor._index)
+        return iter(constants)
+    iterconstants = classmethod(iterconstants)
+
+
+
+class NamedConstant(_Constant):
+    """
+    L{NamedConstant} defines an attribute to be a named constant within a
+    collection defined by a L{Names} subclass.
+
+    L{NamedConstant} is only for use in the definition of L{Names}
+    subclasses.  Do not instantiate L{NamedConstant} elsewhere and do not
+    subclass it.
+    """
+
+
+
+class Names(_ConstantsContainer):
+    """
+    A L{Names} subclass contains constants which differ only in their names and
+    identities.
+    """
+    _constantType = NamedConstant
+
+
+
+class ValueConstant(_Constant):
+    """
+    L{ValueConstant} defines an attribute to be a named constant within a
+    collection defined by a L{Values} subclass.
+
+    L{ValueConstant} is only for use in the definition of L{Values} subclasses.
+    Do not instantiate L{ValueConstant} elsewhere and do not subclass it.
+    """
+    def __init__(self, value):
+        _Constant.__init__(self)
+        self.value = value
+
+
+
+class Values(_ConstantsContainer):
+    """
+    A L{Values} subclass contains constants which are associated with arbitrary
+    values.
+    """
+    _constantType = ValueConstant
+
+    def lookupByValue(cls, value):
+        """
+        Retrieve a constant by its value or raise a C{ValueError} if there is no
+        constant associated with that value.
+
+        @param value: The value of one of the constants defined by C{cls}.
+
+        @raise ValueError: If C{value} is not the value of one of the constants
+            defined by C{cls}.
+
+        @return: The L{ValueConstant} associated with C{value}.
+        """
+        for constant in cls.iterconstants():
+            if constant.value == value:
+                return constant
+        raise ValueError(value)
+    lookupByValue = classmethod(lookupByValue)

wokkel/iwokkel.py

@@ -806 +806 @@
 class IMUCClient(Interface):
     """
-    Multi-User Chat Client
+    Multi-User Chat Client.
 
     A client interface to XEP-045 : http://xmpp.org/extensions/xep-0045.html
-
     """
 
@@ -1028 +1027 @@
         @type sender: L{jid.JID}
         """
+
+
+class IMUCStatuses(Interface):
+    """
+    Interface for a container of Multi-User Chat status conditions.
+    """
+
+    def __contains__(key):
+        """
+        Return if a status exists in the container.
+        """
+
+
+    def __iter__():
+        """
+        Return an iterator over the status codes.
+        """
+
+
+    def __len__():
+        """
+        Return the number of status conditions.
+        """

wokkel/muc.py

@@ -8 +8 @@
 
 This protocol is specified in
-U{XEP-0045<http://www.xmpp.org/extensions/xep-0045.html>}.
+U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
 """
 from dateutil.tz import tzutc
@@ -18 +18 @@
 from twisted.words.xish import domish
 
-from wokkel import data_form, generic, xmppim
+from wokkel import data_form, generic, iwokkel, xmppim
+from wokkel.compat import Values, ValueConstant
 from wokkel.delay import Delay, DelayMixin
 from wokkel.subprotocols import XMPPHandler
@@ -41 +42 @@
 
 DEFER_TIMEOUT = 30 # basic timeout is 30 seconds
+
+class STATUS_CODE(Values):
+    REALJID_PUBLIC = ValueConstant(100)
+    AFFILIATION_CHANGED = ValueConstant(101)
+    UNAVAILABLE_SHOWN = ValueConstant(102)
+    UNAVAILABLE_NOT_SHOWN = ValueConstant(103)
+    CONFIGURATION_CHANGED = ValueConstant(104)
+    SELF_PRESENCE = ValueConstant(110)
+    LOGGING_ENABLED = ValueConstant(170)
+    LOGGING_DISABLED = ValueConstant(171)
+    NON_ANONYMOUS = ValueConstant(172)
+    SEMI_ANONYMOUS = ValueConstant(173)
+    FULLY_ANONYMOUS = ValueConstant(174)
+    ROOM_CREATED = ValueConstant(201)
+    NICK_ASSIGNED = ValueConstant(210)
+    BANNED = ValueConstant(301)
+    NEW_NICK = ValueConstant(303)
+    KICKED = ValueConstant(307)
+    REMOVED_AFFILIATION = ValueConstant(321)
+    REMOVED_MEMBERSHIP = ValueConstant(322)
+    REMOVED_SHUTDOWN = ValueConstant(332)
+
+
+class Statuses(set):
+    """
+    Container of MUC status conditions.
+
+    This is currently implemented as a set of constant values from
+    L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that
+    defines the supported operations. Even though this class currently derives
+    from C{set}, future versions might not. This provides an upgrade path to
+    cater for extensible status conditions, as defined in
+    U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.
+    """
+    implements(iwokkel.IMUCStatuses)
 
 
@@ -354 +390 @@
     """
     Availability presence sent from MUC service to client.
+
+    @ivar affiliation: Affiliation of the entity to the room.
+    @type affiliation: C{unicode}
+
+    @ivar role: Role of the entity in the room.
+    @type role: C{unicode}
+
+    @ivar entity: The real JID of the entity this presence is from.
+    @type entity: L{jid.JID}
+
+    @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.
+        See L{Statuses} for usage notes.
+    @type mucStatuses: L{Statuses}
+
+    @ivar nick: The nick name of the entity in the room.
+    @type nick: C{unicode}
     """
 
@@ -361 +413 @@
     nick = None
 
-    statusCodes = None
+    mucStatuses = None
 
     childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}
 
+    def __init__(self, *args, **kwargs):
+        self.mucStatuses = Statuses()
+        xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)
+
+
     def _childParser_mucUser(self, element):
-        statusCodes = set()
-
+        """
+        Parse the MUC user extension element.
+        """
         for child in element.elements():
             if child.uri != NS_MUC_USER:
@@ -374 +432 @@
             elif child.name == 'status':
                 try:
-                    statusCode = int(child.getAttribute('code'))
+                    value = int(child.getAttribute('code'))
+                    statusCode = STATUS_CODE.lookupByValue(value)
                 except (TypeError, ValueError):
                     continue
 
-                statusCodes.add(statusCode)
+                self.mucStatuses.add(statusCode)
 
             elif child.name == 'item':
@@ -393 +452 @@
             # TODO: destroy
 
-        if statusCodes:
-            self.statusCodes = statusCodes
 
 

wokkel/test/test_compat.py

@@ -1 @@
-# Copyright (c) 2001-2008 Twisted Matrix Laboratories.
+# Copyright (c) Twisted Matrix Laboratories.
 # Copyright (c) Ralph Meijer.
 # See LICENSE for details.
@@ -14 +14 @@
 from twisted.words.xish import utility
 from twisted.words.protocols.jabber import xmlstream
+
 from wokkel.compat import BootstrapMixin, IQ, XmlStreamServerFactory
+from wokkel.compat import NamedConstant, Names, ValueConstant, Values
 
 class DummyProtocol(protocol.Protocol, utility.EventDispatcher):
@@ -208 +210 @@
         self.assertFalse(xs.iqDeferreds)
         return d
+
+
+
+class NamedConstantTests(unittest.TestCase):
+    """
+    Tests for the L{twisted.python.constants.NamedConstant} class which is used
+    to represent individual values.
+    """
+    def setUp(self):
+        """
+        Create a dummy container into which constants can be placed.
+        """
+        class foo(Names):
+            pass
+        self.container = foo
+
+
+    def test_name(self):
+        """
+        The C{name} attribute of a L{NamedConstant} refers to the value passed
+        for the C{name} parameter to C{_realize}.
+        """
+        name = NamedConstant()
+        name._realize(self.container, "bar", None)
+        self.assertEqual("bar", name.name)
+
+
+    def test_representation(self):
+        """
+        The string representation of an instance of L{NamedConstant} includes
+        the container the instances belongs to as well as the instance's name.
+        """
+        name = NamedConstant()
+        name._realize(self.container, "bar", None)
+        self.assertEqual("<foo=bar>", repr(name))
+
+
+    def test_equality(self):
+        """
+        A L{NamedConstant} instance compares equal to itself.
+        """
+        name = NamedConstant()
+        name._realize(self.container, "bar", None)
+        self.assertTrue(name == name)
+        self.assertFalse(name != name)
+
+
+    def test_nonequality(self):
+        """
+        Two different L{NamedConstant} instances do not compare equal to each
+        other.
+        """
+        first = NamedConstant()
+        first._realize(self.container, "bar", None)
+        second = NamedConstant()
+        second._realize(self.container, "bar", None)
+        self.assertFalse(first == second)
+        self.assertTrue(first != second)
+
+
+    def test_hash(self):
+        """
+        Because two different L{NamedConstant} instances do not compare as equal
+        to each other, they also have different hashes to avoid collisions when
+        added to a C{dict} or C{set}.
+        """
+        first = NamedConstant()
+        first._realize(self.container, "bar", None)
+        second = NamedConstant()
+        second._realize(self.container, "bar", None)
+        self.assertNotEqual(hash(first), hash(second))
+
+
+
+class _ConstantsTestsMixin(object):
+    """
+    Mixin defining test helpers common to multiple types of constants
+    collections.
+    """
+    def _notInstantiableTest(self, name, cls):
+        """
+        Assert that an attempt to instantiate the constants class raises
+        C{TypeError}.
+
+        @param name: A C{str} giving the name of the constants collection.
+        @param cls: The constants class to test.
+        """
+        exc = self.assertRaises(TypeError, cls)
+        self.assertEqual(name + " may not be instantiated.", str(exc))
+
+
+
+class NamesTests(unittest.TestCase, _ConstantsTestsMixin):
+    """
+    Tests for L{twisted.python.constants.Names}, a base class for containers of
+    related constaints.
+    """
+    def setUp(self):
+        """
+        Create a fresh new L{Names} subclass for each unit test to use.  Since
+        L{Names} is stateful, re-using the same subclass across test methods
+        makes exercising all of the implementation code paths difficult.
+        """
+        class METHOD(Names):
+            """
+            A container for some named constants to use in unit tests for
+            L{Names}.
+            """
+            GET = NamedConstant()
+            PUT = NamedConstant()
+            POST = NamedConstant()
+            DELETE = NamedConstant()
+
+        self.METHOD = METHOD
+
+
+    def test_notInstantiable(self):
+        """
+        A subclass of L{Names} raises C{TypeError} if an attempt is made to
+        instantiate it.
+        """
+        self._notInstantiableTest("METHOD", self.METHOD)
+
+
+    def test_symbolicAttributes(self):
+        """
+        Each name associated with a L{NamedConstant} instance in the definition
+        of a L{Names} subclass is available as an attribute on the resulting
+        class.
+        """
+        self.assertTrue(hasattr(self.METHOD, "GET"))
+        self.assertTrue(hasattr(self.METHOD, "PUT"))
+        self.assertTrue(hasattr(self.METHOD, "POST"))
+        self.assertTrue(hasattr(self.METHOD, "DELETE"))
+
+
+    def test_withoutOtherAttributes(self):
+        """
+        As usual, names not defined in the class scope of a L{Names}
+        subclass are not available as attributes on the resulting class.
+        """
+        self.assertFalse(hasattr(self.METHOD, "foo"))
+
+
+    def test_representation(self):
+        """
+        The string representation of a constant on a L{Names} subclass includes
+        the name of the L{Names} subclass and the name of the constant itself.
+        """
+        self.assertEqual("<METHOD=GET>", repr(self.METHOD.GET))
+
+
+    def test_lookupByName(self):
+        """
+        Constants can be looked up by name using L{Names.lookupByName}.
+        """
+        method = self.METHOD.lookupByName("GET")
+        self.assertIdentical(self.METHOD.GET, method)
+
+
+    def test_notLookupMissingByName(self):
+        """
+        Names not defined with a L{NamedConstant} instance cannot be looked up
+        using L{Names.lookupByName}.
+        """
+        self.assertRaises(ValueError, self.METHOD.lookupByName, "lookupByName")
+        self.assertRaises(ValueError, self.METHOD.lookupByName, "__init__")
+        self.assertRaises(ValueError, self.METHOD.lookupByName, "foo")
+
+
+    def test_name(self):
+        """
+        The C{name} attribute of one of the named constants gives that
+        constant's name.
+        """
+        self.assertEqual("GET", self.METHOD.GET.name)
+
+
+    def test_attributeIdentity(self):
+        """
+        Repeated access of an attribute associated with a L{NamedConstant} value
+        in a L{Names} subclass results in the same object.
+        """
+        self.assertIdentical(self.METHOD.GET, self.METHOD.GET)
+
+
+    def test_iterconstants(self):
+        """
+        L{Names.iterconstants} returns an iterator over all of the constants
+        defined in the class, in the order they were defined.
+        """
+        constants = list(self.METHOD.iterconstants())
+        self.assertEqual(
+            [self.METHOD.GET, self.METHOD.PUT,
+             self.METHOD.POST, self.METHOD.DELETE],
+            constants)
+
+
+    def test_attributeIterconstantsIdentity(self):
+        """
+        The constants returned from L{Names.iterconstants} are identical to the
+        constants accessible using attributes.
+        """
+        constants = list(self.METHOD.iterconstants())
+        self.assertIdentical(self.METHOD.GET, constants[0])
+        self.assertIdentical(self.METHOD.PUT, constants[1])
+        self.assertIdentical(self.METHOD.POST, constants[2])
+        self.assertIdentical(self.METHOD.DELETE, constants[3])
+
+
+    def test_iterconstantsIdentity(self):
+        """
+        The constants returned from L{Names.iterconstants} are identical on each
+        call to that method.
+        """
+        constants = list(self.METHOD.iterconstants())
+        again = list(self.METHOD.iterconstants())
+        self.assertIdentical(again[0], constants[0])
+        self.assertIdentical(again[1], constants[1])
+        self.assertIdentical(again[2], constants[2])
+        self.assertIdentical(again[3], constants[3])
+
+
+    def test_initializedOnce(self):
+        """
+        L{Names._enumerants} is initialized once and its value re-used on
+        subsequent access.
+        """
+        first = self.METHOD._enumerants
+        self.METHOD.GET # Side-effects!
+        second = self.METHOD._enumerants
+        self.assertIdentical(first, second)
+
+
+
+class ValuesTests(unittest.TestCase, _ConstantsTestsMixin):
+    """
+    Tests for L{twisted.python.constants.Names}, a base class for containers of
+    related constaints with arbitrary values.
+    """
+    def setUp(self):
+        """
+        Create a fresh new L{Values} subclass for each unit test to use.  Since
+        L{Values} is stateful, re-using the same subclass across test methods
+        makes exercising all of the implementation code paths difficult.
+        """
+        class STATUS(Values):
+            OK = ValueConstant("200")
+            NOT_FOUND = ValueConstant("404")
+
+        self.STATUS = STATUS
+
+
+    def test_notInstantiable(self):
+        """
+        A subclass of L{Values} raises C{TypeError} if an attempt is made to
+        instantiate it.
+        """
+        self._notInstantiableTest("STATUS", self.STATUS)
+
+
+    def test_symbolicAttributes(self):
+        """
+        Each name associated with a L{ValueConstant} instance in the definition
+        of a L{Values} subclass is available as an attribute on the resulting
+        class.
+        """
+        self.assertTrue(hasattr(self.STATUS, "OK"))
+        self.assertTrue(hasattr(self.STATUS, "NOT_FOUND"))
+
+
+    def test_withoutOtherAttributes(self):
+        """
+        As usual, names not defined in the class scope of a L{Values}
+        subclass are not available as attributes on the resulting class.
+        """
+        self.assertFalse(hasattr(self.STATUS, "foo"))
+
+
+    def test_representation(self):
+        """
+        The string representation of a constant on a L{Values} subclass includes
+        the name of the L{Values} subclass and the name of the constant itself.
+        """
+        self.assertEqual("<STATUS=OK>", repr(self.STATUS.OK))
+
+
+    def test_lookupByName(self):
+        """
+        Constants can be looked up by name using L{Values.lookupByName}.
+        """
+        method = self.STATUS.lookupByName("OK")
+        self.assertIdentical(self.STATUS.OK, method)
+
+
+    def test_notLookupMissingByName(self):
+        """
+        Names not defined with a L{ValueConstant} instance cannot be looked up
+        using L{Values.lookupByName}.
+        """
+        self.assertRaises(ValueError, self.STATUS.lookupByName, "lookupByName")
+        self.assertRaises(ValueError, self.STATUS.lookupByName, "__init__")
+        self.assertRaises(ValueError, self.STATUS.lookupByName, "foo")
+
+
+    def test_lookupByValue(self):
+        """
+        Constants can be looked up by their associated value, defined by the
+        argument passed to L{ValueConstant}, using L{Values.lookupByValue}.
+        """
+        status = self.STATUS.lookupByValue("200")
+        self.assertIdentical(self.STATUS.OK, status)
+
+
+    def test_lookupDuplicateByValue(self):
+        """
+        If more than one constant is associated with a particular value,
+        L{Values.lookupByValue} returns whichever of them is defined first.
+        """
+        class TRANSPORT_MESSAGE(Values):
+            """
+            Message types supported by an SSH transport.
+            """
+            KEX_DH_GEX_REQUEST_OLD = ValueConstant(30)
+            KEXDH_INIT = ValueConstant(30)
+
+        self.assertIdentical(
+            TRANSPORT_MESSAGE.lookupByValue(30),
+            TRANSPORT_MESSAGE.KEX_DH_GEX_REQUEST_OLD)
+
+
+    def test_notLookupMissingByValue(self):
+        """
+        L{Values.lookupByValue} raises L{ValueError} when called with a value
+        with which no constant is associated.
+        """
+        self.assertRaises(ValueError, self.STATUS.lookupByValue, "OK")
+        self.assertRaises(ValueError, self.STATUS.lookupByValue, 200)
+        self.assertRaises(ValueError, self.STATUS.lookupByValue, "200.1")
+
+
+    def test_name(self):
+        """
+        The C{name} attribute of one of the constants gives that constant's
+        name.
+        """
+        self.assertEqual("OK", self.STATUS.OK.name)
+
+
+    def test_attributeIdentity(self):
+        """
+        Repeated access of an attribute associated with a L{ValueConstant} value
+        in a L{Values} subclass results in the same object.
+        """
+        self.assertIdentical(self.STATUS.OK, self.STATUS.OK)
+
+
+    def test_iterconstants(self):
+        """
+        L{Values.iterconstants} returns an iterator over all of the constants
+        defined in the class, in the order they were defined.
+        """
+        constants = list(self.STATUS.iterconstants())
+        self.assertEqual(
+            [self.STATUS.OK, self.STATUS.NOT_FOUND],
+            constants)
+
+
+    def test_attributeIterconstantsIdentity(self):
+        """
+        The constants returned from L{Values.iterconstants} are identical to the
+        constants accessible using attributes.
+        """
+        constants = list(self.STATUS.iterconstants())
+        self.assertIdentical(self.STATUS.OK, constants[0])
+        self.assertIdentical(self.STATUS.NOT_FOUND, constants[1])
+
+
+    def test_iterconstantsIdentity(self):
+        """
+        The constants returned from L{Values.iterconstants} are identical on
+        each call to that method.
+        """
+        constants = list(self.STATUS.iterconstants())
+        again = list(self.STATUS.iterconstants())
+        self.assertIdentical(again[0], constants[0])
+        self.assertIdentical(again[1], constants[1])
+
+
+    def test_initializedOnce(self):
+        """
+        L{Values._enumerants} is initialized once and its value re-used on
+        subsequent access.
+        """
+        first = self.STATUS._enumerants
+        self.STATUS.OK # Side-effects!
+        second = self.STATUS._enumerants
+        self.assertIdentical(first, second)

wokkel/test/test_muc.py

@@ -43 +43 @@
 
 
+class StatusCodeTest(unittest.TestCase):
+    """
+    Tests for L{muc.STATUS_CODE}.
+    """
+
+    def test_lookupByValue(self):
+        """
+        The registered MUC status codes map to STATUS_CODE value constants.
+
+        Note: the identifiers used in the dictionary of status codes are
+        borrowed from U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}
+        that defines Extensible Status Conditions for Multi-User Chat. If this
+        specification is implemented itself, the dictionary could move there.
+        """
+        codes = {
+            100: 'realjid-public',
+            101: 'affiliation-changed',
+            102: 'unavailable-shown',
+            103: 'unavailable-not-shown',
+            104: 'configuration-changed',
+            110: 'self-presence',
+            170: 'logging-enabled',
+            171: 'logging-disabled',
+            172: 'non-anonymous',
+            173: 'semi-anonymous',
+            174: 'fully-anonymous',
+            201: 'room-created',
+            210: 'nick-assigned',
+            301: 'banned',
+            303: 'new-nick',
+            307: 'kicked',
+            321: 'removed-affiliation',
+            322: 'removed-membership',
+            332: 'removed-shutdown',
+        }
+
+        for code, condition in codes.iteritems():
+            constantName = condition.replace('-', '_').upper()
+            self.assertEqual(getattr(muc.STATUS_CODE, constantName),
+                             muc.STATUS_CODE.lookupByValue(code))
+
+
+
+class StatusesTest(unittest.TestCase):
+    """
+    Tests for L{muc.Statuses}.
+    """
+
+    def setUp(self):
+        self.mucStatuses = muc.Statuses()
+        self.mucStatuses.add(muc.STATUS_CODE.SELF_PRESENCE)
+        self.mucStatuses.add(muc.STATUS_CODE.ROOM_CREATED)
+
+
+    def test_interface(self):
+        """
+        Instances of L{Statuses} provide L{iwokkel.IMUCStatuses}.
+        """
+        verify.verifyObject(iwokkel.IMUCStatuses, self.mucStatuses)
+
+
+    def test_contains(self):
+        """
+        The status contained are 'in' the container.
+        """
+        self.assertIn(muc.STATUS_CODE.SELF_PRESENCE, self.mucStatuses)
+        self.assertIn(muc.STATUS_CODE.ROOM_CREATED, self.mucStatuses)
+        self.assertNotIn(muc.STATUS_CODE.NON_ANONYMOUS, self.mucStatuses)
+
+
+    def test_iter(self):
+        """
+        All statuses can be iterated over.
+        """
+        statuses = set()
+        for status in self.mucStatuses:
+            statuses.add(status)
+
+        self.assertEqual(set([muc.STATUS_CODE.SELF_PRESENCE,
+                              muc.STATUS_CODE.ROOM_CREATED]), statuses)
+
+
+    def test_len(self):
+        """
+        The number of items in this container is returned by C{__len__}.
+        """
+        self.assertEqual(2, len(self.mucStatuses))
+
+
+
 class GroupChatTest(unittest.TestCase):
     """
-    Tests for {muc.GroupChat}.
+    Tests for L{muc.GroupChat}.
     """
 
@@ -121 +211 @@
 
 
+
 class UserPresenceTest(unittest.TestCase):
     """
@@ -126 +217 @@
     """
 
-
-    def test_toElementUnknownChild(self):
+    def test_fromElementNoUserElement(self):
+        """
+        Without user element, all associated attributes are None.
+        """
+        xml = """
+            <presence from='coven@chat.shakespeare.lit/thirdwitch'
+                      id='026B3509-2CCE-4D69-96D6-25F41FFDC408'
+                      to='hag66@shakespeare.lit/pda'>
+            </presence>
+        """
+
+        element = parseXml(xml)
+        presence = muc.UserPresence.fromElement(element)
+
+        self.assertIdentical(None, presence.affiliation)
+        self.assertIdentical(None, presence.role)
+        self.assertIdentical(None, presence.entity)
+        self.assertIdentical(None, presence.nick)
+        self.assertEqual(0, len(presence.mucStatuses))
+
+
+    def test_fromElementUnknownChild(self):
         """
         Unknown child elements are ignored.
@@ -144 +255 @@
         presence = muc.UserPresence.fromElement(element)
 
-        self.assertIdentical(None, presence.statusCodes)
-
-
-    def test_toElementStatusOne(self):
+        self.assertEqual(0, len(presence.mucStatuses))
+
+
+    def test_fromElementStatusOne(self):
         """
         Status codes are extracted.
@@ -165 +276 @@
         presence = muc.UserPresence.fromElement(element)
 
-        self.assertIn(110, presence.statusCodes)
-
-
-    def test_toElementStatusMultiple(self):
+        self.assertIn(muc.STATUS_CODE.SELF_PRESENCE, presence.mucStatuses)
+
+
+    def test_fromElementStatusMultiple(self):
         """
         Multiple status codes are all extracted.
@@ -187 +298 @@
         presence = muc.UserPresence.fromElement(element)
 
-        self.assertIn(110, presence.statusCodes)
-        self.assertIn(100, presence.statusCodes)
-
-
-    def test_toElementStatusEmpty(self):
+        self.assertIn(muc.STATUS_CODE.SELF_PRESENCE, presence.mucStatuses)
+        self.assertIn(muc.STATUS_CODE.REALJID_PUBLIC, presence.mucStatuses)
+
+
+    def test_fromElementStatusEmpty(self):
         """
         Empty status elements are ignored.
@@ -209 +320 @@
         presence = muc.UserPresence.fromElement(element)
 
-        self.assertIdentical(None, presence.statusCodes)
-
-
-    def test_toElementStatusBad(self):
+        self.assertEqual(0, len(presence.mucStatuses))
+
+
+    def test_fromElementStatusBad(self):
         """
         Bad status codes are ignored.
@@ -230 +341 @@
         presence = muc.UserPresence.fromElement(element)
 
-        self.assertIdentical(None, presence.statusCodes)
-
-
-    def test_toElementStatusUnknown(self):
-        """
-        Unknown status codes are still recorded in C{statusCodes}.
+        self.assertEqual(0, len(presence.mucStatuses))
+
+
+    def test_fromElementStatusUnknown(self):
+        """
+        Unknown status codes are not recorded in C{mucStatuses}.
         """
         xml = """
@@ -251 +362 @@
         presence = muc.UserPresence.fromElement(element)
 
-        self.assertIn(999, presence.statusCodes)
-
-
-    def test_toElementItem(self):
+        self.assertEqual(0, len(presence.mucStatuses))
+
+
+    def test_fromElementItem(self):
         """
         Item attributes are parsed properly.