Bugfix/error messages (#72)

Author: alanag13

setup.py

@@ -24,7 +24,7 @@
         "c42eventextractor==0.3.0b1",
         "keyring==18.0.1",
         "keyrings.alt==3.2.0",
-        "py42>=1.1.3",
+        "py42>=1.2.0",
     ],
     license="MIT",
     include_package_data=True,

src/code42cli/cmds/alerts/rules/user_rule.py

@@ -1,5 +1,8 @@
+from py42.exceptions import Py42InternalServerError
 from py42.util import format_json
 
+
+from code42cli.errors import InvalidRuleTypeError
 from code42cli.util import format_to_table, find_format_width
 from code42cli.bulk import run_bulk_process, CSVReader
 from code42cli.logger import get_main_cli_logger
@@ -19,29 +22,55 @@
 
 def add_user(sdk, profile, rule_id, username):
     user_id = get_user_id(sdk, username)
-    sdk.alerts.rules.add_user(rule_id, user_id)
+    rules = _get_rule_metadata(sdk, rule_id)
+    try:
+        if rules:
+            sdk.alerts.rules.add_user(rule_id, user_id)
+    except Py42InternalServerError as e:
+        _check_if_system_rule(sdk, rules)
+        raise
 
 
 def remove_user(sdk, profile, rule_id, username):
-    if username:
-        user_id = get_user_id(sdk, username)
-        sdk.alerts.rules.remove_user(rule_id, user_id)
-    else:
-        sdk.alerts.rules.remove_all_users(rule_id)
+    user_id = get_user_id(sdk, username)
+    rules = _get_rule_metadata(sdk, rule_id)
+    try:
+        if rules:
+            sdk.alerts.rules.remove_user(rule_id, user_id)
+    except Py42InternalServerError as e:
+        _check_if_system_rule(sdk, rules)
+        raise
 
 
-def _get_rules_metadata(sdk, rule_id=None):
+def _get_all_rules_metadata(sdk):
     rules_generator = sdk.alerts.rules.get_all()
     selected_rules = [rule for rules in rules_generator for rule in rules[u"ruleMetadata"]]
-    if rule_id:
-        selected_rules = [rule for rule in selected_rules if rule[u"observerRuleId"] == rule_id]
-    return selected_rules
+    return _handle_rules_results(sdk, selected_rules)
+
+
+def _get_rule_metadata(sdk, rule_id):
+    rules = sdk.alerts.rules.get_by_observer_id(rule_id)[u"ruleMetadata"]
+    return _handle_rules_results(sdk, rules, rule_id)
+
+
+def _handle_rules_results(sdk, rules, rule_id=None):
+    id_msg = u"with RuleId {} ".format(rule_id) if rule_id else u""
+    msg = u"No alert rules {0}found.".format(id_msg)
+    if not rules:
+        get_main_cli_logger().print_and_log_info(msg)
+    return rules
+
+
+def _check_if_system_rule(sdk, rules):
+    if rules and rules[0][u"isSystem"]:
+        raise InvalidRuleTypeError(rules[0][u"observerRuleId"], rules[0][u"ruleSource"])
 
 
 def get_rules(sdk, profile):
-    selected_rules = _get_rules_metadata(sdk)
-    rows, column_size = find_format_width(selected_rules, _HEADER_KEYS_MAP)
-    format_to_table(rows, column_size)
+    selected_rules = _get_all_rules_metadata(sdk)
+    if selected_rules:
+        rows, column_size = find_format_width(selected_rules, _HEADER_KEYS_MAP)
+        format_to_table(rows, column_size)
 
 
 def add_bulk_users(sdk, profile, file_name):
@@ -59,9 +88,9 @@ def remove_bulk_users(sdk, profile, file_name):
 
 
 def show_rule(sdk, profile, rule_id):
-    selected_rule = _get_rules_metadata(sdk, rule_id)
+    selected_rule = _get_rule_metadata(sdk, rule_id)
     rule_detail = None
-    if len(selected_rule):
+    if selected_rule:
         rule_type = selected_rule[0][u"type"]
         if rule_type == AlertRuleTypes.EXFILTRATION:
             rule_detail = sdk.alerts.rules.exfiltration.get(rule_id)

src/code42cli/cmds/detectionlists/__init__.py

@@ -3,25 +3,11 @@
 from code42cli.compat import str
 from code42cli.cmds.detectionlists.commands import DetectionListCommandFactory
 from code42cli.bulk import generate_template, run_bulk_process, CSVReader, FlatFileReader
