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 #8441

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
3 changes: 3 additions & 0 deletions .changelog/11866.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:none
sql: updated `google_sql_database` and `google_sql_user` so they don't perform Read operations if their associated `google_sql_database_instance` has `activation_policy` set to "NEVER". This avoids triggering API errors while the instance is unavailable.
```
8 changes: 8 additions & 0 deletions google-beta/services/sql/resource_sql_database.go
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,14 @@ func resourceSQLDatabaseRead(d *schema.ResourceData, meta interface{}) error {
}

headers := make(http.Header)
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
}
res, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
Config: config,
Method: "GET",
Expand Down
61 changes: 61 additions & 0 deletions google-beta/services/sql/resource_sql_database_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,67 @@ 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 google-beta/services/sql/resource_sql_user.go
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,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 @@ -344,11 +351,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 google-beta/services/sql/resource_sql_user_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,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