Output formats (#149)

Author: Juliya Smith

CHANGELOG.md

@@ -33,9 +33,13 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
 - The `path` positional argument for bulk `generate-template` commands is now an option (`--p/-p`).
 - Below `search` subcommands accept argument `--format/-f` to display result in formats `csv`, `table`, `json`, `raw-json`:
     - Default output format is changed to `table` format from `raw-json`, returns a paginated response.
-    A predefined properties would be displayed by default, pass `--include-all` to view all non-nested top-level properties.
+    All properties would be displayed by default except when using `-f table`.
+    Pass `--include-all` when using `table` to view all non-nested top-level properties.
     - `code42 alerts search`
     - `code42 security-data search`
+    - `code42 security-data saved-search list`
+    - `code42 legal-hold list`
+    - `code42 alert-rules list`
 
 ### Added
 

src/code42cli/cmds/alert_rules.py

@@ -79,8 +79,7 @@ def list_alert_rules(state, format=None):
     formatter = OutputFormatter(format, _HEADER_KEYS_MAP)
     selected_rules = _get_all_rules_metadata(state.sdk)
     if selected_rules:
-        for output in formatter.get_formatted_output(selected_rules):
-            echo(output)
+        formatter.echo_formatted_list(selected_rules)
 
 
 @alert_rules.command()

src/code42cli/cmds/legal_hold.py

@@ -14,6 +14,7 @@
 from code42cli.options import format_option
 from code42cli.options import OrderedGroup
 from code42cli.options import sdk_options
+from code42cli.output_formats import OutputFormat
 from code42cli.output_formats import OutputFormatter
 from code42cli.util import format_string_list_to_columns
 
@@ -75,8 +76,7 @@ def _list(state, format=None):
     formatter = OutputFormatter(format, _MATTER_KEYS_MAP)
     matters = _get_all_active_matters(state.sdk)
     if matters:
-        for output in formatter.get_formatted_output(matters):
-            echo(output)
+        formatter.echo_formatted_list(matters)
 
 
 @legal_hold.command()
@@ -92,11 +92,9 @@ def _list(state, format=None):
     is_flag=True,
     help="View details of the preservation policy associated with the legal hold matter.",
 )
-@format_option
 @sdk_options()
-def show(state, matter_id, include_inactive=False, include_policy=False, format=None):
+def show(state, matter_id, include_inactive=False, include_policy=False):
     """Display details of a given legal hold matter."""
-    formatter = OutputFormatter(format, _MATTER_KEYS_MAP)
     matter = _check_matter_is_accessible(state.sdk, matter_id)
     matter["creator_username"] = matter["creator"]["username"]
     matter = json.loads(matter.text)
@@ -114,9 +112,8 @@ def show(state, matter_id, include_inactive=False, include_policy=False, format=
         member["user"]["username"] for member in memberships if not member["active"]
     ]
 
-    for output in formatter.get_formatted_output([matter]):
-        echo(output)
-
+    formatter = OutputFormatter(OutputFormat.TABLE, _MATTER_KEYS_MAP)
+    formatter.echo_formatted_list([matter])
     _print_matter_members(active_usernames, member_type="active")
 
     if include_inactive:

src/code42cli/cmds/search/extraction.py

@@ -94,16 +94,10 @@ def handle_response(response):
         total_events = len(events)
         handlers.TOTAL_EVENTS += total_events
 
-        def _format_output():
-            return formatter.get_formatted_output(events)
-
         if total_events > 10 or force_pager:
-            click.echo_via_pager(_format_output())
+            click.echo_via_pager(formatter.get_formatted_output(events))
         else:
-            for page in _format_output():
-                click.echo(page, nl=False)
-            if formatter.output_format == OutputFormat.TABLE:
-                click.echo()
+            formatter.echo_formatted_list(events)
 
         # To make sure the extractor records correct timestamp event when `CTRL-C` is pressed.
         if total_events:

src/code42cli/cmds/securitydata.py

@@ -166,7 +166,7 @@ def _get_saved_search_query(ctx, param, arg):
     "--format",
     type=click.Choice(SendToFileEventsOutputFormat(), case_sensitive=False),
     help="The output format of the result. Defaults to json format.",
