!33 feat(target commands): [#73] Bulk target actions only for multiple targets Closes #73

Author: João Silva

probely_cli/__init__.py

@@ -3,6 +3,7 @@
     list_targets,
     retrieve_target,
     retrieve_targets,
+    delete_target,
     delete_targets,
     add_target,
     update_target,
@@ -16,7 +17,7 @@
     "list_targets",
     "retrieve_target",
     "retrieve_targets",
-    # "delete_target",
+    "delete_target",
     "delete_targets",
     "update_target",
     "update_targets",

probely_cli/cli/commands/targets/delete.py

@@ -2,7 +2,7 @@
     target_filters_handler,
 )
 from probely_cli.exceptions import ProbelyCLIValidation
-from probely_cli.sdk.targets import delete_targets, list_targets
+from probely_cli.sdk.targets import delete_targets, list_targets, delete_target
 
 
 def targets_delete_command_handler(args):
@@ -18,10 +18,16 @@ def targets_delete_command_handler(args):
     if filters and targets_ids:
         raise ProbelyCLIValidation("filters and Target IDs are mutually exclusive.")
 
-    if not targets_ids:
+    if filters:
         targets_list = list_targets(targets_filters=filters)
         targets_ids = [target.get("id") for target in targets_list]
 
+    if len(targets_ids) == 1:
+        target_id = delete_target(targets_ids[0])
+        args.console.print(target_id)
+        return
+
     targets = delete_targets(targets_ids=targets_ids)
+
     for ids in targets.get("ids"):
         args.console.print(ids)

probely_cli/cli/commands/targets/parsers.py

