feat: Add suspend/active user to cli (#1422)

* feat: Add suspend/active user to cli
* UserID is now a string and allows for username too

cli/userlist.go

@@ -2,12 +2,9 @@ package cli
 
 import (
 	"fmt"
-	"time"
 
-	"github.com/jedib0t/go-pretty/v6/table"
 	"github.com/spf13/cobra"
 
-	"github.com/coder/coder/cli/cliui"
 	"github.com/coder/coder/codersdk"
 )
 
@@ -28,25 +25,11 @@ func userList() *cobra.Command {
 				return err
 			}
 
-			tableWriter := cliui.Table()
-			header := table.Row{"Username", "Email", "Created At"}
-			tableWriter.AppendHeader(header)
-			tableWriter.SetColumnConfigs(cliui.FilterTableColumns(header, columns))
-			tableWriter.SortBy([]table.SortBy{{
-				Name: "Username",
-			}})
-			for _, user := range users {
-				tableWriter.AppendRow(table.Row{
-					user.Username,
-					user.Email,
-					user.CreatedAt.Format(time.Stamp),
-				})
-			}
-			_, err = fmt.Fprintln(cmd.OutOrStdout(), tableWriter.Render())
+			_, err = fmt.Fprintln(cmd.OutOrStdout(), displayUsers(columns, users...))
 			return err
 		},
 	}
-	cmd.Flags().StringArrayVarP(&columns, "column", "c", nil,
+	cmd.Flags().StringArrayVarP(&columns, "column", "c", []string{"username", "email", "created_at"},
 		"Specify a column to filter in the table.")
 	return cmd
 }

cli/users.go

@@ -1,12 +1,48 @@
 package cli
 
-import "github.com/spf13/cobra"
+import (
+	"time"
+
+	"github.com/jedib0t/go-pretty/v6/table"
+	"github.com/spf13/cobra"
+
+	"github.com/coder/coder/cli/cliui"
+	"github.com/coder/coder/codersdk"
+)
 
 func users() *cobra.Command {
 	cmd := &cobra.Command{
 		Short: "Create, remove, and list users",
 		Use:   "users",
 	}
-	cmd.AddCommand(userCreate(), userList())
+	cmd.AddCommand(
+		userCreate(),
+		userList(),
+		createUserStatusCommand(codersdk.UserStatusActive),
+		createUserStatusCommand(codersdk.UserStatusSuspended),
+	)
 	return cmd
 }
+
+// displayUsers will return a table displaying all users passed in.
+// filterColumns must be a subset of the user fields and will determine which
+// columns to display
+func displayUsers(filterColumns []string, users ...codersdk.User) string {
+	tableWriter := cliui.Table()
+	header := table.Row{"id", "username", "email", "created_at", "status"}
+	tableWriter.AppendHeader(header)
+	tableWriter.SetColumnConfigs(cliui.FilterTableColumns(header, filterColumns))
+	tableWriter.SortBy([]table.SortBy{{
+		Name: "Username",
+	}})
+	for _, user := range users {
+		tableWriter.AppendRow(table.Row{
+			user.ID.String(),
+			user.Username,
+			user.Email,
+			user.CreatedAt.Format(time.Stamp),
+			user.Status,
+		})
+	}
+	return tableWriter.Render()
+}

cli/userstatus.go