-from code42cli.logger import get_main_cli_logger
+from code42cli.errors import UserAlreadyAddedError, UnknownRiskTagError, UserDoesNotExistError
 from code42cli.bulk import BulkCommandType
 from code42cli.cmds.detectionlists.enums import DetectionLists, DetectionListUserKeys, RiskTags
 
 
-class UserAlreadyAddedError(Exception):
-    def __init__(self, username, list_name):
-        msg = u"'{}' is already on the {} list.".format(username, list_name)
-        super(UserAlreadyAddedError, self).__init__(msg)
-
-
-class UnknownRiskTagError(Exception):
-    def __init__(self, bad_tags):
-        tags = u", ".join(bad_tags)
-        super(UnknownRiskTagError, self).__init__(
-            u"The following risk tags are unknown: '{}'.".format(tags)
-        )
-
-
 def try_handle_user_already_added_error(bad_request_err, username_tried_adding, list_name):
     if _error_is_user_already_added(bad_request_err.response.text):
         raise UserAlreadyAddedError(username_tried_adding, list_name)
@@ -32,15 +18,6 @@ def _error_is_user_already_added(bad_request_error_text):
     return u"User already on list" in bad_request_error_text
 
 
-class UserDoesNotExistError(Exception):
-    """An error to represent a username that is not in our system. The CLI shows this error when 
-    the user tries to add or remove a user that does not exist. This error is not shown during 
-    bulk add or remove."""
-
-    def __init__(self, username):
-        super(UserDoesNotExistError, self).__init__(u"User '{}' does not exist.".format(username))
-
-
 class DetectionListHandlers(object):
     """Handlers DTO for passing in specific detection list functions.
     
@@ -206,9 +183,7 @@ def get_user_id(sdk, username):
     """
     users = sdk.users.get_by_username(username)[u"users"]
     if not users:
-        ex = UserDoesNotExistError(username)
-        get_main_cli_logger().print_and_log_error(str(ex))
-        raise ex
+        raise UserDoesNotExistError(username)
     return users[0][u"userUid"]
 
 

src/code42cli/cmds/search_shared/extraction.py

@@ -19,7 +19,7 @@ def begin_date_is_required(args, cursor_store):
 
     # Ignore begin date when in incremental mode, it is not required, and it was passed an argument.
     if not is_required and args.begin:
