Chore/Incorporate-update-user-custom-errors (#306)

Author: Juliya Smith

setup.py

@@ -39,7 +39,7 @@
         "keyrings.alt==3.2.0",
         "ipython>=7.16.1",
         "pandas>=1.1.3",
-        "py42>=1.15.1",
+        "py42>=1.16.0",
     ],
     extras_require={
         "dev": [

src/code42cli/click_ext/groups.py

@@ -8,7 +8,10 @@
 from py42.exceptions import Py42DescriptionLimitExceededError
 from py42.exceptions import Py42ForbiddenError
 from py42.exceptions import Py42HTTPError
+from py42.exceptions import Py42InvalidEmailError
+from py42.exceptions import Py42InvalidPasswordError
 from py42.exceptions import Py42InvalidRuleOperationError
+from py42.exceptions import Py42InvalidUsernameError
 from py42.exceptions import Py42LegalHoldNotFoundOrPermissionDeniedError
 from py42.exceptions import Py42UpdateClosedCaseError
 from py42.exceptions import Py42UserAlreadyAddedError
@@ -69,6 +72,9 @@ def invoke(self, ctx):
             Py42CaseAlreadyHasEventError,
             Py42UpdateClosedCaseError,
             Py42UsernameMustBeEmailError,
+            Py42InvalidEmailError,
+            Py42InvalidPasswordError,
+            Py42InvalidUsernameError,
         ) as err:
             self.logger.log_error(err)
             raise Code42CLIError(str(err))

tests/cmds/conftest.py

@@ -1,15 +1,16 @@
+import json
 import json as json_module
 import threading
 
 import pytest
 from py42.exceptions import Py42UserAlreadyAddedError
 from py42.exceptions import Py42UserNotOnListError
-from py42.response import Py42Response
 from py42.sdk import SDKClient
 from requests import HTTPError
-from requests import Request
 from requests import Response
 from tests.conftest import convert_str_to_date
+from tests.conftest import create_mock_http_error
+from tests.conftest import create_mock_response
 from tests.conftest import TEST_ID
 
 from code42cli.logger import CliLogger
@@ -20,12 +21,8 @@
 
 def get_user_not_on_list_side_effect(mocker, list_name):
     def side_effect(*args, **kwargs):
-        err = mocker.MagicMock(spec=HTTPError)
-        resp = mocker.MagicMock(spec=Response)
-        resp.text = "TEST_ERR"
-        err.response = resp
-        err.response.request = mocker.MagicMock(spec=Request)
-        raise Py42UserNotOnListError(err, TEST_ID, list_name)
+        mock_http_error = create_mock_http_error(mocker, data="TEST_ERR")
+        raise Py42UserNotOnListError(mock_http_error, TEST_ID, list_name)
 
     return side_effect
 
@@ -114,12 +111,13 @@ def f(*args):
 
 
 def get_generator_for_get_all(mocker, mock_return_items):
-    mock_return_items = mock_return_items or ""
+    if not mock_return_items:
+        mock_return_items = []
+    elif not isinstance(mock_return_items, dict):
+        mock_return_items = [json.loads(mock_return_items)]
 
     def gen(*args, **kwargs):
-        response = mocker.MagicMock(spec=Request)
-        response.text = f'{{"items": [{mock_return_items}]}}'
-        yield Py42Response(response)
+        yield create_mock_response(mocker, data={"items": mock_return_items})
 
     return gen
 

tests/cmds/detectionlists/test_init.py

@@ -1,10 +1,8 @@
 import pytest
-from py42.response import Py42Response
-from requests import Response
+from tests.conftest import create_mock_response
 
 from code42cli.cmds.detectionlists import update_user
 
-
 MOCK_USER_ID = "USER-ID"
 MOCK_USER_NAME = "[email protected]"
 MOCK_ALIAS = "alias@example"
@@ -24,9 +22,7 @@
 
 @pytest.fixture
 def user_response_with_cloud_aliases(mocker):
-    response = mocker.MagicMock(spec=Response)
-    response.text = MOCK_USER_PROFILE_RESPONSE
-    return Py42Response(response)
+    return create_mock_response(mocker, data=MOCK_USER_PROFILE_RESPONSE)
 
 
 @pytest.fixture

tests/cmds/search/test_extraction.py

@@ -1,7 +1,6 @@
 import pytest
 from c42eventextractor.extractors import BaseExtractor
-from py42.response import Py42Response
-from requests import Response
+from tests.conftest import create_mock_response
 
 from code42cli import errors
 from code42cli.cmds.search.cursor_store import BaseCursorStore
@@ -10,7 +9,6 @@
 from code42cli.cmds.search.extraction import try_get_default_header
 from code42cli.output_formats import OutputFormat
 
-
 key = "events"
 
 
@@ -59,10 +57,9 @@ def _get_timestamp_from_item(self, item):
     handlers = create_handlers(
         sdk, TestExtractor, cursor_store, "chk-name", formatter, force_pager=False
     )
-    http_response = mocker.MagicMock(spec=Response)
     events = [{"property": "bar"}]
-    http_response.text = f'{{"{key}": [{{"property": "bar"}}]}}'
-    py42_response = Py42Response(http_response)
+    data = f'{{"{key}": [{{"property": "bar"}}]}}'
+    py42_response = create_mock_response(mocker, data=data)
     handlers.handle_response(py42_response)
     formatter.echo_formatted_list.assert_called_once_with(events, force_pager=False)
 
@@ -82,9 +79,8 @@ def _get_timestamp_from_item(self, item):
     handlers = create_send_to_handlers(
         sdk, TestExtractor, cursor_store, "chk-name", event_extractor_logger
     )
-    http_response = mocker.MagicMock(spec=Response)
     events = [{"property": "bar"}]
-    http_response.text = f'{{"{key}": [{{"property": "bar"}}]}}'
-    py42_response = Py42Response(http_response)
+    data = f'{{"{key}": [{{"property": "bar"}}]}}'
+    py42_response = create_mock_response(mocker, data=data)
     handlers.handle_response(py42_response)
     event_extractor_logger.info.assert_called_once_with(events[0])

tests/cmds/test_alert_rules.py

@@ -1,26 +1,23 @@
-import json
 import logging
 
 import pytest
 from py42.exceptions import Py42BadRequestError
 from py42.exceptions import Py42InternalServerError
 from py42.exceptions import Py42InvalidRuleOperationError
-from py42.response import Py42Response
 from requests import HTTPError
 from requests import Request
 from requests import Response
+from tests.conftest import create_mock_http_error
+from tests.conftest import create_mock_response
 
 from code42cli.main import cli
 
 TEST_RULE_ID = "rule-id"
 TEST_USER_ID = "test-user-id"
 TEST_USERNAME = "[email protected]"
 TEST_SOURCE = "rule source"
-
 TEST_EMPTY_RULE_RESPONSE = {"ruleMetadata": []}
-
 ALERT_RULES_COMMAND = "alert-rules"
-
 TEST_RULE_RESPONSE = {
     "ruleMetadata": [
         {
@@ -33,7 +30,6 @@
         }
     ]
 }
-
 TEST_GET_ALL_RESPONSE_EXFILTRATION = {
     "ruleMetadata": [
         {"observerRuleId": TEST_RULE_ID, "type": "FED_ENDPOINT_EXFILTRATION"}
@@ -51,30 +47,22 @@
 
 def get_rule_not_found_side_effect(mocker):
     def side_effect(*args, **kwargs):
-        response = mocker.MagicMock(spec=Response)
-        response.text = json.dumps(TEST_EMPTY_RULE_RESPONSE)
-        return Py42Response(response)
+        return create_mock_response(mocker, data=TEST_EMPTY_RULE_RESPONSE)
 
     return side_effect
 
 
 def get_user_not_on_alert_rule_side_effect(mocker):
     def side_effect(*args, **kwargs):
-        err = mocker.MagicMock(spec=HTTPError)
-        resp = mocker.MagicMock(spec=Response)
-        resp.text = "TEST_ERR"
-        err.response = resp
+        err = create_mock_http_error(mocker, data="TEST_ERR", status=400)
         raise Py42BadRequestError(err)
 
     return side_effect
 
 
 def create_invalid_rule_type_side_effect(mocker):
     def side_effect(*args, **kwargs):
-        err = mocker.MagicMock(spec=HTTPError)
-        resp = mocker.MagicMock(spec=Response)
-        resp.text = "TEST_ERR"
-        err.response = resp
+        err = create_mock_http_error(mocker, data="TEST_ERR", status=400)
         raise Py42InvalidRuleOperationError(err, TEST_RULE_ID, TEST_SOURCE)
 
     return side_effect

tests/cmds/test_alerts.py

@@ -5,12 +5,11 @@
 import pytest
 from c42eventextractor.extractors import AlertExtractor
 from py42.exceptions import Py42NotFoundError
-from py42.response import Py42Response
 from py42.sdk.queries.alerts.filters import AlertState
-from requests import Response
 from tests.cmds.conftest import filter_term_is_in_call_args
 from tests.cmds.conftest import get_filter_value_from_json
 from tests.cmds.conftest import get_mark_for_search_and_send_to
+from tests.conftest import create_mock_response
 from tests.conftest import get_test_date_str
 
 from code42cli import errors
@@ -344,9 +343,7 @@ def send_to_logger_factory(mocker):
 
 @pytest.fixture
 def full_alert_details_response(mocker):
-    response = mocker.MagicMock(spec=Response)
-    response.text = json.dumps(ALERT_DETAILS_FULL_RESPONSE)
-    return Py42Response(response)
+    return create_mock_response(mocker, data=ALERT_DETAILS_FULL_RESPONSE)
 
 
 @search_and_send_to_test
@@ -992,11 +989,11 @@ def test_show_when_alert_has_note_includes_note(
 def test_show_when_alert_has_no_note_excludes_note(
     mocker, cli_state, runner, full_alert_details_response
 ):
-    response = mocker.MagicMock(spec=Response)
-    sans_note_text = dict(ALERT_DETAILS_FULL_RESPONSE)
-    sans_note_text["alerts"][0]["note"] = None
-    response.text = json.dumps(sans_note_text)
-    cli_state.sdk.alerts.get_details.return_value = Py42Response(response)
+    response_data = dict(ALERT_DETAILS_FULL_RESPONSE)
+    response_data["alerts"][0]["note"] = None
+    cli_state.sdk.alerts.get_details.return_value = create_mock_response(
+        mocker, data=response_data
+    )
     result = runner.invoke(cli, ["alerts", "show", "TEST-ALERT-ID"], obj=cli_state)
     # Note is included in `full_alert_details_response` initially.
     assert "Note" not in result.output
@@ -1037,11 +1034,11 @@ def test_show_when_alert_has_observations_and_excludes_observations_does_not_out
 def test_show_when_alert_does_not_have_observations_and_includes_observations_outputs_no_observations(
     mocker, cli_state, runner
 ):
-    response = mocker.MagicMock(spec=Response)
-    response_text = dict(ALERT_DETAILS_FULL_RESPONSE)
-    response_text["alerts"][0]["observations"] = None
-    response.text = json.dumps(response_text)
-    cli_state.sdk.alerts.get_details.return_value = Py42Response(response)
+    response_data = dict(ALERT_DETAILS_FULL_RESPONSE)
+    response_data["alerts"][0]["observations"] = None
+    cli_state.sdk.alerts.get_details.return_value = create_mock_response(
+        mocker, data=response_data
+    )
     result = runner.invoke(
         cli,
         ["alerts", "show", "TEST-ALERT-ID", "--include-observations"],

tests/cmds/test_auditlogs.py

@@ -105,10 +105,10 @@ def send_to_logger(mocker, send_to_logger_factory):
 @pytest.fixture
 def mock_audit_log_response(mocker):
     response1 = create_mock_response(
-        mocker, json.dumps({"events": TEST_EVENTS_WITH_SAME_TIMESTAMP})
+        mocker, data={"events": TEST_EVENTS_WITH_SAME_TIMESTAMP}
     )
     response2 = create_mock_response(
-        mocker, json.dumps({"events": TEST_EVENTS_WITH_DIFFERENT_TIMESTAMPS})
+        mocker, data={"events": TEST_EVENTS_WITH_DIFFERENT_TIMESTAMPS}
     )
 
     def response_gen():
@@ -120,10 +120,10 @@ def response_gen():
 
 @pytest.fixture
 def mock_audit_log_response_with_10_records(mocker):
-    text = json.dumps({"events": TEST_EVENTS_WITH_SAME_TIMESTAMP})
+    data = json.dumps({"events": TEST_EVENTS_WITH_SAME_TIMESTAMP})
     responses = []
     for _ in range(0, 10):
-        responses.append(create_mock_response(mocker, text))
+        responses.append(create_mock_response(mocker, data=data))
 
     def response_gen():
         yield from responses
@@ -133,10 +133,10 @@ def response_gen():
 
 @pytest.fixture
 def mock_audit_log_response_with_only_same_timestamps(mocker):
-    text = json.dumps({"events": TEST_EVENTS_WITH_SAME_TIMESTAMP})
+    data = {"events": TEST_EVENTS_WITH_SAME_TIMESTAMP}
 
     def response_gen():
-        yield create_mock_response(mocker, text)
+        yield create_mock_response(mocker, data=data)
 
     return response_gen()
 
@@ -146,10 +146,9 @@ def mock_audit_log_response_with_missing_ms_timestamp(mocker):
     event = dict(TEST_EVENTS_WITH_SAME_TIMESTAMP[0])
     event["timestamp"] = "2020-01-01T12:00:00Z"
     response_data = {"events": [event]}
-    text = json.dumps(response_data)
 
     def response_gen():
-        yield create_mock_response(mocker, text)
+        yield create_mock_response(mocker, data=response_data)
 
     return response_gen()
 
@@ -158,11 +157,9 @@ def response_gen():
 def mock_audit_log_response_with_micro_seconds(mocker):
     event = dict(TEST_EVENTS_WITH_SAME_TIMESTAMP[0])
     event["timestamp"] = "2021-07-01T14:47:13.093616Z"
-    response_data = {"events": [event]}
-    text = json.dumps(response_data)
 
     def response_gen():
-        yield create_mock_response(mocker, text)
+        yield create_mock_response(mocker, data={"events": [event]})
 
     return response_gen()
 
@@ -171,11 +168,9 @@ def response_gen():
 def mock_audit_log_response_with_nano_seconds(mocker):
     event = dict(TEST_EVENTS_WITH_SAME_TIMESTAMP[0])
     event["timestamp"] = "2021-07-01T14:47:13.093616500Z"
-    response_data = {"events": [event]}
-    text = json.dumps(response_data)
 
     def response_gen():
-        yield create_mock_response(mocker, text)
+        yield create_mock_response(mocker, data={"events": [event]})
 
     return response_gen()
 
@@ -185,13 +180,12 @@ def mock_audit_log_response_with_error_causing_timestamp(mocker):
     good_event = dict(TEST_EVENTS_WITH_SAME_TIMESTAMP[0])
     bad_event = dict(TEST_EVENTS_WITH_SAME_TIMESTAMP[0])
     bad_event["timestamp"] = "I AM NOT A TIMESTAMP"  # Will cause a ValueError.
-    response_data = {
-        "events": [good_event, bad_event]
-    }  # good_event should still get processed.
-    text = json.dumps(response_data)
+
+    # good_event should still get processed.
+    response_data = {"events": [good_event, bad_event]}
 
     def response_gen():
-        yield create_mock_response(mocker, text)
+        yield create_mock_response(mocker, data=response_data)
 
     return response_gen()