Add coder providers rename command (#320)

f0ssel · web-flow · commit eccaa79b59b5 · 2021-04-21T09:52:27.000-05:00
* Add coder providers rename command

* Update interface.go
diff --git a/coder-sdk/interface.go b/coder-sdk/interface.go
@@ -232,4 +232,7 @@ type Client interface {
 	// UnCordonWorkspaceProvider changes an existing cordoned providers status to 'Ready';
 	// allowing it to continue creating new workspaces and provisioning resources for them.
 	UnCordonWorkspaceProvider(ctx context.Context, id string) error
+
+	// RenameWorkspaceProvider changes an existing providers name field.
+	RenameWorkspaceProvider(ctx context.Context, id string, name string) error
 }
diff --git a/coder-sdk/workspace_providers.go b/coder-sdk/workspace_providers.go
@@ -123,3 +123,18 @@ func (c *DefaultClient) UnCordonWorkspaceProvider(ctx context.Context, id string
 	}
 	return nil
 }
+
+// RenameWorkspaceProviderReq defines the request parameters for changing a workspace provider name.
+type RenameWorkspaceProviderReq struct {
+	Name string `json:"name"`
+}
+
+// RenameWorkspaceProvider changes an existing cordoned providers name field.
+func (c *DefaultClient) RenameWorkspaceProvider(ctx context.Context, id string, name string) error {
+	req := RenameWorkspaceProviderReq{Name: name}
+	err := c.requestBody(ctx, http.MethodPatch, "/api/private/resource-pools/"+id, req, nil)
+	if err != nil {
+		return err
+	}
+	return nil
+}
diff --git a/internal/cmd/providers.go b/internal/cmd/providers.go
@@ -29,6 +29,7 @@ func providersCmd() *cobra.Command {
 		deleteProviderCmd(),
 		cordonProviderCmd(),
 		unCordonProviderCmd(),
+		renameProviderCmd(),
 	)
 	return cmd
 }
@@ -284,3 +285,35 @@ coder providers uncordon my-workspace-provider`,
 	}
 	return cmd
 }
+
+func renameProviderCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "rename [old_name] [new_name]",
+		Args:  xcobra.ExactArgs(2),
+		Short: "rename a workspace provider.",
+		Long:  "Changes the name field of an existing workspace provider.",
+		Example: `# rename a workspace provider from 'built-in' to 'us-east-1'
+coder providers rename build-in us-east-1`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			ctx := cmd.Context()
+			client, err := newClient(ctx)
+			if err != nil {
+				return err
+			}
+
+			oldName := args[0]
+			newName := args[1]
+			provider, err := coderutil.ProviderByName(ctx, client, oldName)
+			if err != nil {
+				return err
+			}
+
+			if err := client.RenameWorkspaceProvider(ctx, provider.ID, newName); err != nil {
+				return err
+			}
+			clog.LogSuccess(fmt.Sprintf("provider %s successfully renamed to %s", oldName, newName))
+			return nil
+		},
+	}
+	return cmd
+}

Original file line number	Diff line number	Diff line change
`@@ -232,4 +232,7 @@ type Client interface {`
`232`	`232`	`// UnCordonWorkspaceProvider changes an existing cordoned providers status to 'Ready';`
`233`	`233`	`// allowing it to continue creating new workspaces and provisioning resources for them.`
`234`	`234`	`UnCordonWorkspaceProvider(ctx context.Context, id string) error`
	`235`	`+`
	`236`	`+ // RenameWorkspaceProvider changes an existing providers name field.`
	`237`	`+ RenameWorkspaceProvider(ctx context.Context, id string, name string) error`
`235`	`238`	`}`