Merge pull request #144 from GitGuardian/amascia/nhi-651/add-nhi-field

chore(nhi): added is_secret_vaulted attribute to PolicyBreak

Author: amascia-gg

pygitguardian/models.py

@@ -231,6 +231,9 @@ class PolicyBreakSchema(BaseSchema):
     diff_kind = fields.Enum(
         DiffKind, by_value=True, required=False, load_default=None, dump_default=None
     )
+    is_secret_vaulted = fields.Boolean(
+        required=False, load_default=False, dump_default=False
+    )
 
     @post_load
     def make_policy_break(self, data: Dict[str, Any], **kwargs: Any) -> "PolicyBreak":
@@ -261,6 +264,7 @@ def __init__(
         is_excluded: bool = False,
         exclude_reason: Optional[str] = None,
         diff_kind: Optional[DiffKind] = None,
+        is_secret_vaulted: bool = False,
         **kwargs: Any,
     ) -> None:
         super().__init__()
@@ -276,6 +280,7 @@ def __init__(
         self.is_excluded = is_excluded
         self.exclude_reason = exclude_reason
         self.diff_kind = diff_kind
+        self.is_secret_vaulted = is_secret_vaulted
 
     @property
     def is_secret(self) -> bool:

tests/test_models.py

@@ -173,6 +173,7 @@ def test_document_handle_surrogates(self):
                     "is_excluded": False,
                     "exclude_reason": None,
                     "diff_kind": None,
+                    "is_secret_vaulted": False,
                 },
             ),
             (
@@ -191,6 +192,7 @@ def test_document_handle_surrogates(self):
                     "is_excluded": False,
                     "exclude_reason": None,
                     "diff_kind": "addition",
+                    "is_secret_vaulted": True,
                 },
             ),
             (