provider/google: Add import support to google_sql_user #14457

rileykarson · 2017-05-13T00:56:00Z

Add support for "terraform import" with google_sql_user resources.

This uses a slightly different format than normal to support specifying the database instance name. The format is documented on the resource's page, along with a note that passwords are not retrieved

rileykarson · 2017-05-13T00:56:12Z

@danawillow

catsby

Question about a possibly errant SetId

catsby · 2017-05-15T14:16:49Z

builtin/providers/google/resource_sql_user.go

 		log.Printf("[WARN] Removing SQL User %q because it's gone", d.Get("name").(string))
 		d.SetId("")

 		return nil
 	}

-	d.SetId(name)
+	d.SetId(fmt.Sprintf("%s.%s", instance, name))


It's generally not a good idea to call SetId outside of a CREATE method. I realize this isn't your addition, but do you know off hand why this is here? Can it be removed and have the resource work as expected?

You're right - this was able to be safely removed. 🎉

danawillow · 2017-05-15T23:59:37Z

builtin/providers/google/resource_sql_user.go

@@ -77,6 +83,8 @@ func resourceSqlUserCreate(d *schema.ResourceData, meta interface{}) error {
 			"user %s into instance %s: %s", name, instance, err)
 	}

+	d.SetId(fmt.Sprintf("%s.%s", instance, name))


So I take back part of what I told you in person. We shouldn't change the format of the ID, since that will break refreshing (since the ID in state will still be the old version). At this point we have three possible solutions:

Write a migration function to change all the IDs in state. I think it would work, but migration functions are kind of a pain.

Do the ID parsing in the StateFn, so instead of doing a schema.ImportStatePassthrough, create a custom function that parses the ID and then sets the two properties in the state before it gets passed to the read fn.

Create a custom function that reads all available instances, and then tries each one to see if the user belongs to that instance (see resource_pagerduty_service_integration for an example). This is actually less bad than I initially made it out to be. Since Terraform is currently storing the user name as the ID, it's already not allowing multiple users with the same name in different instances. And so a naive import should fail in this case anyway. However the point could be made that Terraform should allow users with the same name in different instances.

I'm not sure yet which the best solution is. I'll consult with Hashicorp people and get back to you.

All right, the experts have spoken and recommended solution 1. I can explain migration fns to you once I'm in the office, or feel free to give it a try on your own (I actually don't think it'll be much of a pain, this will be a pretty straightforward one)

danawillow · 2017-05-16T00:00:01Z

builtin/providers/google/resource_sql_user.go

-	instance := d.Get("instance").(string)
+	instanceAndName := strings.SplitN(d.Id(), ".", 2)
+	if len(instanceAndName) != 2 {
+		return errors.New(


fmt.Errorf :D

JDiPierro · 2017-05-18T14:01:11Z

This is great to see! I started adding importability for google_dns_record_sets but stopped since they don't have a singular ID; import would have to do something similar to {instance}.{name} that's done here. I think I'll pick that back up soon and follow this pattern. :)

Also: I think you'll want to add google_sql_user to the list of importable resources at /website/source/docs/import/importability.html.md.

danawillow · 2017-05-22T19:52:19Z

builtin/providers/google/resource_sql_user_migrate.go

+func resourceSqlUserMigrateState(
+	v int, is *terraform.InstanceState, meta interface{}) (*terraform.InstanceState, error) {
+	if is.Empty() {
+		log.Println("[DEBUG] Empty SqlUserState; nothing to migrate.")


Actually InstanceState is a terraform type so you do want InstanceState here instead of SqlUserState

danawillow · 2017-05-22T19:54:30Z

builtin/providers/google/resource_sql_user_migrate_test.go

+				"name":     "tf-user",
+				"instance": "tf-instance",
+			},
+			Expected:   map[string]string{},


Why is Expected empty?

danawillow · 2017-05-22T20:01:21Z

builtin/providers/google/resource_sql_user.go

@@ -95,32 +104,41 @@ func resourceSqlUserRead(d *schema.ResourceData, meta interface{}) error {
 		return err
 	}

-	name := d.Get("name").(string)
-	instance := d.Get("instance").(string)
+	instanceAndName := strings.SplitN(d.Id(), ".", 2)


I'm slightly nervous about using dots as a separator. Even though this set of properties is safe, I can imagine a resource that needs to be imported in a similar way but dots are acceptable characters in names for both types of resources, and then we would have an inconsistency between resources. I think a "/" would be safer, since I'd be really surprised if it ever came up as a separator (because of weirdness in self_links). What do you think?

This makes sense - "/" is probably a safer character to use than ".".

Done.

ghost · 2020-04-12T02:04:34Z

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

rileykarson added 3 commits May 12, 2017 17:32

Support importing google_sql_user

fe900fa

Updated documentation to reflect that passwords are not retrieved.

6889347

Added additional documentation detailing use.

50c2b10

apparentlymart added provider/google-cloud enhancement labels May 13, 2017

grubernaut requested review from paddycarver and danawillow May 15, 2017 13:05

catsby reviewed May 15, 2017

View reviewed changes

Removed unneeded d.setId() line from GoogleSqlUser Read method.

abec2b6

danawillow suggested changes May 16, 2017

View reviewed changes

rileykarson added 3 commits May 16, 2017 10:51

Changed an errors.New() call to fmt.Errorf().

88ebb20

Migrate schemas of existing GoogleSqlUser resources.

7905afe

Remove explicitly setting 'id' property

286d190

paddycarver mentioned this pull request May 18, 2017

resource google_sql_user doesn't support import #14440

Closed

Added google_sql_user to importability page.

7c50897

danawillow suggested changes May 22, 2017

View reviewed changes

Changed separator to '/' from '.' and updated tests + debug messages.

ba9059f

danawillow approved these changes May 22, 2017

View reviewed changes

danawillow merged commit 56f89e2 into hashicorp:master May 22, 2017

ghost locked and limited conversation to collaborators Apr 12, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

provider/google: Add import support to google_sql_user #14457

provider/google: Add import support to google_sql_user #14457

rileykarson commented May 13, 2017

rileykarson commented May 13, 2017

catsby left a comment

catsby May 15, 2017

rileykarson May 15, 2017

danawillow May 15, 2017

danawillow May 16, 2017

danawillow May 16, 2017

JDiPierro commented May 18, 2017

danawillow May 22, 2017

rileykarson May 22, 2017

danawillow May 22, 2017

rileykarson May 22, 2017

danawillow May 22, 2017

rileykarson May 22, 2017

ghost commented Apr 12, 2020

provider/google: Add import support to google_sql_user #14457

provider/google: Add import support to google_sql_user #14457

Conversation

rileykarson commented May 13, 2017

rileykarson commented May 13, 2017

catsby left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JDiPierro commented May 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Apr 12, 2020