Feature/case bulk commands (#273)

* added cases file-events bulk commands

* fix style

* add unit tests

* Added changelog

* change docs

Author: kiran-chaudhary

CHANGELOG.md

@@ -8,6 +8,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 The intended audience of this file is for py42 consumers -- as such, changes that don't affect
 how a consumer would use the library (e.g. adding unit tests, updating documentation, etc) are not captured here.
 
+## Unreleased
+
+### Added
+
+- `code42 cases file-events bulk` with sub-commands:
+    - `generate-template`: that creates the file template. And parameters:
+        - `cmd`: with options `add` and `remove`.
+        - `path`
+    - `add`: that takes a csv file with case number and event ID.
+    - `remove`: that takes a csv file with case number and event ID.
+
 ## 1.4.2 - 2021-04-22
 
 ### Added

src/code42cli/cmds/cases.py

@@ -8,8 +8,11 @@
 from py42.exceptions import Py42NotFoundError
 from py42.exceptions import Py42UpdateClosedCaseError
 
+from code42cli.bulk import generate_template_cmd_factory
+from code42cli.bulk import run_bulk_process
 from code42cli.click_ext.groups import OrderedGroup
 from code42cli.errors import Code42CLIError
+from code42cli.file_readers import read_csv_arg
 from code42cli.options import format_option
 from code42cli.options import sdk_options
 from code42cli.options import set_begin_default_dict
@@ -261,3 +264,60 @@ def remove(state, case_number, event_id):
         state.sdk.cases.file_events.delete(case_number, event_id)
     except Py42NotFoundError:
         raise Code42CLIError("Invalid case-number or event-id.")
+
+
+@file_events.group(cls=OrderedGroup)
+@sdk_options(hidden=True)
+def bulk(state):
+    """Tools for executing bulk case file-event actions."""
+    pass
+
+
+FILE_EVENTS_HEADERS = [
+    "number",
+    "eventId",
+]
+
+case_file_events_generate_template = generate_template_cmd_factory(
+    group_name="file_events",
+    commands_dict={"add": FILE_EVENTS_HEADERS, "remove": FILE_EVENTS_HEADERS},
+)
+bulk.add_command(case_file_events_generate_template)
+
+
+@bulk.command(
+    name="add",
+    help="Bulk associate file events to cases using a CSV file with "
+    "format: {}.".format(",".join(FILE_EVENTS_HEADERS)),
+)
+@read_csv_arg(headers=FILE_EVENTS_HEADERS)
+@sdk_options()
+def bulk_add(state, csv_rows):
+    sdk = state.sdk
+
+    def handle_row(case_number, event_id):
+        sdk.cases.file_events.add(case_number, event_id)
+
+    run_bulk_process(
+        handle_row, csv_rows, progress_label="Associating file events to cases:",
+    )
+
+
+@bulk.command(
+    name="remove",
+    help="Bulk remove the file event association from cases using a CSV file with "
+    "format: {}.".format(",".join(FILE_EVENTS_HEADERS)),
+)
+@read_csv_arg(headers=FILE_EVENTS_HEADERS)
+@sdk_options()
+def bulk_remove(state, csv_rows):
+    sdk = state.sdk
+
+    def handle_row(case_number, event_id):
+        sdk.cases.file_events.delete(case_number, event_id)
+
+    run_bulk_process(
+        handle_row,
+        csv_rows,
+        progress_label="Removing the file event association from cases:",
+    )

tests/cmds/test_cases.py

@@ -464,3 +464,39 @@ def test_fileevents_when_event_id_is_already_associated_with_case_py42_raises_ex
     )
     cli_state.sdk.cases.file_events.add.assert_called_once_with(1, "1")
     assert "Event is already associated to the case." in result.output
+
+
+def test_add_bulk_file_events_to_cases_uses_expected_arguments(
+    runner, mocker, cli_state_with_user
+):
+    bulk_processor = mocker.patch("code42cli.cmds.cases.run_bulk_process")
+    with runner.isolated_filesystem():
+        with open("test_add.csv", "w") as csv:
+            csv.writelines(["number,eventId\n", "1,abc\n", "2,pqr\n"])
+        runner.invoke(
+            cli,
+            ["cases", "file-events", "bulk", "add", "test_add.csv"],
+            obj=cli_state_with_user,
+        )
+    assert bulk_processor.call_args[0][1] == [
+        {"number": "1", "eventId": "abc"},
+        {"number": "2", "eventId": "pqr"},
+    ]
+
+
+def test_remove_bulk_file_events_from_cases_uses_expected_arguments(
+    runner, mocker, cli_state_with_user
+):
+    bulk_processor = mocker.patch("code42cli.cmds.cases.run_bulk_process")
+    with runner.isolated_filesystem():
+        with open("test_remove.csv", "w") as csv:
+            csv.writelines(["number,eventId\n", "1,abc\n", "2,pqr\n"])
+        runner.invoke(
+            cli,
+            ["cases", "file-events", "bulk", "remove", "test_remove.csv"],
+            obj=cli_state_with_user,
+        )
+    assert bulk_processor.call_args[0][1] == [
+        {"number": "1", "eventId": "abc"},
+        {"number": "2", "eventId": "pqr"},
+    ]