Convert the Switchboard test in test_runners.py to a doctest. Add an

ISwitchboard interface and modernize the Python code in the Switchboard.py
implementation.

The SAVE_MSGS_AS_PICKLES option is removed.  Messages are always saved as
pickles unless the metadata '_plaintext' key is present, though this should
eventually go away too.

In testall.py, put the entire VAR_PREFIX in a temporary directory.  This helps
the switchboard tests by not mixing their data with the installation's queue
directories.  The Configuration object now also ensures that all the queue and
log directories exist -- one more step on the road to getting rid of the
autoconf mess.

1 files changed, 82 insertions, 0 deletions

diff --git a/Mailman/interfaces/switchboard.py b/Mailman/interfaces/switchboard.py
new file mode 100644
index 000000000..3a54359c2
--- /dev/null
+++ b/Mailman/interfaces/switchboard.py
@@ -0,0 +1,82 @@
+# Copyright (C) 2007 by the Free Software Foundation, Inc.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+# USA.
+
+"""Interface for switchboards."""
+
+from zope.interface import Interface, Attribute
+
+
+
+class ISwitchboard(Interface):
+    """The switchboard."""
+
+    queue_directory = Attribute(
+        """The name of the queue directory this switchboard is responsible for.
+
+        This should be a subdirectory of the system-wide top-level queue
+        directory.
+        """)
+
+    def enqueue(_msg, _metadata=None, **_kws):
+        """Store the message and metadata in the switchboard's queue.
+
+        When metadata is not given, an empty metadata dictionary is used.  The
+        keyword arguments are added to the metadata dictonary, with precedence
+        given to the keyword arguments.
+
+        The base name of the message file is returned.
+        """
+
+    def dequeue(filebase):
+        """Return the message and metadata contained in the named file.
+
+        filebase is the base name of the message file as returned by the
+        .enqueue() method.  This file must exist and contain a message and
+        metadata.  The message file is preserved in a backup file, which must
+        be removed by calling the .finish() method.
+
+        Returned is a 2-tuple of the form (message, metadata).
+        """
+
+    def finish(filebase, preserve=False):
+        """Remove the backup file for filebase.
+
+        If preserve is True, then the backup file is actually just renamed to
+        a preservation file instead of being unlinked.
+        """
+
+    files = Attribute(
+        """An iterator over all the .pck files in the queue directory.
+
+        The base names of the matching files are returned.
+        """)
+
+    def get_files(extension='.pck'):
+        """Like the 'files' attribute, but accepts an alternative extension.
+
+        Only the files in the queue directory that have a matching extension
+        are returned.  Like 'files', the base names of the matching files are
+        returned.
+        """
+
+    def recover_backup_files():
+        """Move all backup files to active message files.
+
+        It is impossible for both the .bak and .pck files to exist at the same
+        time, so moving them is enough to ensure that a normal dequeing
+        operation will handle them.
+        """