Implement state rename command for renaming a resource #9098
Conversation
pkg/cmd/pulumi/state_rename.go
Outdated
| res := runStateEdit(stack, showPrompt, urn, func(snap *deploy.Snapshot, resource *resource.State) error { | ||
|
|
||
| // the resource is protected but the user didn't use --force | ||
| if !force && resource.Protect { |
There was a problem hiding this comment.
I don't think "Protect" needs to be taken into consideration for renames. Protect is that you won't delete it, not that you won't change anything about it.
There was a problem hiding this comment.
I see, I will change it ✔️
|
|
||
| // update the URN with only the name part changed | ||
| resource.URN = resource.URN.Rename(newResourceName) | ||
|
|
There was a problem hiding this comment.
I think we want to use runTotalStateEdit because we need to rename this resources URN but we also need to look at every other resource to see if it references this URN and update it's references (for things like Dependencies and PropertyDependencies)
There was a problem hiding this comment.
is this only a matter of changing runStateEdit to runTotalStateEdit and it will take care of the rest? I thought I actually needed to look for dependants rather than dependencies since only dependants would reference an existing resource
There was a problem hiding this comment.
Yes anything that is dependent on the resource being renamed will need a fix up. You don't actually need to build a dependency graph though, you can just do a straight forward iterate through everything and replace anywhere you see the old URN with the new URN I think.
| urn := resource.URN(args[0]) | ||
| newResourceName := args[1] | ||
| // Show the confirmation prompt if the user didn't pass the --yes parameter to skip it. | ||
| showPrompt := !yes |
There was a problem hiding this comment.
Before running any stateEdit we should do a non-mutating pass of the current state to check the renamed URN isn't already present, and error if it is.
There was a problem hiding this comment.
That makes sense, I'll try to figure how to do that 👍
pkg/cmd/pulumi/state_rename.go
Outdated
| @@ -0,0 +1,121 @@ | |||
| // Copyright 2016-2018, Pulumi Corporation. | |||
There was a problem hiding this comment.
| // Copyright 2016-2018, Pulumi Corporation. | |
| // Copyright 2016-2022, Pulumi Corporation. |
| This command renames a resource from a stack's state. The resource is specified | ||
| by its Pulumi URN (use ` + "`pulumi stack --show-urns`" + ` to get it) and the new name of the resource. | ||
|
|
||
| Make sure that URNs are single-quoted to avoid having characters unexpectedly interpreted by the shell. |
| Args: cmdutil.ExactArgs(2), | ||
| Run: cmdutil.RunResultFunc(func(cmd *cobra.Command, args []string) result.Result { | ||
| yes = yes || skipConfirmations() | ||
| urn := resource.URN(args[0]) |
There was a problem hiding this comment.
Should probably add a check here for urn.IsValid() and error out if false
| if len(candidateResources) > 0 { | ||
| return errors.New("The chosen new name for the state corresponds to an already existing resource") | ||
| } | ||
|
|
There was a problem hiding this comment.
Ideally the checks above could come before the user prompt that we're going to modify state. I think this is fine for this PR but would be nice to have a think if there's a way to keep the code this simple but split the check/prompt/do work up.
Description
Implements
state renamecommand. Fixes #2060Checklist