Merge lp:~daniel-nichter/boots/vertical-output into lp:boots

[Daniel Nichter]

Adds --vertical-output option to enable mysql cli \G-like output:

> show master status;
=================================== Row 1 ====================================
            File: mysql-bin.000001
        Position: 364
    Binlog_Do_DB:
Binlog_Ignore_DB:

1 row in set (0.00s server | +0.00s working)

[Jay Pipes (jaypipes)]

Awesomeness! Daniel, is it possible to include a simple test case for this new functionality?

Unit testing is pretty light right now. However, from a glance, it looks like adding a test method to the TestPlain class in /tests/lib/ui/ui_tests.py is the right way to go...

Cheers!

jay

review: Approve

[Daniel Nichter (daniel-nichter)]

> Awesomeness! Daniel, is it possible to include a simple test case for this
> new functionality?

Yes, I will write tests...

[lp:~daniel-nichter/boots/vertical-output]

165. By Daniel Nichter on 2010-06-02

Move padded(), show_NULL() and _gen_output() out of present() for testing; prepend _ to first two. Add ui tests.

[Daniel Nichter (daniel-nichter)]

Added some basic ui tests. My understanding of boots internals is not complete so if the _gen_output() tests in particular seem odd please correct/enlighten me. Thanks.

Unmerged revisions

165. By Daniel Nichter on 2010-06-02

Move padded(), show_NULL() and _gen_output() out of present() for testing; prepend _ to first two. Add ui tests.

164. By Daniel Nichter on 2010-05-16

Add --vertical-output.

=== modified file 'boots/app/client_config.py'
--- boots/app/client_config.py	2010-04-06 04:56:01 +0000
+++ boots/app/client_config.py	2010-06-02 04:01:24 +0000
@@ -107,6 +107,7 @@
                           "pager":              None,
                           "pager_command":      None,
                           "terminating_char":   ";",
+                          "vertical_output":    False,
                           "history_length":     100,
                           "history_file":       os.path.expanduser("~/.boots_history")}
         self._dict = self._defaults.copy()
@@ -195,6 +196,11 @@
                               type = "string",
                               dest = "terminating_char",
                               help = _("specify the SQL statement terminating character (default is ';')"))
