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

Update google_sql_database and google_sql_user to not do Read actions when instance is not active #11866

Merged
merged 12 commits into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions mmv1/products/sql/Database.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ async:
collection_url_key: 'items'
custom_code:
pre_delete: 'templates/terraform/pre_delete/sql_database_deletion_policy.tmpl'
pre_read: 'templates/terraform/pre_read/sql_database_activation_policy.tmpl'
SarahFrench marked this conversation as resolved.
Show resolved Hide resolved
# Sweeper skipped as this resource has customized deletion.
exclude_sweeper: true
read_error_transform: 'transformSQLDatabaseReadError'
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
instance := d.Get("instance").(string)
databaseInstance, err := config.NewSqlAdminClient(userAgent).Instances.Get(project, instance).Do()
if err != nil {
return err
}
if databaseInstance.Settings.ActivationPolicy != "ALWAYS" {
return nil
}
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,9 @@ func testAccCheckGoogleSqlDatabaseExists(t *testing.T, n string, database *sqlad

*database = *found

return nil
}
}
return nil
}
}

func testAccSqlDatabaseDestroyProducer(t *testing.T) func(s *terraform.State) error {
return func(s *terraform.State) error {
Expand All @@ -183,6 +183,68 @@ func testAccSqlDatabaseDestroyProducer(t *testing.T) func(s *terraform.State) er
}
}

func TestAccSqlDatabase_instanceWithActivationPolicy(t *testing.T) {
t.Parallel()

var database sqladmin.Database

instance_name := fmt.Sprintf("tf-test-%d", acctest.RandInt(t))
database_name := fmt.Sprintf("tf-test-%d", acctest.RandInt(t))

acctest.VcrTest(t, resource.TestCase{
PreCheck: func() { acctest.AccTestPreCheck(t) },
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
CheckDestroy: testAccSqlDatabaseDestroyProducer(t),
Steps: []resource.TestStep{
{
Config: testGoogleSqlDatabase_instanceWithActivationPolicy(instance_name, database_name , "ALWAYS"),
Check: resource.ComposeTestCheckFunc(
testAccCheckGoogleSqlDatabaseExists(
t, "google_sql_database.database", &database),
),
},
// Step 2: Update activation_policy to NEVER
{
Config: testGoogleSqlDatabase_instanceWithActivationPolicy(instance_name, database_name, "NEVER"),
},
// Step 3: Refresh to verify no errors
{
Config: testGoogleSqlDatabase_instanceWithActivationPolicy(instance_name, database_name, "NEVER"),
},
// Step 4: Update activation_policy to ALWAYS so that post-test destroy code is able to delete the google_sql_database resource
{
Config: testGoogleSqlDatabase_instanceWithActivationPolicy(instance_name, database_name, "ALWAYS"),
Check: resource.ComposeTestCheckFunc(
testAccCheckGoogleSqlDatabaseExists(
t, "google_sql_database.database", &database),
),
},
},
})
}

func testGoogleSqlDatabase_instanceWithActivationPolicy(instance_name, database_name, activationPolicy string) string {
return fmt.Sprintf(`
resource "google_sql_database_instance" "instance" {
name = "%s"
database_version = "MYSQL_5_7"
region = "us-central1"
deletion_protection = false
settings {
tier = "db-f1-micro"
availability_type = "ZONAL"
activation_policy = "%s"
}
}
resource "google_sql_database" "database" {
name = "%s"
instance = google_sql_database_instance.instance.name
}
`, instance_name, activationPolicy, database_name,)
}


var testGoogleSqlDatabase_basic = `
resource "google_sql_database_instance" "instance" {
name = "%s"
Expand Down
12 changes: 7 additions & 5 deletions mmv1/third_party/terraform/services/sql/resource_sql_user.go
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,13 @@ func resourceSqlUserRead(d *schema.ResourceData, meta interface{}) error {
instance := d.Get("instance").(string)
name := d.Get("name").(string)
host := d.Get("host").(string)
databaseInstance, err := config.NewSqlAdminClient(userAgent).Instances.Get(project, instance).Do()
if err != nil {
return err
}
if databaseInstance.Settings.ActivationPolicy != "ALWAYS" {
return nil
}

var users *sqladmin.UsersListResponse
err = nil
Expand All @@ -342,11 +349,6 @@ func resourceSqlUserRead(d *schema.ResourceData, meta interface{}) error {
}

var user *sqladmin.User
databaseInstance, err := config.NewSqlAdminClient(userAgent).Instances.Get(project, instance).Do()
if err != nil {
return err
}

for _, currentUser := range users.Items {
var username string
if !(strings.Contains(databaseInstance.DatabaseVersion, "POSTGRES") || currentUser.Type == "CLOUD_IAM_GROUP") {
Expand Down
59 changes: 59 additions & 0 deletions mmv1/third_party/terraform/services/sql/resource_sql_user_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,65 @@ func TestAccSqlUser_mysqlPasswordPolicy(t *testing.T) {
})
}

func TestAccSqlUser_instanceWithActivationPolicy(t *testing.T) {
// Multiple fine-grained resources
acctest.SkipIfVcr(t)
t.Parallel()

instance := fmt.Sprintf("tf-test-%d", acctest.RandInt(t))

acctest.VcrTest(t, resource.TestCase{
PreCheck: func() { acctest.AccTestPreCheck(t) },
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
CheckDestroy: testAccSqlUserDestroyProducer(t),
Steps: []resource.TestStep{
{
Config: testGoogleSqlUser_instanceWithActivationPolicy(instance, "ALWAYS"),
Check: resource.ComposeTestCheckFunc(
testAccCheckGoogleSqlUserExists(t, "google_sql_user.user"),
),
},
// Step 2: Update activation_policy to NEVER
{
Config: testGoogleSqlUser_instanceWithActivationPolicy(instance, "NEVER"),
},
// Step 3: Refresh to verify no errors
{
Config: testGoogleSqlUser_instanceWithActivationPolicy(instance, "NEVER"),
},
// Step 4: Update activation_policy to ALWAYS so that post-test destroy code is able to delete the google_sql_user resource
{
Config: testGoogleSqlUser_instanceWithActivationPolicy(instance, "ALWAYS"),
Check: resource.ComposeTestCheckFunc(
testAccCheckGoogleSqlUserExists(t, "google_sql_user.user"),
),
},
},
})
}

func testGoogleSqlUser_instanceWithActivationPolicy(instance, activationPolicy string) string {
return fmt.Sprintf(`
resource "google_sql_database_instance" "instance" {
name = "%s"
database_version = "MYSQL_5_7"
region = "us-central1"
deletion_protection = false
settings {
tier = "db-f1-micro"
availability_type = "ZONAL"
activation_policy = "%s"
}
}
resource "google_sql_user" "user" {
name = "admin"
instance = google_sql_database_instance.instance.name
password = "password"
}
`, instance, activationPolicy)
}

func testGoogleSqlUser_mysql(instance, password string) string {
return fmt.Sprintf(`
resource "google_sql_database_instance" "instance" {
Expand Down
Loading