Changeset 26

Timestamp:

10/16/07 03:13:30 (1 year ago)

Author:

amcgregor

Message:

Applied testmode.patch and guide_testmode_doc.patch as per ticket #18.

Location:

branches/2.0.5

Files:

• documentation/guide.wiki (modified) (1 diff)
• turbomail/pool.py (modified) (4 diffs)
• turbomail/startup.py (modified) (1 diff)

branches/2.0.5/documentation/guide.wiki

@@ -46 +46 @@
     * `utf-8-qp` -- Configures utf-8 to use quoted-printable encoding.  (Note: this is not a real character set and can only be used with !TurboMail.  Note also that this setting reconfigures the global ''utf-8'' setting to use a different encoding and will effect other processes using this mechanism.)
  * `mail.polling` (Default: ''False'') If enabled, configures the thread pool to poll every mail.interval seconds for new jobs. This may give performance benefits to the running application. The default behaviour is to create new threads as soon as work is enqueued, resulting in faster delivery, but greater initial load.
+ * `mail.testmode` (Default: ''False'') If enabled, configures TurboMail NOT to send any mail to the specified server. Enqueued mails will just sit in the queue. This is very useful for unit tests where no interaction with the environment should take place. 
 
 In debug mode, using a single thread with a maximum of one job can be advantageous. Having a single thread with a maximum of a single job limits !TurboMail to a single SMTP connection at a time and automatically disconnects after sending each message.

branches/2.0.5/turbomail/pool.py

@@ -23 +23 @@
         """
         
-        def __init__(self, interval=10, threads=4, jobs=10, timeout=60, polling=False, **kw):
+        def __init__(self, interval=10, threads=4, jobs=10, timeout=60, polling=False, testmode=False, **kw):
                 """Initialize the thread pool.
                 
@@ -44 +44 @@
                                 as required, when work is enqueued.
                 @type polling: bool
+
+                @param testmode: Enable or disable the unit testing mode. 
+                                Disabled, no mail is actually sent but only
+                                stored in the queue for later retrieval.
+                @type testmode: bool
                 """
                 
@@ -56 +61 @@
                 self._timeout = timeout
                 self._polling = False
+                self._testmode = testmode
                 self._kw = kw
                 
@@ -85 +91 @@
                 else:
                         self._queue.put(work, block=block, timeout=timeout)
+
+                if self._testmode:
+                        log.debug("Testmode enabled, not sending mail.")
+                        return
                 
                 optimum_threads = min(self._threads, math.ceil(self._queue.qsize() / float(self._jobs)))

branches/2.0.5/turbomail/startup.py

@@ -47 +47 @@
                         debug=turbogears.config.get("mail.debug", False),
                         tls=turbogears.config.get("mail.tls", None),
-                        polling=turbogears.config.get("mail.polling", None)
+                        polling=turbogears.config.get("mail.polling", None),
+                        testmode=turbogears.config.get("mail.testmode", False)
                 )