Feature/user alert rules (#53)

Author: kiran-chaudhary

CHANGELOG.md

@@ -12,6 +12,17 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
 
 ### Added
 
+- `code42 alert-rules` commands:
+    - `add-user` with parameters `--rule-id` and `--username`.
+    - `remove-user` that takes a rule ID and optionally `--username`.
+    - `list`.
+    - `show` takes a rule ID.
+    - `bulk` with subcommands:
+        - `add`: that takes a csv file with rule IDs and usernames.
+        - `generate-template`: that creates the file template. And parameters:
+            - `cmd`: with options `add` and `remove`.
+            - `path`
+        - `remove`: that takes a csv file with rule IDs and usernames.
 - Success messages for `profile delete` and `profile update`.
 - Additional information in the error log file:
     - The full command path for the command that errored.

src/code42cli/args.py

@@ -2,7 +2,7 @@
 import inspect
 
 
-PROFILE_HELP = u"The name of the Code42 profile use when executing this command."
+PROFILE_HELP = u"The name of the Code42 profile to use when executing this command."
 SDK_ARG_NAME = u"sdk"
 PROFILE_ARG_NAME = u"profile"
 
@@ -18,6 +18,7 @@ def __init__(self, *args, **kwargs):
             u"help": kwargs.get(u"help"),
             u"options_list": list(args),
             u"nargs": kwargs.get(u"nargs"),
+            u"required": kwargs.get(u"required"),
         }
 
     @property
@@ -36,6 +37,9 @@ def add_short_option_name(self, short_name):
     def as_multi_val_param(self, nargs=u"+"):
         self._settings[u"nargs"] = nargs
 
+    def set_required(self, required=False):
+        self._settings[u"required"] = required
+
 
 class ArgConfigCollection(object):
     def __init__(self):

src/code42cli/bulk.py

@@ -8,6 +8,14 @@
 from code42cli.args import SDK_ARG_NAME, PROFILE_ARG_NAME
 
 
