Feature/interactive errors (#9)

Author: Juliya Smith

CHANGELOG.md

@@ -13,6 +13,7 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
 ### Added
 
 - Begin and end date now support specifying time: `code42 securitydata print -b 2020-02-02 12:00:00`.
+- If running interactively and errors occur, you will be told them at the end of `code42 securitydata` commands.
 - New search arguments for `print`, `write-to`, and `send-to`:
     - `--c42username`
     - `--actor`

src/code42cli/securitydata/extraction.py

@@ -12,7 +12,7 @@
 from py42.sdk.file_event_query.file_query import MD5, SHA256, FileName, FilePath
 
 from code42cli.compat import str
-from code42cli.util import print_error, print_bold
+from code42cli.util import print_error, print_bold, is_interactive
 from code42cli.profile.profile import get_profile
 from code42cli.securitydata.options import ExposureType as ExposureTypeOptions
 from code42cli.securitydata import date_helper as date_helper
@@ -22,6 +22,9 @@
 from code42cli.securitydata.arguments.main import IS_INCREMENTAL_KEY
 
 
+_EXCEPTIONS_OCCURRED = False
+
+
 def extract(output_logger, args):
     """Extracts file events using the given command-line arguments.
 
@@ -38,12 +41,20 @@ def extract(output_logger, args):
     sdk = _get_sdk(profile, args.is_debug_mode)
     extractor = FileEventExtractor(sdk, handlers)
     _call_extract(extractor, args)
+    _handle_result()
 
 
 def _create_event_handlers(output_logger, is_incremental):
     handlers = FileEventHandlers()
     error_logger = get_error_logger()
-    handlers.handle_error = error_logger.error
+
+    def handle_error(exception):
+        error_logger.error(exception)
+        global _EXCEPTIONS_OCCURRED
+        _EXCEPTIONS_OCCURRED = True
+
+    handlers.handle_error = handle_error
+
     if is_incremental:
         store = AEDCursorStore()
         handlers.record_cursor_position = store.replace_stored_insertion_timestamp
@@ -116,7 +127,7 @@ def _verify_begin_date(begin_date):
     if not begin_date:
         print_error(u"'begin date' is required.")
         print(u"")
-        print(u"Try using  '-b' or '--begin'. Use `-h` for more info.")
+        print_bold(u"Try using  '-b' or '--begin'. Use `-h` for more info.")
         print(u"")
         exit(1)
 
@@ -131,6 +142,11 @@ def _verify_exposure_types(exposure_types):
             exit(1)
 
 
+def _handle_result():
+    if is_interactive() and _EXCEPTIONS_OCCURRED:
+        print_error(u"View exceptions that occurred at [HOME]/.code42cli/log/code42_errors.")
+
+
 def _create_filters(args):
     filters = [_get_event_timestamp_filter(args)]
     not args.c42username or filters.append(DeviceUsername.eq(args.c42username))

src/code42cli/securitydata/subcommands/write_to.py

@@ -10,7 +10,7 @@ def init(subcommand_parser):
         Args:
             subcommand_parser: The subparsers group created by the parent parser.
     """
-    parser = subcommand_parser.add_parser("write-to")
+    parser = subcommand_parser.add_parser(u"write-to")
     parser.set_defaults(func=write_to)
     _add_filename_subcommand(parser)
     search_args.add_arguments_to_parser(parser)
@@ -19,11 +19,11 @@ def init(subcommand_parser):
 
 def write_to(args):
     """Activates 'write-to' command. It gets security events and writes them to the given file."""
-    logger = get_logger_for_file(args.filename, args.format)
+    logger = get_logger_for_file(args.output_file, args.format)
     extract(logger, args)
 
 
 def _add_filename_subcommand(parser):
     parser.add_argument(
-        action="store", dest="filename", help="The name of the local file to send output to."
+        action=u"store", dest=u"output_file", help=u"The name of the local file to send output to."
     )

src/code42cli/util.py

@@ -37,3 +37,7 @@ def print_error(error_text):
 
 def print_bold(bold_text):
     print("\033[1m{}\033[0m".format(bold_text))
+
+
+def is_interactive():
+    return sys.stdin.isatty()

tests/securitydata/subcommands/test_write_to.py

@@ -11,7 +11,7 @@
 
 @pytest.fixture
 def file_namespace(namespace):
-    namespace.filename = "out.txt"
+    namespace.output_file = "out.txt"
     namespace.format = "CEF"
     return namespace