Skip to content

chore(nhi): add vault related attributes to PoliyBreak model #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 9, 2025
Merged

chore(nhi): add vault related attributes to PoliyBreak model #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions changelog.d/20250702_102756_achille.mascia_nhi_ggshield_v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
### Added

- Added `vault_type`, `vault_name`, `vault_path` and `vault_path_count` fields to `PolicyBreak`.
12 changes: 12 additions & 0 deletions pygitguardian/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,10 @@ class PolicyBreakSchema(BaseSchema):
DiffKind, by_value=True, required=False, load_default=None, dump_default=None
)
is_vaulted = fields.Boolean(required=False, load_default=False, dump_default=False)
vault_type = fields.String(required=False, load_default=None, dump_default=None)
vault_name = fields.String(required=False, load_default=None, dump_default=None)
vault_path = fields.String(required=False, load_default=None, dump_default=None)
vault_path_count = fields.Int(required=False, load_default=None, dump_default=None)

@post_load
def make_policy_break(self, data: Dict[str, Any], **kwargs: Any) -> "PolicyBreak":
Expand Down Expand Up @@ -265,6 +269,10 @@ def __init__(
exclude_reason: Optional[str] = None,
diff_kind: Optional[DiffKind] = None,
is_vaulted: bool = False,
vault_type: Optional[str] = None,
vault_name: Optional[str] = None,
vault_path: Optional[str] = None,
vault_path_count: Optional[int] = None,
**kwargs: Any,
) -> None:
super().__init__()
Expand All @@ -281,6 +289,10 @@ def __init__(
self.exclude_reason = exclude_reason
self.diff_kind = diff_kind
self.is_vaulted = is_vaulted
self.vault_type = vault_type
self.vault_name = vault_name
self.vault_path = vault_path
self.vault_path_count = vault_path_count

@property
def is_secret(self) -> bool:
Expand Down
8 changes: 8 additions & 0 deletions tests/test_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,10 @@ def test_document_handle_surrogates(self):
"exclude_reason": None,
"diff_kind": None,
"is_vaulted": False,
"vault_type": None,
"vault_name": None,
"vault_path": None,
"vault_path_count": None,
},
),
(
Expand All @@ -190,6 +194,10 @@ def test_document_handle_surrogates(self):
"exclude_reason": None,
"diff_kind": "addition",
"is_vaulted": True,
"vault_type": "hashicorpvault",
"vault_name": "my-vault",
"vault_path": "my-secret",
"vault_path_count": 3,
},
),
(
Expand Down
Loading