Changeset 268:e61ddf6f2d41

Timestamp:

08/11/11 20:32:59 (7 months ago)

Author:

Menno Smits <menno@…>

Branch:

default

Message:

NOOP support (#74)

Untagged response handling shared with IDLE.

Files:

• imapclient/imapclient.py (modified) (5 diffs)
• imapclient/test/test_IMAPClient.py (modified) (3 diffs)
• livetest.py (modified) (1 diff)

imapclient/imapclient.py

@@ -316 +316 @@
             out[key] = value
         return out
+
+    def noop(self):
+        """Execute the NOOP command.
+
+        This command returns immediately, returning any server side
+        status updates. It can also be used to reset any auto-logout
+        timers.
+
+        The return value is the server command response message
+        followed by a list of status responses. For example::
+
+            ('NOOP completed.',
+             [(4, 'EXISTS'),
+              (3, 'FETCH', ('FLAGS', ('bar', 'sne'))),
+              (6, 'FETCH', ('FLAGS', ('sne',)))])
+
+        """
+        tag = self._imap._command('NOOP')
+        return self._consume_until_tagged_response(tag, 'NOOP')
 
     def idle(self):
@@ -373 +392 @@
                         break
                     else:
-                        resps.append(_parse_idle_response(line))
+                        resps.append(_parse_untagged_response(line))
             return resps
         finally:
@@ -393 +412 @@
         """
         self._imap.send('DONE\r\n')
-        # Slurp up any remaining IDLE responses until the IDLE is done
-        tag = self._idle_tag
-        tagged_commands = self._imap.tagged_commands
-        resps = []
-        while True:
-            line = self._imap._get_response()
-            if tagged_commands[tag]:
-                break
-            resps.append(_parse_idle_response(line))
-        self._idle_tag = None
-        typ, data = tagged_commands.pop(tag)
-        self._checkok('idle', typ, data)
-        return data[0], resps
+        return self._consume_until_tagged_response(self._idle_tag, 'IDLE')
 
     def folder_status(self, folder, what=None):
@@ -753 +760 @@
         if typ != expected:
             raise self.Error('%s failed: %r' % (command, data[0]))
+
+    def _consume_until_tagged_response(self, tag, command):
+        tagged_commands = self._imap.tagged_commands
+        resps = []
+        while True:
+            line = self._imap._get_response()
+            if tagged_commands[tag]:
+                break
+            resps.append(_parse_untagged_response(line))
+        typ, data = tagged_commands.pop(tag)
+        self._checkok(command, typ, data)
+        return data[0], resps
 
     def _checkok(self, command, typ, data):
@@ -859 +878 @@
 
 
-def _parse_idle_response(text):
+def _parse_untagged_response(text):
     assert text.startswith('* ')
     text = text[2:]

imapclient/test/test_IMAPClient.py

@@ -169 +169 @@
 
 
-class TestIdle(IMAPClientTest):
+class TestIdleAndNoop(IMAPClientTest):
 
     def test_idle(self):
@@ -242 +242 @@
     def test_idle_done(self):
         self.client._idle_tag = sentinel.tag
-        self.client._imap.tagged_commands = {sentinel.tag: None}
+
+        mockSend = Mock()
+        self.client._imap.send = mockSend
+        mockConsume = Mock(return_value=sentinel.out)
+        self.client._consume_until_tagged_response = mockConsume
+
+        result = self.client.idle_done()
+
+        mockSend.assert_called_with('DONE\r\n')
+        mockConsume.assert_called_with(sentinel.tag, 'IDLE')
+        self.assertEquals(result, sentinel.out)
+
+    def test_noop(self):
+        mockCommand = Mock(return_value=sentinel.tag)
+        self.client._imap._command = mockCommand
+        mockConsume = Mock(return_value=sentinel.out)
+        self.client._consume_until_tagged_response = mockConsume
+
+        result = self.client.noop()
+
+        mockCommand.assert_called_with('NOOP')
+        mockConsume.assert_called_with(sentinel.tag, 'NOOP')
+        self.assertEquals(result, sentinel.out)
+
+    def test_consume_until_tagged_response(self):
+        client = self.client
+        client._imap.tagged_commands = {sentinel.tag: None}
 
         counter = itertools.count()
@@ -249 +275 @@
             if count == 0:
                 return '* 99 EXISTS'
-            self.client._imap.tagged_commands[sentinel.tag] = ('OK', ['Idle done'])
-        self.client._imap._get_response = fake_get_response
+            client._imap.tagged_commands[sentinel.tag] = ('OK', ['Idle done'])
+        client._imap._get_response = fake_get_response
             
-        text, responses = self.client.idle_done()
-
-        self.assertEqual(self.client._imap.tagged_commands, {})
+        text, responses = client._consume_until_tagged_response(sentinel.tag,
+                                                                'IDLE')
+        self.assertEqual(client._imap.tagged_commands, {})
         self.assertEqual(text, 'Idle done')
         self.assertListEqual([(99, 'EXISTS')], responses)
 
 
+                         
 class TestDebugLogging(IMAPClientTest):
 

livetest.py

@@ -507 +507 @@
             self.assertGreater(len(text), 0)
 
+        def test_noop(self):
+            self.client.select_folder('INBOX')
+
+            # Initially there should be no responses
+            text, resps = self.client.noop()
+            self.assertTrue(isinstance(text, str))
+            self.assertGreater(len(text), 0)
+            self.assertEquals(resps, [])
+
+            # Start a new connection and upload a new message
+            client2 = create_client_from_config(conf)
+            client2.select_folder('INBOX')
+            client2.append('INBOX', SIMPLE_MESSAGE)
+
+            # Check for this addition in the NOOP data
+            msg, resps = self.client.noop()
+            self.assertTrue(isinstance(text, str))
+            self.assertGreater(len(text), 0)
+            self.assertTrue(isinstance(resps, list))
+            self.assertIn((1, 'EXISTS'), resps)
 
     return LiveTest