@@ -97,7 +97,7 @@ def build_targets_parser(commands_parser, configs_parser, file_parser, output_pa
 
     targets_delete_parser = targets_command_parser.add_parser(
         "delete",
-        parents=[configs_parser, target_filters_parser, output_parser],
+        parents=[configs_parser, target_filters_parser],
         formatter_class=RichHelpFormatter,
     )
     targets_delete_parser.add_argument(

probely_cli/sdk/client.py

@@ -76,6 +76,9 @@ def post(cls, url, query_params: dict = None, payload: dict = None):
     def patch(cls, url, payload: dict = None):
         return cls._send_request("patch", url, payload=payload)
 
+    def delete(self, url):
+        return self._send_request("delete", url)
+
     @classmethod
     def _send_request(
         cls, method: str, url: str, payload: dict = None, query_params: dict = None

probely_cli/sdk/targets.py

@@ -19,6 +19,7 @@
     PROBELY_API_TARGETS_BULK_UPDATE_URL,
     PROBELY_API_TARGETS_URL,
     PROBELY_API_TARGETS_RETRIEVE_URL,
+    PROBELY_API_TARGETS_DELETE_URL,
 )
 
 logger = logging.getLogger(__name__)
@@ -44,6 +45,20 @@ def retrieve_target(target_id: str) -> dict:
     return resp_content
 
 
+def delete_target(target_id: str) -> str:
+    url = PROBELY_API_TARGETS_DELETE_URL.format(id=target_id)
+
+    resp_status_code, resp_content = ProbelyAPIClient().delete(url=url)
+
+    if resp_status_code == 404:
+        raise ProbelyObjectNotFound(id=target_id)
+
+    if resp_status_code != 204:
+        raise ProbelyRequestFailed(resp_content)
+
+    return target_id
+
+
 def delete_targets(targets_ids: List[str]):
     """Delete targets
 

probely_cli/settings.py

@@ -95,6 +95,7 @@ def _get_config(
 # URLs
 PROBELY_API_TARGETS_URL = PROBELY_API_URL_BASE + "targets/"
 PROBELY_API_TARGETS_RETRIEVE_URL = PROBELY_API_TARGETS_URL + "{id}/"
+PROBELY_API_TARGETS_DELETE_URL = PROBELY_API_TARGETS_URL + "{id}/"
 PROBELY_API_TARGETS_BULK_DELETE_URL = PROBELY_API_TARGETS_URL + "bulk/delete/"
 PROBELY_API_TARGETS_BULK_UPDATE_URL = PROBELY_API_TARGETS_URL + "bulk/update/"
 

tests/cli/test_targets_delete.py

@@ -1,10 +1,14 @@
-from unittest.mock import patch, Mock
+from unittest.mock import patch, Mock, MagicMock
 
 
+@patch("probely_cli.cli.commands.targets.delete.delete_target")
 @patch("probely_cli.cli.commands.targets.delete.delete_targets")
 @patch("probely_cli.cli.commands.targets.delete.list_targets")
-def test_targets_delete_target(
-    list_targets_mock: Mock, delete_targets_mock: Mock, probely_cli
+def test_targets_delete__multiple_targets(
+    list_targets_mock: Mock,
+    delete_targets_mock: Mock,
+    delete_target_mock: MagicMock,
+    probely_cli,
 ):
     target_id1 = "target_id1"
     target_id2 = "target_id2"
@@ -18,22 +22,87 @@ def test_targets_delete_target(
         target_id2,
         return_list=True,
     )
-    list_targets_mock.assert_not_called()
+
+    assert delete_target_mock.call_count == 0, "Expected bulk call for multiple targets"
+    assert list_targets_mock.call_count == 0, "Expected no search for multiple IDs"
+
     delete_targets_mock.assert_called_once_with(targets_ids=[target_id1, target_id2])
-    assert len(stderr_lines) == 0
+    assert stderr_lines == []
     assert len(stdout_lines) == 2, "Expected to have 2 line with the deleted target id"
+    assert target_id1 == stdout_lines[0]
     assert target_id2 == stdout_lines[1]
 
 
+@patch("probely_cli.cli.commands.targets.delete.delete_targets")
+@patch("probely_cli.cli.commands.targets.delete.delete_target")
+@patch("probely_cli.cli.commands.targets.delete.list_targets")
+def test_targets_delete__one_target(
+    list_targets_mock: Mock,
+    delete_target_mock: MagicMock,
+    delete_targets_mock: MagicMock,
+    probely_cli,
+):
+    testable_target_id = "testable_target_id"
+    delete_target_mock.return_value = testable_target_id
+
+    stdout_lines, stderr_lines = probely_cli(
+        "targets", "delete", testable_target_id, return_list=True
+    )
+
+    assert delete_targets_mock.call_count == 0, "Expected bulk delete to NOT called"
+    assert list_targets_mock.call_count == 0, "Expected no search for ID"
+
+    assert delete_target_mock.call_count == 1, "Expected usage of single delete"
+
+    assert stderr_lines == []
+    assert stdout_lines[-1] == testable_target_id
+
+
+@patch("probely_cli.cli.commands.targets.delete.delete_target")
 @patch("probely_cli.cli.commands.targets.delete.delete_targets")
 @patch("probely_cli.cli.commands.targets.delete.list_targets")
-def test_targets_delete_target_with_filters(
-    list_targets_mock: Mock, delete_targets_mock: Mock, probely_cli
+def test_targets_delete__filters_with_multiple_results(
+    list_targets_mock: Mock,
+    delete_targets_mock: Mock,
+    delete_target_mock: Mock,
+    probely_cli,
+):
+    target_id1 = "target_id1"
+    target_id2 = "target_id2"
+    list_targets_mock.return_value = [{"id": target_id1}, {"id": target_id2}]
+
+    delete_targets_mock.return_value = {"ids": [target_id1, target_id2]}
+
+    stdout_lines, stderr_lines = probely_cli(
+        "targets",
+        "delete",
+        "--f-has-unlimited-scans=True",
+        return_list=True,
+    )
+
+    assert delete_target_mock.call_count == 0, "Expect single delete method not called"
+
+    list_targets_mock.assert_called_with(targets_filters={"unlimited": True})
+    delete_targets_mock.assert_called_once_with(targets_ids=[target_id1, target_id2])
+    assert stderr_lines == []
+    assert len(stdout_lines) == 2, "Expected to have 1 line with the deleted target id"
+    assert target_id1 == stdout_lines[0]
+    assert target_id2 == stdout_lines[1]
+
+
+@patch("probely_cli.cli.commands.targets.delete.delete_target")
+@patch("probely_cli.cli.commands.targets.delete.delete_targets")
+@patch("probely_cli.cli.commands.targets.delete.list_targets")
+def test_targets_delete__filters_with_single_result(
+    list_targets_mock: Mock,
+    delete_targets_mock: Mock,
+    delete_target_mock: Mock,
+    probely_cli,
 ):
     target_id1 = "target_id1"
     list_targets_mock.return_value = [{"id": target_id1}]
 
-    delete_targets_mock.return_value = {"ids": [target_id1]}
+    delete_target_mock.return_value = target_id1
 
     stdout_lines, stderr_lines = probely_cli(
         "targets",
@@ -42,8 +111,10 @@ def test_targets_delete_target_with_filters(
         return_list=True,
     )
 
+    assert delete_targets_mock.call_count == 0, "Expect single delete method not called"
+
     list_targets_mock.assert_called_with(targets_filters={"unlimited": True})
-    delete_targets_mock.assert_called_once_with(targets_ids=[target_id1])
+    delete_target_mock.assert_called_once_with(target_id1)
     assert len(stderr_lines) == 0
     assert len(stdout_lines) == 1, "Expected to have 1 line with the deleted target id"
     assert target_id1 == stdout_lines[0]
@@ -66,8 +137,13 @@ def test_targets_delete__mutually_exclusive_arguments(probely_cli):
     )
 
 
+@patch("probely_cli.cli.commands.targets.delete.delete_target")
 @patch("probely_cli.cli.commands.targets.delete.delete_targets")
-def test_targets_delete__without_any_argument(delete_targets_mock: Mock, probely_cli):
+def test_targets_delete__without_any_argument(
+    delete_targets_mock: Mock,
+    delete_target_mock: Mock,
+    probely_cli,
+):
     stdout_lines, stderr_lines = probely_cli(
         "targets",
         "delete",
@@ -81,3 +157,4 @@ def test_targets_delete__without_any_argument(delete_targets_mock: Mock, probely
     )
 
     delete_targets_mock.assert_not_called()
+    delete_target_mock.assert_not_called()

tests/sdk/test_targets.py

@@ -17,11 +17,13 @@
     retrieve_targets,
     update_target,
     add_target,
+    delete_target,
 )
 from probely_cli.settings import (
     PROBELY_API_TARGETS_BULK_DELETE_URL,
     PROBELY_API_TARGETS_BULK_UPDATE_URL,
     PROBELY_API_TARGETS_RETRIEVE_URL,
+    PROBELY_API_TARGETS_DELETE_URL,
 )
 from tests.testable_api_responses import RETRIEVE_TARGET_200_RESPONSE
 
@@ -84,27 +86,51 @@ def test_retrieve_target__success_api_call(api_client_mock: Mock):
     api_client_mock.assert_called_with(expected_call_url)
 
 
-@patch("probely_cli.sdk.client.ProbelyAPIClient.post")
+@patch("probely_cli.sdk.client.ProbelyAPIClient.delete")
 def test_delete_target__success_api_call(api_client_mock: Mock):
-    resp_code = 200
+    resp_code = 204
     testable_id = "2DZkoZH8WMEM"
     resp_content = {"id": testable_id}
 
     api_client_mock.return_value = (resp_code, resp_content)
 
-    delete_targets([testable_id])
+    delete_target(testable_id)
 
-    expected_call_url = PROBELY_API_TARGETS_BULK_DELETE_URL
-    api_client_mock.assert_called_with(
-        url=expected_call_url, payload={"ids": [testable_id]}
-    )
+    expected_call_url = PROBELY_API_TARGETS_DELETE_URL.format(id=testable_id)
 
+    api_client_mock.assert_called_with(url=expected_call_url)
 
-@patch("probely_cli.sdk.client.ProbelyAPIClient.post")
+
+@patch("probely_cli.sdk.client.ProbelyAPIClient.delete")
 def test_delete_target__unsuccessful_api_call(api_client_mock: Mock):
     resp_code = 400
     testable_id = "2DZkoZH8WMEM"
 
+    api_client_mock.return_value = (resp_code, {})
+    with pytest.raises(BaseException) as exc_info:
+        delete_target([testable_id])
+
+    raised_exception = exc_info.value
+    assert isinstance(raised_exception, ProbelyRequestFailed)
+
+    api_client_mock.reset_mock()
+
+    not_found_id = "random_target_id"
+    api_client_mock.return_value = (404, {})
+
+    with pytest.raises(BaseException) as exc_info:
+        delete_target(not_found_id)
+
+    raised_exception = exc_info.value
+    assert isinstance(raised_exception, ProbelyObjectNotFound)
+    assert raised_exception.not_found_object_id == not_found_id
+
+
+@patch("probely_cli.sdk.client.ProbelyAPIClient.post")
+def test_delete_targets__unsuccessful_api_call(api_client_mock: Mock):
+    resp_code = 400
+    testable_id = "2DZkoZH8WMEM"
+
     api_client_mock.return_value = (resp_code, {})
     with pytest.raises(BaseException) as exc_info:
         delete_targets([testable_id])