Skip to content

Commit

Permalink
docs(samples): included snippet for unmute finding (#308)
Browse files Browse the repository at this point in the history
  • Loading branch information
Sita04 committed Mar 30, 2022
1 parent 6444a15 commit 952308a
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 6 deletions.
38 changes: 33 additions & 5 deletions securitycenter/snippets/snippets_mute_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -176,12 +176,11 @@ def update_mute_rule(mute_config_name: str) -> None:
# [END securitycenter_update_mute_config]


# [START securitycenter_set_mute_unmute]
def set_mute_unmute_finding(finding_path: str) -> None:
# [START securitycenter_set_mute]
def set_mute_finding(finding_path: str) -> None:
"""
Mute/unmute an individual finding.
Mute an individual finding.
If a finding is already muted, muting it again has no effect.
Similarly, unmuting a finding that isn't muted has no effect.
Various mute states are: MUTE_UNSPECIFIED/MUTE/UNMUTE.
Args:
finding_path: The relative resource name of the finding. See:
Expand All @@ -203,7 +202,36 @@ def set_mute_unmute_finding(finding_path: str) -> None:
print(f"Mute value for the finding: {finding.mute.name}")


# [END securitycenter_set_mute_unmute]
# [END securitycenter_set_mute]


# [START securitycenter_set_unmute]
def set_unmute_finding(finding_path: str) -> None:
"""
Unmute an individual finding.
Unmuting a finding that isn't muted has no effect.
Various mute states are: MUTE_UNSPECIFIED/MUTE/UNMUTE.
Args:
finding_path: The relative resource name of the finding. See:
https://cloud.google.com/apis/design/resource_names#relative_resource_name
Use any one of the following formats:
- organizations/{organization_id}/sources/{source_id}/finding/{finding_id},
- folders/{folder_id}/sources/{source_id}/finding/{finding_id},
- projects/{project_id}/sources/{source_id}/finding/{finding_id}.
"""
from google.cloud import securitycenter

client = securitycenter.SecurityCenterClient()

request = securitycenter.SetMuteRequest()
request.name = finding_path
request.mute = securitycenter.Finding.Mute.UNMUTED

finding = client.set_mute(request)
print(f"Mute value for the finding: {finding.mute.name}")


# [END securitycenter_set_unmute]


# [START securitycenter_bulk_mute]
Expand Down
9 changes: 8 additions & 1 deletion securitycenter/snippets/snippets_mute_config_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,18 @@ def test_update_mute_rule(capsys: CaptureFixture, mute_rule):

def test_set_mute_finding(capsys: CaptureFixture, finding):
finding_path = finding.get("finding1")
snippets_mute_config.set_mute_unmute_finding(finding_path)
snippets_mute_config.set_mute_finding(finding_path)
out, _ = capsys.readouterr()
assert re.search("Mute value for the finding: MUTED", out)


def test_set_unmute_finding(capsys: CaptureFixture, finding):
finding_path = finding.get("finding1")
snippets_mute_config.set_unmute_finding(finding_path)
out, _ = capsys.readouterr()
assert re.search("Mute value for the finding: UNMUTED", out)


def test_bulk_mute_findings(capsys: CaptureFixture, finding):
# Mute findings that belong to this project.
snippets_mute_config.bulk_mute_findings(
Expand Down

0 comments on commit 952308a

Please sign in to comment.