+class BulkCommandType(object):
+    ADD = u"add"
+    REMOVE = u"remove"
+
+    def __iter__(self):
+        return iter([self.ADD, self.REMOVE])
+
+
 def generate_template(handler, path=None):
     """Looks at the parameter names of `handler` and creates a file with the same column names. If 
     `handler` only has one parameter that is not `sdk` or `profile`, it will create a blank file. 

src/code42cli/cmds/alerts/__init__.py

@@ -0,0 +1,142 @@
+from code42cli.commands import Command
+from code42cli.bulk import generate_template, BulkCommandType
+from code42cli.cmds.alerts.rules.user_rule import (
+    add_user,
+    remove_user,
+    get_rules,
+    add_bulk_users,
+    remove_bulk_users,
+    show_rules,
+)
+
+
+def _customize_add_arguments(argument_collection):
+    rule_id = argument_collection.arg_configs[u"rule_id"]
+    rule_id.set_help(u"Observer ID of the rule to be updated. Required.")
+    rule_id.set_required(True)
+    username = argument_collection.arg_configs[u"username"]
+    username.set_help(u"The username of the user to add to the alert rule. Required.")
+    username.set_required(True)
+
+
+def _customize_remove_arguments(argument_collection):
+    rule_id = argument_collection.arg_configs[u"rule_id"]
+    rule_id.set_help(u"Observer ID of the rule to be updated.")
+    username = argument_collection.arg_configs[u"username"]
+    username.set_help(u"The username of the user to remove from the alert rule.")
+
+
+def _customize_list_arguments(argument_collection):
+    rule_id = argument_collection.arg_configs[u"rule_id"]
+    rule_id.set_help(u"Observer ID of the rule.")
+
+
+def _customize_bulk_arguments(argument_collection):
+    file_name = argument_collection.arg_configs[u"file_name"]
+    file_name.set_help(
+        u"The path to the csv file with columns 'rule_id,user_id' "
+        u"for bulk adding users to the alert rule."
+    )
+
+
+def _generate_template_file(cmd, path=None):
+    """Generates a template file a user would need to fill-in for bulk operating.
+
+    Args:
+        cmd (str or unicode): An option from the `BulkCommandType` enum specifying which type of file to
+            generate.
+        path (str or unicode, optional): A path to put the file after it's generated. If None, will use
+            the current working directory. Defaults to None.
+    """
+    handler = None
+    if cmd == BulkCommandType.ADD:
+        handler = add_user
+    elif cmd == BulkCommandType.REMOVE:
+        handler = remove_user
+
+    generate_template(handler, path)
+
+
+def _load_bulk_generate_template_description(argument_collection):
+    cmd_type = argument_collection.arg_configs[u"cmd"]
+    cmd_type.set_help(u"The type of command the template with be used for.")
+    cmd_type.set_choices(BulkCommandType())
+
+
+class AlertRulesBulkCommands(object):
+    @staticmethod
+    def load_commands():
+        usage_prefix = u"code42 alert-rules bulk"
+
+        generate_template_cmd = Command(
+            u"generate-template",
+            u"Generate the necessary csv template needed for bulk adding users.",
+            u"{} generate-template <cmd> <optional args>".format(usage_prefix),
+            handler=_generate_template_file,
+            arg_customizer=_load_bulk_generate_template_description,
+        )
+
+        bulk_add = Command(
+            u"add",
+            u"Update alert rule criteria to add users and all their aliases. "
+            u"CSV file format: rule_id,username",
+            u"{} add <filename>".format(usage_prefix),
+            handler=add_bulk_users,
+            arg_customizer=_customize_bulk_arguments,
+        )
+
+        bulk_remove = Command(
+            u"remove",
+            u"Update alert rule criteria to remove users and all their aliases. "
+            u"CSV file format: rule_id,username",
+            u"{} remove <filename>".format(usage_prefix),
+            handler=remove_bulk_users,
+            arg_customizer=_customize_bulk_arguments,
+        )
+
+        return [generate_template_cmd, bulk_add, bulk_remove]
+
+
+class AlertRulesCommands(object):
+    @staticmethod
+    def load_subcommands():
+        usage_prefix = u"code42 alert-rules"
+
+        add = Command(
+            u"add-user",
+            u"Update alert rule criteria to monitor user aliases against the given username.",
+            u"{} add-user --rule-id <id>  --username <username>".format(usage_prefix),
+            handler=add_user,
+            arg_customizer=_customize_add_arguments,
+        )
+
+        remove = Command(
+            u"remove-user",
+            u"Update alert rule criteria to remove a user and all their aliases.",
+            u"{} remove-user <rule-id> --username <username>".format(usage_prefix),
+            handler=remove_user,
+            arg_customizer=_customize_remove_arguments,
+        )
+
+        list_rules = Command(
+            u"list",
+            u"Fetch existing alert rules.",
+            u"{} list".format(usage_prefix),
+            handler=get_rules,
+        )
+
+        show = Command(
+            u"show",
+            u"Fetch configured alert-rules against the rule ID.",
+            u"{} show <rule-id>".format(usage_prefix),
+            handler=show_rules,
+            arg_customizer=_customize_list_arguments,
+        )
+
+        bulk = Command(
+            u"bulk",
+            u"Tools for executing bulk commands.",
+            subcommand_loader=AlertRulesBulkCommands.load_commands,
+        )
+
+        return [add, remove, list_rules, show, bulk]

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

@@ -0,0 +1,4 @@
+class AlertRuleTypes(object):
+    EXFILTRATION = u"FED_ENDPOINT_EXFILTRATION"
+    CLOUD_SHARE = u"FED_CLOUD_SHARE_PERMISSIONS"
+    FILE_TYPE_MISMATCH = u"FED_FILE_TYPE_MISMATCH"

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

@@ -0,0 +1,74 @@
+from py42.util import format_json
+
+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
+from code42cli.cmds.detectionlists import get_user_id
+from code42cli.cmds.alerts.rules.enums import AlertRuleTypes
+
+
+_HEADER_KEYS_MAP = {
+    u"observerRuleId": u"RuleId",
+    u"name": u"Name",
+    u"severity": u"Severity",
+    u"type": u"Type",
+    u"ruleSource": u"Source",
+    u"isEnabled": u"Enabled",
+}
+
+
+def add_user(sdk, profile, rule_id=None, username=None):
+    user_id = get_user_id(sdk, username)
+    sdk.alerts.rules.add_user(rule_id, user_id)
+
+
+def remove_user(sdk, profile, rule_id, username=None):
+    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)
+
+
+def _get_rules_metadata(sdk, rule_id=None):
+    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
+
+
+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)
+
+
+def add_bulk_users(sdk, profile, file_name):
+    run_bulk_process(
+        file_name, lambda rule_id, username: add_user(sdk, profile, rule_id, username), CSVReader()
+    )
+
+
+def remove_bulk_users(sdk, profile, file_name):
+    run_bulk_process(
+        file_name,
+        lambda rule_id, username: remove_user(sdk, profile, rule_id, username),
+        CSVReader(),
+    )
+
+
+def show_rules(sdk, profile, rule_id):
+    selected_rule = _get_rules_metadata(sdk, rule_id)
+    rule_detail = None
+    if len(selected_rule):
+        rule_type = selected_rule[0][u"type"]
+        if rule_type == AlertRuleTypes.EXFILTRATION:
+            rule_detail = sdk.alerts.rules.exfiltration.get(rule_id)
+        elif rule_type == AlertRuleTypes.CLOUD_SHARE:
+            rule_detail = sdk.alerts.rules.cloudshare.get(rule_id)
+        elif rule_type == AlertRuleTypes.FILE_TYPE_MISMATCH:
+            rule_detail = sdk.alerts.rules.filetypemismatch.get(rule_id)
+    if rule_detail:
+        logger = get_main_cli_logger()
+        logger.print_info(format_json(rule_detail.text))

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

@@ -4,12 +4,8 @@
 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.cmds.detectionlists.enums import (
-    BulkCommandType,
-    DetectionLists,
-    DetectionListUserKeys,
-    RiskTags,
-)
+from code42cli.bulk import BulkCommandType
+from code42cli.cmds.detectionlists.enums import DetectionLists, DetectionListUserKeys, RiskTags
 
 
 class UserAlreadyAddedError(Exception):

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

@@ -1,4 +1,4 @@
-from code42cli.cmds.detectionlists.enums import BulkCommandType
+from code42cli.bulk import BulkCommandType
 from code42cli.commands import Command