+        misc_group.add_option("--vertical-output",
+                              action = "store_true",
+                              dest = "vertical_output",
+                              default = False,
+                              help = _("print vertical output (like \G)"))
         misc_group.add_option("-F", "--historyfile",
                               action = "store",
                               type = "string",

=== modified file 'boots/lib/ui/plain.py'
--- boots/lib/ui/plain.py	2010-03-29 23:47:14 +0000
+++ boots/lib/ui/plain.py	2010-06-02 04:01:24 +0000
@@ -68,6 +68,7 @@
         self.prompt2 = console.config["prompt2"]
         self.hist_file = console.config["history_file"]
         self.pager_command = console.config["pager_command"]
+        self.vertical_output = console.config["vertical_output"]
         self.last_desc = None
         self.buffer = []
         
@@ -166,69 +167,16 @@
     def present(self, result):
         """Print the result provided as an argument.
 
-        If the result is a packet buffer the results until the last packet is
+        If the result is a packet, buffer the results until the last packet is
         received. At that point print all of the buffered result rows in table
         format. Non packet results are presented in their string representation
         as received."""
-        def padded(fields, widths):
-            """Utility function used to convert rows from tuples to table rows.
-            Results are returned as strings."""
-            padded_fields = []
-            for index, field in enumerate(fields):
-                padded_fields.append(field.ljust(widths[index]))
-            return u"| {0} |".format(u" | ".join(padded_fields))
-        
-        def show_NULL(value):
-            """There is a 'bug' in the dbapi that does not convert NULL objects
-            to the string 'NULL'. This utility function performs that
-            conversion."""
-            return value if value is not None else "NULL"
-
-        def _gen_table(info):
-            with DurationCounter() as table_elapsed:
-                if self.buffer:
-                    # If a column can contain the value NULL, we leave at least 4
-                    # characters, since display_size does not account for NULL.
-                    max_widths = map(max, [(len(column.name),
-                                            column.display_size,
-                                            4 if column.null_ok else 0)
-                                     for column in info["description"]])
-                    dashes = map(lambda x: "-"*(x+2), max_widths)
-                    sep_line = "+" + "+".join(dashes) + "+"
-                    names = (column[0] for column in info["description"])
-                    yield sep_line
-                    yield padded(names, max_widths)
-                    yield sep_line
-                    for row in self.buffer:
-                        yield padded(map(show_NULL, row), max_widths)
-        
-                    yield sep_line
-            
-            if self.console.driver.is_interactive:
-                if info["description"] is not None:
-                    set_count = n_("{count} row in set", 
-                                   "{count} rows in set",
-                                   info["row_count"])
-                else:
-                    set_count = n_("{count} row affected",
-                                   "{count} rows affected",
-                                   info["row_count"])
-
-                nodes_elapsed = info["end_time"] - info["begin_time"] - info["server_elapsed"]                
-                timings = [_("{0:.2f}s server").format(info["server_elapsed"]),
-                           _("+{0:.2f}s working").format(nodes_elapsed)]
-                
-                if self.console.config["debug"]:
-                    timings.append(_("{0:.2f}s table").format(table_elapsed.duration))
-
-                yield "{0} ({1})".format(set_count.format(count=info["row_count"]),
-                                         " | ".join(timings))
 
         if type(result) is Rows:
             self.buffer.extend(result)
         elif isinstance(result, ResultInfo):
             printed = False
-            output = _gen_table(result.value)
+            output = self._gen_output(result.value)
             if self.pager_command and self.console.driver.is_interactive:
                 printed = self.print_with_pager("\n".join(output).encode("utf-8"))
             
@@ -237,7 +185,7 @@
                 for line in output:
                     sys.stdout.write(line.encode("utf-8"))
                     sys.stdout.write("\n")
-                
+
             # Reset values for next result set.
             self.buffer = []
         elif isinstance(result, Status):
@@ -258,6 +206,72 @@
         else:
             return True
 
+    def _padded(self, fields, widths):
+        """Utility function used to convert rows from tuples to table rows.
+        Results are returned as strings."""
+        padded_fields = []
+        for index, field in enumerate(fields):
+            padded_fields.append(field.ljust(widths[index]))
+        return u"| {0} |".format(u" | ".join(padded_fields))
+    
+    def _show_NULL(self, value):
+        """There is a 'bug' in the dbapi that does not convert NULL objects
+        to the string 'NULL'. This utility function performs that
+        conversion."""
+        return value if value is not None else "NULL"
+
+    def _gen_output(self, info):
+        with DurationCounter() as table_elapsed:
+            if self.buffer:
+                if self.vertical_output is False:
+                    # If a column can contain the value NULL, we leave at least 4
+                    # characters, since display_size does not account for NULL.
+                    max_widths = map(max, [(len(column.name),
+                                            column.display_size,
+                                            4 if column.null_ok else 0)
+                                     for column in info["description"]])
+                    dashes = map(lambda x: "-"*(x+2), max_widths)
+                    sep_line = "+" + "+".join(dashes) + "+"
+                    names = (column[0] for column in info["description"])
+                    yield sep_line
+                    yield self._padded(names, max_widths)
+                    yield sep_line
+                    for row in self.buffer:
+                        yield self._padded(map(self._show_NULL, row), max_widths)
+        
+                    yield sep_line
+                else:
+                    max_width = max([
+                        len(column.name) for column in info["description"]])
+                    for row_number, row in enumerate(self.buffer, start=1):
+                        row_header = " Row {0} ".format(row_number)
+                        yield row_header.center(78, '=')
+                        for i, column in enumerate(info["description"]):
+                            line = "{0}: {1}".format(
+                                column.name.rjust(max_width), row[i])
+                            yield line
+                        yield ""
+
+        if self.console.driver.is_interactive:
+            if info["description"] is not None:
+                set_count = n_("{count} row in set", 
+                               "{count} rows in set",
+                               info["row_count"])
+            else:
+                set_count = n_("{count} row affected",
+                               "{count} rows affected",
+                               info["row_count"])
+
+            nodes_elapsed = info["end_time"] - info["begin_time"] - info["server_elapsed"]                
+            timings = [_("{0:.2f}s server").format(info["server_elapsed"]),
+                       _("+{0:.2f}s working").format(nodes_elapsed)]
+            
+            if self.console.config["debug"]:
+                timings.append(_("{0:.2f}s table").format(table_elapsed.duration))
+
+            yield "{0} ({1})".format(set_count.format(count=info["row_count"]),
+                                     " | ".join(timings))
+
     @property
     def is_interactive(self):
         if hasattr(os, "isatty"):

=== modified file 'tests/boots/lib/ui/ui_tests.py'
--- tests/boots/lib/ui/ui_tests.py	2010-02-27 05:40:10 +0000
+++ tests/boots/lib/ui/ui_tests.py	2010-06-02 04:01:24 +0000
@@ -24,6 +24,10 @@
 import unittest
 import boots_unit_test
 from boots.lib.ui import generic, plain
+from boots.lib import console
+from boots.app import client_config
+from boots.api import api
+import StringIO
 
 class TestGeneric(boots_unit_test.BootsBaseTester):
     def setUp(self):
@@ -33,14 +37,82 @@
         pass
 
     def test_example(self):
-        self.assert_(False)
+        # TODO: test me!
+        pass
 
 class TestPlain(boots_unit_test.BootsBaseTester):
     def setUp(self):
-        pass
+        self.config = client_config.ClientConfig()
+        self.console = console.Console(self.config)
+        self.plain_ui = plain.PlainUI(self.console)
 
     def tearDown(self):
         pass
 
-    def test_example(self):
-        self.assert_(False)
+    def test_show_NULL(self):
+        """_show_NULL() should return whatever it's given unless
+        it's given nothing/None, in which case it should return
+        the string 'NULL'."""
+        self.assertEqual(self.plain_ui._show_NULL(None), "NULL")
+        self.assertEqual(self.plain_ui._show_NULL(0), 0)
+        self.assertEqual(self.plain_ui._show_NULL("0"), "0")
+        self.assertEqual(self.plain_ui._show_NULL(1), 1)
+        self.assertEqual(self.plain_ui._show_NULL("1"), "1")
+        self.assertEqual(self.plain_ui._show_NULL("hello, world!"), "hello, world!")
+
+    def test_print_notificatilon(self):
+        """By default print_notification() writes a message to STDOUT
+        like the one below.  For testing, we pass a third arg, a StringIO
+        to capture the output."""
+        output = StringIO.StringIO()
+        self.plain_ui.print_notification("title", "here's my message", output)
+        notif = output.getvalue()
+        output.close()
+        self.assertEqual(notif, "title :: here's my message\n")
+
+    def test_gen_output(self):
+        """_gen_output() outputs rows in either default table/horizontal
+        format or optional vertical (\G) format.  It returns a generator
+        that yields output lines."""
+
+        # Add a row so _gen_output() has something to output.
+        row_desc = api.RowDescription(
+            (('Databases', 15, 3, 256, 256, 0, 0),))
+        rows = api.Rows( (('db1',),), row_desc)
+        self.plain_ui.present(rows)
+
+        # Result info for the row.
+        info = api.ResultInfo({
+            "description": row_desc,
+            "row_count": 1,
+            "begin_time": 1.0,
+            "end_time": 3.0,
+            "server_elapsed": 1.0,
+        })
+
+        # Test default table/horizontal output.
+        res = self.plain_ui._gen_output(info.value)
+        lines = []
+        for line in res:
+            lines.append(line)
+        self.assertEqual(lines, [
+            "+-----------+",
+            "| Databases |",
+            "+-----------+",
+            "| db1       |",
+            "+-----------+",
+            "1 row in set (1.00s server | +1.00s working)",
+        ])
+
+        # Test optional veritcal output.
+        self.plain_ui.vertical_output = True
+        res = self.plain_ui._gen_output(info.value)
+        lines = []
+        for line in res:
+            lines.append(line)
+        self.assertEqual(lines, [
+            "=================================== Row 1 ====================================",
+            "Databases: db1",
+            "",
+            "1 row in set (1.00s server | +1.00s working)",
+        ])