Skip to content
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.

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

feat: Account v1 readiness #3236

Merged
merged 11 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
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
133 changes: 132 additions & 1 deletion pkg/acceptance/helpers/account_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,27 @@ package helpers

import (
"context"
"fmt"
"strings"
"testing"
"time"

"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance/helpers/random"
"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/internal/snowflakeroles"
"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk"
"github.com/snowflakedb/gosnowflake"
"github.com/stretchr/testify/require"
)

type AccountClient struct {
context *TestClientContext
ids *IdsGenerator
}

func NewAccountClient(context *TestClientContext) *AccountClient {
func NewAccountClient(context *TestClientContext, idsGenerator *IdsGenerator) *AccountClient {
return &AccountClient{
context: context,
ids: idsGenerator,
}
}

Expand Down Expand Up @@ -42,3 +50,126 @@ func (c *AccountClient) GetAccountIdentifier(t *testing.T) sdk.AccountIdentifier
t.Fatal("could not find the account identifier for the locator")
return sdk.AccountIdentifier{}
}

func (c *AccountClient) Create(t *testing.T) (*sdk.Account, func()) {
t.Helper()
id := c.ids.RandomAccountObjectIdentifier()
name := c.ids.Alpha()
email := random.Email()
privateKey := random.GenerateRSAPrivateKey(t)
publicKey, _ := random.GenerateRSAPublicKeyFromPrivateKey(t, privateKey)

return c.CreateWithRequest(t, id, &sdk.CreateAccountOptions{
AdminName: name,
AdminRSAPublicKey: sdk.String(publicKey),
Email: email,
Edition: sdk.EditionStandard,
})
}

func (c *AccountClient) CreateWithRequest(t *testing.T, id sdk.AccountObjectIdentifier, opts *sdk.CreateAccountOptions) (*sdk.Account, func()) {
t.Helper()
err := c.client().Create(context.Background(), id, opts)
require.NoError(t, err)

account, err := c.client().ShowByID(context.Background(), id)
require.NoError(t, err)

return account, c.DropFunc(t, id)
}

func (c *AccountClient) Alter(t *testing.T, opts *sdk.AlterAccountOptions) {
t.Helper()
err := c.client().Alter(context.Background(), opts)
require.NoError(t, err)
}

func (c *AccountClient) UnsetPoliciesFunc(t *testing.T) func() {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this method is dangerous because it can alter the "wrong" account. We should at least have some safeguards (for now).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed SelfAlter tests for account are skipped. For now it's pointing to the general ticket (but mentioned it explicitly in the acc criteria).

t.Helper()
return func() {
_ = c.client().Alter(context.Background(), &sdk.AlterAccountOptions{
Unset: &sdk.AccountUnset{
PackagesPolicy: sdk.Bool(true),
},
})
_ = c.client().Alter(context.Background(), &sdk.AlterAccountOptions{
Unset: &sdk.AccountUnset{
PasswordPolicy: sdk.Bool(true),
},
})
_ = c.client().Alter(context.Background(), &sdk.AlterAccountOptions{
Unset: &sdk.AccountUnset{
SessionPolicy: sdk.Bool(true),
},
})
_ = c.client().Alter(context.Background(), &sdk.AlterAccountOptions{
Unset: &sdk.AccountUnset{
AuthenticationPolicy: sdk.Bool(true),
},
})
}
}

func (c *AccountClient) DropFunc(t *testing.T, id sdk.AccountObjectIdentifier) func() {
t.Helper()
return func() {
require.NoError(t, c.Drop(t, id))
}
}

func (c *AccountClient) Drop(t *testing.T, id sdk.AccountObjectIdentifier) error {
t.Helper()
ctx := context.Background()

return c.client().Drop(ctx, id, 3, &sdk.DropAccountOptions{IfExists: sdk.Bool(true)})
}

type Region struct {
SnowflakeRegion string `db:"snowflake_region"`
Cloud string `db:"cloud"`
Region string `db:"region"`
DisplayName string `db:"display_name"`
}

func (c *AccountClient) ShowRegions(t *testing.T) []Region {
t.Helper()

var regions []Region
err := c.context.client.QueryForTests(context.Background(), &regions, "SHOW REGIONS")
require.NoError(t, err)

return regions
}

func (c *AccountClient) CreateAndLogIn(t *testing.T) (*sdk.Account, *sdk.Client, func()) {
t.Helper()
id := c.ids.RandomAccountObjectIdentifier()
name := c.ids.Alpha()
privateKey := random.GenerateRSAPrivateKey(t)
publicKey, _ := random.GenerateRSAPublicKeyFromPrivateKey(t, privateKey)
email := random.Email()

account, accountCleanup := c.CreateWithRequest(t, id, &sdk.CreateAccountOptions{
AdminName: name,
AdminRSAPublicKey: sdk.String(publicKey),
AdminUserType: sdk.Pointer(sdk.UserTypeService),
Email: email,
Edition: sdk.EditionStandard,
})

var client *sdk.Client
require.Eventually(t, func() bool {
newClient, err := sdk.NewClient(&gosnowflake.Config{
Account: fmt.Sprintf("%s-%s", account.OrganizationName, account.AccountName),
User: name,
Host: strings.TrimPrefix(*account.AccountLocatorURL, `https://`),
Authenticator: gosnowflake.AuthTypeJwt,
PrivateKey: privateKey,
Role: snowflakeroles.Accountadmin.Name(),
})
client = newClient
return err == nil
}, 2*time.Minute, time.Second*15)

return account, client, accountCleanup
}
10 changes: 10 additions & 0 deletions pkg/acceptance/helpers/context_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,16 @@ func (c *ContextClient) CurrentAccountId(t *testing.T) sdk.AccountIdentifier {
return sdk.NewAccountIdentifier(currentSessionDetails.OrganizationName, currentSessionDetails.AccountName)
}

func (c *ContextClient) CurrentAccountName(t *testing.T) string {
t.Helper()
ctx := context.Background()

currentAccount, err := c.client().CurrentAccountName(ctx)
require.NoError(t, err)

return currentAccount
}

func (c *ContextClient) CurrentRole(t *testing.T) sdk.AccountObjectIdentifier {
t.Helper()
ctx := context.Background()
Expand Down
37 changes: 37 additions & 0 deletions pkg/acceptance/helpers/packages_policy_client.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
package helpers

import (
"context"
"fmt"
"testing"

"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk"
"github.com/stretchr/testify/require"
)

type PackagesPolicyClient struct {
context *TestClientContext
ids *IdsGenerator
}

func NewPackagesPolicyClient(context *TestClientContext, idsGenerator *IdsGenerator) *PackagesPolicyClient {
return &PackagesPolicyClient{
context: context,
ids: idsGenerator,
}
}

func (c *PackagesPolicyClient) Create(t *testing.T) (sdk.SchemaObjectIdentifier, func()) {
t.Helper()

// TODO(SNOW-1348357): Replace raw SQL with SDK

id := c.ids.RandomSchemaObjectIdentifier()
sfc-gh-jmichalak marked this conversation as resolved.
Show resolved Hide resolved
_, err := c.context.client.ExecForTests(context.Background(), fmt.Sprintf("CREATE PACKAGES POLICY %s LANGUAGE PYTHON", id.FullyQualifiedName()))
require.NoError(t, err)

return id, func() {
_, err = c.context.client.ExecForTests(context.Background(), fmt.Sprintf("DROP PACKAGES POLICY IF EXISTS %s", id.FullyQualifiedName()))
require.NoError(t, err)
}
}
8 changes: 4 additions & 4 deletions pkg/acceptance/helpers/random/certs.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ func GenerateRSAPublicKey(t *testing.T) (string, string) {
t.Helper()
key := GenerateRSAPrivateKey(t)

return generateRSAPublicKeyFromPrivateKey(t, key)
return GenerateRSAPublicKeyFromPrivateKey(t, key)
}

// GenerateRSAPublicKey returns an RSA public key without BEGIN and END markers, and key's hash.
func generateRSAPublicKeyFromPrivateKey(t *testing.T, key *rsa.PrivateKey) (string, string) {
// GenerateRSAPublicKeyFromPrivateKey returns an RSA public key without BEGIN and END markers, and key's hash.
func GenerateRSAPublicKeyFromPrivateKey(t *testing.T, key *rsa.PrivateKey) (string, string) {
t.Helper()

pub := key.Public()
Expand Down Expand Up @@ -82,7 +82,7 @@ func GenerateRSAKeyPair(t *testing.T, pass string) (string, string, string, stri
unencrypted := string(pem.EncodeToMemory(&privBlock))
encrypted := encrypt(t, privateKey, pass)

publicKey, keyHash := generateRSAPublicKeyFromPrivateKey(t, privateKey)
publicKey, keyHash := GenerateRSAPublicKeyFromPrivateKey(t, privateKey)
return unencrypted, encrypted, publicKey, keyHash
}

Expand Down
4 changes: 3 additions & 1 deletion pkg/acceptance/helpers/test_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ type TestClient struct {
NetworkPolicy *NetworkPolicyClient
NetworkRule *NetworkRuleClient
NotificationIntegration *NotificationIntegrationClient
PackagesPolicy *PackagesPolicyClient
Parameter *ParameterClient
PasswordPolicy *PasswordPolicyClient
Pipe *PipeClient
Expand Down Expand Up @@ -82,7 +83,7 @@ func NewTestClient(c *sdk.Client, database string, schema string, warehouse stri

Ids: idsGenerator,

Account: NewAccountClient(context),
Account: NewAccountClient(context, idsGenerator),
AggregationPolicy: NewAggregationPolicyClient(context, idsGenerator),
Alert: NewAlertClient(context, idsGenerator),
ApiIntegration: NewApiIntegrationClient(context, idsGenerator),
Expand Down Expand Up @@ -115,6 +116,7 @@ func NewTestClient(c *sdk.Client, database string, schema string, warehouse stri
NetworkPolicy: NewNetworkPolicyClient(context, idsGenerator),
NetworkRule: NewNetworkRuleClient(context, idsGenerator),
NotificationIntegration: NewNotificationIntegrationClient(context, idsGenerator),
PackagesPolicy: NewPackagesPolicyClient(context, idsGenerator),
Parameter: NewParameterClient(context),
PasswordPolicy: NewPasswordPolicyClient(context, idsGenerator),
Pipe: NewPipeClient(context, idsGenerator),
Expand Down
2 changes: 1 addition & 1 deletion pkg/datasources/accounts.go
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ func ReadAccounts(ctx context.Context, d *schema.ResourceData, meta any) diag.Di
m["account_name"] = account.AccountName
m["region_group"] = account.RegionGroup
m["snowflake_region"] = account.SnowflakeRegion
m["edition"] = string(account.Edition)
m["edition"] = string(*account.Edition)
m["account_url"] = account.AccountURL
m["created_on"] = account.CreatedOn.String()
m["comment"] = account.Comment
Expand Down
2 changes: 1 addition & 1 deletion pkg/schemas/account_gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading