Integ 1061 test format str to cols (#115)

Author: Juliya Smith

CHANGELOG.md

@@ -10,6 +10,10 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
 
 ## Unreleased
 
+### Fixed
+
+- Bug where `code42 legal-hold show` would error when terminal was too small.
+
 ### Changed
 
 - `-i` (`--incremental`) has been removed, use `-c` (`--use-checkpoint`) with a string name for the checkpoint instead.

src/code42cli/util.py

@@ -78,7 +78,7 @@ def format_string_list_to_columns(string_list, max_width=None):
     if not max_width:
         max_width, _ = shutil.get_terminal_size()
     column_width = len(max(string_list, key=len)) + _PADDING_SIZE
-    num_columns = int(max_width / column_width)
+    num_columns = int(max_width / column_width) or 1
     format_string = "{{:<{0}}}".format(column_width) * num_columns
     batches = [string_list[i : i + num_columns] for i in range(0, len(string_list), num_columns)]
     padding = ["" for _ in range(num_columns)]

tests/test_util.py

@@ -1,7 +1,12 @@
 import pytest
 
 from code42cli import PRODUCT_NAME
-from code42cli.util import does_user_agree, find_format_width
+from code42cli.util import (
+    does_user_agree,
+    find_format_width,
+    format_string_list_to_columns,
+    _PADDING_SIZE,
+)
 
 TEST_HEADER = {u"key1": u"Column 1", u"key2": u"Column 10", u"key3": u"Column 100"}
 
@@ -22,9 +27,20 @@ def context_without_assume_yes(mocker, cli_state):
     return mocker.patch("code42cli.util.get_current_context", return_value=ctx)
 
 
+@pytest.fixture
+def echo_output(mocker):
+    return mocker.patch("code42cli.util.echo")
+
+
 _NAMESPACE = "{}.util".format(PRODUCT_NAME)
 
 
+def get_expected_row_width(max_col_len, max_width):
+    col_size = max_col_len + _PADDING_SIZE
+    num_cols = int(max_width / col_size) or 1
+    return col_size * num_cols
+
+
 def test_does_user_agree_when_user_says_y_returns_true(mocker, context_without_assume_yes):
     mocker.patch("builtins.input", return_value="y")
     assert does_user_agree("Test Prompt")
@@ -76,3 +92,54 @@ def test_find_format_width_filters_keys_not_present_in_header():
     result, _ = find_format_width(report, header_with_subset_keys)
     for item in result:
         assert u"key2" not in item.keys()
+
+
+def test_format_string_list_to_columns_when_given_no_string_list_does_not_echo(echo_output):
+    format_string_list_to_columns([], None)
+    format_string_list_to_columns(None, None)
+    assert not echo_output.call_count
+
+
+def test_format_string_list_to_columns_when_not_given_max_uses_shell_size(mocker, echo_output):
+    terminal_size = mocker.patch("code42cli.util.shutil.get_terminal_size")
+    max_width = 30
+    terminal_size.return_value = (max_width, None)  # Cols, Rows
+
+    columns = ["col1", "col2"]
+    format_string_list_to_columns(columns)
+
+    printed_row = echo_output.call_args_list[0][0][0]
+    assert len(printed_row) == get_expected_row_width(4, max_width)
+    assert printed_row == "col1   col2                 "
+
+
+def test_format_string_list_to_columns_when_given_small_max_width_prints_one_column_per_row(echo_output):
+    max_width = 5
+
+    columns = ["col1", "col2"]
+    format_string_list_to_columns(columns, max_width)
+
+    expected_row_width = get_expected_row_width(4, max_width)
+    printed_row = echo_output.call_args_list[0][0][0]
+    assert len(printed_row) == expected_row_width
+    assert printed_row == "col1   "
+
+    printed_row = echo_output.call_args_list[1][0][0]
+    assert len(printed_row) == expected_row_width
+    assert printed_row == "col2   "
+
+
+def test_format_string_list_to_columns_uses_width_of_longest_string(echo_output):
+    max_width = 5
+
+    columns = ["col1", "col2_that_is_really_long"]
+    format_string_list_to_columns(columns, max_width)
+
+    expected_row_width = get_expected_row_width(len("col2_that_is_really_long"), max_width)
+    printed_row = echo_output.call_args_list[0][0][0]
+    assert len(printed_row) == expected_row_width
+    assert printed_row == "col1                       "
+
+    printed_row = echo_output.call_args_list[1][0][0]
+    assert len(printed_row) == expected_row_width
+    assert printed_row == "col2_that_is_really_long   "