Merge lp:~david-soto/mailman/postconf_equivalent into lp:mailman

[David Soto]

This branch adds a postconf equivalent to the subcommands which displays configuration values as described in #518517. I have included a test class with two methods which ensure that the command displays an error message if invalid sections or keys are passed.
You can call the command by executing "/bin/mailman mailmanconf -s section -k key".

[lp:~david-soto/mailman/postconf_equivalent]

7211. By David Soto on 2013-01-23

documentation added

[Barry Warsaw (barry)]

This branch looks great, and I'm really sorry for letting this sit for so long. I'm finally merging this at Pycon 2013, and thanks for your contribution to Mailman!

I made a few changes. I renamed it from Mailmanconf to Conf and I renamed the command from 'mailmanconf' to just 'conf' (the 'mailman' prefix part seemed redundant since this always gets run as a subcommand). I also added a few unittests for making sure that output to a file works, and I added "-o -" as a synonym for output to stdout. Also, TestConf must have a "layer = ConfigLayer" attribute otherwise the configuration system isn't set up by the time the tests run. Ironically this doesn't affect the failing tests, but with the expected-to-succeed tests I added, this has to be done.

I just cleaned up a few other things, but basically kept your code pretty well intact. Great work.

BTW, what do you think of adding a --sort/-s option so that the output is printed in sorted order, i.e. first by section and then by key?

If you like the idea, how would you like doing a new branch to add that feature?

review: Approve

=== added file 'src/mailman/commands/cli_mailmanconf.py'
--- src/mailman/commands/cli_mailmanconf.py	1970-01-01 00:00:00 +0000
+++ src/mailman/commands/cli_mailmanconf.py	2013-01-23 20:35:25 +0000
@@ -0,0 +1,128 @@
+# Copyright (C) 2009-2013 by the Free Software Foundation, Inc.
+#
+# This file is part of GNU Mailman.
+#
+# GNU Mailman 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 3 of the License, or (at your option)
+# any later version.
+#
+# GNU Mailman 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
+# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Print the mailman configuration."""
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+__metaclass__ = type
+__all__ = [
+    'Mailmanconf'
+    ]
+
+
+import sys
+
+from zope.interface import implementer
+from lazr.config._config import Section
+
+from mailman.config import config
+from mailman.core.i18n import _
+from mailman.interfaces.command import ICLISubCommand
+
+
+

+@implementer(ICLISubCommand)
+class Mailmanconf:
+    """Print the mailman configuration."""
+
+    name = 'mailmanconf'
+
+    def add(self, parser, command_parser):
+        self.parser = parser
+        """See `ICLISubCommand`."""
+        command_parser.add_argument(
+            '-o', '--output',
+            action='store', help=_("""\
+            File to send the output to.  If not given, standard output is
+            used."""))
+        command_parser.add_argument(
+            '-s', '--section',
+            action='store', help=_("""\
+            Section to use for the lookup. If no key is given,
+            all the key-value pairs of the given section will be displayed.
+            """))
+        command_parser.add_argument(
+            '-k', '--key',
+            action='store', help=_("""\
+            Key to use for the lookup. If no section is given,
+            all the key-values pair from any section matching the given key
+            will be displayed.
+            """))
+
+    def _get_value(self, section, key):
+        return getattr(getattr(config, section), key)
+
+    def _print_full_syntax(self, section, key, value, output):
+        print('[{0}] {1}: {2}'.format(section, key, value), file=output)
+
+    def _show_key_error(self, section, key):
+        self.parser.error('Section %s: No such key: %s' % (section, key))
+
+    def _show_section_error(self, section):
+        self.parser.error('No such section: %s' % section)
+
+    def _print_values_for_section(self, section, output):
+        current_section = getattr(config, section)
+        for key in current_section:
+            if hasattr(current_section, key):
+                self._print_full_syntax(section, key, self._get_value(section, key), output)
+
+    def _section_exists(self, section):
+        # not all the attributes in config are actual sections,
+        # so we have to additionally check a sections type
+        return hasattr(config, section) and isinstance(getattr(config, section), Section)
+
+    def process(self, args):
+        """See `ICLISubCommand`."""
+        if args.output is None:
+            output = sys.stdout
+        else:
+            # We don't need to close output because that will happen
+            # automatically when the script exits.
+            output = open(args.output, 'w')
+        section = args.section
+        key = args.key
+        # Case 1: Both section and key are given, we can directly look up the value
+        if section is not None and key is not None:
+            if not self._section_exists(section):
+                self._show_section_error(section)
+            elif not hasattr(getattr(config, section), key):
+                self._show_key_error(section, key)
+            else:
+                print(self._get_value(section, key))
+        # Case 2: Section is given, key is not given
+        elif section is not None and key is None:
+            if self._section_exists(section):
+                self._print_values_for_section(section, output)
+            else:
+                self._show_section_error(section)
+        # Case 3: Section is not given, key is given
+        elif section is None and key is not None:
+            for current_section in config.schema._section_schemas:
+                # We have to ensure that the current section actually exists and
+                # that it contains the given key
+                if self._section_exists(current_section) and hasattr(getattr(config, current_section), key):
+                    self._print_full_syntax(current_section, key, self._get_value(current_section, key), output)
+        # Case 4: Neither section nor key are given, 
+        # just display all the sections and their corresponding key/value pairs.
+        elif section is None and key is None:
+            for current_section in config.schema._section_schemas:
+                # However, we have to make sure that the current sections and key
+                # which are being looked up actually exist before trying to print them
+                if self._section_exists(current_section):
+                    self._print_values_for_section(current_section, output)

