Add test with all the bells and whistles

Author: Dan Hertz

nightfall/detection_rules.py

@@ -30,7 +30,7 @@ class WordList:
     is_case_sensitive: bool
 
     def as_dict(self):
-        return {"wordList": self.word_list, "isCaseSensitive": self.is_case_sensitive}
+        return {"values": self.word_list, "isCaseSensitive": self.is_case_sensitive}
 
 
 class Confidence(Enum):
@@ -60,7 +60,7 @@ class ContextRule:
 
     def as_dict(self):
         return {
-            "regex": self.regex,
+            "regex": self.regex.as_dict(),
             "proximity": {"windowBefore": self.window_before, "windowAfter": self.window_after},
             "confidenceAdjustment": {"fixedConfidence": self.fixed_confidence.value}
         }
@@ -92,8 +92,10 @@ def as_dict(self):
         result = {"matchType": self.match_type.value}
         if self.regex:
             result["regex"] = self.regex.as_dict()
+            result["exclusionType"] = "REGEX"
         if self.word_list:
             result["wordList"] = self.word_list.as_dict()
+            result["exclusionType"] = "WORD_LIST"
         return result
 
 

tests/test_api.py

@@ -2,7 +2,8 @@
 import pytest
 
 from nightfall.api import Nightfall
-from nightfall.detection_rules import DetectionRule, Detector, LogicalOp, Confidence, ExclusionRule
+from nightfall.detection_rules import DetectionRule, Detector, LogicalOp, Confidence, ExclusionRule, ContextRule, \
+    WordList, MatchType, RedactionConfig, MaskConfig, Regex
 from nightfall.findings import Finding, Range
 
 
@@ -12,22 +13,38 @@ def nightfall():
 
 
 def test_scan_text_detection_rules_v3(nightfall):
-    result, _ = nightfall.scan_text(
+    result, redactions = nightfall.scan_text(
         ["4916-6734-7572-5015 is my credit card number"],
         detection_rules=[DetectionRule(logical_op=LogicalOp.ANY, detectors=[
-            Detector(min_confidence=Confidence.LIKELY, min_num_findings=1,
-                     display_name="Credit Card Number", nightfall_detector="CREDIT_CARD_NUMBER")])]
+            Detector(min_confidence=Confidence.LIKELY,
+                     min_num_findings=1,
+                     display_name="Credit Card Number",
+                     nightfall_detector="CREDIT_CARD_NUMBER",
+                     context_rules=[ContextRule(regex=Regex("fake regex", is_case_sensitive=False),
+                                                window_before=10, window_after=10,
+                                                fixed_confidence=Confidence.VERY_UNLIKELY)],
+                     exclusion_rules=[ExclusionRule(MatchType.FULL,
+                                                    word_list=WordList(["never", "match"],
+                                                                       is_case_sensitive=True))],
+                     redaction_config=RedactionConfig(remove_finding=False,
+                                                      mask_config=MaskConfig(masking_char='👀',
+                                                                             num_chars_to_leave_unmasked=3,
+                                                                             chars_to_ignore=["-"]))
+                     )])]
     )
 
     assert len(result) == 1
     assert result[0][0] == Finding(
         "4916-6734-7572-5015",
-        None, None, None,
+        '491👀-👀👀👀👀-👀👀👀👀-👀👀👀👀',
+        None, None,
         "Credit Card Number",
         result[0][0].detector_uuid,
         Confidence.VERY_LIKELY,
         Range(0, 19), Range(0, 19),
         [], ["Inline Detection Rule #1"])
+    assert len(redactions) == 1
+    assert redactions[0] == "491👀-👀👀👀👀-👀👀👀👀-👀👀👀👀 is my credit card number"
 
 
 @pytest.mark.filetest