handle custom exceptions in cases (#222)

Author: kiran-chaudhary

CHANGELOG.md

@@ -10,6 +10,16 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
 
 ## Unreleased
 
+### Changed
+
+- The error text in cases command when:
+    - `cases create` sets a name that already exists in the system.
+    - `cases create` sets a description that has more than 250 characters.
+    - `cases update` sets a description that has more than 250 characters.
+    - `cases file-events add` is performed on an already closed case.
+    - `cases file-events add` sets an event id that is already added to the case.
+    - `cases file-events remove` is performed on an already closed case.
+
 ### Added
 
 - New choice `TLS-TCP` for `--protocol` option used by `send-to` commands:

setup.py

@@ -37,7 +37,7 @@
         "keyring==18.0.1",
         "keyrings.alt==3.2.0",
         "pandas>=1.1.3",
-        "py42>=1.11",
+        "py42>=1.11.1",
     ],
     extras_require={
         "dev": [

src/code42cli/click_ext/groups.py

@@ -3,10 +3,14 @@
 from collections import OrderedDict
 
 import click
+from py42.exceptions import Py42CaseAlreadyHasEventError
+from py42.exceptions import Py42CaseNameExistsError
+from py42.exceptions import Py42DescriptionLimitExceededError
 from py42.exceptions import Py42ForbiddenError
 from py42.exceptions import Py42HTTPError
 from py42.exceptions import Py42InvalidRuleOperationError
 from py42.exceptions import Py42LegalHoldNotFoundOrPermissionDeniedError
+from py42.exceptions import Py42UpdateClosedCaseError
 from py42.exceptions import Py42UserAlreadyAddedError
 from py42.exceptions import Py42UserNotOnListError
 
@@ -59,6 +63,10 @@ def invoke(self, ctx):
             Py42InvalidRuleOperationError,
             Py42LegalHoldNotFoundOrPermissionDeniedError,
             SyslogServerNetworkConnectionError,
+            Py42CaseNameExistsError,
+            Py42DescriptionLimitExceededError,
+            Py42CaseAlreadyHasEventError,
+            Py42UpdateClosedCaseError,
         ) as err:
             self.logger.log_error(err)
             raise Code42CLIError(str(err))

src/code42cli/cmds/cases.py

@@ -4,7 +4,9 @@
 import click
 from py42.clients.cases import CaseStatus
 from py42.exceptions import Py42BadRequestError
+from py42.exceptions import Py42CaseAlreadyHasEventError
 from py42.exceptions import Py42NotFoundError
+from py42.exceptions import Py42UpdateClosedCaseError
 
 from code42cli.click_ext.groups import OrderedGroup
 from code42cli.errors import Code42CLIError
@@ -241,6 +243,10 @@ def add(state, case_number, event_id):
     """Associate a file event to a case, by event ID."""
     try:
         state.sdk.cases.file_events.add(case_number, event_id)
+    except Py42UpdateClosedCaseError:
+        raise
+    except Py42CaseAlreadyHasEventError:
+        raise
     except Py42BadRequestError:
         raise Code42CLIError("Invalid case-number or event-id.")
 

tests/cmds/conftest.py

@@ -72,12 +72,17 @@ def cli_state_without_user(sdk_without_user, cli_state):
 
 
 @pytest.fixture
-def user_already_added_error(mocker):
+def custom_error(mocker):
     err = mocker.MagicMock(spec=HTTPError)
     resp = mocker.MagicMock(spec=Response)
     resp.text = "TEST_ERR"
     err.response = resp
-    return Py42UserAlreadyAddedError(err, TEST_ID, "detection list")
+    return err
+
+
+@pytest.fixture
+def user_already_added_error(custom_error):
+    return Py42UserAlreadyAddedError(custom_error, TEST_ID, "detection list")
 
 
 def get_filter_value_from_json(json, filter_index):

tests/cmds/test_cases.py

@@ -5,7 +5,11 @@
 
 import pytest
 from py42.exceptions import Py42BadRequestError
+from py42.exceptions import Py42CaseAlreadyHasEventError
+from py42.exceptions import Py42CaseNameExistsError
+from py42.exceptions import Py42DescriptionLimitExceededError
 from py42.exceptions import Py42NotFoundError
+from py42.exceptions import Py42UpdateClosedCaseError
 from py42.response import Py42Response
 
 from code42cli.main import cli
@@ -51,6 +55,26 @@ def py42_response(mocker):
     return mocker.MagicMock(spec=Py42Response)
 
 
+@pytest.fixture
+def case_already_exists_error(custom_error):
+    return Py42CaseNameExistsError(custom_error, "test case")
+
+
+@pytest.fixture
+def case_description_limit_exceeded_error(custom_error):
+    return Py42DescriptionLimitExceededError(custom_error)
+
+
+@pytest.fixture
+def case_already_has_event_error(custom_error):
+    return Py42CaseAlreadyHasEventError(custom_error)
+
+
+@pytest.fixture
+def update_on_a_closed_case_error(custom_error):
+    return Py42UpdateClosedCaseError(custom_error)
+
+
 def test_create_calls_create_with_expected_params(runner, cli_state):
     runner.invoke(
         cli, ["cases", "create", "TEST_CASE"], obj=cli_state,
@@ -333,3 +357,74 @@ def test_file_events_list_when_missing_case_number_prints_error(runner, cli_stat
     result = runner.invoke(cli, command, obj=cli_state)
     assert result.exit_code == 2
     assert MISSING_CASE_NUMBER_ARG in result.output
+
+
+def test_cases_create_when_case_name_already_exists_raises_exception_prints_error_message(
+    runner, cli_state, case_already_exists_error
+):
+    cli_state.sdk.cases.create.side_effect = case_already_exists_error
+    result = runner.invoke(cli, ["cases", "create", "test case"], obj=cli_state,)
+    assert (
+        "Case name 'test case' already exists, please set another name" in result.output
+    )
+
+
+def test_cases_create_when_description_length_limit_exceeds_raises_exception_prints_error_message(
+    runner, cli_state, case_description_limit_exceeded_error
+):
+    cli_state.sdk.cases.create.side_effect = case_description_limit_exceeded_error
+    result = runner.invoke(
+        cli,
+        ["cases", "create", "test case", "--description", "too long"],
+        obj=cli_state,
+    )
+    assert "Description limit exceeded, max 250 characters allowed." in result.output
+
+
+def test_cases_udpate_when_description_length_limit_exceeds_raises_exception_prints_error_message(
+    runner, cli_state, case_description_limit_exceeded_error
+):
+    cli_state.sdk.cases.update.side_effect = case_description_limit_exceeded_error
+    result = runner.invoke(
+        cli, ["cases", "update", "1", "--description", "too long"], obj=cli_state,
+    )
+    assert "Description limit exceeded, max 250 characters allowed." in result.output
+
+
+def test_fileevents_add_on_closed_case_when_py42_raises_exception_prints_error_message(
+    runner, cli_state, update_on_a_closed_case_error
+):
+    cli_state.sdk.cases.file_events.add.side_effect = update_on_a_closed_case_error
+    result = runner.invoke(
+        cli,
+        ["cases", "file-events", "add", "--case-number", "1", "--event-id", "1"],
+        obj=cli_state,
+    )
+    cli_state.sdk.cases.file_events.add.assert_called_once_with(1, "1")
+    assert "Cannot update a closed case." in result.output
+
+
+def test_fileevents_remove_on_closed_case_when_py42_raises_exception_prints_error_message(
+    runner, cli_state, update_on_a_closed_case_error
+):
+    cli_state.sdk.cases.file_events.delete.side_effect = update_on_a_closed_case_error
+    result = runner.invoke(
+        cli,
+        ["cases", "file-events", "remove", "--case-number", "1", "--event-id", "1"],
+        obj=cli_state,
+    )
+    cli_state.sdk.cases.file_events.delete.assert_called_once_with(1, "1")
+    assert "Cannot update a closed case." in result.output
+
+
+def test_fileevents_when_event_id_is_already_associated_with_case_py42_raises_exception_prints_error_message(
+    runner, cli_state, case_already_has_event_error
+):
+    cli_state.sdk.cases.file_events.add.side_effect = case_already_has_event_error
+    result = runner.invoke(
+        cli,
+        ["cases", "file-events", "add", "--case-number", "1", "--event-id", "1"],
+        obj=cli_state,
+    )
+    cli_state.sdk.cases.file_events.add.assert_called_once_with(1, "1")
+    assert "Event is already associated to the case." in result.output