feat: add provisioners and jobs endspoints and CLI commands

coder · mafredri · Dec 19, 2024 · Dec 19, 2024 · Dec 19, 2024 · Dec 19, 2024
commit 650cbaf3ab2775c568dcd973209d4d94ff60fa22
diff --git a/cli/provisionerjobs.go b/cli/provisionerjobs.go
@@ -0,0 +1,125 @@
+package cli
+
+import (
+	"fmt"
+
+	"golang.org/x/xerrors"
+
+	"github.com/coder/coder/v2/cli/cliui"
+	"github.com/coder/coder/v2/codersdk"
+	"github.com/coder/serpent"
+)
+
+func (r *RootCmd) provisionerJobs() *serpent.Command {
+	cmd := &serpent.Command{
+		Use:   "jobs",
+		Short: "View and manage provisioner jobs",
+		Handler: func(inv *serpent.Invocation) error {
+			return inv.Command.HelpHandler(inv)
+		},
+		Aliases: []string{"job"},
+		Children: []*serpent.Command{
+			r.provisionerJobsList(),
+		},
+	}
+	return cmd
+}
+
+func (r *RootCmd) provisionerJobsList() *serpent.Command {
+	type provisionerJobRow struct {
+		codersdk.ProvisionerJob `table:"provisioner_job,recursive_inline"`
+		OrganizaitonName        string `json:"organization_name" table:"organization"`
+		Queue                   string `json:"-" table:"queue"`
+	}
+
+	var (
+		client     = new(codersdk.Client)
+		orgContext = NewOrganizationContext()
+		formatter  = cliui.NewOutputFormatter(
+			cliui.TableFormat([]provisionerJobRow{}, []string{"created at", "id", "organization", "status", "type", "queue", "tags"}),
+			cliui.JSONFormat(),
+		)
+		status []string
+		limit  int64 = 50
+	)
+
+	cmd := &serpent.Command{
+		Use:     "list",
+		Short:   "List provisioner jobs",
+		Aliases: []string{"ls"},
+		Middleware: serpent.Chain(
+			serpent.RequireNArgs(0),
+			r.InitClient(client),
+		),
+		Handler: func(inv *serpent.Invocation) error {
+			ctx := inv.Context()
+			org, err := orgContext.Selected(inv, client)
+			if err != nil {
+				return xerrors.Errorf("current organization: %w", err)
+			}
+
+			jobs, err := client.OrganizationProvisionerJobs(ctx, org.ID, &codersdk.OrganizationProvisionerJobsOptions{
+				Status: convertSlice([]codersdk.ProvisionerJobStatus{}, status),
+				Limit:  int(limit),
+			})
+			if err != nil {
+				return xerrors.Errorf("list provisioner jobs: %w", err)
+			}
+
+			if len(jobs) == 0 {
+				_, _ = fmt.Fprintln(inv.Stdout, "No provisioner jobs found")
+				return nil
+			}
+
+			var rows []provisionerJobRow
+			for _, job := range jobs {
+				row := provisionerJobRow{
+					ProvisionerJob:   job,
+					OrganizaitonName: org.HumanName(),
+				}
+				if job.Status == codersdk.ProvisionerJobPending {
+					row.Queue = fmt.Sprintf("%d/%d", job.QueuePosition, job.QueueSize)
+				}
+				rows = append(rows, row)
+			}
+
+			out, err := formatter.Format(ctx, rows)
+			if err != nil {
+				return xerrors.Errorf("display provisioner daemons: %w", err)
+			}
+
+			_, _ = fmt.Fprintln(inv.Stdout, out)
+
+			return nil
+		},
+	}
+
+	cmd.Options = append(cmd.Options, []serpent.Option{
+		{
+			Flag:          "status",
+			FlagShorthand: "s",
+			Env:           "CODER_PROVISIONER_JOB_LIST_STATUS",
+			Description:   "Filter by job status.",
+			Value:         serpent.EnumArrayOf(&status, convertSlice([]string{}, codersdk.ProvisionerJobStatusEnums())...),
+		},
+		{
+			Flag:          "limit",
+			FlagShorthand: "l",
+			Env:           "CODER_PROVISIONER_JOB_LIST_LIMIT",
+			Description:   "Limit the number of jobs returned.",
+			Value:         serpent.Int64Of(&limit),
+		},
+	}...)
+
+	orgContext.AttachOptions(cmd)
+	formatter.AttachOptions(&cmd.Options)
+
+	return cmd
+}
+
+func convertSlice[D, S ~string](dstType []D, src []S) []D {
+	for _, item := range src {
+		dstType = append(dstType, D(item))
+	}
+	return dstType
+}
 // ToStrings works for any type where the base type is a string. 
 func ToStrings[T ~string](a []T) []string { 
 	tmp := make([]string, 0, len(a)) 
 	for _, v := range a { 
 		tmp = append(tmp, string(v)) 
 	} 
 	return tmp 
 } 
 // ToStrings works for any type where the base type is a string. 
 func ToStrings[T ~string](a []T) []string { 
 	tmp := make([]string, 0, len(a)) 
 	for _, v := range a { 
 		tmp = append(tmp, string(v)) 
 	} 
 	return tmp 
 } 
