add stat subcommands

coder · mtojek · Jun 20, 2023 · May 29, 2023 · Jun 7, 2023 · Jun 7, 2023
commit 7eb526d9d74a799d1b8f8cbd30d3555b7928041b
diff --git a/cli/stat.go b/cli/stat.go
@@ -5,30 +5,40 @@ import (
 	"os"
 
 	"github.com/spf13/afero"
+	"golang.org/x/xerrors"
 
 	"github.com/coder/coder/cli/clibase"
 	"github.com/coder/coder/cli/clistat"
 	"github.com/coder/coder/cli/cliui"
 )
 
-func (*RootCmd) stat() *clibase.Cmd {
+func (r *RootCmd) stat() *clibase.Cmd {
 	fs := afero.NewReadOnlyFs(afero.NewOsFs())
-	defaultCols := []string{"host_cpu", "host_memory", "home_disk", "container_cpu", "container_memory"}
+	defaultCols := []string{
+		"host_cpu",
+		"host_memory",
+		"home_disk",
+		"container_cpu",
+		"container_memory",
+	}
 	formatter := cliui.NewOutputFormatter(
 		cliui.TableFormat([]statsRow{}, defaultCols),
 		cliui.JSONFormat(),
 	)
+	st, err := clistat.New(clistat.WithFS(fs))
+	if err != nil {
+		panic(xerrors.Errorf("initialize workspace stats collector: %w", err))
+	}
 
 	cmd := &clibase.Cmd{
-		Use:     "stat",
-		Short:   "Show workspace resource usage.",
-		Options: clibase.OptionSet{},
+		Use:   "stat",
+		Short: "Show resource usage for the current workspace.",
+		Children: []*clibase.Cmd{
+			r.statCPU(st, fs),
+			r.statMem(st, fs),
+			r.statDisk(st, fs),
+		},
 		Handler: func(inv *clibase.Invocation) error {
-			st, err := clistat.New(clistat.WithFS(fs))
-			if err != nil {
-				return err
-			}
-
 			var sr statsRow
 
 			// Get CPU measurements first.
@@ -108,6 +118,114 @@ func (*RootCmd) stat() *clibase.Cmd {
 	return cmd
 }
 
+func (*RootCmd) statCPU(s *clistat.Statter, fs afero.Fs) *clibase.Cmd {
+	var hostArg bool
+	formatter := cliui.NewOutputFormatter(cliui.TextFormat(), cliui.JSONFormat())
+
+	cmd := &clibase.Cmd{
+		Use:   "cpu",
+		Short: "Show CPU usage, in cores.",
+		Options: clibase.OptionSet{
+			{
+				Flag:        "host",
+				Value:       clibase.BoolOf(&hostArg),
+				Description: "Force host CPU measurement.",
+			},
+		},
+		Handler: func(inv *clibase.Invocation) error {
+			var cs *clistat.Result
+			var err error
+			if ok, _ := clistat.IsContainerized(fs); ok && !hostArg {
+				cs, err = s.ContainerCPU()
+			} else {
+				cs, err = s.HostCPU()
+			}
+			if err != nil {
+				return err
+			}
+			out, err := formatter.Format(inv.Context(), cs)
+			if err != nil {
+				return err
+			}
+			_, err = fmt.Fprintln(inv.Stdout, out)
+			return err
+		},
+	}
+	formatter.AttachOptions(&cmd.Options)
+
+	return cmd
+}
+
+func (*RootCmd) statMem(s *clistat.Statter, fs afero.Fs) *clibase.Cmd {
+	var hostArg bool
+	formatter := cliui.NewOutputFormatter(cliui.TextFormat(), cliui.JSONFormat())
+	cmd := &clibase.Cmd{
+		Use:   "mem",
+		Short: "Show memory usage, in gigabytes.",
+		Options: clibase.OptionSet{
+			{
+				Flag:        "host",
+				Value:       clibase.BoolOf(&hostArg),
+				Description: "Force host memory measurement.",
+			},
+		},
+		Handler: func(inv *clibase.Invocation) error {
+			var ms *clistat.Result
+			var err error
+			if ok, _ := clistat.IsContainerized(fs); ok && !hostArg {
+				ms, err = s.ContainerMemory()
+			} else {
+				ms, err = s.HostMemory()
+			}
+			if err != nil {
+				return err
+			}
+			out, err := formatter.Format(inv.Context(), ms)
+			if err != nil {
+				return err
+			}
+			_, err = fmt.Fprintln(inv.Stdout, out)
+			return err
+		},
+	}
+
+	formatter.AttachOptions(&cmd.Options)
+	return cmd
+}
+
+func (*RootCmd) statDisk(s *clistat.Statter, fs afero.Fs) *clibase.Cmd {
+	var pathArg string
+	formatter := cliui.NewOutputFormatter(cliui.TextFormat(), cliui.JSONFormat())
+	cmd := &clibase.Cmd{
+		Use:   "disk",
+		Short: "Show disk usage, in gigabytes.",
+		Options: clibase.OptionSet{
+			{
+				Flag:        "path",
+				Value:       clibase.StringOf(&pathArg),
+				Description: "Path for which to check disk usage.",
+				Default:     "/",
+			},
+		},
+		Handler: func(inv *clibase.Invocation) error {
+			ds, err := s.Disk(pathArg)
+			if err != nil {
+				return err
+			}
+
+			out, err := formatter.Format(inv.Context(), ds)
+			if err != nil {
+				return err
+			}
+			_, err = fmt.Fprintln(inv.Stdout, out)
+			return err
+		},
+	}
+
+	formatter.AttachOptions(&cmd.Options)
+	return cmd
+}
+
 type statsRow struct {
 	HostCPU         *clistat.Result `json:"host_cpu" table:"host_cpu,default_sort"`
 	HostMemory      *clistat.Result `json:"host_memory" table:"host_memory"`

diff --git a/cli/stat_test.go b/cli/stat_test.go
@@ -23,7 +23,7 @@ func TestStatCmd(t *testing.T) {
 		t.Parallel()
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
 		t.Cleanup(cancel)
-		inv, _ := clitest.New(t, "stat", "--output=json")
+		inv, _ := clitest.New(t, "stat", "all", "--output=json")
 		buf := new(bytes.Buffer)
 		inv.Stdout = buf
 		err := inv.WithContext(ctx).Run()
@@ -38,7 +38,7 @@ func TestStatCmd(t *testing.T) {
 		t.Parallel()
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
 		t.Cleanup(cancel)
-		inv, _ := clitest.New(t, "stat", "--output=table")
+		inv, _ := clitest.New(t, "stat", "all", "--output=table")
 		buf := new(bytes.Buffer)
 		inv.Stdout = buf
 		err := inv.WithContext(ctx).Run()
@@ -53,7 +53,7 @@ func TestStatCmd(t *testing.T) {
 		t.Parallel()
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
 		t.Cleanup(cancel)
-		inv, _ := clitest.New(t, "stat")
+		inv, _ := clitest.New(t, "stat", "all")
 		buf := new(bytes.Buffer)
 		inv.Stdout = buf
 		err := inv.WithContext(ctx).Run()
@@ -65,3 +65,96 @@ func TestStatCmd(t *testing.T) {
 		require.Contains(t, s, "HOME DISK")
 	})
 }
+
+func TestStatCPUCmd(t *testing.T) {
+	t.Parallel()
+
+	t.Run("Text", func(t *testing.T) {
+		t.Parallel()
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
+		t.Cleanup(cancel)
+		inv, _ := clitest.New(t, "stat", "cpu", "--output=text")
+		buf := new(bytes.Buffer)
+		inv.Stdout = buf
+		err := inv.WithContext(ctx).Run()
+		require.NoError(t, err)
+		s := buf.String()
+		require.NotEmpty(t, s)
+	})
+
+	t.Run("JSON", func(t *testing.T) {
+		t.Parallel()
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
+		t.Cleanup(cancel)
+		inv, _ := clitest.New(t, "stat", "cpu", "--output=json")
+		buf := new(bytes.Buffer)
+		inv.Stdout = buf
+		err := inv.WithContext(ctx).Run()
+		require.NoError(t, err)
+		s := buf.String()
+		tmp := struct{}{}
+		require.NoError(t, json.NewDecoder(strings.NewReader(s)).Decode(&tmp))
+	})
+}
+
+func TestStatMemCmd(t *testing.T) {
+	t.Parallel()
+
+	t.Run("Text", func(t *testing.T) {
+		t.Parallel()
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
+		t.Cleanup(cancel)
+		inv, _ := clitest.New(t, "stat", "mem", "--output=text")
+		buf := new(bytes.Buffer)
+		inv.Stdout = buf
+		err := inv.WithContext(ctx).Run()
+		require.NoError(t, err)
+		s := buf.String()
+		require.NotEmpty(t, s)
+	})
+
+	t.Run("JSON", func(t *testing.T) {
+		t.Parallel()
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
+		t.Cleanup(cancel)
+		inv, _ := clitest.New(t, "stat", "mem", "--output=json")
+		buf := new(bytes.Buffer)
+		inv.Stdout = buf
+		err := inv.WithContext(ctx).Run()
+		require.NoError(t, err)
+		s := buf.String()
+		tmp := struct{}{}
+		require.NoError(t, json.NewDecoder(strings.NewReader(s)).Decode(&tmp))
+	})
+}
+
+func TestStatDiskCmd(t *testing.T) {
+	t.Parallel()
+
+	t.Run("Text", func(t *testing.T) {
+		t.Parallel()
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
+		t.Cleanup(cancel)
+		inv, _ := clitest.New(t, "stat", "disk", "--output=text")
+		buf := new(bytes.Buffer)
+		inv.Stdout = buf
+		err := inv.WithContext(ctx).Run()
+		require.NoError(t, err)
+		s := buf.String()
+		require.NotEmpty(t, s)
+	})
+
+	t.Run("JSON", func(t *testing.T) {
+		t.Parallel()
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
+		t.Cleanup(cancel)
+		inv, _ := clitest.New(t, "stat", "disk", "--output=json")
+		buf := new(bytes.Buffer)
+		inv.Stdout = buf
+		err := inv.WithContext(ctx).Run()
+		require.NoError(t, err)
+		s := buf.String()
+		tmp := struct{}{}
+		require.NoError(t, json.NewDecoder(strings.NewReader(s)).Decode(&tmp))
+	})
+}
diff --git a/cli/testdata/coder_--help.golden b/cli/testdata/coder_--help.golden
@@ -34,7 +34,7 @@ Coder v0.0.0-devel — A tool for provisioning self-hosted development environme
                       workspace
     ssh               Start a shell into a workspace
     start             Start a workspace
-    stat              Show workspace resource usage.
+    stat              Show resource usage for the current workspace.
     state             Manually manage Terraform state to fix broken workspaces
     stop              Stop a workspace
     templates         Manage templates

diff --git a/cli/testdata/coder_stat_--help.golden b/cli/testdata/coder_stat_--help.golden
@@ -1,6 +1,11 @@
 Usage: coder stat [flags]
 
-Show workspace resource usage.
+Show resource usage for the current workspace.
+
+[1mSubcommands[0m
+    cpu     Show CPU usage, in cores.
+    disk    Show disk usage, in gigabytes.
+    mem     Show memory usage, in gigabytes.
 
 [1mOptions[0m
   -c, --column string-array (default: host_cpu,host_memory,home_disk,container_cpu,container_memory)

diff --git a/cli/testdata/coder_stat_cpu_--help.golden b/cli/testdata/coder_stat_cpu_--help.golden
@@ -0,0 +1,13 @@
+Usage: coder stat cpu [flags]
+
+Show CPU usage, in cores.
+
+[1mOptions[0m
+      --host bool
+          Force host CPU measurement.
+
+  -o, --output string (default: text)
+          Output format. Available formats: text, json.
+
+---
+Run `coder --help` for a list of global options.
diff --git a/cli/testdata/coder_stat_disk_--help.golden b/cli/testdata/coder_stat_disk_--help.golden
@@ -0,0 +1,13 @@
+Usage: coder stat disk [flags]
+
+Show disk usage, in gigabytes.
+
+[1mOptions[0m
+  -o, --output string (default: text)
+          Output format. Available formats: text, json.
+
+      --path string (default: /)
+          Path for which to check disk usage.
+
+---
+Run `coder --help` for a list of global options.
diff --git a/cli/testdata/coder_stat_mem_--help.golden b/cli/testdata/coder_stat_mem_--help.golden
@@ -0,0 +1,13 @@
+Usage: coder stat mem [flags]
+
+Show memory usage, in gigabytes.
+
+[1mOptions[0m
+      --host bool
+          Force host memory measurement.
+
+  -o, --output string (default: text)
+          Output format. Available formats: text, json.
+
+---
+Run `coder --help` for a list of global options.
diff --git a/docs/cli.md b/docs/cli.md
@@ -49,7 +49,7 @@ Coder — A tool for provisioning self-hosted development environments with Terr
 | [<code>speedtest</code>](./cli/speedtest.md)           | Run upload and download tests from your machine to a workspace         |
 | [<code>ssh</code>](./cli/ssh.md)                       | Start a shell into a workspace                                         |
 | [<code>start</code>](./cli/start.md)                   | Start a workspace                                                      |
-| [<code>stat</code>](./cli/stat.md)                     | Show workspace resource usage.                                         |
+| [<code>stat</code>](./cli/stat.md)                     | Show resource usage for the current workspace.                         |
 | [<code>state</code>](./cli/state.md)                   | Manually manage Terraform state to fix broken workspaces               |
 | [<code>stop</code>](./cli/stop.md)                     | Stop a workspace                                                       |
 | [<code>templates</code>](./cli/templates.md)           | Manage templates                                                       |

diff --git a/docs/cli/stat.md b/docs/cli/stat.md
@@ -2,14 +2,22 @@
 
 # stat
 
-Show workspace resource usage.
+Show resource usage for the current workspace.
 
 ## Usage
 
 ```console
 coder stat [flags]
 ```
 
+## Subcommands
+
+| Name                                | Purpose                          |
+| ----------------------------------- | -------------------------------- |
+| [<code>cpu</code>](./stat_cpu.md)   | Show CPU usage, in cores.        |
+| [<code>disk</code>](./stat_disk.md) | Show disk usage, in gigabytes.   |
+| [<code>mem</code>](./stat_mem.md)   | Show memory usage, in gigabytes. |
+
 ## Options
 
 ### -c, --column