Changeset 160:33ef849a77d8 for wokkel/test/test_muc.py

Timestamp:

Jan 8, 2012, 9:26:02 AM (11 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.

File:

• wokkel/test/test_muc.py (modified) (9 diffs)

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.