feat: source_uuid to multiscan, when provided, the incidents will be created for the found secrets

Author: alina-tuholukova-gg

pygitguardian/client.py

@@ -482,6 +482,7 @@ def multi_content_scan(
         ignore_known_secrets: Optional[bool] = None,
         *,
         all_secrets: Optional[bool] = None,
+        source_uuid: Optional[str] = None,
     ) -> Union[Detail, MultiScanResult]:
         """
         multi_content_scan handles the /multiscan endpoint of the API.
@@ -495,6 +496,8 @@ def multi_content_scan(
         :param extra_headers: additional headers to add to the request
         :param ignore_known_secrets: indicates whether known secrets should be ignored
         :param all_secrets: indicates whether all secrets should be returned
+        :param source_uuid: if provided, the source UUID will be used to identify the custom source, for which
+        incidents will be created
         :return: Detail or ScanResult response and status code
         """
         max_documents = self.secret_scan_preferences.maximum_documents_per_scan
@@ -520,6 +523,8 @@ def multi_content_scan(
             params["ignore_known_secrets"] = ignore_known_secrets
         if all_secrets is not None:
             params["all_secrets"] = all_secrets
+        if source_uuid is not None:
+            params["source_uuid"] = source_uuid
 
         resp = self.post(
             endpoint="multiscan",

tests/test_client.py

@@ -557,7 +557,13 @@ def test_scan_parameters(client: GGClient, all_secrets):
 @responses.activate
 @pytest.mark.parametrize("ignore_known_secrets", (None, True, False))
 @pytest.mark.parametrize("all_secrets", (None, True, False))
-def test_multiscan_parameters(client: GGClient, ignore_known_secrets, all_secrets):
+@pytest.mark.parametrize("source_uuid", (None, "test-source-uuid"))
+def test_multiscan_parameters(
+    client: GGClient,
+    ignore_known_secrets: Optional[bool],
+    all_secrets: Optional[bool],
+    source_uuid: Optional[str],
+) -> None:
     """
     GIVEN a ggclient
     WHEN calling multi_content_scan with parameters
@@ -569,6 +575,8 @@ def test_multiscan_parameters(client: GGClient, ignore_known_secrets, all_secret
         to_match["ignore_known_secrets"] = ignore_known_secrets
     if all_secrets is not None:
         to_match["all_secrets"] = all_secrets
+    if source_uuid is not None:
+        to_match["source_uuid"] = source_uuid
 
     mock_response = responses.post(
         url=client._url_from_endpoint("multiscan", "v1"),
@@ -601,6 +609,7 @@ def test_multiscan_parameters(client: GGClient, ignore_known_secrets, all_secret
         [{"filename": FILENAME, "document": DOCUMENT}],
         ignore_known_secrets=ignore_known_secrets,
         all_secrets=all_secrets,
+        source_uuid=source_uuid,
     )
 
     assert mock_response.call_count == 1