@@ -0,0 +1,85 @@
+package cli
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"golang.org/x/xerrors"
+
+	"github.com/coder/coder/cli/cliui"
+	"github.com/coder/coder/codersdk"
+)
+
+// createUserStatusCommand sets a user status.
+func createUserStatusCommand(sdkStatus codersdk.UserStatus) *cobra.Command {
+	var verb string
+	var aliases []string
+	var short string
+	switch sdkStatus {
+	case codersdk.UserStatusActive:
+		verb = "activate"
+		aliases = []string{"active"}
+		short = "Update a user's status to 'active'. Active users can fully interact with the platform"
+	case codersdk.UserStatusSuspended:
+		verb = "suspend"
+		aliases = []string{"rm", "delete"}
+		short = "Update a user's status to 'suspended'. A suspended user cannot log into the platform"
+	default:
+		panic(fmt.Sprintf("%s is not supported", sdkStatus))
+	}
+
+	var (
+		columns []string
+	)
+	cmd := &cobra.Command{
+		Use:     fmt.Sprintf("%s <username|user_id>", verb),
+		Short:   short,
+		Args:    cobra.ExactArgs(1),
+		Aliases: aliases,
+		Example: fmt.Sprintf("coder users %s example_user", verb),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			client, err := createClient(cmd)
+			if err != nil {
+				return err
+			}
+
+			identifier := args[0]
+			if identifier == "" {
+				return xerrors.Errorf("user identifier cannot be an empty string")
+			}
+
+			user, err := client.User(cmd.Context(), identifier)
+			if err != nil {
+				return xerrors.Errorf("fetch user: %w", err)
+			}
+
+			// Display the user
+			_, _ = fmt.Fprintln(cmd.OutOrStdout(), displayUsers(columns, user))
+
+			// User status is already set to this
+			if user.Status == sdkStatus {
+				_, _ = fmt.Fprintf(cmd.OutOrStdout(), "User status is already %q\n", sdkStatus)
+				return nil
+			}
+
+			// Prompt to confirm the action
+			_, err = cliui.Prompt(cmd, cliui.PromptOptions{
+				Text:      fmt.Sprintf("Are you sure you want to %s this user?", verb),
+				IsConfirm: true,
+				Default:   "yes",
+			})
+			if err != nil {
+				return err
+			}
+
+			_, err = client.UpdateUserStatus(cmd.Context(), user.ID.String(), sdkStatus)
+			if err != nil {
+				return xerrors.Errorf("%s user: %w", verb, err)
+			}
+			return nil
+		},
+	}
+	cmd.Flags().StringArrayVarP(&columns, "column", "c", []string{"username", "email", "created_at", "status"},
+		"Specify a column to filter in the table.")
+	return cmd
+}

cli/userstatus_test.go

@@ -0,0 +1,64 @@
+package cli_test
+
+import (
+	"bytes"
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/coder/coder/cli/clitest"
+	"github.com/coder/coder/coderd/coderdtest"
+	"github.com/coder/coder/codersdk"
+)
+
+func TestUserStatus(t *testing.T) {
+	t.Parallel()
+	client := coderdtest.New(t, nil)
+	admin := coderdtest.CreateFirstUser(t, client)
+	other := coderdtest.CreateAnotherUser(t, client, admin.OrganizationID)
+	otherUser, err := other.User(context.Background(), codersdk.Me)
+	require.NoError(t, err, "fetch user")
+
+	//nolint:paralleltest
+	t.Run("StatusSelf", func(t *testing.T) {
+		cmd, root := clitest.New(t, "users", "suspend", "me")
+		clitest.SetupConfig(t, client, root)
+		// Yes to the prompt
+		cmd.SetIn(bytes.NewReader([]byte("yes\n")))
+		err := cmd.Execute()
+		// Expect an error, as you cannot suspend yourself
+		require.Error(t, err)
+		require.ErrorContains(t, err, "cannot suspend yourself")
+	})
+
+	//nolint:paralleltest
+	t.Run("StatusOther", func(t *testing.T) {
+		require.Equal(t, otherUser.Status, codersdk.UserStatusActive, "start as active")
+
+		cmd, root := clitest.New(t, "users", "suspend", otherUser.Username)
+		clitest.SetupConfig(t, client, root)
+		// Yes to the prompt
+		cmd.SetIn(bytes.NewReader([]byte("yes\n")))
+		err := cmd.Execute()
+		require.NoError(t, err, "suspend user")
+
+		// Check the user status
+		otherUser, err = client.User(context.Background(), otherUser.Username)
+		require.NoError(t, err, "fetch suspended user")
+		require.Equal(t, otherUser.Status, codersdk.UserStatusSuspended, "suspended user")
+
+		// Set back to active. Try using a uuid as well
+		cmd, root = clitest.New(t, "users", "activate", otherUser.ID.String())
+		clitest.SetupConfig(t, client, root)
+		// Yes to the prompt
+		cmd.SetIn(bytes.NewReader([]byte("yes\n")))
+		err = cmd.Execute()
+		require.NoError(t, err, "suspend user")
+
+		// Check the user status
+		otherUser, err = client.User(context.Background(), otherUser.ID.String())
+		require.NoError(t, err, "fetch active user")
+		require.Equal(t, otherUser.Status, codersdk.UserStatusActive, "active user")
+	})
+}