docs: Create set_mute_undefined_finding sample (#4309)

* docs: Create set_mute_undefined_finding sample

Create set_mute_undefined_finding sample for use case: resetting an individual finding's mute state to UNDEFINED.

* docs: Create set_mute_undefined sample

Add code sample for resetting finding mute state to UNDEFINED.

* Update function name to match sample context

* Update set_unmute_finding.go

* docs: Update set_mute_finding.go

* fix undefined type

* Update mute_config_test.go

* Update mute_config_test.go

* chore: skip test possibly related to #3793

---------

Co-authored-by: Tony Pujals <[email protected]>
Co-authored-by: Tony Pujals <[email protected]>

Author: hannahtsai2024

securitycenter/muteconfig/mute_config_test.go

@@ -252,6 +252,9 @@ func TestSetMuteFinding(t *testing.T) {
 
 func TestSetUnmuteFinding(t *testing.T) {
 	t.Skip("see https://github.com/GoogleCloudPlatform/golang-samples/issues/3793")
+	// Needs more investigation (doesn't match on missing `locations/global`)
+	// got:       Mute value for the finding: organizations/688851828130/sources/14743348522722609714/locations/global/findings/updated is UNDEFINED
+	// expected:  Mute value for the finding: organizations/688851828130/sources/14743348522722609714/findings/updated is UNDEFINED
 	testutil.SystemTest(t)
 
 	var buf bytes.Buffer
@@ -265,8 +268,25 @@ func TestSetUnmuteFinding(t *testing.T) {
 	if err := setUnmute(&buf, fixture.finding2Name); err != nil {
 		t.Errorf("setUnmute had error: %v", err)
 	}
-	if got := buf.String(); !strings.Contains(got, fmt.Sprintf("Mute value for the finding: %s is %s", fixture.finding1Name, "UNMUTE")) {
-		t.Errorf("setUnmute got %q, expected %q", got, fmt.Sprintf("Mute value for the finding: %s is %s", fixture.finding1Name, "UNMUTE"))
+	if got := buf.String(); !strings.Contains(got, fmt.Sprintf("Mute value for the finding: %s is %s", fixture.finding2Name, "UNMUTE")) {
+		t.Errorf("setUnmute got %q, expected %q", got, fmt.Sprintf("Mute value for the finding: %s is %s", fixture.finding2Name, "UNMUTE"))
+	}
+}
+
+func TestSetMuteUndefinedFinding(t *testing.T) {
+	t.Skip("see https://github.com/GoogleCloudPlatform/golang-samples/issues/3793")
+	// Needs more investigation (doesn't match on missing `locations/global`)
+	// got:       Mute value for the finding: organizations/688851828130/sources/14743348522722609714/locations/global/findings/updated is UNDEFINED
+	// expected:  Mute value for the finding: organizations/688851828130/sources/14743348522722609714/findings/updated is UNDEFINED
+	testutil.SystemTest(t)
+
+	var buf bytes.Buffer
+	// Reset an individual finding mute state to UNDEFINED.
+	if err := setMuteUndefined(&buf, fixture.finding1Name); err != nil {
+		t.Errorf("setMuteUndefined had error: %v", err)
+	}
+	if got := buf.String(); !strings.Contains(got, fmt.Sprintf("Mute value for the finding: %s is %s", fixture.finding1Name, "UNDEFINED")) {
+		t.Errorf("setMuteUndefined got %q, expected %q", got, fmt.Sprintf("Mute value for the finding: %s is %s", fixture.finding1Name, "UNDEFINED"))
 	}
 }
 

securitycenter/muteconfig/set_mute_finding.go

@@ -24,9 +24,9 @@ import (
 	"cloud.google.com/go/securitycenter/apiv1/securitycenterpb"
 )
 
-// setMute mutes an individual finding.
+// setMute mutes an individual finding, can also unmute or reset the mute state of a finding.
 // If a finding is already muted, muting it again has no effect.
-// Various mute states are: MUTE_UNSPECIFIED/MUTE/UNMUTE.
+// Various mute states are: UNDEFINED/MUTE/UNMUTE.
 func setMute(w io.Writer, findingPath string) error {
 	// findingPath: The relative resource name of the finding. See:
 	// https://cloud.google.com/apis/design/resource_names#relative_resource_name

securitycenter/muteconfig/set_mute_undefined_finding.go

@@ -0,0 +1,57 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package muteconfig
+
+// [START securitycenter_set_mute_undefined]
+import (
+	"context"
+	"fmt"
+	"io"
+
+	securitycenter "cloud.google.com/go/securitycenter/apiv1"
+	"cloud.google.com/go/securitycenter/apiv1/securitycenterpb"
+)
+
+// setMute mutes an individual finding, can also unmute or reset the mute state of a finding.
+// If a finding is already muted, muting it again has no effect.
+// Various mute states are: UNDEFINED/MUTE/UNMUTE.
+func setMuteUndefined(w io.Writer, findingPath string) error {
+	// findingPath: 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}
+	// findingPath := fmt.Sprintf("projects/%s/sources/%s/finding/%s", "your-google-cloud-project-id", "source", "finding-id")
+	ctx := context.Background()
+	client, err := securitycenter.NewClient(ctx)
+	if err != nil {
+		return fmt.Errorf("securitycenter.NewClient: %w", err)
+	}
+	defer client.Close()
+
+	req := &securitycenterpb.SetMuteRequest{
+		Name: findingPath,
+		Mute: securitycenterpb.Finding_UNDEFINED}
+
+	finding, err := client.SetMute(ctx, req)
+	if err != nil {
+		return fmt.Errorf("failed to set the specified mute value: %w", err)
+	}
+	fmt.Fprintf(w, "Mute value for the finding: %s is %s", finding.Name, finding.Mute)
+	return nil
+}
+
+// [END securitycenter_set_mute_undefined]

securitycenter/muteconfig/set_unmute_finding.go

@@ -25,9 +25,9 @@ import (
 	"cloud.google.com/go/securitycenter/apiv1/securitycenterpb"
 )
 
-// setUnmute unmutes an individual finding.
-// Unmuting a finding that isn't muted has no effect.
-// Various mute states are: MUTE_UNSPECIFIED/MUTE/UNMUTE.
+// setMute mutes an individual finding, can also unmute or reset the mute state of a finding.
+// If a finding is already muted, muting it again has no effect.
+// Various mute states are: UNDEFINED/MUTE/UNMUTE.
 func setUnmute(w io.Writer, findingPath string) error {
 	// findingPath: The relative resource name of the finding. See:
 	// https://cloud.google.com/apis/design/resource_names#relative_resource_name