Merge lp:~macobo/mailman/macobo-conf_sort_option into lp:mailman

[Karl-Aksel Puulmann]

Since the -s option is taken by --section, I decided to use -x instead (perhaps should be changed).

When doing the changes, I didn't notice that David Soto had already made a branch to fix this issue.

[lp:~macobo/mailman/macobo-conf_sort_option]

7212. By Karl-Aksel Puulmann on 2013-04-06

Fixed tests broken by previous commit

7213. By Karl-Aksel Puulmann on 2013-04-06

Added an example to the docs

[Barry Warsaw (barry)]

Thanks for the contribution to Mailman! Your branch looks quite good, and with just a few modifications, I am merging this branch. I did change -x to -t and added a few tests. I am giving you top credit for fixing the bug but I'm also going to mention David Soto's contribution. His branch lacked tests and there was no merge proposal from him, so your branch provided the bulk of the new code.

Again, thanks!

review: Approve

=== modified file 'src/mailman/commands/cli_conf.py'
--- src/mailman/commands/cli_conf.py	2013-03-20 00:34:45 +0000
+++ src/mailman/commands/cli_conf.py	2013-04-06 07:18:25 +0000
@@ -65,10 +65,20 @@
             key-values pair from any section matching the given key will be
             displayed.
             """))
+        command_parser.add_argument(
+            '-x', '--sort',
+            default=False, action='store_true',
+            help=_("Sort the output by sections and keys."))
 
     def _get_value(self, section, key):
         return getattr(getattr(config, section), key)
 
+    def _sections(self, to_sort):
+        sections = config.schema._section_schemas
+        if to_sort:
+            sections = sorted(sections)
+        return sections
+
     def _print_full_syntax(self, section, key, value, output):
         print('[{}] {}: {}'.format(section, key, value), file=output)
 
@@ -78,8 +88,10 @@
     def _show_section_error(self, section):
         self.parser.error('No such section: {}'.format(section))
 
-    def _print_values_for_section(self, section, output):
+    def _print_values_for_section(self, section, output, to_sort):
         current_section = getattr(config, section)
+        if to_sort:
+            current_section = sorted(current_section)
         for key in current_section:
             self._print_full_syntax(section, key,
                                     self._get_value(section, key), output)
@@ -94,6 +106,7 @@
         # Process the command, ignoring the closing of the output file.
         section = args.section
         key = args.key
+        to_sort = args.sort
         # Case 1: Both section and key are given, so we can directly look up
         # the value.
         if section is not None and key is not None:
@@ -106,12 +119,12 @@
         # 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)
+                self._print_values_for_section(section, output, to_sort)
             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:
+            for current_section in self._sections(to_sort):
                 # We have to ensure that the current section actually exists
                 # and that it contains the given key.
                 if (self._section_exists(current_section) and
@@ -124,12 +137,12 @@
         # 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:
+            for current_section in self._sections(to_sort):
                 # 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)
+                    self._print_values_for_section(current_section, output, to_sort)
 
     def process(self, args):
         """See `ICLISubCommand`."""

=== modified file 'src/mailman/commands/docs/conf.rst'
--- src/mailman/commands/docs/conf.rst	2013-03-20 00:34:45 +0000
+++ src/mailman/commands/docs/conf.rst	2013-04-06 07:18:25 +0000
@@ -14,6 +14,7 @@
     ...     key = None
     ...     section = None
     ...     output = None
+    ...     sort = False
     >>> from mailman.commands.cli_conf import Conf
     >>> command = Conf()
 
@@ -64,5 +65,12 @@
     >>> command.process(FakeArgs)
     [e-mail]
 
+You can also sort the output. The output will be first sorted by section, then by key.
+
+    >>> FakeArgs.section = 'shell'
+    >>> FakeArgs.sort = True
+    [shell] banner: Welcome to the GNU Mailman shell
+    [shell] prompt: >>>
+    [shell] use_ipython: no
 
 .. _`Postfix command postconf(1)`: http://www.postfix.org/postconf.1.html

=== modified file 'src/mailman/commands/tests/test_conf.py'
--- src/mailman/commands/tests/test_conf.py	2013-03-20 00:34:45 +0000
+++ src/mailman/commands/tests/test_conf.py	2013-04-06 07:18:25 +0000
@@ -40,6 +40,7 @@
     section = None
     key = None
     output = None
+    sort = False
 
 
 class FakeParser: