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.

Sign up for GitHub

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

chore: Fix env variables for tests #2603

Merged
merged 8 commits into from
Mar 7, 2024
+176 −41
Merged

chore: Fix env variables for tests #2603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fee0f8c
Introduce acceptance test context
sfc-gh-asawicki Mar 7, 2024
fe76117
Expose default config in integration tests
sfc-gh-asawicki Mar 7, 2024
4e3a793
Remove not needed test envs
sfc-gh-asawicki Mar 7, 2024
fb47ef4
Expose envs to test jobs
sfc-gh-asawicki Mar 7, 2024
cf7be55
Skip tests requiring business critical account
sfc-gh-asawicki Mar 7, 2024
991fbf7
Set up client everytime in provider setup test
sfc-gh-asawicki Mar 7, 2024
f4037d6
Fix situation with switching SF_TF_ACC_TEST_CONFIGURE_CLIENT_ONCE on/off
sfc-gh-asawicki Mar 7, 2024
4dc2e5e
Added test name and comments
sfc-gh-asawicki Mar 7, 2024
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
20 changes: 20 additions & 0 deletions .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,16 @@ jobs:

- run: make test
if: steps.create_config.conclusion == 'success'
env:
SNOWFLAKE_BUSINESS_CRITICAL_ACCOUNT: ${{ secrets.SNOWFLAKE_BUSINESS_CRITICAL_ACCOUNT }}
TEST_SF_TF_AWS_EXTERNAL_BUCKET_URL: ${{ secrets.TEST_SF_TF_AWS_EXTERNAL_BUCKET_URL }}
TEST_SF_TF_AWS_EXTERNAL_KEY_ID: ${{ secrets.TEST_SF_TF_AWS_EXTERNAL_KEY_ID }}
TEST_SF_TF_AWS_EXTERNAL_ROLE_ARN: ${{ secrets.TEST_SF_TF_AWS_EXTERNAL_ROLE_ARN }}
TEST_SF_TF_AWS_EXTERNAL_SECRET_KEY: ${{ secrets.TEST_SF_TF_AWS_EXTERNAL_SECRET_KEY }}
TEST_SF_TF_AZURE_EXTERNAL_BUCKET_URL: ${{ secrets.TEST_SF_TF_AZURE_EXTERNAL_BUCKET_URL }}
TEST_SF_TF_AZURE_EXTERNAL_SAS_TOKEN: ${{ secrets.TEST_SF_TF_AZURE_EXTERNAL_SAS_TOKEN }}
TEST_SF_TF_AZURE_EXTERNAL_TENANT_ID: ${{ secrets.TEST_SF_TF_AZURE_EXTERNAL_TENANT_ID }}
TEST_SF_TF_GCS_EXTERNAL_BUCKET_URL: ${{ secrets.TEST_SF_TF_GCS_EXTERNAL_BUCKET_URL }}

- name: Setup Terraform
if: steps.create_config.conclusion == 'success'
Expand All @@ -53,6 +63,16 @@ jobs:

- run: make test-acceptance
if: steps.create_config.conclusion == 'success'
env:
SNOWFLAKE_BUSINESS_CRITICAL_ACCOUNT: ${{ secrets.SNOWFLAKE_BUSINESS_CRITICAL_ACCOUNT }}
TEST_SF_TF_AWS_EXTERNAL_BUCKET_URL: ${{ secrets.TEST_SF_TF_AWS_EXTERNAL_BUCKET_URL }}
TEST_SF_TF_AWS_EXTERNAL_KEY_ID: ${{ secrets.TEST_SF_TF_AWS_EXTERNAL_KEY_ID }}
TEST_SF_TF_AWS_EXTERNAL_ROLE_ARN: ${{ secrets.TEST_SF_TF_AWS_EXTERNAL_ROLE_ARN }}
TEST_SF_TF_AWS_EXTERNAL_SECRET_KEY: ${{ secrets.TEST_SF_TF_AWS_EXTERNAL_SECRET_KEY }}
TEST_SF_TF_AZURE_EXTERNAL_BUCKET_URL: ${{ secrets.TEST_SF_TF_AZURE_EXTERNAL_BUCKET_URL }}
TEST_SF_TF_AZURE_EXTERNAL_SAS_TOKEN: ${{ secrets.TEST_SF_TF_AZURE_EXTERNAL_SAS_TOKEN }}
TEST_SF_TF_AZURE_EXTERNAL_TENANT_ID: ${{ secrets.TEST_SF_TF_AZURE_EXTERNAL_TENANT_ID }}
TEST_SF_TF_GCS_EXTERNAL_BUCKET_URL: ${{ secrets.TEST_SF_TF_GCS_EXTERNAL_BUCKET_URL }}

- name: sweepers cleanup
if: ${{ always() }}
Expand Down
26 changes: 13 additions & 13 deletions pkg/acceptance/testenvs/testenvs_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ func Test_GetOrSkipTest(t *testing.T) {
wg.Add(1)
go func() {
defer wg.Done()
env = testenvs.GetOrSkipTest(t, testenvs.User)
env = testenvs.GetOrSkipTest(t, testenvs.BusinessCriticalAccount)
}()
wg.Wait()
return env
}

t.Run("skip test if missing", func(t *testing.T) {
t.Setenv(string(testenvs.User), "")
t.Setenv(string(testenvs.BusinessCriticalAccount), "")

tut := &testing.T{}
env := runGetOrSkipInGoroutineAndWaitForCompletion(tut)
Expand All @@ -35,7 +35,7 @@ func Test_GetOrSkipTest(t *testing.T) {
})

t.Run("get env if exists", func(t *testing.T) {
t.Setenv(string(testenvs.User), "user")
t.Setenv(string(testenvs.BusinessCriticalAccount), "user")

tut := &testing.T{}
env := runGetOrSkipInGoroutineAndWaitForCompletion(tut)
Expand All @@ -60,19 +60,19 @@ func Test_SkipTestIfSet(t *testing.T) {
}

t.Run("skip test if env is set", func(t *testing.T) {
t.Setenv(string(testenvs.User), "1")
t.Setenv(string(testenvs.BusinessCriticalAccount), "1")

tut := &testing.T{}
runSkipTestIfSetInGoroutineAndWaitForCompletion(tut, testenvs.User)
runSkipTestIfSetInGoroutineAndWaitForCompletion(tut, testenvs.BusinessCriticalAccount)

require.True(t, tut.Skipped())
})

t.Run("do not skip if env not set", func(t *testing.T) {
t.Setenv(string(testenvs.User), "")
t.Setenv(string(testenvs.BusinessCriticalAccount), "")

tut := &testing.T{}
runSkipTestIfSetInGoroutineAndWaitForCompletion(tut, testenvs.User)
runSkipTestIfSetInGoroutineAndWaitForCompletion(tut, testenvs.BusinessCriticalAccount)

require.False(t, tut.Skipped())
})
Expand All @@ -92,26 +92,26 @@ func Test_Assertions(t *testing.T) {
}

t.Run("test if env does not exist", func(t *testing.T) {
t.Setenv(string(testenvs.User), "")
t.Setenv(string(testenvs.BusinessCriticalAccount), "")

tut1 := &testing.T{}
runAssertionInGoroutineAndWaitForCompletion(func() { testenvs.AssertEnvNotSet(tut1, string(testenvs.User)) })
runAssertionInGoroutineAndWaitForCompletion(func() { testenvs.AssertEnvNotSet(tut1, string(testenvs.BusinessCriticalAccount)) })

tut2 := &testing.T{}
runAssertionInGoroutineAndWaitForCompletion(func() { testenvs.AssertEnvSet(tut2, string(testenvs.User)) })
runAssertionInGoroutineAndWaitForCompletion(func() { testenvs.AssertEnvSet(tut2, string(testenvs.BusinessCriticalAccount)) })

require.False(t, tut1.Failed())
require.True(t, tut2.Failed())
})

t.Run("test if env exists", func(t *testing.T) {
t.Setenv(string(testenvs.User), "user")
t.Setenv(string(testenvs.BusinessCriticalAccount), "user")

tut1 := &testing.T{}
runAssertionInGoroutineAndWaitForCompletion(func() { testenvs.AssertEnvNotSet(tut1, string(testenvs.User)) })
runAssertionInGoroutineAndWaitForCompletion(func() { testenvs.AssertEnvNotSet(tut1, string(testenvs.BusinessCriticalAccount)) })

tut2 := &testing.T{}
runAssertionInGoroutineAndWaitForCompletion(func() { testenvs.AssertEnvSet(tut2, string(testenvs.User)) })
runAssertionInGoroutineAndWaitForCompletion(func() { testenvs.AssertEnvSet(tut2, string(testenvs.BusinessCriticalAccount)) })

require.True(t, tut1.Failed())
require.False(t, tut2.Failed())
Expand Down
9 changes: 2 additions & 7 deletions pkg/acceptance/testenvs/testing_environment_variables.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,6 @@ import (
type env string

const (
User env = "TEST_SF_TF_USER"
Password env = "TEST_SF_TF_PASSWORD" // #nosec G101
Account env = "TEST_SF_TF_ACCOUNT"
Role env = "TEST_SF_TF_ROLE"
Host env = "TEST_SF_TF_HOST"

BusinessCriticalAccount env = "SNOWFLAKE_BUSINESS_CRITICAL_ACCOUNT"

TestAccountCreate env = "TEST_SF_TF_TEST_ACCOUNT_CREATE"
Expand All @@ -33,7 +27,8 @@ const (
SkipManagedAccountTest env = "TEST_SF_TF_SKIP_MANAGED_ACCOUNT_TEST"
SkipSamlIntegrationTest env = "TEST_SF_TF_SKIP_SAML_INTEGRATION_TEST"

EnableSweep env = "TEST_SF_TF_ENABLE_SWEEP"
EnableSweep env = "TEST_SF_TF_ENABLE_SWEEP"
ConfigureClientOnce env = "SF_TF_ACC_TEST_CONFIGURE_CLIENT_ONCE"
)

func GetOrSkipTest(t *testing.T, envName Env) string {
Expand Down
45 changes: 37 additions & 8 deletions pkg/acceptance/testing.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@ import (
"sync"
"testing"

"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance/testprofiles"
"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/provider"
"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk"
"github.com/hashicorp/terraform-plugin-go/tfprotov5"
"github.com/hashicorp/terraform-plugin-go/tfprotov6"
"github.com/hashicorp/terraform-plugin-mux/tf5to6server"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-plugin-testing/config"
"github.com/snowflakedb/gosnowflake"
)

const (
Expand All @@ -28,6 +30,7 @@ var (
TestAccProvider *schema.Provider
v5Server tfprotov5.ProviderServer
v6Server tfprotov6.ProviderServer
atc acceptanceTestContext
)

func init() {
Expand All @@ -44,6 +47,26 @@ func init() {
log.Panicf("Cannot upgrade server from proto v5 to proto v6, failing, err: %v", err)
}
_ = testAccProtoV6ProviderFactoriesNew

defaultConfig, err := sdk.ProfileConfig(testprofiles.Default)
if err != nil {
log.Panicf("Cannot load default config, err: %v", err)
}
if defaultConfig == nil {
log.Panic("Config is required to run acceptance tests")
}
atc.config = defaultConfig

client, err := sdk.NewClient(defaultConfig)
if err != nil {
log.Panicf("Cannot instantiate new client, err: %v", err)
}
atc.client = client
}

type acceptanceTestContext struct {
config *gosnowflake.Config
client *sdk.Client
}

var TestAccProtoV6ProviderFactories = map[string]func() (tfprotov6.ProviderServer, error){
Expand All @@ -68,35 +91,31 @@ var once sync.Once
func TestAccPreCheck(t *testing.T) {
// use singleton design pattern to ensure we only create these resources once
once.Do(func() {
client, err := sdk.NewDefaultClient()
if err != nil {
t.Fatal(err)
}
ctx := context.Background()

dbId := sdk.NewAccountObjectIdentifier(TestDatabaseName)
if err := client.Databases.Create(ctx, dbId, &sdk.CreateDatabaseOptions{
if err := atc.client.Databases.Create(ctx, dbId, &sdk.CreateDatabaseOptions{
IfNotExists: sdk.Bool(true),
}); err != nil {
t.Fatal(err)
}

schemaId := sdk.NewDatabaseObjectIdentifier(TestDatabaseName, TestSchemaName)
if err := client.Schemas.Create(ctx, schemaId, &sdk.CreateSchemaOptions{
if err := atc.client.Schemas.Create(ctx, schemaId, &sdk.CreateSchemaOptions{
IfNotExists: sdk.Bool(true),
}); err != nil {
t.Fatal(err)
}

warehouseId := sdk.NewAccountObjectIdentifier(TestWarehouseName)
if err := client.Warehouses.Create(ctx, warehouseId, &sdk.CreateWarehouseOptions{
if err := atc.client.Warehouses.Create(ctx, warehouseId, &sdk.CreateWarehouseOptions{
IfNotExists: sdk.Bool(true),
}); err != nil {
t.Fatal(err)
}

warehouseId2 := sdk.NewAccountObjectIdentifier(TestWarehouseName2)
if err := client.Warehouses.Create(ctx, warehouseId2, &sdk.CreateWarehouseOptions{
if err := atc.client.Warehouses.Create(ctx, warehouseId2, &sdk.CreateWarehouseOptions{
IfNotExists: sdk.Bool(true),
}); err != nil {
t.Fatal(err)
Expand All @@ -119,3 +138,13 @@ func ConfigurationDirectory(directory string) func(config.TestStepConfigRequest)
return filepath.Join("testdata", directory)
}
}

func Client(t *testing.T) *sdk.Client {
t.Helper()
return atc.client
}

func DefaultConfig(t *testing.T) *gosnowflake.Config {
t.Helper()
return atc.config
}
3 changes: 3 additions & 0 deletions pkg/datasources/failover_groups_acceptance_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ import (
)

func TestAcc_FailoverGroups(t *testing.T) {
// TODO [SNOW-1002023]: Unskip; Business Critical Snowflake Edition needed
_ = testenvs.GetOrSkipTest(t, testenvs.TestFailoverGroups)

accountName := testenvs.GetOrSkipTest(t, testenvs.BusinessCriticalAccount)

name := strings.ToUpper(acctest.RandStringFromCharSet(10, acctest.CharSetAlpha))
Expand Down
17 changes: 13 additions & 4 deletions pkg/provider/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -782,11 +782,20 @@ func ConfigureProvider(s *schema.ResourceData) (interface{}, error) {
}
}

configuredClient, configureClientError = sdk.NewClient(config)
cl, clErr := sdk.NewClient(config)

if configureClientError != nil {
return nil, configureClientError
// needed for tests verifying different provider setups
if os.Getenv("TF_ACC") != "" && os.Getenv("SF_TF_ACC_TEST_CONFIGURE_CLIENT_ONCE") == "true" {
configuredClient = cl
configureClientError = clErr
} else {
configuredClient = nil
configureClientError = nil
}

if clErr != nil {
return nil, clErr
}

return &provider.Context{Client: configuredClient}, nil
return &provider.Context{Client: cl}, nil
}
45 changes: 40 additions & 5 deletions pkg/provider/provider_acceptance_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,13 @@ import (
)

func TestAcc_Provider_configHierarchy(t *testing.T) {
user := testenvs.GetOrSkipTest(t, testenvs.User)
pass := testenvs.GetOrSkipTest(t, testenvs.Password)
account := testenvs.GetOrSkipTest(t, testenvs.Account)
role := testenvs.GetOrSkipTest(t, testenvs.Role)
host := testenvs.GetOrSkipTest(t, testenvs.Host)
t.Setenv(string(testenvs.ConfigureClientOnce), "")

user := acc.DefaultConfig(t).User
pass := acc.DefaultConfig(t).Password
account := acc.DefaultConfig(t).Account
role := acc.DefaultConfig(t).Role
host := acc.DefaultConfig(t).Host

nonExistingUser := "non-existing-user"

Expand Down Expand Up @@ -119,6 +121,39 @@ func TestAcc_Provider_configHierarchy(t *testing.T) {
})
}

func TestAcc_Provider_configureClientOnceSwitching(t *testing.T) {
t.Setenv(string(testenvs.ConfigureClientOnce), "")

resource.Test(t, resource.TestCase{
ProtoV6ProviderFactories: acc.TestAccProtoV6ProviderFactories,
PreCheck: func() {
acc.TestAccPreCheck(t)
testenvs.AssertEnvNotSet(t, snowflakeenvs.User)
testenvs.AssertEnvNotSet(t, snowflakeenvs.Password)
},
TerraformVersionChecks: []tfversion.TerraformVersionCheck{
tfversion.RequireAbove(tfversion.Version1_5_0),
},
Steps: []resource.TestStep{
// client setup is incorrect
{
Config: providerConfig(testprofiles.IncorrectUserAndPassword),
ExpectError: regexp.MustCompile("Incorrect username or password was specified"),
},
// in this step we simulate the situation when we want to use client configured once, but it was faulty last time
{
PreConfig: func() {
t.Setenv(string(testenvs.ConfigureClientOnce), "true")
},
Config: emptyProviderConfig(),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("data.snowflake_database.t", "name", acc.TestDatabaseName),
),
},
},
})
}

func emptyProviderConfig() string {
return `
provider "snowflake" {
Expand Down
15 changes: 15 additions & 0 deletions pkg/resources/failover_group_acceptance_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ import (
)

func TestAcc_FailoverGroupBasic(t *testing.T) {
// TODO [SNOW-1002023]: Unskip; Business Critical Snowflake Edition needed
_ = testenvs.GetOrSkipTest(t, testenvs.TestFailoverGroups)

randomCharacters := strings.ToUpper(acctest.RandStringFromCharSet(10, acctest.CharSetAlpha))

accountName := testenvs.GetOrSkipTest(t, testenvs.BusinessCriticalAccount)
Expand Down Expand Up @@ -49,6 +52,9 @@ func TestAcc_FailoverGroupBasic(t *testing.T) {
}

func TestAcc_FailoverGroupRemoveObjectTypes(t *testing.T) {
// TODO [SNOW-1002023]: Unskip; Business Critical Snowflake Edition needed
_ = testenvs.GetOrSkipTest(t, testenvs.TestFailoverGroups)

randomCharacters := strings.ToUpper(acctest.RandStringFromCharSet(10, acctest.CharSetAlpha))

accountName := testenvs.GetOrSkipTest(t, testenvs.BusinessCriticalAccount)
Expand Down Expand Up @@ -87,6 +93,9 @@ func TestAcc_FailoverGroupRemoveObjectTypes(t *testing.T) {
}

func TestAcc_FailoverGroupInterval(t *testing.T) {
// TODO [SNOW-1002023]: Unskip; Business Critical Snowflake Edition needed
_ = testenvs.GetOrSkipTest(t, testenvs.TestFailoverGroups)

randomCharacters := strings.ToUpper(acctest.RandStringFromCharSet(10, acctest.CharSetAlpha))

accountName := testenvs.GetOrSkipTest(t, testenvs.BusinessCriticalAccount)
Expand Down Expand Up @@ -183,6 +192,9 @@ func TestAcc_FailoverGroupInterval(t *testing.T) {
}

func TestAcc_FailoverGroup_issue2517(t *testing.T) {
// TODO [SNOW-1002023]: Unskip; Business Critical Snowflake Edition needed
_ = testenvs.GetOrSkipTest(t, testenvs.TestFailoverGroups)

randomCharacters := strings.ToUpper(acctest.RandStringFromCharSet(10, acctest.CharSetAlpha))

accountName := testenvs.GetOrSkipTest(t, testenvs.BusinessCriticalAccount)
Expand Down Expand Up @@ -211,6 +223,9 @@ func TestAcc_FailoverGroup_issue2517(t *testing.T) {
}

func TestAcc_FailoverGroup_issue2544(t *testing.T) {
// TODO [SNOW-1002023]: Unskip; Business Critical Snowflake Edition needed
_ = testenvs.GetOrSkipTest(t, testenvs.TestFailoverGroups)

randomCharacters := strings.ToUpper(acctest.RandStringFromCharSet(10, acctest.CharSetAlpha))

accountName := testenvs.GetOrSkipTest(t, testenvs.BusinessCriticalAccount)
Expand Down
3 changes: 3 additions & 0 deletions pkg/resources/failover_group_grant_acceptance_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ import (
)

func TestAcc_FailoverGroupGrant(t *testing.T) {
// TODO [SNOW-1002023]: Unskip; Business Critical Snowflake Edition needed
_ = testenvs.GetOrSkipTest(t, testenvs.TestFailoverGroups)

accountName := testenvs.GetOrSkipTest(t, testenvs.BusinessCriticalAccount)
name := strings.ToUpper(acctest.RandStringFromCharSet(10, acctest.CharSetAlpha))

Expand Down
Loading
Loading