chore: Clean collection utils (#3028)

Clean collection utils - one copy of collection utils left - queue moved - FindOne renamed to FindFirst - FindFirst tests added - tests renamed
Snowflake-Labs · Sep 2, 2024 · 426ddb1 · 426ddb1
1 parent bde2638
commit 426ddb1
Show file tree

Hide file tree

Showing 80 changed files with 266 additions and 269 deletions.
diff --git a/pkg/acceptance/helpers/parameter_client.go b/pkg/acceptance/helpers/parameter_client.go
@@ -122,7 +122,7 @@ func (c *ParameterClient) UnsetAccountParameter(t *testing.T, parameter sdk.Acco
 
 func FindParameter[T ~string](t *testing.T, parameters []*sdk.Parameter, parameter T) *sdk.Parameter {
 	t.Helper()
-	param, err := collections.FindOne(parameters, func(p *sdk.Parameter) bool { return p.Key == string(parameter) })
+	param, err := collections.FindFirst(parameters, func(p *sdk.Parameter) bool { return p.Key == string(parameter) })
 	require.NoError(t, err)
 	return *param
 }
diff --git a/pkg/internal/collections/collection_helpers.go b/pkg/internal/collections/collection_helpers.go
@@ -6,8 +6,7 @@ import (
 
 var ErrObjectNotFound = errors.New("object does not exist")
 
-// TODO [SNOW-1473414]: move collection helpers fully with a separate PR
-func FindOne[T any](collection []T, condition func(T) bool) (*T, error) {
+func FindFirst[T any](collection []T, condition func(T) bool) (*T, error) {
 	for _, o := range collection {
 		if condition(o) {
 			return &o, nil

diff --git a/...al/collections/collection_helpers_test.go → ...al/collections/collection_helpers_test.go b/...al/collections/collection_helpers_test.go → ...al/collections/collection_helpers_test.go
@@ -1,12 +1,38 @@
 package collections
 
 import (
+	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/require"
 )
 
-func TestMap(t *testing.T) {
+func Test_FindFirst(t *testing.T) {
+	stringSlice := []string{"1", "22", "333", "334"}
+
+	t.Run("basic find", func(t *testing.T) {
+		result, resultErr := FindFirst(stringSlice, func(s string) bool { return s == "22" })
+
+		require.Equal(t, "22", *result)
+		require.Nil(t, resultErr)
+	})
+
+	t.Run("two matching, first returned", func(t *testing.T) {
+		result, resultErr := FindFirst(stringSlice, func(s string) bool { return strings.HasPrefix(s, "33") })
+
+		require.Equal(t, "333", *result)
+		require.Nil(t, resultErr)
+	})
+
+	t.Run("no item", func(t *testing.T) {
+		result, resultErr := FindFirst(stringSlice, func(s string) bool { return s == "4444" })
+
+		require.Nil(t, result)
+		require.ErrorIs(t, resultErr, ErrObjectNotFound)
+	})
+}
+
+func Test_Map(t *testing.T) {
 	t.Run("basic mapping", func(t *testing.T) {
 		stringSlice := []string{"1", "22", "333"}
 		stringLenSlice := Map(stringSlice, func(s string) int { return len(s) })

diff --git a/pkg/sdk/internal/collections/queue.go → pkg/internal/collections/queue.go b/pkg/sdk/internal/collections/queue.go → pkg/internal/collections/queue.go
diff --git a/pkg/sdk/internal/collections/queue_test.go → pkg/internal/collections/queue_test.go b/pkg/sdk/internal/collections/queue_test.go → pkg/internal/collections/queue_test.go
@@ -6,7 +6,7 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-func TestQueue(t *testing.T) {
+func Test_Queue(t *testing.T) {
 	t.Run("empty queue initialization", func(t *testing.T) {
 		queue := NewQueue[int]()
 

diff --git a/pkg/resources/api_authentication_integration_common.go b/pkg/resources/api_authentication_integration_common.go
@@ -223,7 +223,7 @@ func handleApiAuthImport(d *schema.ResourceData, integration *sdk.SecurityIntegr
 		return err
 	}
 
-	oauthAccessTokenValidity, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool {
+	oauthAccessTokenValidity, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool {
 		return property.Name == "OAUTH_ACCESS_TOKEN_VALIDITY"
 	})
 	if err == nil {
@@ -235,7 +235,7 @@ func handleApiAuthImport(d *schema.ResourceData, integration *sdk.SecurityIntegr
 			return err
 		}
 	}
-	oauthRefreshTokenValidity, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool {
+	oauthRefreshTokenValidity, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool {
 		return property.Name == "OAUTH_REFRESH_TOKEN_VALIDITY"
 	})
 	if err == nil {
@@ -247,21 +247,21 @@ func handleApiAuthImport(d *schema.ResourceData, integration *sdk.SecurityIntegr
 			return err
 		}
 	}
-	oauthClientId, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_CLIENT_ID" })
+	oauthClientId, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_CLIENT_ID" })
 	if err == nil {
 		if err = d.Set("oauth_client_id", oauthClientId.Value); err != nil {
 			return err
 		}
 	}
-	oauthClientAuthMethod, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool {
+	oauthClientAuthMethod, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool {
 		return property.Name == "OAUTH_CLIENT_AUTH_METHOD"
 	})
 	if err == nil {
 		if err = d.Set("oauth_client_auth_method", oauthClientAuthMethod.Value); err != nil {
 			return err
 		}
 	}
-	oauthTokenEndpoint, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_TOKEN_ENDPOINT" })
+	oauthTokenEndpoint, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_TOKEN_ENDPOINT" })
 	if err == nil {
 		if err = d.Set("oauth_token_endpoint", oauthTokenEndpoint.Value); err != nil {
 			return err
@@ -288,33 +288,33 @@ func handleApiAuthRead(d *schema.ResourceData,
 		return err
 	}
 	if withExternalChangesMarking {
-		oauthAccessTokenValidity, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool {
+		oauthAccessTokenValidity, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool {
 			return property.Name == "OAUTH_ACCESS_TOKEN_VALIDITY"
 		})
 		if err != nil {
 			return err
 		}
 
-		oauthRefreshTokenValidity, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool {
+		oauthRefreshTokenValidity, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool {
 			return property.Name == "OAUTH_REFRESH_TOKEN_VALIDITY"
 		})
 		if err != nil {
 			return err
 		}
 
-		oauthClientId, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_CLIENT_ID" })
+		oauthClientId, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_CLIENT_ID" })
 		if err != nil {
 			return err
 		}
 
-		oauthClientAuthMethod, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool {
+		oauthClientAuthMethod, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool {
 			return property.Name == "OAUTH_CLIENT_AUTH_METHOD"
 		})
 		if err != nil {
 			return err
 		}
 
-		oauthTokenEndpoint, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_TOKEN_ENDPOINT" })
+		oauthTokenEndpoint, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_TOKEN_ENDPOINT" })
 		if err != nil {
 			return err
 		}

diff --git a/pkg/resources/api_authentication_integration_with_authorization_code_grant.go b/pkg/resources/api_authentication_integration_with_authorization_code_grant.go
@@ -79,15 +79,15 @@ func ImportApiAuthenticationWithAuthorizationCodeGrant(ctx context.Context, d *s
 	if err := handleApiAuthImport(d, integration, properties); err != nil {
 		return nil, err
 	}
-	oauthAuthorizationEndpoint, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool {
+	oauthAuthorizationEndpoint, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool {
 		return property.Name == "OAUTH_AUTHORIZATION_ENDPOINT"
 	})
 	if err == nil {
 		if err = d.Set("oauth_authorization_endpoint", oauthAuthorizationEndpoint.Value); err != nil {
 			return nil, err
 		}
 	}
-	oauthAllowedScopes, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_ALLOWED_SCOPES" })
+	oauthAllowedScopes, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_ALLOWED_SCOPES" })
 	if err == nil {
 		if err = d.Set("oauth_allowed_scopes", sdk.ParseCommaSeparatedStringArray(oauthAllowedScopes.Value, false)); err != nil {
 			return nil, err
@@ -168,14 +168,14 @@ func ReadContextApiAuthenticationIntegrationWithAuthorizationCodeGrant(withExter
 		if c := integration.Category; c != sdk.SecurityIntegrationCategory {
 			return diag.FromErr(fmt.Errorf("expected %v to be a %s integration, got %v", id, sdk.SecurityIntegrationCategory, c))
 		}
-		oauthAuthorizationEndpoint, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool {
+		oauthAuthorizationEndpoint, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool {
 			return property.Name == "OAUTH_AUTHORIZATION_ENDPOINT"
 		})
 		if err != nil {
 			return diag.FromErr(err)
 		}
 
-		oauthAllowedScopes, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_ALLOWED_SCOPES" })
+		oauthAllowedScopes, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_ALLOWED_SCOPES" })
 		if err != nil {
 			return diag.FromErr(err)
 		}

diff --git a/pkg/resources/api_authentication_integration_with_client_credentials.go b/pkg/resources/api_authentication_integration_with_client_credentials.go
@@ -71,7 +71,7 @@ func ImportApiAuthenticationWithClientCredentials(ctx context.Context, d *schema
 	if err := handleApiAuthImport(d, integration, properties); err != nil {
 		return nil, err
 	}
-	oauthAllowedScopes, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_ALLOWED_SCOPES" })
+	oauthAllowedScopes, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_ALLOWED_SCOPES" })
 	if err == nil {
 		if err = d.Set("oauth_allowed_scopes", sdk.ParseCommaSeparatedStringArray(oauthAllowedScopes.Value, false)); err != nil {
 			return nil, err
@@ -148,7 +148,7 @@ func ReadContextApiAuthenticationIntegrationWithClientCredentials(withExternalCh
 		if c := integration.Category; c != sdk.SecurityIntegrationCategory {
 			return diag.FromErr(fmt.Errorf("expected %v to be a %s integration, got %v", id, sdk.SecurityIntegrationCategory, c))
 		}
-		oauthAllowedScopes, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_ALLOWED_SCOPES" })
+		oauthAllowedScopes, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_ALLOWED_SCOPES" })
 		if err != nil {
 			return diag.FromErr(err)
 		}

diff --git a/pkg/resources/api_authentication_integration_with_jwt_bearer.go b/pkg/resources/api_authentication_integration_with_jwt_bearer.go
@@ -76,15 +76,15 @@ func ImportApiAuthenticationWithJwtBearer(ctx context.Context, d *schema.Resourc
 	if err := handleApiAuthImport(d, integration, properties); err != nil {
 		return nil, err
 	}
-	oauthAuthorizationEndpoint, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool {
+	oauthAuthorizationEndpoint, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool {
 		return property.Name == "OAUTH_AUTHORIZATION_ENDPOINT"
 	})
 	if err == nil {
 		if err = d.Set("oauth_authorization_endpoint", oauthAuthorizationEndpoint.Value); err != nil {
 			return nil, err
 		}
 	}
-	oauthAssertionIssuer, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_ASSERTION_ISSUER" })
+	oauthAssertionIssuer, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_ASSERTION_ISSUER" })
 	if err == nil {
 		if err = d.Set("oauth_assertion_issuer", oauthAssertionIssuer.Value); err != nil {
 			return nil, err
@@ -156,14 +156,14 @@ func ReadContextApiAuthenticationIntegrationWithJwtBearer(withExternalChangesMar
 		if c := integration.Category; c != sdk.SecurityIntegrationCategory {
 			return diag.FromErr(fmt.Errorf("expected %v to be a %s integration, got %v", id, sdk.SecurityIntegrationCategory, c))
 		}
-		oauthAuthorizationEndpoint, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool {
+		oauthAuthorizationEndpoint, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool {
 			return property.Name == "OAUTH_AUTHORIZATION_ENDPOINT"
 		})
 		if err != nil {
 			return diag.FromErr(err)
 		}
 
-		oauthAssertionIssuer, err := collections.FindOne(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_ASSERTION_ISSUER" })
+		oauthAssertionIssuer, err := collections.FindFirst(properties, func(property sdk.SecurityIntegrationProperty) bool { return property.Name == "OAUTH_ASSERTION_ISSUER" })
 		if err != nil {
 			return diag.FromErr(err)
 		}

diff --git a/pkg/resources/custom_diffs.go b/pkg/resources/custom_diffs.go
@@ -27,7 +27,7 @@ func BoolParameterValueComputedIf[T ~string](key string, params []*sdk.Parameter
 
 func ParameterValueComputedIf[T ~string](key string, parameters []*sdk.Parameter, objectParameterLevel sdk.ParameterType, param T, valueToString func(v any) string) schema.CustomizeDiffFunc {
 	return func(ctx context.Context, d *schema.ResourceDiff, meta any) error {
-		foundParameter, err := collections.FindOne(parameters, func(parameter *sdk.Parameter) bool { return parameter.Key == string(param) })
+		foundParameter, err := collections.FindFirst(parameters, func(parameter *sdk.Parameter) bool { return parameter.Key == string(param) })
 		if err != nil {
 			log.Printf("[WARN] failed to find parameter: %s", param)
 			return nil

diff --git a/pkg/resources/database_state_upgraders.go b/pkg/resources/database_state_upgraders.go
@@ -43,7 +43,7 @@ func v092DatabaseStateUpgrader(ctx context.Context, rawState map[string]any, met
 			}
 
 			for i, accountLocator := range accountLocators {
-				replicationAccount, err := collections.FindOne(replicationAccounts, func(account *sdk.ReplicationAccount) bool {
+				replicationAccount, err := collections.FindFirst(replicationAccounts, func(account *sdk.ReplicationAccount) bool {
 					return account.AccountLocator == accountLocator
 				})
 				if err != nil {