remove broken OutputFormat.echo_formatted_generated_output() (#322)

* remove broken OutputFormat.echo_formatted_generated_output()

* "no results" message to stderr

* revert header params

* changelog update

* exclude flake8 rule

* black

Author: timabrmsn

CHANGELOG.md

@@ -22,6 +22,10 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
 
 - `code42 profile use` now prompts you to select a profile when not given a profile name argument.
 
+### Fixed
+
+- Bug where `audit-logs search` with `--use-checkpoint` option was causing output formatting problems.
+
 ## 1.9.0 - 2021-08-19
 
 ### Added

setup.cfg

@@ -27,5 +27,7 @@ ignore =
     E722
     # binary operation line break, different opinion from black
     W503
+    # exception chaining
+    B904
 # up to 88 allowed by bugbear B950
 max-line-length = 80

src/code42cli/cmds/auditlogs.py

@@ -141,18 +141,20 @@ def search(
         affected_user_ids=affected_user_id,
         affected_usernames=affected_username,
     )
-    if not events:
-        click.echo("No results found.")
-        return
 
     if use_checkpoint:
         checkpoint_name = use_checkpoint
-        events_gen = _dedupe_checkpointed_events_and_store_updated_checkpoint(
-            cursor, checkpoint_name, events
+        events = list(
+            _dedupe_checkpointed_events_and_store_updated_checkpoint(
+                cursor, checkpoint_name, events
+            )
         )
-        formatter.echo_formatted_generated_output(events_gen)
-    else:
-        formatter.echo_formatted_list(events)
+
+    if not events:
+        click.echo("No results found.", err=True)
+        return
+
+    formatter.echo_formatted_list(events)
 
 
 @audit_logs.command(cls=SendToCommand)

src/code42cli/output_formats.py

@@ -79,19 +79,6 @@ def echo_formatted_list(self, output_list, force_pager=False):
             if self.output_format in [OutputFormat.TABLE]:
                 click.echo()
 
-    def echo_formatted_generated_output(self, output_generator):
-        def _gen():
-            include_header = True
-            for output in output_generator:
-                if output:
-                    formatted_output = self._format_output(
-                        output, include_header=include_header
-                    )
-                    yield formatted_output
-                    include_header = False
-
-        click.echo_via_pager(_gen)
-
     @property
     def _requires_list_output(self):
         return self.output_format in (OutputFormat.TABLE, OutputFormat.CSV)

tests/cmds/test_auditlogs.py

@@ -586,23 +586,6 @@ def test_search_and_send_when_timestamps_have_nanoseconds_saves_checkpoint(
     assert call_args[0][1] == 1625150833.093616
 
 
-def test_search_if_error_occurs_when_processing_event_timestamp_still_outputs_results(
-    cli_state,
-    runner,
-    mock_audit_log_response_with_error_causing_timestamp,
-    audit_log_cursor_with_checkpoint,
-):
-    cli_state.sdk.auditlogs.get_all.return_value = (
-        mock_audit_log_response_with_error_causing_timestamp
-    )
-    res = runner.invoke(
-        cli, ["audit-logs", "search", "--use-checkpoint", "test"], obj=cli_state,
-    )
-    assert TEST_AUDIT_LOG_TIMESTAMP_1 in res.output
-    assert "I AM NOT A TIMESTAMP" in res.output
-    assert "Error: Unknown problem occurred." in res.output
-
-
 def test_search_if_error_occurs_when_processing_event_timestamp_does_not_store_error_timestamp(
     cli_state,
     runner,