Add commit hash to finding. (#31)

Part of PLAT-1576

Author: martinmr

nightfall/findings.py

@@ -31,6 +31,7 @@ class Finding:
         byte_range (Range): The byte range in which a finding was detected within the item.
         codepoint_range (Range): The codepoint range in which a finding was detected within the item. This differs
             from byte range since a codepoint may contain multiple bytes.
+        commit_hash (str): The hash of the commit in which the finding was detected, if known.
         matched_detection_rule_uuids (List[str]): The list of detection rule UUIDs that contained a detector that
             triggered a match.
         matched_detection_rules (List[str]): The list of inline detection rules that contained a detector that triggered
@@ -45,6 +46,7 @@ class Finding:
     confidence: Confidence
     byte_range: Range
     codepoint_range: Range
+    commit_hash: str
     matched_detection_rule_uuids: List[str]
     matched_detection_rules: List[str]
 
@@ -60,6 +62,7 @@ def from_dict(cls, resp: dict) -> "Finding":
             Confidence[resp["confidence"]],
             Range(resp["location"]["byteRange"]["start"], resp["location"]["byteRange"]["end"]),
             Range(resp["location"]["codepointRange"]["start"], resp["location"]["codepointRange"]["end"]),
+            resp["location"].get("commitHash", ""),
             resp["matchedDetectionRuleUUIDs"],
             resp["matchedDetectionRules"]
         )

tests/test_api.py

@@ -57,7 +57,7 @@ def finding_orderer(f):
         "Credit Card Number",
         result[0][0].detector_uuid,
         Confidence.VERY_LIKELY,
-        Range(0, 19), Range(0, 19),
+        Range(0, 19), Range(0, 19), "",
         [], ["Inline Detection Rule #1"])
     assert result[0][1] == Finding(
         "489-36-8350",
@@ -66,7 +66,7 @@ def finding_orderer(f):
         "",
         result[0][1].detector_uuid,
         Confidence.VERY_LIKELY,
-        Range(46, 57), Range(46, 57),
+        Range(46, 57), Range(46, 57), "",
         [], ["Inline Detection Rule #1"])
     assert len(redactions) == 1
     assert redactions[0] == "491👀-👀👀👀👀-👀👀👀👀-👀👀👀👀 is my credit card number, [REDACTED] ssn"
@@ -318,7 +318,7 @@ def test_scan_text():
         "Credit Card Number",
         result[0][0].detector_uuid,
         Confidence.VERY_LIKELY,
-        Range(0, 19), Range(0, 19),
+        Range(0, 19), Range(0, 19), "",
         [], ["Inline Detection Rule #1"])
     assert result[0][1] == Finding(
         "489-36-8350",
@@ -327,7 +327,7 @@ def test_scan_text():
         "",
         result[0][1].detector_uuid,
         Confidence.VERY_LIKELY,
-        Range(46, 57), Range(46, 57),
+        Range(46, 57), Range(46, 57), "",
         [], ["Inline Detection Rule #1"])
     assert len(redactions) == 1
     assert redactions[0] == "491👀-👀👀👀👀-👀👀👀👀-👀👀👀👀 is my credit card number, [REDACTED] ssn"