-        logger.print_info(
+        logger.print_and_log_info(
             u"Ignoring --begin value as --incremental was passed and cursor checkpoint exists.\n"
         )
         args.begin = None

src/code42cli/date_helper.py

@@ -3,35 +3,25 @@
 
 from c42eventextractor.common import convert_datetime_to_timestamp
 
-
-_FORMAT_VALUE_ERROR_MESSAGE = (
-    u"input must be a date/time string (e.g. 'YYYY-MM-DD', "
-    u"'YY-MM-DD HH:MM', 'YY-MM-DD HH:MM:SS'), or a short value in days, "
-    u"hours, or minutes (e.g. 30d, 24h, 15m)"
-)
+from code42cli.errors import DateArgumentError
 
 TIMESTAMP_REGEX = re.compile(u"(\d{4}-\d{2}-\d{2})\s*(.*)?")
 MAGIC_TIME_REGEX = re.compile(u"(\d+)([dhm])$")
 
 
-class DateArgumentException(Exception):
-    def __init__(self, message=_FORMAT_VALUE_ERROR_MESSAGE):
-        super(DateArgumentException, self).__init__(message)
-
-
 def verify_timestamp_order(min_timestamp, max_timestamp):
     if min_timestamp is None or max_timestamp is None:
         return
     if min_timestamp >= max_timestamp:
-        raise DateArgumentException(u"Begin date cannot be after end date")
+        raise DateArgumentError(u"Begin date cannot be after end date")
 
 
 def parse_min_timestamp(begin_date_str, max_days_back=90):
     dt = _parse_timestamp(begin_date_str, _round_datetime_to_day_start)
 
     boundary_date = _round_datetime_to_day_start(datetime.utcnow() - timedelta(days=max_days_back))
     if dt < boundary_date:
-        raise DateArgumentException(u"'Begin date' must be within {0} days.".format(max_days_back))
+        raise DateArgumentError(u"'Begin date' must be within {0} days.".format(max_days_back))
 
     return convert_datetime_to_timestamp(dt)
 
@@ -58,7 +48,7 @@ def _parse_timestamp(date_str, rounding_func):
             dt = rounding_func(dt)
 
     else:
-        raise DateArgumentException()
+        raise DateArgumentError()
     return dt
 
 
@@ -72,7 +62,7 @@ def _get_dt_from_date_time_pair(date, time):
     try:
         dt = datetime.strptime(date_string, date_format)
     except ValueError:
-        raise DateArgumentException()
+        raise DateArgumentError()
     else:
         return dt
 
@@ -86,7 +76,7 @@ def _get_dt_from_magic_time_pair(num, period):
     elif period == u"m":
         dt = datetime.utcnow() - timedelta(minutes=num)
     else:
-        raise DateArgumentException(u"Couldn't parse magic time string: {}{}".format(num, period))
+        raise DateArgumentError(u"Couldn't parse magic time string: {}{}".format(num, period))
     return dt
 
 

src/code42cli/errors.py

@@ -1 +1,46 @@
 ERRORED = False
+
+_FORMAT_VALUE_ERROR_MESSAGE = (
+    u"input must be a date/time string (e.g. 'YYYY-MM-DD', "
+    u"'YY-MM-DD HH:MM', 'YY-MM-DD HH:MM:SS'), or a short value in days, "
+    u"hours, or minutes (e.g. 30d, 24h, 15m)"
+)
+
+
+class Code42CLIError(Exception):
+    pass
+
+
+class UserAlreadyAddedError(Code42CLIError):
+    def __init__(self, username, list_name):
+        msg = u"'{}' is already on the {} list.".format(username, list_name)
+        super(UserAlreadyAddedError, self).__init__(msg)
+
+
+class UnknownRiskTagError(Code42CLIError):
+    def __init__(self, bad_tags):
+        tags = u", ".join(bad_tags)
+        super(UnknownRiskTagError, self).__init__(
+            u"The following risk tags are unknown: '{}'.".format(tags)
+        )
+
+
+class InvalidRuleTypeError(Code42CLIError):
+    def __init__(self, rule_id, source):
+        msg = u"Only alert rules with a source of 'Alerting' can be targeted by this command. "
+        msg += "Rule {0} has a source of '{1}'."
+        super(InvalidRuleTypeError, self).__init__(msg.format(rule_id, source))
+
+
+class UserDoesNotExistError(Code42CLIError):
+    """An error to represent a username that is not in our system. The CLI shows this error when 
+    the user tries to add or remove a user that does not exist. This error is not shown during 
+    bulk add or remove."""
+
+    def __init__(self, username):
+        super(UserDoesNotExistError, self).__init__(u"User '{}' does not exist.".format(username))
+
+
+class DateArgumentError(Code42CLIError):
+    def __init__(self, message=_FORMAT_VALUE_ERROR_MESSAGE):
+        super(DateArgumentError, self).__init__(message)

src/code42cli/invoker.py

@@ -2,6 +2,8 @@
 
 from py42.exceptions import Py42HTTPError, Py42ForbiddenError
 
+from code42cli.compat import str
+from code42cli.errors import Code42CLIError
 from code42cli.parser import ArgumentParserError, CommandParser
 from code42cli.logger import get_main_cli_logger
 
@@ -25,6 +27,9 @@ def run(self, input_args):
             path_parts = self._get_path_parts(input_args)
             command = self._commands.get(u" ".join(path_parts))
             self._try_run_command(command, path_parts, input_args)
+        except Code42CLIError as err:
+            logger = get_main_cli_logger()
+            logger.print_and_log_error(str(err))
         except Py42ForbiddenError as err:
             logger = get_main_cli_logger()
             logger.log_verbose_error(invocation_str, err.response.request)

src/code42cli/worker.py

@@ -2,6 +2,8 @@
 
 from py42.exceptions import Py42HTTPError, Py42ForbiddenError
 
+from code42cli.compat import str
+from code42cli.errors import Code42CLIError
 from code42cli.compat import queue
 from code42cli.logger import get_main_cli_logger
 
@@ -77,6 +79,10 @@ def _process_queue(self):
                 args = task[u"args"]
                 kwargs = task[u"kwargs"]
                 func(*args, **kwargs)
+            except Code42CLIError as err:
+                self._increment_total_errors()
+                logger = get_main_cli_logger()
+                logger.log_error(err)
             except Py42ForbiddenError as err:
                 self._increment_total_errors()
                 logger = get_main_cli_logger()