PR cleanup, better short msg

Emyrk · Emyrk · commit 53adce9c75da · 2022-05-13T13:03:58.000-05:00
diff --git a/cli/userstatus.go b/cli/userstatus.go
@@ -16,23 +16,26 @@ func userStatus() *cobra.Command {
 		Short: "Update the status of a user",
 	}
 	cmd.AddCommand(
-		setUserStatus(codersdk.UserStatusActive),
-		setUserStatus(codersdk.UserStatusSuspended),
+		createUserStatusCommand(codersdk.UserStatusActive),
+		createUserStatusCommand(codersdk.UserStatusSuspended),
 	)
 	return cmd
 }
 
-// setUserStatus sets a user status.
-func setUserStatus(sdkStatus codersdk.UserStatus) *cobra.Command {
+// 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 = "active"
-		aliases = []string{"activate"}
+		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))
 	}
@@ -42,7 +45,7 @@ func setUserStatus(sdkStatus codersdk.UserStatus) *cobra.Command {
 	)
 	cmd := &cobra.Command{
 		Use:     fmt.Sprintf("%s <username|user_id>", verb),
-		Short:   fmt.Sprintf("Update a user's status to %q", sdkStatus),
+		Short:   short,
 		Args:    cobra.ExactArgs(1),
 		Aliases: aliases,
 		Example: fmt.Sprintf("coder users status %s example_user", verb),
@@ -81,7 +84,7 @@ func setUserStatus(sdkStatus codersdk.UserStatus) *cobra.Command {
 				return err
 			}
 
-			_, err = client.SetUserStatus(cmd.Context(), user.ID, sdkStatus)
+			_, err = client.UpdateUserStatus(cmd.Context(), user.ID, sdkStatus)
 			if err != nil {
 				return xerrors.Errorf("%s user: %w", verb, err)
 			}
diff --git a/coderd/users_test.go b/coderd/users_test.go
@@ -452,7 +452,7 @@ func TestPutUserSuspend(t *testing.T) {
 			Password:       "password",
 			OrganizationID: me.OrganizationID,
 		})
-		user, err := client.SetUserStatus(context.Background(), user.ID, codersdk.UserStatusSuspended)
+		user, err := client.UpdateUserStatus(context.Background(), user.ID, codersdk.UserStatusSuspended)
 		require.NoError(t, err)
 		require.Equal(t, user.Status, codersdk.UserStatusSuspended)
 	})
@@ -462,7 +462,7 @@ func TestPutUserSuspend(t *testing.T) {
 		client := coderdtest.New(t, nil)
 		coderdtest.CreateFirstUser(t, client)
 		client.User(context.Background(), codersdk.Me)
-		_, err := client.SetUserStatus(context.Background(), codersdk.Me, codersdk.UserStatusSuspended)
+		_, err := client.UpdateUserStatus(context.Background(), codersdk.Me, codersdk.UserStatusSuspended)
 
 		require.ErrorContains(t, err, "suspend yourself", "cannot suspend yourself")
 	})
@@ -555,7 +555,7 @@ func TestGetUsers(t *testing.T) {
 		require.NoError(t, err)
 		active = append(active, bruno)
 
-		_, err = client.SetUserStatus(context.Background(), alice.ID, codersdk.UserStatusSuspended)
+		_, err = client.UpdateUserStatus(context.Background(), alice.ID, codersdk.UserStatusSuspended)
 		require.NoError(t, err)
 
 		users, err := client.Users(context.Background(), codersdk.UsersRequest{
diff --git a/codersdk/users.go b/codersdk/users.go
@@ -212,8 +212,8 @@ func (c *Client) UpdateUserProfile(ctx context.Context, userID uuid.UUID, req Up
 	return user, json.NewDecoder(res.Body).Decode(&user)
 }
 
-// SetUserStatus sets the user status to the given status
-func (c *Client) SetUserStatus(ctx context.Context, userID uuid.UUID, status UserStatus) (User, error) {
+// UpdateUserStatus sets the user status to the given status
+func (c *Client) UpdateUserStatus(ctx context.Context, userID uuid.UUID, status UserStatus) (User, error) {
 	path := fmt.Sprintf("/api/v2/users/%s/status/", uuidOrMe(userID))
 	switch status {
 	case UserStatusActive:
