feat: Add listing proxies to cli 'coder proxy ls'

Emyrk · Emyrk · commit a76937e08e9c · 2023-05-02T10:47:38.000-05:00
diff --git a/codersdk/workspaceproxy.go b/codersdk/workspaceproxy.go
@@ -29,7 +29,7 @@ const (
 )
 
 type WorkspaceProxyStatus struct {
-	Status ProxyHealthStatus `json:"status" table:"status"`
+	Status ProxyHealthStatus `json:"status" table:"status,default_sort"`
 	// Report provides more information about the health of the workspace proxy.
 	Report    ProxyHealthReport `json:"report,omitempty" table:"report"`
 	CheckedAt time.Time         `json:"checked_at" table:"checked_at" format:"date-time"`
@@ -60,11 +60,11 @@ type WorkspaceProxy struct {
 	// Status is the latest status check of the proxy. This will be empty for deleted
 	// proxies. This value can be used to determine if a workspace proxy is healthy
 	// and ready to use.
-	Status WorkspaceProxyStatus `json:"status,omitempty" table:"status"`
+	Status WorkspaceProxyStatus `json:"status,omitempty" table:"status,recursive"`
 }
 
 type CreateWorkspaceProxyRequest struct {
-	Name        string `json:"name"`
+	Name        string `json:"name" validate:"required"`
 	DisplayName string `json:"display_name"`
 	Icon        string `json:"icon"`
 }
diff --git a/enterprise/cli/workspaceproxy.go b/enterprise/cli/workspaceproxy.go
@@ -23,6 +23,7 @@ func (r *RootCmd) workspaceProxy() *clibase.Cmd {
 			r.proxyServer(),
 			r.createProxy(),
 			r.deleteProxy(),
+			r.listProxies(),
 		},
 	}
 
@@ -66,7 +67,8 @@ func (r *RootCmd) createProxy() *clibase.Cmd {
 				if !ok {
 					return nil, xerrors.Errorf("unexpected type %T", data)
 				}
-				return fmt.Sprintf("Workspace Proxy %q registered successfully\nToken: %s", response.Proxy.Name, response.ProxyToken), nil
+				return fmt.Sprintf("Workspace Proxy %q created successfully. Save this token, it will not be shown again."+
+					"\nToken: %s", response.Proxy.Name, response.ProxyToken), nil
 			}),
 			cliui.JSONFormat(),
 			// Table formatter expects a slice, make a slice of one.
@@ -91,6 +93,10 @@ func (r *RootCmd) createProxy() *clibase.Cmd {
 		),
 		Handler: func(inv *clibase.Invocation) error {
 			ctx := inv.Context()
+			if proxyName == "" {
+				return xerrors.Errorf("proxy name is required")
+			}
+
 			resp, err := client.CreateWorkspaceProxy(ctx, codersdk.CreateWorkspaceProxyRequest{
 				Name:        proxyName,
 				DisplayName: displayName,
@@ -140,3 +146,42 @@ func (r *RootCmd) createProxy() *clibase.Cmd {
 	)
 	return cmd
 }
+
+func (r *RootCmd) listProxies() *clibase.Cmd {
+	var (
+		formatter = cliui.NewOutputFormatter(
+			cliui.TableFormat([]codersdk.WorkspaceProxy{}, []string{"name", "url", "status status"}),
+			cliui.JSONFormat(),
+			cliui.TextFormat(),
+		)
+	)
+
+	client := new(codersdk.Client)
+	cmd := &clibase.Cmd{
+		Use:     "ls",
+		Aliases: []string{"list"},
+		Short:   "List all workspace proxies",
+		Middleware: clibase.Chain(
+			clibase.RequireNArgs(0),
+			r.InitClient(client),
+		),
+		Handler: func(inv *clibase.Invocation) error {
+			ctx := inv.Context()
+			proxies, err := client.WorkspaceProxies(ctx)
+			if err != nil {
+				return xerrors.Errorf("list workspace proxies: %w", err)
+			}
+
+			output, err := formatter.Format(ctx, proxies)
+			if err != nil {
+				return err
+			}
+
+			_, err = fmt.Fprintln(inv.Stdout, output)
+			return err
+		},
+	}
+
+	formatter.AttachOptions(&cmd.Options)
+	return cmd
+}
