coder · coadler · Oct 9, 2023 · Oct 6, 2023
diff --git a/cli/testdata/coder_users_--help.golden b/cli/testdata/coder_users_--help.golden
@@ -11,6 +11,7 @@ SUBCOMMANDS:
     activate    Update a user's status to 'active'. Active users can fully
                 interact with the platform
     create      
+    delete      Delete a user by username or user_id.
     list        
     show        Show a single user. Use 'me' to indicate the currently
                 authenticated user.

diff --git a/cli/testdata/coder_users_delete_--help.golden b/cli/testdata/coder_users_delete_--help.golden
@@ -0,0 +1,11 @@
+coder v0.0.0-devel
+
+USAGE:
+  coder users delete <username|user_id>
+
+  Delete a user by username or user_id.
+
+  Aliases: rm
+
+———
+Run `coder --help` for a list of global options.
diff --git a/cli/testdata/coder_users_suspend_--help.golden b/cli/testdata/coder_users_suspend_--help.golden
@@ -6,8 +6,6 @@ USAGE:
   Update a user's status to 'suspended'. A suspended user cannot log into the
   platform
 
-  Aliases: rm, delete
-
    $ coder users suspend example_user
 
 OPTIONS:

diff --git a/cli/user_delete_test.go b/cli/user_delete_test.go
@@ -0,0 +1,165 @@
+package cli_test
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/coder/coder/v2/cli/clitest"
+	"github.com/coder/coder/v2/coderd/coderdtest"
+	"github.com/coder/coder/v2/codersdk"
+	"github.com/coder/coder/v2/cryptorand"
+	"github.com/coder/coder/v2/pty/ptytest"
+)
+
+func TestUserDelete(t *testing.T) {
+	t.Parallel()
+	t.Run("Username", func(t *testing.T) {
+		t.Parallel()
+		ctx := context.Background()
+		client := coderdtest.New(t, nil)
+		aUser := coderdtest.CreateFirstUser(t, client)
+
+		pw, err := cryptorand.String(16)
+		require.NoError(t, err)
+
+		_, err = client.CreateUser(ctx, codersdk.CreateUserRequest{
+			Email:          "colin5@coder.com",
+			Username:       "coolin",
+			Password:       pw,
+			UserLoginType:  codersdk.LoginTypePassword,
+			OrganizationID: aUser.OrganizationID,
+			DisableLogin:   false,
+		})
+		require.NoError(t, err)
+
+		inv, root := clitest.New(t, "users", "delete", "coolin")
+		clitest.SetupConfig(t, client, root)
+		pty := ptytest.New(t).Attach(inv)
+		errC := make(chan error)
+		go func() {
+			errC <- inv.Run()
+		}()
+		require.NoError(t, <-errC)
+		pty.ExpectMatch("coolin")
+	})
+
+	t.Run("UserID", func(t *testing.T) {
+		t.Parallel()
+		ctx := context.Background()
+		client := coderdtest.New(t, nil)
+		aUser := coderdtest.CreateFirstUser(t, client)
+
+		pw, err := cryptorand.String(16)
+		require.NoError(t, err)
+
+		user, err := client.CreateUser(ctx, codersdk.CreateUserRequest{
+			Email:          "colin5@coder.com",
+			Username:       "coolin",
+			Password:       pw,
+			UserLoginType:  codersdk.LoginTypePassword,
+			OrganizationID: aUser.OrganizationID,
+			DisableLogin:   false,
+		})
+		require.NoError(t, err)
+
+		inv, root := clitest.New(t, "users", "delete", user.ID.String())
+		clitest.SetupConfig(t, client, root)
+		pty := ptytest.New(t).Attach(inv)
+		errC := make(chan error)
+		go func() {
+			errC <- inv.Run()
+		}()
+		require.NoError(t, <-errC)
+		pty.ExpectMatch("coolin")
+	})
+
+	t.Run("UserID", func(t *testing.T) {
+		t.Parallel()
+		ctx := context.Background()
+		client := coderdtest.New(t, nil)
+		aUser := coderdtest.CreateFirstUser(t, client)
+
+		pw, err := cryptorand.String(16)
+		require.NoError(t, err)
+
+		user, err := client.CreateUser(ctx, codersdk.CreateUserRequest{
+			Email:          "colin5@coder.com",
+			Username:       "coolin",
+			Password:       pw,
+			UserLoginType:  codersdk.LoginTypePassword,
+			OrganizationID: aUser.OrganizationID,
+			DisableLogin:   false,
+		})
+		require.NoError(t, err)
+
+		inv, root := clitest.New(t, "users", "delete", user.ID.String())
+		clitest.SetupConfig(t, client, root)
+		pty := ptytest.New(t).Attach(inv)
+		errC := make(chan error)
+		go func() {
+			errC <- inv.Run()
+		}()
+		require.NoError(t, <-errC)
+		pty.ExpectMatch("coolin")
+	})
+
+	// TODO: reenable this test case. Fetching users without perms returns a
+	// "user "testuser@coder.com" must be a member of at least one organization"
+	// error.
+	// t.Run("NoPerms", func(t *testing.T) {
+	// 	t.Parallel()
+	// 	ctx := context.Background()
+	// 	client := coderdtest.New(t, nil)
+	// 	aUser := coderdtest.CreateFirstUser(t, client)
+
+	// 	pw, err := cryptorand.String(16)
+	// 	require.NoError(t, err)
+
+	// 	fmt.Println(aUser.OrganizationID)
+	// 	toDelete, err := client.CreateUser(ctx, codersdk.CreateUserRequest{
+	// 		Email:          "colin5@coder.com",
+	// 		Username:       "coolin",
+	// 		Password:       pw,
+	// 		UserLoginType:  codersdk.LoginTypePassword,
+	// 		OrganizationID: aUser.OrganizationID,
+	// 		DisableLogin:   false,
+	// 	})
+	// 	require.NoError(t, err)
+
+	// 	uClient, _ := coderdtest.CreateAnotherUser(t, client, aUser.OrganizationID)
+	// 	_ = uClient
+	// 	_ = toDelete
+
+	// 	inv, root := clitest.New(t, "users", "delete", "coolin")
+	// 	clitest.SetupConfig(t, uClient, root)
+	// 	require.ErrorContains(t, inv.Run(), "...")
+	// })
+
+	t.Run("DeleteSelf", func(t *testing.T) {
+		t.Parallel()
+		ctx := context.Background()
+		client := coderdtest.New(t, nil)
+		aUser := coderdtest.CreateFirstUser(t, client)
+
+		pw, err := cryptorand.String(16)
+		require.NoError(t, err)
+
+		_, err = client.CreateUser(ctx, codersdk.CreateUserRequest{
+			Email:          "colin5@coder.com",
+			Username:       "coolin",
+			Password:       pw,
+			UserLoginType:  codersdk.LoginTypePassword,
+			OrganizationID: aUser.OrganizationID,
+			DisableLogin:   false,
+		})
+		require.NoError(t, err)
+
+		coderdtest.CreateAnotherUser(t, client, aUser.OrganizationID)
+
+		inv, root := clitest.New(t, "users", "delete", "me")
+		clitest.SetupConfig(t, client, root)
+		require.ErrorContains(t, inv.Run(), "You cannot delete yourself!")
+	})
+}
diff --git a/cli/userdelete.go b/cli/userdelete.go
@@ -0,0 +1,42 @@
+package cli
+
+import (
+	"fmt"
+
+	"golang.org/x/xerrors"
+
+	"github.com/coder/coder/v2/cli/clibase"
+	"github.com/coder/coder/v2/cli/cliui"
+	"github.com/coder/coder/v2/codersdk"
+	"github.com/coder/pretty"
+)
+
+func (r *RootCmd) userDelete() *clibase.Cmd {
+	client := new(codersdk.Client)
+	cmd := &clibase.Cmd{
+		Use:   "delete <username|user_id>",
+		Short: "Delete a user by username or user_id.",
+		Middleware: clibase.Chain(
+			clibase.RequireNArgs(1),
+			r.InitClient(client),
+		),
+		Handler: func(inv *clibase.Invocation) error {
+			ctx := inv.Context()
+			user, err := client.User(ctx, inv.Args[0])
+			if err != nil {
+				return xerrors.Errorf("fetch user: %w", err)
+			}
+
+			err = client.DeleteUser(ctx, user.ID)
+			if err != nil {
+				return xerrors.Errorf("delete user: %w", err)
+			}
+
+			_, _ = fmt.Fprintln(inv.Stderr,
+				"Successfully deleted "+pretty.Sprint(cliui.DefaultStyles.Keyword, user.Username)+".",
+			)
+			return nil
+		},
+	}
+	return cmd
+}
diff --git a/cli/users.go b/cli/users.go
@@ -17,6 +17,7 @@ func (r *RootCmd) users() *clibase.Cmd {
 			r.userCreate(),
 			r.userList(),
 			r.userSingle(),
+			r.userDelete(),
 			r.createUserStatusCommand(codersdk.UserStatusActive),
 			r.createUserStatusCommand(codersdk.UserStatusSuspended),
 		},

