feat: add groups support to the CLI

sreya · sreya · commit 728c7a4bb9d6 · 2022-10-25T21:41:19.000Z
- Adds a route to get a group by org and name.
diff --git a/cli/cliui/table.go b/cli/cliui/table.go
@@ -166,6 +166,9 @@ func DisplayTable(out any, sort string, filterColumns []string) (string, error)
 				if val != nil {
 					v = val.String()
 				}
+			case []string:
+				//nolint
+				v = strings.Join(v.([]string), ", ")
 			}
 
 			rowSlice[i] = v
diff --git a/cli/create.go b/cli/create.go
@@ -33,7 +33,7 @@ func create() *cobra.Command {
 				return err
 			}
 
-			organization, err := currentOrganization(cmd, client)
+			organization, err := CurrentOrganization(cmd, client)
 			if err != nil {
 				return err
 			}
diff --git a/cli/login.go b/cli/login.go
@@ -86,7 +86,7 @@ func login() *cobra.Command {
 				return xerrors.Errorf("Failed to check server %q for first user, is the URL correct and is coder accessible from your browser? Error - has initial user: %w", serverURL.String(), err)
 			}
 			if !hasInitialUser {
-				_, _ = fmt.Fprintf(cmd.OutOrStdout(), caret+"Your Coder deployment hasn't been set up!\n")
+				_, _ = fmt.Fprintf(cmd.OutOrStdout(), Caret+"Your Coder deployment hasn't been set up!\n")
 
 				if username == "" {
 					if !isTTY(cmd) {
@@ -244,7 +244,7 @@ func login() *cobra.Command {
 				return xerrors.Errorf("write server url: %w", err)
 			}
 
-			_, _ = fmt.Fprintf(cmd.OutOrStdout(), caret+"Welcome to Coder, %s! You're authenticated.\n", cliui.Styles.Keyword.Render(resp.Username))
+			_, _ = fmt.Fprintf(cmd.OutOrStdout(), Caret+"Welcome to Coder, %s! You're authenticated.\n", cliui.Styles.Keyword.Render(resp.Username))
 			return nil
 		},
 	}
diff --git a/cli/logout.go b/cli/logout.go
@@ -67,7 +67,7 @@ func logout() *cobra.Command {
 				errorString := strings.TrimRight(errorStringBuilder.String(), "\n")
 				return xerrors.New("Failed to log out.\n" + errorString)
 			}
-			_, _ = fmt.Fprintf(cmd.OutOrStdout(), caret+"You are no longer logged in. You can log in using 'coder login <url>'.\n")
+			_, _ = fmt.Fprintf(cmd.OutOrStdout(), Caret+"You are no longer logged in. You can log in using 'coder login <url>'.\n")
 			return nil
 		},
 	}
diff --git a/cli/parameterslist.go b/cli/parameterslist.go
@@ -27,7 +27,7 @@ func parameterList() *cobra.Command {
 				return err
 			}
 
-			organization, err := currentOrganization(cmd, client)
+			organization, err := CurrentOrganization(cmd, client)
 			if err != nil {
 				return xerrors.Errorf("get current organization: %w", err)
 			}