=== added file 'src/mailman/commands/docs/mailmanconf.rst'
--- src/mailman/commands/docs/mailmanconf.rst	1970-01-01 00:00:00 +0000
+++ src/mailman/commands/docs/mailmanconf.rst	2013-01-23 20:35:25 +0000
@@ -0,0 +1,61 @@
+==================
+Display configuration values
+==================
+
+Just like the postfix command postconf(1), mailmanconf lets you dump
+one or more mailman configuration variables. Internally, these can be
+retrieved by using the mailman.config.config object. Their structure
+is based on the schema given by src/mailman/config/schema.cfg.
+For more information on how the values are actually set, see
+src/mailman/docs/START.rst
+
+Basically, the configuration is divided in multiple sections which
+contain multiple key-value pairs. The ``bin/mailman mailmanconf``
+command allows you to display a specific or several key-value pairs.
+
+    >>> class FakeArgs:
+    ...     key = None
+    ...     section = None
+    ...     output = None
+    >>> from mailman.commands.cli_mailmanconf import Mailmanconf
+    >>> command = Mailmanconf()
+
+To get a list of all key-value pairs of any section, you need to call
+the command without any options.
+
+    >>> command.process(FakeArgs)
+    ... [logging.archiver] path: mailman.log
+    ... [logging.archiver] level: info
+    ... [logging.locks] propagate: no
+    ... [logging.locks] level: info
+    ... [passwords] configuration: python:mailman.config.passlib
+    ... etc.
+    
+You can list all the key-value pairs of a specific section.
+
+    >>> FakeArgs.section = 'mailman'
+    >>> command.process(FakeArgs)
+    ... [mailman] filtered_messages_are_preservable: no
+    ... [mailman] post_hook: 
+    ... [mailman] pending_request_life: 3d
+    ... etc.
+    
+You can also pass a key and display all key-value pairs matching
+the given key, along with the names of the corresponding sections.
+
+    >>> FakeArgs.section = 'None'
+    >>> FakeArgs.key = 'path'
+    >>> command.process(FakeArgs)
+    ... [logging.archiver] path: mailman.log
+    ... [logging.mischief] path: mailman.log
+    ... [logging.error] path: mailman.log
+    ... [logging.smtp] path: smtp.log
+    ... etc.
+    
+If you specify both a section and a key, you will get the corresponding value.
+
+    >>> FakeArgs.section = 'mailman'
+    >>> FakeArgs.key = 'site_owner'
+    >>> command.process(FakeArgs)
+    ... [e-mail]
+    
\ No newline at end of file

=== added file 'src/mailman/commands/tests/test_mailmanconf.py'
--- src/mailman/commands/tests/test_mailmanconf.py	1970-01-01 00:00:00 +0000
+++ src/mailman/commands/tests/test_mailmanconf.py	2013-01-23 20:35:25 +0000
@@ -0,0 +1,76 @@
+# Copyright (C) 2011-2013 by the Free Software Foundation, Inc.
+#
+# This file is part of GNU Mailman.
+#
+# GNU Mailman 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 3 of the License, or (at your option)
+# any later version.
+#
+# GNU Mailman 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
+# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Test the mailmanconf subcommand."""
+
+from __future__ import absolute_import, unicode_literals
+
+__metaclass__ = type
+__all__ = [
+    ]
+
+import sys
+import unittest
+
+from mailman.commands.cli_mailmanconf import Mailmanconf
+from mailman.config import config
+
+

+class FakeArgs:
+    section = None
+    key = None
+    output = None
+
+
+class FakeParser:
+    def __init__(self):
+        self.message = None
+
+    def error(self, message):
+        self.message = message
+        sys.exit(1)
+
+
+

+class TestMailmanconf(unittest.TestCase):
+    """Test the mailmanconf subcommand."""
+
+    def setUp(self):
+        self.command = Mailmanconf()
+        self.command.parser = FakeParser()
+        self.args = FakeArgs()
+
+    def test_cannot_access_nonexistent_section(self):
+        self.args.section = 'thissectiondoesnotexist'
+        self.args.key = None
+        try:
+            self.command.process(self.args)
+        except SystemExit:
+            pass
+        self.assertEqual(self.command.parser.message,
+                         'No such section: thissectiondoesnotexist')
+
+    def test_cannot_access_nonexistent_key(self):
+        self.args.section = "mailman"
+        self.args.key = 'thiskeydoesnotexist'
+        try:
+            self.command.process(self.args)
+        except SystemExit:
+            pass
+        self.assertEqual(self.command.parser.message,
+                         'Section mailman: No such key: thiskeydoesnotexist')
+        
\ No newline at end of file