diff --git a/cli/userstatus.go b/cli/userstatus.go
@@ -28,7 +28,6 @@ func (r *RootCmd) createUserStatusCommand(sdkStatus codersdk.UserStatus) *clibas
 	case codersdk.UserStatusSuspended:
 		verb = "suspend"
 		pastVerb = "suspended"
-		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))

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/users.go b/coderd/users.go
@@ -501,7 +501,7 @@ func (api *API) deleteUser(rw http.ResponseWriter, r *http.Request) {
 // @Security CoderSessionToken
 // @Produce json
 // @Tags Users
-// @Param user path string true "User ID, name, or me"
+// @Param user path string true "User ID, username, or me"
 // @Success 200 {object} codersdk.User
 // @Router /users/{user} [get]
 func (api *API) userByName(rw http.ResponseWriter, r *http.Request) {

diff --git a/docs/api/users.md b/docs/api/users.md
diff --git a/docs/cli/users.md b/docs/cli/users.md
diff --git a/docs/cli/users_delete.md b/docs/cli/users_delete.md
diff --git a/docs/cli/users_suspend.md b/docs/cli/users_suspend.md
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -885,6 +885,11 @@
           "title": "users create",
           "path": "cli/users_create.md"
         },
+        {
+          "title": "users delete",
+          "description": "Delete a user by username or user_id.",
+          "path": "cli/users_delete.md"
+        },
         {
           "title": "users list",
           "path": "cli/users_list.md"