-    default=SendToFileEventsOutputFormat.JSON,
+    default=SendToFileEventsOutputFormat.RAW,
 )
 
 
@@ -286,8 +286,7 @@ def _list(state, format=None):
     response = state.sdk.securitydata.savedsearches.get()
     saved_searches = response["searches"]
     if saved_searches:
-        for output in formatter.get_formatted_output(saved_searches):
-            echo(output)
+        formatter.echo_formatted_list(saved_searches)
 
 
 @saved_search.command()

src/code42cli/output_formats.py

@@ -2,6 +2,8 @@
 import io
 import json
 
+import click
+
 from code42cli.util import find_format_width
 from code42cli.util import format_to_table
 
@@ -62,6 +64,13 @@ def get_formatted_output(self, output):
             for item in output:
                 yield self._format_output(item)
 
+    def echo_formatted_list(self, output_list):
+        formatted_output = self.get_formatted_output(output_list)
+        for output in formatted_output:
+            click.echo(output, nl=False)
+        if self.output_format in [OutputFormat.TABLE]:
+            click.echo()
+
     @property
     def _requires_list_output(self):
         return self.output_format in (OutputFormat.TABLE, OutputFormat.CSV)
@@ -90,7 +99,7 @@ def to_table(output, header):
 
 def to_json(output):
     """Output is a single record"""
-    return "{}".format(json.dumps(output))
+    return "{}\n".format(json.dumps(output))
 
 
 def to_formatted_json(output):

tests/cmds/search/test_extraction.py

@@ -43,7 +43,7 @@ def test_try_get_default_header_returns_none_when_is_table_and_told_to_include_a
     assert actual is None
 
 
-def test_create_handlers_creates_handlers_that_pass_events_to_output_format(
+def test_create_handlers_creates_handlers_that_pass_events_to_output_formatter(
     mocker, sdk,
 ):
     class TestExtractor(BaseExtractor):
@@ -64,7 +64,7 @@ def _get_timestamp_from_item(self, item):
     http_response.text = '{{"{0}": [{{"property": "bar"}}]}}'.format(key)
     py42_response = Py42Response(http_response)
     handlers.handle_response(py42_response)
-    formatter.get_formatted_output.assert_called_once_with(events)
+    formatter.echo_formatted_list.assert_called_once_with(events)
 
 
 def test_send_to_handlers_creates_handlers_that_pass_events_to_logger(

tests/cmds/test_legal_hold.py

@@ -572,31 +572,3 @@ def test_list_with_csv_format_returns_no_response_when_response_is_empty(
     cli_state.sdk.legalhold.get_all_matters.return_value = empty_matters_response
     result = runner.invoke(cli, ["legal-hold", "list", "-f", "csv"], obj=cli_state)
     assert "Matter ID,Name,Description,Creator,Creation Date" not in result.output
-
-
-def test_show_with_csv_format_option_returns_expected_format(
-    runner,
-    cli_state,
-    check_matter_accessible_success,
-    get_user_id_success,
-    active_and_inactive_legal_hold_memberships_response,
-):
-    cli_state.sdk.legalhold.get_all_matter_custodians.return_value = (
-        active_and_inactive_legal_hold_memberships_response
-    )
-    result = runner.invoke(
-        cli, ["legal-hold", "show", TEST_MATTER_ID, "-f", "csv"], obj=cli_state
-    )
-    assert "legalHoldUid" in result.output
-    assert "name" in result.output
-    assert "description" in result.output
-    assert "active" in result.output
-    assert "creationDate" in result.output
-    assert "lastModified" in result.output
-    assert "creator" in result.output
-    assert "holdPolicyUid" in result.output
-    assert "creator_username" in result.output
-    assert "88888" in result.output
-    assert "Test_Matter" in result.output
-    comma_count = [c for c in result.output if c == ","]
-    assert len(comma_count) >= 13

tests/test_output_formats.py

@@ -136,7 +136,7 @@ def test_to_table_when_not_given_header_creates_header_dynamically():
 
 def test_to_json():
     formatted_output = output_formats_module.to_json(TEST_DATA)
-    assert formatted_output == json.dumps(TEST_DATA)
+    assert formatted_output == "{}\n".format(json.dumps(TEST_DATA))
 
 
 def test_to_formatted_json():