chore: Sweepers and Test workflow changes (#3881)

## Changes
- Adjust sweepers to include user sweeping (to avoid policy related
issues)
- Change test workflow's test object suffix so that it's unique even if
test are re-run
- This is important in the context of failed cleanup, on test workflow
re-run we may encounter "object already exists" errors. By having unique
object prefix this could be avoided (and because we have stale object
sweepers, leftovers will be cleaned up anyway)

Author: sfc-gh-jcieslak

pkg/sdk/sweepers.go

@@ -8,44 +8,6 @@ import (
 	"strings"
 )
 
-func SweepAfterIntegrationTests(client *Client, suffix string) error {
-	return sweep(client, suffix)
-}
-
-func SweepAfterAcceptanceTests(client *Client, suffix string) error {
-	return sweep(client, suffix)
-}
-
-// TODO [SNOW-867247]: move this to test code
-// TODO [SNOW-867247]: use if exists/use method from helper for dropping
-// TODO [SNOW-867247]: sweep all missing account-level objects (like users, integrations, replication groups, network policies, ...)
-// TODO [SNOW-867247]: extract sweepers to a separate dir
-// TODO [SNOW-867247]: rework the sweepers (funcs -> objects)
-// TODO [SNOW-867247]: consider generalization (almost all the sweepers follow the same pattern: show, drop if matches)
-// TODO [SNOW-867247]: consider failing after all sweepers and not with the first error
-// TODO [SNOW-867247]: consider showing only objects with the given suffix (in almost every sweeper)
-func sweep(client *Client, suffix string) error {
-	if suffix == "" {
-		return fmt.Errorf("suffix is required to run sweepers")
-	}
-	sweepers := []func() error{
-		getAccountPolicyAttachmentsSweeper(client),
-		getResourceMonitorSweeper(client, suffix),
-		getNetworkPolicySweeper(client, suffix),
-		getFailoverGroupSweeper(client, suffix),
-		getShareSweeper(client, suffix),
-		getDatabaseSweeper(client, suffix),
-		getWarehouseSweeper(client, suffix),
-		getRoleSweeper(client, suffix),
-	}
-	for _, sweeper := range sweepers {
-		if err := sweeper(); err != nil {
-			return err
-		}
-	}
-	return nil
-}
-
 func getAccountPolicyAttachmentsSweeper(client *Client) func() error {
 	return func() error {
 		log.Printf("[DEBUG] Unsetting password and session policies set on the account level")

pkg/sdk/sweepers_test.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"log"
 	"slices"
+	"strings"
 	"testing"
 	"time"
 
@@ -39,6 +40,44 @@ func TestSweepAll(t *testing.T) {
 	})
 }
 
+func SweepAfterIntegrationTests(client *Client, suffix string) error {
+	return sweep(client, suffix)
+}
+
+func SweepAfterAcceptanceTests(client *Client, suffix string) error {
+	return sweep(client, suffix)
+}
+
+// TODO [SNOW-867247]: use if exists/use method from helper for dropping
+// TODO [SNOW-867247]: sweep all missing account-level objects (like users, integrations, replication groups, network policies, ...)
+// TODO [SNOW-867247]: extract sweepers to a separate dir
+// TODO [SNOW-867247]: rework the sweepers (funcs -> objects)
+// TODO [SNOW-867247]: consider generalization (almost all the sweepers follow the same pattern: show, drop if matches)
+// TODO [SNOW-867247]: consider failing after all sweepers and not with the first error
+// TODO [SNOW-867247]: consider showing only objects with the given suffix (in almost every sweeper)
+func sweep(client *Client, suffix string) error {
+	if suffix == "" {
+		return fmt.Errorf("suffix is required to run sweepers")
+	}
+	sweepers := []func() error{
+		getAccountPolicyAttachmentsSweeper(client),
+		getResourceMonitorSweeper(client, suffix),
+		getNetworkPolicySweeper(client, suffix),
+		nukeUsers(client, suffix),
+		getFailoverGroupSweeper(client, suffix),
+		getShareSweeper(client, suffix),
+		getDatabaseSweeper(client, suffix),
+		getWarehouseSweeper(client, suffix),
+		getRoleSweeper(client, suffix),
+	}
+	for _, sweeper := range sweepers {
+		if err := sweeper(); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
 func Test_Sweeper_NukeStaleObjects(t *testing.T) {
 	_ = testenvs.GetOrSkipTest(t, testenvs.EnableSweep)
 
@@ -81,7 +120,7 @@ func Test_Sweeper_NukeStaleObjects(t *testing.T) {
 
 	t.Run("sweep users", func(t *testing.T) {
 		for _, c := range allClients {
-			err := nukeUsers(c)()
+			err := nukeUsers(c, "")()
 			assert.NoError(t, err)
 		}
 	})
@@ -223,7 +262,7 @@ func nukeDatabases(client *Client, prefix string) func() error {
 	}
 }
 
-func nukeUsers(client *Client) func() error {
+func nukeUsers(client *Client, suffix string) func() error {
 	protectedUsers := []string{
 		"SNOWFLAKE",
 		"ARTUR_SAWICKI",
@@ -239,27 +278,42 @@ func nukeUsers(client *Client) func() error {
 	}
 
 	return func() error {
-		log.Println("[DEBUG] Nuking users")
 		ctx := context.Background()
 
-		users, err := client.Users.Show(ctx, &ShowUserOptions{})
+		var userDropCondition func(u User) bool
+		if suffix != "" {
+			log.Printf("[DEBUG] Sweeping users with suffix %s", suffix)
+			userDropCondition = func(u User) bool {
+				return strings.HasSuffix(u.Name, suffix)
+			}
+		} else {
+			log.Println("[DEBUG] Sweeping stale users")
+			userDropCondition = func(u User) bool {
+				return u.CreatedOn.Before(time.Now().Add(-15 * time.Minute))
+			}
+		}
+
+		urs, err := client.Users.Show(ctx, new(ShowUserOptions))
 		if err != nil {
-			return fmt.Errorf("sweeping users ended with error, err = %w", err)
+			return fmt.Errorf("SHOW USERS ended with error, err = %w", err)
 		}
+
+		log.Printf("[DEBUG] Found %d users", len(urs))
+
 		var errs []error
-		log.Printf("[DEBUG] Found %d users", len(users))
-		for idx, user := range users {
-			log.Printf("[DEBUG] Processing user [%d/%d]: %s...", idx+1, len(users), user.ID().FullyQualifiedName())
-			if !slices.Contains(protectedUsers, user.Name) && user.CreatedOn.Before(time.Now().Add(-15*time.Minute)) {
+		for idx, user := range urs {
+			log.Printf("[DEBUG] Processing user [%d/%d]: %s...", idx+1, len(urs), user.ID().FullyQualifiedName())
+
+			if !slices.Contains(protectedUsers, user.Name) && userDropCondition(user) {
 				log.Printf("[DEBUG] Dropping user %s", user.ID().FullyQualifiedName())
 				if err := client.Users.Drop(ctx, user.ID(), &DropUserOptions{IfExists: Bool(true)}); err != nil {
-					log.Printf("[DEBUG] Dropping user %s, resulted in error %v", user.ID().FullyQualifiedName(), err)
 					errs = append(errs, fmt.Errorf("sweeping user %s ended with error, err = %w", user.ID().FullyQualifiedName(), err))
 				}
 			} else {
 				log.Printf("[DEBUG] Skipping user %s", user.ID().FullyQualifiedName())
 			}
 		}
+
 		return errors.Join(errs...)
 	}
 }