fix tests and add request metadata

Author: Dan Hertz

nightfall/api.py

@@ -119,7 +119,7 @@ def _scan_text_v3(self, data: dict):
     def scan_file(self, location: str, webhook_url: Optional[str] = None, policy_uuid: Optional[str] = None,
                   detection_rules: Optional[List[DetectionRule]] = None,
                   detection_rule_uuids: Optional[List[str]] = None,
-                  request_metadata: Optional[Dict[str, str]] = None) -> Tuple[str, str]:
+                  request_metadata: Optional[str] = None) -> Tuple[str, str]:
         """Scan file with Nightfall.
         At least one of policy_uuid, detection_rule_uuids or detection_rules is required.
 
@@ -131,6 +131,8 @@ def scan_file(self, location: str, webhook_url: Optional[str] = None, policy_uui
         :type detection_rules: List[DetectionRule] or None
         :param detection_rule_uuids: list of detection rule UUIDs.
         :type detection_rule_uuids: List[str] or None
+        :param request_metadata: additional metadata that will be returned with the webhook response
+        :type request_metadata: str or None
         :returns: (scan_id, message)
         """
 
@@ -201,8 +203,7 @@ def _file_scan_finalize(self, session_id: str):
 
     def _file_scan_scan(self, session_id: str, detection_rules: Optional[List[DetectionRule]] = None,
                         detection_rule_uuids: Optional[List[str]] = None, webhook_url: Optional[str] = None,
-                        policy_uuid: Optional[str] = None, request_metadata: Optional[Dict[str, str]] = None) \
-            -> requests.Response:
+                        policy_uuid: Optional[str] = None, request_metadata: Optional[str] = None) -> requests.Response:
         if policy_uuid:
             data = {"policyUUID": policy_uuid}
         else:

tests/test_api.py

@@ -263,20 +263,19 @@ def test_scan_file(tmpdir):
     responses.add(responses.POST, 'https://api.nightfall.ai/v3/upload/1/scan', status=200,
                   json={"id": 1, "message": "scan_started"})
 
-    id, message = nightfall.scan_file(file, "https://my-website.example/callback", detection_rule_uuids=["a_uuid"])
+    id, message = nightfall.scan_file(file, "https://my-website.example/callback", detection_rule_uuids=["a_uuid"], request_metadata="some test data")
 
     assert len(responses.calls) == 5
     for call in responses.calls:
         assert call.request.headers.get("Authorization") == "Bearer NF-NOT_REAL"
 
     assert responses.calls[0].request.body == '{"fileSizeBytes": 44}'
-    assert responses.calls[1].request.body == "4916-6734-7572-5015 is"
+    assert responses.calls[1].request.body == b"4916-6734-7572-5015 is"
     assert responses.calls[1].request.headers.get("X-UPLOAD-OFFSET") == '0'
-    assert responses.calls[2].request.body == " my credit card number"
+    assert responses.calls[2].request.body == b" my credit card number"
     assert responses.calls[2].request.headers.get("X-UPLOAD-OFFSET") == '22'
     assert responses.calls[4].request.body == '{"policy": {"webhookURL": "https://my-website.example/callback", ' \
-                                              '"detectionRuleUUIDs": ["a_uuid"]}}'
-
+                                              '"detectionRuleUUIDs": ["a_uuid"]}, "requestMetadata": "some test data"}'
     assert id == 1
     assert message == "scan_started"