diff --git a/cli/provisioners.go b/cli/provisioners.go
@@ -0,0 +1,93 @@
+package cli
+
+import (
+	"fmt"
+
+	"golang.org/x/xerrors"
+
+	"github.com/coder/coder/v2/cli/cliui"
+	"github.com/coder/coder/v2/codersdk"
+	"github.com/coder/serpent"
+)
+
+func (r *RootCmd) Provisioners() *serpent.Command {
+	cmd := &serpent.Command{
+		Use:   "provisioners",
+		Short: "View and manage provisioner daemons and jobs",
+		Handler: func(inv *serpent.Invocation) error {
+			return inv.Command.HelpHandler(inv)
+		},
+		Aliases: []string{"provisioner"},
+		Children: []*serpent.Command{
+			r.provisionerList(),
+			r.provisionerJobs(),
+		},
+	}
+
+	return cmd
+}
+
+func (r *RootCmd) provisionerList() *serpent.Command {
+	type provisionerDaemonRow struct {
+		codersdk.ProvisionerDaemonWithStatus `table:"provisioner_daemon,recursive_inline"`
+		OrganizationName                     string `json:"organization_name" table:"organization"`
+	}
+	var (
+		client     = new(codersdk.Client)
+		orgContext = NewOrganizationContext()
+		formatter  = cliui.NewOutputFormatter(
+			cliui.TableFormat([]provisionerDaemonRow{}, []string{"name", "organization", "status" /*"type",*/, "created at", "last seen at", "version", "tags"}),
+			cliui.JSONFormat(),
+		)
+	)
+
+	cmd := &serpent.Command{
+		Use:     "list",
+		Short:   "List provisioner daemons in an organization",
+		Aliases: []string{"ls"},
+		Middleware: serpent.Chain(
+			serpent.RequireNArgs(0),
+			r.InitClient(client),
+		),
+		Handler: func(inv *serpent.Invocation) error {
+			ctx := inv.Context()
+
+			org, err := orgContext.Selected(inv, client)
+			if err != nil {
+				return xerrors.Errorf("current organization: %w", err)
+			}
+
+			daemons, err := client.OrganizationProvisionerDaemons(ctx, org.ID, nil)
+			if err != nil {
+				return xerrors.Errorf("list provisioner daemons: %w", err)
+			}
+
+			if len(daemons) == 0 {
+				_, _ = fmt.Fprintln(inv.Stdout, "No provisioner daemons found")
+				return nil
+			}
+
+			var rows []provisionerDaemonRow
+			for _, daemon := range daemons {
+				rows = append(rows, provisionerDaemonRow{
+					ProvisionerDaemonWithStatus: daemon,
+					OrganizationName:            org.HumanName(),
+				})
+			}
+
+			out, err := formatter.Format(ctx, rows)
+			if err != nil {
+				return xerrors.Errorf("display provisioner daemons: %w", err)
+			}
+
+			_, _ = fmt.Fprintln(inv.Stdout, out)
+
+			return nil
+		},
+	}
+
+	orgContext.AttachOptions(cmd)
+	formatter.AttachOptions(&cmd.Options)
+
+	return cmd
+}
diff --git a/cli/root.go b/cli/root.go
@@ -132,7 +132,11 @@ func (r *RootCmd) CoreSubcommands() []*serpent.Command {
 }
 
 func (r *RootCmd) AGPL() []*serpent.Command {
-	all := append(r.CoreSubcommands(), r.Server( /* Do not import coderd here. */ nil))
+	all := append(
+		r.CoreSubcommands(),
+		r.Server( /* Do not import coderd here. */ nil),
+		r.Provisioners(),
+	)
 	return all
 }