diff --git a/cli/root.go b/cli/root.go
@@ -29,7 +29,7 @@ import (
 )
 
 var (
-	caret = cliui.Styles.Prompt.String()
+	Caret = cliui.Styles.Prompt.String()
 
 	// Applied as annotations to workspace commands
 	// so they display in a separated "help" section.
@@ -114,7 +114,7 @@ func Root(subcommands []*cobra.Command) *cobra.Command {
 		Use:           "coder",
 		SilenceErrors: true,
 		SilenceUsage:  true,
-		Long: fmt.Sprintf(fmtLong, buildinfo.Version()),
+		Long:          fmt.Sprintf(fmtLong, buildinfo.Version()),
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {
 			if cliflag.IsSetBool(cmd, varNoVersionCheck) &&
 				cliflag.IsSetBool(cmd, varNoFeatureWarning) {
@@ -328,8 +328,8 @@ func createAgentClient(cmd *cobra.Command) (*codersdk.Client, error) {
 	return client, nil
 }
 
-// currentOrganization returns the currently active organization for the authenticated user.
-func currentOrganization(cmd *cobra.Command, client *codersdk.Client) (codersdk.Organization, error) {
+// CurrentOrganization returns the currently active organization for the authenticated user.
+func CurrentOrganization(cmd *cobra.Command, client *codersdk.Client) (codersdk.Organization, error) {
 	orgs, err := client.OrganizationsByUser(cmd.Context(), codersdk.Me)
 	if err != nil {
 		return codersdk.Organization{}, nil
diff --git a/cli/templatecreate.go b/cli/templatecreate.go
@@ -40,7 +40,7 @@ func templateCreate() *cobra.Command {
 				return err
 			}
 
-			organization, err := currentOrganization(cmd, client)
+			organization, err := CurrentOrganization(cmd, client)
 			if err != nil {
 				return err
 			}
diff --git a/cli/templatedelete.go b/cli/templatedelete.go
@@ -27,7 +27,7 @@ func templateDelete() *cobra.Command {
 			if err != nil {
 				return err
 			}
-			organization, err := currentOrganization(cmd, client)
+			organization, err := CurrentOrganization(cmd, client)
 			if err != nil {
 				return err
 			}
diff --git a/cli/templateedit.go b/cli/templateedit.go
@@ -29,7 +29,7 @@ func templateEdit() *cobra.Command {
 			if err != nil {
 				return xerrors.Errorf("create client: %w", err)
 			}
-			organization, err := currentOrganization(cmd, client)
+			organization, err := CurrentOrganization(cmd, client)
 			if err != nil {
 				return xerrors.Errorf("get current organization: %w", err)
 			}
diff --git a/cli/templatelist.go b/cli/templatelist.go
@@ -20,7 +20,7 @@ func templateList() *cobra.Command {
 			if err != nil {
 				return err
 			}
-			organization, err := currentOrganization(cmd, client)
+			organization, err := CurrentOrganization(cmd, client)
 			if err != nil {
 				return err
 			}
@@ -30,7 +30,7 @@ func templateList() *cobra.Command {
 			}
 
 			if len(templates) == 0 {
-				_, _ = fmt.Fprintf(cmd.ErrOrStderr(), "%s No templates found in %s! Create one:\n\n", caret, color.HiWhiteString(organization.Name))
+				_, _ = fmt.Fprintf(cmd.ErrOrStderr(), "%s No templates found in %s! Create one:\n\n", Caret, color.HiWhiteString(organization.Name))
 				_, _ = fmt.Fprintln(cmd.ErrOrStderr(), color.HiMagentaString("  $ coder templates create <directory>\n"))
 				return nil
 			}
diff --git a/cli/templatepull.go b/cli/templatepull.go
@@ -35,7 +35,7 @@ func templatePull() *cobra.Command {
 			}
 
 			// TODO(JonA): Do we need to add a flag for organization?
-			organization, err := currentOrganization(cmd, client)
+			organization, err := CurrentOrganization(cmd, client)
 			if err != nil {
 				return xerrors.Errorf("current organization: %w", err)
 			}
diff --git a/cli/templatepush.go b/cli/templatepush.go
@@ -34,7 +34,7 @@ func templatePush() *cobra.Command {
 			if err != nil {
 				return err
 			}
-			organization, err := currentOrganization(cmd, client)
+			organization, err := CurrentOrganization(cmd, client)
 			if err != nil {
 				return err
 			}
diff --git a/cli/templateversions.go b/cli/templateversions.go
@@ -45,7 +45,7 @@ func templateVersionsList() *cobra.Command {
 			if err != nil {
 				return xerrors.Errorf("create client: %w", err)
 			}
-			organization, err := currentOrganization(cmd, client)
+			organization, err := CurrentOrganization(cmd, client)
 			if err != nil {
 				return xerrors.Errorf("get current organization: %w", err)
 			}
diff --git a/cli/usercreate.go b/cli/usercreate.go
@@ -25,7 +25,7 @@ func userCreate() *cobra.Command {
 			if err != nil {
 				return err
 			}
-			organization, err := currentOrganization(cmd, client)
+			organization, err := CurrentOrganization(cmd, client)
 			if err != nil {
 				return err
 			}
diff --git a/coderd/httpmw/groupparam.go b/coderd/httpmw/groupparam.go
@@ -7,6 +7,7 @@ import (
 	"net/http"
 
 	"github.com/go-chi/chi/v5"
+	"golang.org/x/xerrors"
 
 	"github.com/coder/coder/coderd/database"
 	"github.com/coder/coder/coderd/httpapi"
@@ -24,6 +25,41 @@ func GroupParam(r *http.Request) database.Group {
 	return group
 }
 
+func ExtractGroupByNameParam(db database.Store) func(http.Handler) http.Handler {
+	return func(next http.Handler) http.Handler {
+		return http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
+			var (
+				ctx = r.Context()
+				org = OrganizationParam(r)
+			)
+
+			name := chi.URLParam(r, "groupName")
+			if name == "" {
+				httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
+					Message: "Missing group name in URL",
+				})
+				return
+			}
+
+			group, err := db.GetGroupByOrgAndName(ctx, database.GetGroupByOrgAndNameParams{
+				OrganizationID: org.ID,
+				Name:           name,
+			})
+			if xerrors.Is(err, sql.ErrNoRows) {
+				httpapi.ResourceNotFound(rw)
+				return
+			}
+			if err != nil {
+				httpapi.InternalServerError(rw, err)
+				return
+			}
+
+			ctx = context.WithValue(ctx, groupParamContextKey{}, group)
+			next.ServeHTTP(rw, r.WithContext(ctx))
+		})
+	}
+}
+
 // ExtraGroupParam grabs a group from the "group" URL parameter.
 func ExtractGroupParam(db database.Store) func(http.Handler) http.Handler {
 	return func(next http.Handler) http.Handler {
diff --git a/codersdk/groups.go b/codersdk/groups.go
@@ -58,6 +58,23 @@ func (c *Client) GroupsByOrganization(ctx context.Context, orgID uuid.UUID) ([]G
 	return groups, json.NewDecoder(res.Body).Decode(&groups)
 }
 
+func (c *Client) GroupByOrgAndName(ctx context.Context, orgID uuid.UUID, name string) (Group, error) {
+	res, err := c.Request(ctx, http.MethodGet,
+		fmt.Sprintf("/api/v2/organizations/%s/groups/%s", orgID.String(), name),
+		nil,
+	)
+	if err != nil {
+		return Group{}, xerrors.Errorf("make request: %w", err)
+	}
+	defer res.Body.Close()
+
+	if res.StatusCode != http.StatusOK {
+		return Group{}, readBodyAsError(res)
+	}
+	var resp Group
+	return resp, json.NewDecoder(res.Body).Decode(&resp)
+}
+
 func (c *Client) Group(ctx context.Context, group uuid.UUID) (Group, error) {
 	res, err := c.Request(ctx, http.MethodGet,
 		fmt.Sprintf("/api/v2/groups/%s", group.String()),
diff --git a/enterprise/cli/groupcreate.go b/enterprise/cli/groupcreate.go
@@ -0,0 +1,53 @@
+package cli
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"golang.org/x/xerrors"
+
+	agpl "github.com/coder/coder/cli"
+	"github.com/coder/coder/cli/cliflag"
+	"github.com/coder/coder/codersdk"
+)
+
+func groupCreate() *cobra.Command {
+	var (
+		avatarURL string
+	)
+	cmd := &cobra.Command{
+		Use:   "create <name>",
+		Short: "Create a user group",
+		Args:  cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			var (
+				ctx = cmd.Context()
+			)
+
+			client, err := agpl.CreateClient(cmd)
+			if err != nil {
+				return xerrors.Errorf("create client: %w", err)
+			}
+
+			org, err := agpl.CurrentOrganization(cmd, client)
+			if err != nil {
+				return xerrors.Errorf("current organization: %w", err)
+			}
+
+			group, err := client.CreateGroup(ctx, org.ID, codersdk.CreateGroupRequest{
+				Name:      args[0],
+				AvatarURL: avatarURL,
+			})
+			if err != nil {
+				return xerrors.Errorf("create group: %w", err)
+			}
+
+			_, _ = fmt.Fprintf(cmd.OutOrStdout(), "Successfully created group %s", group.Name)
+			return nil
+		},
+	}
+
+	cliflag.StringVarP(cmd.Flags(), &avatarURL, "avatar-url", "u", "CODER_AVATAR_URL", "", "set an avatar for a group")
+
+	return cmd
+}
diff --git a/enterprise/cli/groupcreate_test.go b/enterprise/cli/groupcreate_test.go
@@ -0,0 +1,36 @@
+package cli_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/coder/coder/cli/clitest"
+	"github.com/coder/coder/coderd/coderdtest"
+)
+
+func TestCreateGroup(t *testing.T) {
+	t.Parallel()
+
+	t.Run("OK", func(t *testing.T) {
+		t.Parallel()
+
+		client := coderdtest.New(t, nil)
+		coderdtest.CreateFirstUser(t, client)
+
+		var (
+			groupName = "test"
+			avatarURL = "https://example.com"
+		)
+
+		cmd, root := clitest.New(t, "groups",
+			"create", groupName,
+			"--avatar-url", avatarURL,
+		)
+
+		clitest.SetupConfig(t, client, root)
+
+		err := cmd.Execute()
+		require.NoError(t, err)
+	})
+}
diff --git a/enterprise/cli/groupdelete.go b/enterprise/cli/groupdelete.go
@@ -0,0 +1,50 @@
+package cli
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"golang.org/x/xerrors"
+
+	agpl "github.com/coder/coder/cli"
+	"github.com/coder/coder/cli/cliui"
+)
+
+func groupDelete() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "delete <name>",
+		Short: "Delete a user group",
+		Args:  cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			var (
+				ctx       = cmd.Context()
+				groupName = args[0]
+			)
+
+			client, err := agpl.CreateClient(cmd)
+			if err != nil {
+				return xerrors.Errorf("create client: %w", err)
+			}
+
+			org, err := agpl.CurrentOrganization(cmd, client)
+			if err != nil {
+				return xerrors.Errorf("current organization: %w", err)
+			}
+
+			group, err := client.GroupByOrgAndName(ctx, org.ID, groupName)
+			if err != nil {
+				return xerrors.Errorf("group by org and name: %w", err)
+			}
+
+			err = client.DeleteGroup(ctx, group.ID)
+			if err != nil {
+				return xerrors.Errorf("patch group: %w", err)
+			}
+
+			_, _ = fmt.Fprintf(cmd.OutOrStdout(), "Successfully deleted group %s!\n", cliui.Styles.Keyword.Render(group.Name))
+			return nil
+		},
+	}
+
+	return cmd
+}
diff --git a/enterprise/cli/groupdelete_test.go b/enterprise/cli/groupdelete_test.go
diff --git a/enterprise/cli/groupedit.go b/enterprise/cli/groupedit.go
diff --git a/enterprise/cli/groupedit_test.go b/enterprise/cli/groupedit_test.go
diff --git a/enterprise/cli/grouplist.go b/enterprise/cli/grouplist.go
diff --git a/enterprise/cli/grouplist_test.go b/enterprise/cli/grouplist_test.go
diff --git a/enterprise/cli/groups.go b/enterprise/cli/groups.go
diff --git a/enterprise/cli/root.go b/enterprise/cli/root.go
diff --git a/enterprise/coderd/coderd.go b/enterprise/coderd/coderd.go
diff --git a/enterprise/coderd/groups_test.go b/enterprise/coderd/groups_test.go

Original file line number	Diff line number	Diff line change
`@@ -166,6 +166,9 @@ func DisplayTable(out any, sort string, filterColumns []string) (string, error)`
`166`	`166`	`if val != nil {`
`167`	`167`	`v = val.String()`
`168`	`168`	`}`
	`169`	`+ case []string:`
	`170`	`+ //nolint`
	`171`	`+ v = strings.Join(v.([]string), ", ")`
`169`	`172`	`}`
`170`	`173`
`171`	`174`	`rowSlice[i] = v`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ func create() *cobra.Command {`
`33`	`33`	`return err`
`34`	`34`	`}`
`35`	`35`
`36`		`- organization, err := currentOrganization(cmd, client)`
	`36`	`+ organization, err := CurrentOrganization(cmd, client)`
`37`	`37`	`if err != nil {`
`38`	`38`	`return err`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ func login() *cobra.Command {`
`86`	`86`	`return xerrors.Errorf("Failed to check server %q for first user, is the URL correct and is coder accessible from your browser? Error - has initial user: %w", serverURL.String(), err)`
`87`	`87`	`}`
`88`	`88`	`if !hasInitialUser {`
`89`		`- _, _ = fmt.Fprintf(cmd.OutOrStdout(), caret+"Your Coder deployment hasn't been set up!\n")`
	`89`	`+ _, _ = fmt.Fprintf(cmd.OutOrStdout(), Caret+"Your Coder deployment hasn't been set up!\n")`
`90`	`90`
`91`	`91`	`if username == "" {`
`92`	`92`	`if !isTTY(cmd) {`
`@@ -244,7 +244,7 @@ func login() *cobra.Command {`
`244`	`244`	`return xerrors.Errorf("write server url: %w", err)`
`245`	`245`	`}`
`246`	`246`
`247`		`- _, _ = fmt.Fprintf(cmd.OutOrStdout(), caret+"Welcome to Coder, %s! You're authenticated.\n", cliui.Styles.Keyword.Render(resp.Username))`
	`247`	`+ _, _ = fmt.Fprintf(cmd.OutOrStdout(), Caret+"Welcome to Coder, %s! You're authenticated.\n", cliui.Styles.Keyword.Render(resp.Username))`
`248`	`248`	`return nil`
`249`	`249`	`},`
`250`	`250`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ func logout() *cobra.Command {`
`67`	`67`	`errorString := strings.TrimRight(errorStringBuilder.String(), "\n")`
`68`	`68`	`return xerrors.New("Failed to log out.\n" + errorString)`
`69`	`69`	`}`
`70`		`- _, _ = fmt.Fprintf(cmd.OutOrStdout(), caret+"You are no longer logged in. You can log in using 'coder login <url>'.\n")`
	`70`	`+ _, _ = fmt.Fprintf(cmd.OutOrStdout(), Caret+"You are no longer logged in. You can log in using 'coder login <url>'.\n")`
`71`	`71`	`return nil`
`72`	`72`	`},`
`73`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ func parameterList() *cobra.Command {`
`27`	`27`	`return err`
`28`	`28`	`}`
`29`	`29`
`30`		`- organization, err := currentOrganization(cmd, client)`
	`30`	`+ organization, err := CurrentOrganization(cmd, client)`
`31`	`31`	`if err != nil {`
`32`	`32`	`return xerrors.Errorf("get current organization: %w", err)`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ func templateCreate() *cobra.Command {`
`40`	`40`	`return err`
`41`	`41`	`}`
`42`	`42`
`43`		`- organization, err := currentOrganization(cmd, client)`
	`43`	`+ organization, err := CurrentOrganization(cmd, client)`
`44`	`44`	`if err != nil {`
`45`	`45`	`return err`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ func templateDelete() *cobra.Command {`
`27`	`27`	`if err != nil {`
`28`	`28`	`return err`
`29`	`29`	`}`
`30`		`- organization, err := currentOrganization(cmd, client)`
	`30`	`+ organization, err := CurrentOrganization(cmd, client)`
`31`	`31`	`if err != nil {`
`32`	`32`	`return err`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ func templateEdit() *cobra.Command {`
`29`	`29`	`if err != nil {`
`30`	`30`	`return xerrors.Errorf("create client: %w", err)`
`31`	`31`	`}`
`32`		`- organization, err := currentOrganization(cmd, client)`
	`32`	`+ organization, err := CurrentOrganization(cmd, client)`
`33`	`33`	`if err != nil {`
`34`	`34`	`return xerrors.Errorf("get current organization: %w", err)`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ func templateList() *cobra.Command {`
`20`	`20`	`if err != nil {`
`21`	`21`	`return err`
`22`	`22`	`}`
`23`		`- organization, err := currentOrganization(cmd, client)`
	`23`	`+ organization, err := CurrentOrganization(cmd, client)`
`24`	`24`	`if err != nil {`
`25`	`25`	`return err`
`26`	`26`	`}`
`@@ -30,7 +30,7 @@ func templateList() *cobra.Command {`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`if len(templates) == 0 {`
`33`		`- _, _ = fmt.Fprintf(cmd.ErrOrStderr(), "%s No templates found in %s! Create one:\n\n", caret, color.HiWhiteString(organization.Name))`
	`33`	`+ _, _ = fmt.Fprintf(cmd.ErrOrStderr(), "%s No templates found in %s! Create one:\n\n", Caret, color.HiWhiteString(organization.Name))`
`34`	`34`	`_, _ = fmt.Fprintln(cmd.ErrOrStderr(), color.HiMagentaString(" $ coder templates create <directory>\n"))`
`35`	`35`	`return nil`
`36`	`36`	`}`