!41 bug(Filters): [#80] Start scan with filters is not working Closes #80

Author: João Silva

probely_cli/cli/commands/targets/start_scan.py

@@ -11,6 +11,7 @@
 
 logger = logging.getLogger(__name__)
 
+
 def validate_and_retrieve_extra_payload(args):
     extra_payload = validate_and_retrieve_yaml_content(args.yaml_file_path)
 
@@ -47,4 +48,5 @@ def start_scans_command_handler(args):
         scans = [start_scan(targets_ids[0], extra_payload)]
     else:
         scans = start_scans(targets_ids, extra_payload)
+
     display_scans_response_output(args, scans)

probely_cli/sdk/client.py

@@ -63,8 +63,8 @@ class ProbelyAPIClient:
     _session_cache: Union[Session, None] = None
 
     @classmethod
-    def get(cls, url, query_params=None):
-        return cls._send_request("get", url, query_params=query_params)
+    def get(cls, url, query_params: dict = None, payload: dict = None):
+        return cls._send_request("get", url, query_params=query_params, payload=payload)
 
     @classmethod
     def post(cls, url, query_params: dict = None, payload: dict = None):
@@ -73,11 +73,16 @@ def post(cls, url, query_params: dict = None, payload: dict = None):
         )
 
     @classmethod
-    def patch(cls, url, payload: dict = None):
-        return cls._send_request("patch", url, payload=payload)
+    def patch(cls, url, query_params: dict = None, payload: dict = None):
+        return cls._send_request(
+            "patch", url, query_params=query_params, payload=payload
+        )
 
-    def delete(self, url):
-        return self._send_request("delete", url)
+    @classmethod
+    def delete(cls, url, query_params: dict = None, payload: dict = None):
+        return cls._send_request(
+            "delete", url, query_params=query_params, payload=payload
+        )
 
     @classmethod
     def _send_request(

probely_cli/sdk/scans.py

@@ -10,7 +10,7 @@
 from probely_cli.sdk.client import ProbelyAPIClient
 from probely_cli.sdk.helpers import validate_resource_ids
 from probely_cli.settings import (
-    PROBELY_API_BULK_START_SCANS_URL,
+    PROBELY_API_SCANS_BULK_START_URL,
     PROBELY_API_PAGE_SIZE,
     PROBELY_API_SCAN_CANCEL_URL,
     PROBELY_API_SCAN_PAUSE_URL,
@@ -19,18 +19,18 @@
     PROBELY_API_SCANS_BULK_PAUSE_URL,
     PROBELY_API_SCANS_BULK_RESUME_URL,
     PROBELY_API_SCANS_URL,
-    PROBELY_API_START_SCAN_URL,
+    PROBELY_API_TARGETS_START_SCAN_URL,
     PROBELY_API_TARGETS_URL,
 )
 
 logger = logging.getLogger(__name__)
 
 
 def start_scan(target_id: str, extra_payload: dict = None) -> dict:
-    scan_target_url = PROBELY_API_START_SCAN_URL.format(target_id=target_id)
+    scan_target_url = PROBELY_API_TARGETS_START_SCAN_URL.format(target_id=target_id)
 
     resp_status_code, resp_content = ProbelyAPIClient.post(
-        scan_target_url, extra_payload
+        scan_target_url, payload=extra_payload
     )
 
     if resp_status_code != 200:
@@ -47,19 +47,20 @@ def start_scan(target_id: str, extra_payload: dict = None) -> dict:
 def start_scans(target_ids: List[str], extra_payload: dict = None) -> List[dict]:
     validate_resource_ids(PROBELY_API_TARGETS_URL, target_ids)
 
-    url = PROBELY_API_BULK_START_SCANS_URL
+    url = PROBELY_API_SCANS_BULK_START_URL
     extra_payload = extra_payload or {}
 
     payload = {
         "targets": [{"id": target_id} for target_id in target_ids],
         **extra_payload,
     }
 
-    resp_status_code, resp_content = ProbelyAPIClient.post(url, payload)
+    resp_status_code, resp_content = ProbelyAPIClient.post(url, payload=payload)
+
+    if resp_status_code == 400:
+        raise ProbelyBadRequest(resp_content)
 
     if resp_status_code != 200:
-        if resp_status_code == 400:
-            raise ProbelyBadRequest(resp_content)
         raise ProbelyRequestFailed(resp_content)
 
     scans = resp_content
@@ -72,8 +73,10 @@ def cancel_scans(scan_ids: List[str]) -> List[dict]:
     for scan_id in scan_ids:
         retrieve_scan(scan_id)
 
+    payload = {"scans": [{"id": scan_id} for scan_id in scan_ids]}
+
     resp_status_code, resp_content = ProbelyAPIClient.post(
-        scan_cancel_url, {"scans": [{"id": scan_id} for scan_id in scan_ids]}
+        scan_cancel_url, payload=payload
     )
 
     if resp_status_code != 200:
@@ -88,24 +91,25 @@ def cancel_scans(scan_ids: List[str]) -> List[dict]:
 
 
 def cancel_scan(scan_id: str) -> dict:
-
     scan = retrieve_scan(scan_id)
     target = scan.get("target", {})
 
     scan_cancel_url = PROBELY_API_SCAN_CANCEL_URL.format(
         target_id=target.get("id"), scan_id=scan_id
     )
 
-    resp_status_code, resp_content = ProbelyAPIClient().post(
-        scan_cancel_url,
-        {
-            "target_options": {
-                "site": target.get("site"),
-                "scanning_agent": target.get("scanning_agent"),
-            },
-            "has_sequence_navigation": scan.get("has_sequence_navigation"),
-            "user_data": scan.get("user_data"),
+    payload = {
+        "target_options": {
+            "site": target.get("site"),
+            "scanning_agent": target.get("scanning_agent"),
         },
+        "has_sequence_navigation": scan.get("has_sequence_navigation"),
+        "user_data": scan.get("user_data"),
+    }
+
+    resp_status_code, resp_content = ProbelyAPIClient.post(
+        scan_cancel_url,
+        payload=payload,
     )
 
     if resp_status_code != 200:
@@ -122,16 +126,18 @@ def pause_scan(scan_id: str) -> dict:
         target_id=target.get("id"), scan_id=scan_id
     )
 
+    payload = {
+        "target_options": {
+            "site": target.get("site"),
+            "scanning_agent": target.get("scanning_agent"),
+        },
+        "has_sequence_navigation": scan.get("has_sequence_navigation"),
+        "user_data": scan.get("user_data"),
+    }
+
     resp_status_code, resp_content = ProbelyAPIClient.post(
         scan_pause_url,
-        {
-            "target_options": {
-                "site": target.get("site"),
-                "scanning_agent": target.get("scanning_agent"),
-            },
-            "has_sequence_navigation": scan.get("has_sequence_navigation"),
-            "user_data": scan.get("user_data"),
-        },
+        payload=payload,
     )
 
     if resp_status_code != 200:
@@ -146,8 +152,11 @@ def pause_scans(scan_ids: List[str]) -> List[dict]:
     for scan_id in scan_ids:
         scan = retrieve_scan(scan_id)
 
+    payload = {"scans": [{"id": scan_id} for scan_id in scan_ids]}
+
     resp_status_code, resp_content = ProbelyAPIClient.post(
-        scan_pause_url, {"scans": [{"id": scan_id} for scan_id in scan_ids]}
+        scan_pause_url,
+        payload=payload,
     )
 
     if resp_status_code != 200:
@@ -169,16 +178,18 @@ def resume_scan(scan_id: str) -> dict:
         target_id=target.get("id"), scan_id=scan_id
     )
 
-    resp_status_code, resp_content = ProbelyAPIClient().post(
-        scan_resume_url,
-        {
-            "target_options": {
-                "site": target.get("site"),
-                "scanning_agent": target.get("scanning_agent"),
-            },
-            "has_sequence_navigation": scan.get("has_sequence_navigation"),
-            "user_data": scan.get("user_data"),
+    payload = {
+        "target_options": {
+            "site": target.get("site"),
+            "scanning_agent": target.get("scanning_agent"),
         },
+        "has_sequence_navigation": scan.get("has_sequence_navigation"),
+        "user_data": scan.get("user_data"),
+    }
+
+    resp_status_code, resp_content = ProbelyAPIClient.post(
+        scan_resume_url,
+        payload=payload,
     )
 
     if resp_status_code != 200:
@@ -198,7 +209,9 @@ def resume_scans(scan_ids: List[str], ignore_blackout_period=False) -> List[Dict
         "overrides": {"ignore_blackout_period": ignore_blackout_period},
     }
 
-    resp_status_code, resp_content = ProbelyAPIClient.post(scan_resume_url, payload)
+    resp_status_code, resp_content = ProbelyAPIClient.post(
+        scan_resume_url, payload=payload
+    )
 
     if resp_status_code != 200:
         raise ProbelyRequestFailed(resp_content, resp_status_code)

probely_cli/sdk/targets.py

@@ -10,15 +10,14 @@
 )
 from probely_cli.sdk.enums import TargetAPISchemaTypeEnum, TargetTypeEnum
 from probely_cli.sdk.helpers import validate_resource_ids
-
+from .client import ProbelyAPIClient
 from ..settings import (
     PROBELY_API_TARGETS_BULK_DELETE_URL,
     PROBELY_API_TARGETS_BULK_UPDATE_URL,
     PROBELY_API_TARGETS_DELETE_URL,
     PROBELY_API_TARGETS_RETRIEVE_URL,
     PROBELY_API_TARGETS_URL,
 )
-from .client import ProbelyAPIClient
 
 logger = logging.getLogger(__name__)
 
@@ -46,7 +45,7 @@ def retrieve_target(target_id: str) -> dict:
 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)
+    resp_status_code, resp_content = ProbelyAPIClient.delete(url=url)
 
     if resp_status_code == 404:
         raise ProbelyObjectNotFound(id=target_id)
@@ -160,7 +159,7 @@ def add_target(
 
     merge(body_data, arguments_settings, strategy=Strategy.REPLACE)
 
-    resp_status_code, resp_content = ProbelyAPIClient().post(
+    resp_status_code, resp_content = ProbelyAPIClient.post(
         url=create_target_url, query_params=query_params, payload=body_data
     )
 
@@ -177,7 +176,7 @@ def add_target(
 def update_target(target_id: str, payload: dict) -> dict:
     url = PROBELY_API_TARGETS_RETRIEVE_URL.format(id=target_id)
 
-    resp_status_code, resp_content = ProbelyAPIClient.patch(url, payload)
+    resp_status_code, resp_content = ProbelyAPIClient.patch(url, payload=payload)
 
     if resp_status_code != 200:
         if resp_status_code == 400:
@@ -195,7 +194,7 @@ def update_targets(target_ids: List[str], payload: dict) -> List[Dict]:
     url = PROBELY_API_TARGETS_BULK_UPDATE_URL
     update_payload = {"ids": target_ids, **payload}
 
-    resp_status_code, resp_content = ProbelyAPIClient.post(url, update_payload)
+    resp_status_code, resp_content = ProbelyAPIClient.post(url, payload=update_payload)
 
     if resp_status_code != 200:
         if resp_status_code == 400:

probely_cli/settings.py

@@ -108,13 +108,13 @@ def get_probely_api_base_url():
 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/"
+PROBELY_API_TARGETS_START_SCAN_URL = PROBELY_API_TARGETS_URL + "{target_id}/scan_now/"
 
 PROBELY_API_SCANS_URL = PROBELY_API_BASE_URL + "scans/"
-PROBELY_API_START_SCAN_URL = PROBELY_API_TARGETS_URL + "{target_id}/scan_now/"
 PROBELY_API_SCANS_BULK_CANCEL_URL = PROBELY_API_SCANS_URL + "bulk/cancel/"
 PROBELY_API_SCANS_BULK_RESUME_URL = PROBELY_API_SCANS_URL + "bulk/resume/"
 PROBELY_API_SCANS_BULK_PAUSE_URL = PROBELY_API_SCANS_URL + "bulk/pause/"
-PROBELY_API_BULK_START_SCANS_URL = PROBELY_API_SCANS_URL + "bulk/start/"
+PROBELY_API_SCANS_BULK_START_URL = PROBELY_API_SCANS_URL + "bulk/start/"
 PROBELY_API_SCAN_PAUSE_URL = (
     PROBELY_API_TARGETS_URL + "{target_id}/scans/{scan_id}/pause/"
 )

tests/sdk/test_scans.py

@@ -18,8 +18,8 @@
     start_scans,
 )
 from probely_cli.settings import (
-    PROBELY_API_BULK_START_SCANS_URL,
-    PROBELY_API_START_SCAN_URL,
+    PROBELY_API_SCANS_BULK_START_URL,
+    PROBELY_API_TARGETS_START_SCAN_URL,
 )
 
 
@@ -32,22 +32,26 @@
 )
 @patch("probely_cli.sdk.client.ProbelyAPIClient.post")
 def test_start_scan(
-    api_client_mock: Mock, valid_scans_start_api_response: Dict, payload
+    api_client_mock: Mock,
+    valid_scans_start_api_response: Dict,
+    payload,
 ):
     """
     Test that start_scan successfully starts a scan and returns the scan details,
     both with and without an extra payload.
     """
     target_id = valid_scans_start_api_response["target"]["id"]
     expected_response = valid_scans_start_api_response
-    expected_endpoint_url = PROBELY_API_START_SCAN_URL.format(target_id=target_id)
+    expected_endpoint_url = PROBELY_API_TARGETS_START_SCAN_URL.format(
+        target_id=target_id
+    )
 
     api_client_mock.return_value = (200, expected_response)
 
-    result = start_scan(target_id, payload) if payload else start_scan(target_id)
+    result = start_scan(target_id, payload)
 
     assert result == expected_response
-    api_client_mock.assert_called_once_with(expected_endpoint_url, payload)
+    api_client_mock.assert_called_once_with(expected_endpoint_url, payload=payload)
 
 
 @patch("probely_cli.sdk.client.ProbelyAPIClient.post")
@@ -82,7 +86,7 @@ def test_start_scans__successful_api_call(
     valid_scans_start_api_response: Dict,
 ):
     validate_resource_ids_mock.return_value = None  # target IDs are valid
-    expected_endpoint_url = PROBELY_API_BULK_START_SCANS_URL
+    expected_endpoint_url = PROBELY_API_SCANS_BULK_START_URL
     payload = {"overrides": {"scan_profile": "lightning"}}
     target_ids = ["target_id1", "target_id2"]
     expected_payload_on_api_call = {
@@ -96,7 +100,7 @@ def test_start_scans__successful_api_call(
 
     assert result == expected_response
     api_client_mock.assert_called_once_with(
-        expected_endpoint_url, expected_payload_on_api_call
+        expected_endpoint_url, payload=expected_payload_on_api_call
     )
 
 
@@ -154,7 +158,9 @@ def test_cancel_scan(
     scan = cancel_scans([scan_id_to_cancel])
 
     mock_client.assert_called_once()
-    scans_to_cancel = mock_client.call_args[0][1]
+    _args, kwargs = mock_client.call_args
+
+    scans_to_cancel = kwargs["payload"]
 
     assert scans_to_cancel is not None
     assert scans_to_cancel["scans"][0]["id"] == scan_id_to_cancel
@@ -223,7 +229,9 @@ def test_resume_scan(
     scan = resume_scans([scan_id_to_resume])
 
     mock_client.assert_called_once()
-    scans_to_resume = mock_client.call_args[0][1]
+    _args, kwargs = mock_client.call_args
+
+    scans_to_resume = kwargs["payload"]
 
     assert scans_to_resume is not None
     assert scans_to_resume["scans"][0]["id"] == scan_id_to_resume
@@ -282,7 +290,9 @@ def test_pause_scans(
     scan = pause_scans([scan_id_to_pause])
 
     mock_client.assert_called_once()
-    scans_to_pause = mock_client.call_args[0][1]
+    _args, kwargs = mock_client.call_args
+
+    scans_to_pause = kwargs["payload"]
 
     assert scans_to_pause is not None
     assert scans_to_pause["scans"][0]["id"] == scan_id_to_pause