Resolves issues with CSV printing on Python 2

Add lots of unit tests to ensure we don't regress.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: f3974aa ("utils: Wrap CSV in quotes")

Author: stephenfin

git_pw/utils.py

@@ -11,20 +11,10 @@
 import sys
 
 import click
+import six
 from tabulate import tabulate
 
 
-if sys.version_info < (3, 0):
-    from io import BytesIO  # noqa
-else:
-    from io import StringIO  # noqa
-
-if sys.version_info < (3, 0):
-    _text = unicode  # noqa
-else:
-    _text = str  # noqa
-
-
 def trim(string, length=70):  # type: (str, int) -> str
     """Trim a string to the given length."""
     return (string[:length - 1] + '...') if len(string) > length else string
@@ -70,11 +60,13 @@ def _tabulate(output, headers, fmt):
     elif fmt == 'simple':
         return tabulate(output, headers, tablefmt='simple')
     elif fmt == 'csv':
-        result = StringIO()
-        writer = csv.writer(result, quoting=csv.QUOTE_ALL)
-        writer.writerow(headers)
+        result = six.StringIO()
+        writer = csv.writer(
+            result, quoting=csv.QUOTE_ALL, lineterminator=os.linesep)
+        writer.writerow([six.ensure_str(h) for h in headers])
         for item in output:
-            writer.writerow(_text(x if x is not None else '') for x in item)
+            writer.writerow([
+                six.ensure_str(x if x is not None else '') for x in item])
         return result.getvalue()
 
     print('pw.format must be one of: table, simple, csv')

requirements.txt

@@ -2,3 +2,4 @@ click>=6.0,<8.0
 requests>2.0,<3.0
 tabulate>=0.8
 arrow>=0.10
+six>=1.12

tests/test_utils.py

@@ -1,6 +1,9 @@
+# -*- coding: utf-8 -*-
+
 """Unit tests for ``git_pw/utils.py``."""
 
 import subprocess
+import textwrap
 import os
 
 import mock
@@ -78,3 +81,59 @@ def test_echo_via_pager_env_default(mock_inner, mock_tabulate, mock_config):
     mock_config.assert_called_once_with('core.parser')
     mock_tabulate.assert_called_once_with('test', ('foo',), None)
     mock_inner.assert_called_once_with('less', mock_tabulate.return_value)
+
+
+def _test_tabulate(fmt):
+    output = [(b'foo', 'bar', u'baz', '😀', None)]
+    headers = ('col1', 'colb', 'colIII', 'colX', 'colY')
+
+    result = utils._tabulate(output, headers, fmt)
+
+    return output, headers, result
+
+
+@mock.patch.object(utils, 'tabulate')
+def test_tabulate_table(mock_tabulate):
+    output, headers, result = _test_tabulate('table')
+
+    mock_tabulate.assert_called_once_with(output, headers, tablefmt='psql')
+    assert result == mock_tabulate.return_value
+
+
+@mock.patch.object(utils, 'tabulate')
+def test_tabulate_simple(mock_tabulate):
+    output, headers, result = _test_tabulate('simple')
+
+    mock_tabulate.assert_called_once_with(output, headers, tablefmt='simple')
+    assert result == mock_tabulate.return_value
+
+
+@mock.patch.object(utils, 'tabulate')
+def test_tabulate_csv(mock_tabulate):
+    output, headers, result = _test_tabulate('csv')
+
+    mock_tabulate.assert_not_called()
+    assert result == textwrap.dedent("""\
+        "col1","colb","colIII","colX","colY"
+        "foo","bar","baz","😀",""
+    """)
+
+
+@mock.patch.object(utils, 'git_config', return_value='simple')
+@mock.patch.object(utils, 'tabulate')
+def test_tabulate_git_config(mock_tabulate, mock_git_config):
+    output, headers, result = _test_tabulate(None)
+
+    mock_git_config.assert_called_once_with('pw.format')
+    mock_tabulate.assert_called_once_with(output, headers, tablefmt='simple')
+    assert result == mock_tabulate.return_value
+
+
+@mock.patch.object(utils, 'git_config', return_value='')
+@mock.patch.object(utils, 'tabulate')
+def test_tabulate_default(mock_tabulate, mock_git_config):
+    output, headers, result = _test_tabulate(None)
+
+    mock_git_config.assert_called_once_with('pw.format')
+    mock_tabulate.assert_called_once_with(output, headers, tablefmt='psql')
+    assert result == mock_tabulate.return_value