add usage command to 'src scout' (#983)

* move style folder out of resources directory and into scout directory for ease of reuse

* adds metrics api client

* refactor

* connect metrics api

* borked percentages

* WIP - incorrect usage percentages for some containers

* fixes bug that was causing certain containers to return bad usage percentages

* adds percentage of storage capacity used column

* add tests and use remotecommand package instead of exec

* delete stray line

* add line breaks for readability

* fix incorrect flag name

* refactor to ensure all functions are doing one thing

* formatting

* formatting

* remove duplicate import, remove todo

---------

Co-authored-by: Jacob Pleiness <jdpleiness@users.noreply.github.com>

Author: jasonhawkharris

cmd/src/scout_usage.go

@@ -0,0 +1,120 @@
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"path/filepath"
+
+	"github.com/docker/docker/client"
+	"github.com/sourcegraph/sourcegraph/lib/errors"
+	"github.com/sourcegraph/src-cli/internal/scout/usage"
+	"k8s.io/client-go/kubernetes"
+	"k8s.io/client-go/tools/clientcmd"
+	"k8s.io/client-go/util/homedir"
+	metricsv "k8s.io/metrics/pkg/client/clientset/versioned"
+)
+
+func init() {
+	cmdUsage := `'src scout usage' is a tool that tracks resource usage for Sourcegraph instances.
+    Part of the EXPERIMENTAL "src scout" tool.
+    
+    Examples
+        List pods and resource usage in a Kubernetes deployment:
+        $ src scout usage
+
+        List containers and resource usage in a Docker deployment:
+        $ src scout usage --docker
+
+        Check usage for specific pod
+        $ src scout usage --pod <podname>
+
+        Add namespace if using namespace in a Kubernetes cluster
+        $ src scout usage --namespace <namespace>
+        
+        Watch usage in real time 
+        $ src scout usage --spy
+    `
+
+	flagSet := flag.NewFlagSet("usage", flag.ExitOnError)
+	usageFunc := func() {
+		fmt.Fprintf(flag.CommandLine.Output(), "Usage of 'src scout %s':\n", flagSet.Name())
+		flagSet.PrintDefaults()
+		fmt.Println(cmdUsage)
+	}
+
+	var (
+		kubeConfig *string
+		namespace  = flagSet.String("namespace", "", "(optional) specify the kubernetes namespace to use")
+		pod        = flagSet.String("pod", "", "(optional) specify a single pod")
+		docker     = flagSet.Bool("docker", false, "(optional) using docker deployment")
+		spy        = flagSet.Bool("spy", false, "(optional) see resource usage in real time")
+	)
+
+	if home := homedir.HomeDir(); home != "" {
+		kubeConfig = flagSet.String(
+			"kubeconfig",
+			filepath.Join(home, ".kube", "config"),
+			"(optional) absolute path to the kubeconfig file",
+		)
+	} else {
+		kubeConfig = flagSet.String("kubeconfig", "", "absolute path to the kubeconfig file")
+	}
+
+	handler := func(args []string) error {
+		if err := flagSet.Parse(args); err != nil {
+			return err
+		}
+
+		config, err := clientcmd.BuildConfigFromFlags("", *kubeConfig)
+		if err != nil {
+			return errors.Wrap(err, "failed to load .kube config: ")
+		}
+
+		clientSet, err := kubernetes.NewForConfig(config)
+		if err != nil {
+			return errors.Wrap(err, "failed to initiate kubernetes client: ")
+		}
+
+		metricsClient, err := metricsv.NewForConfig(config)
+		if err != nil {
+			return errors.Wrap(err, "failed to initiate metrics client")
+		}
+
+		var options []usage.Option
+
+		if *namespace != "" {
+			options = append(options, usage.WithNamespace(*namespace))
+		}
+		if *spy {
+			options = append(options, usage.WithSpy(true))
+		}
+		if *pod != "" {
+			options = append(options, usage.WithPod(*pod))
+		}
+
+		if *docker {
+			dockerClient, err := client.NewClientWithOpts(client.FromEnv)
+			if err != nil {
+				return errors.Wrap(err, "error creating docker client: ")
+			}
+
+			return usage.Docker(context.Background(), *dockerClient)
+		}
+
+		return usage.K8s(
+			context.Background(),
+			clientSet,
+			metricsClient,
+			config,
+			options...,
+		)
+	}
+
+	scoutCommands = append(scoutCommands, &command{
+		flagSet:   flagSet,
+		handler:   handler,
+		usageFunc: usageFunc,
+	})
+
+}

go.mod

@@ -39,13 +39,14 @@ require (
 	google.golang.org/protobuf v1.28.1
 	gopkg.in/yaml.v3 v3.0.1
 	jaytaylor.com/html2text v0.0.0-20200412013138-3577fbdbcff7
-	k8s.io/api v0.26.1
-	k8s.io/apimachinery v0.26.1
-	k8s.io/client-go v0.26.1
+	k8s.io/api v0.27.1
+	k8s.io/apimachinery v0.27.1
+	k8s.io/client-go v0.27.1
+	k8s.io/metrics v0.27.1
 )
 
 require (
-	golang.org/x/exp v0.0.0-20190731235908-ec7cb31e5a56 // indirect
+	golang.org/x/exp v0.0.0-20200224162631-6cc2880d07d6 // indirect
 	golang.org/x/image v0.6.0 // indirect
 	golang.org/x/mobile v0.0.0-20230301163155-e0f57694e12c // indirect
 )
@@ -93,14 +94,14 @@ require (
 	github.com/getsentry/sentry-go v0.15.0 // indirect
 	github.com/ghodss/yaml v1.0.0 // indirect
 	github.com/go-logr/logr v1.2.3 // indirect
-	github.com/go-openapi/jsonpointer v0.19.5 // indirect
-	github.com/go-openapi/jsonreference v0.20.0 // indirect
-	github.com/go-openapi/swag v0.19.14 // indirect
+	github.com/go-openapi/jsonpointer v0.19.6 // indirect
+	github.com/go-openapi/jsonreference v0.20.1 // indirect
+	github.com/go-openapi/swag v0.22.3 // indirect
 	github.com/gofrs/flock v0.8.1 // indirect
 	github.com/gofrs/uuid v4.2.0+incompatible // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
-	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/google/gnostic v0.5.7-v3refs // indirect
 	github.com/google/gofuzz v1.1.0 // indirect
 	github.com/google/uuid v1.3.0 // indirect
@@ -130,7 +131,7 @@ require (
 	github.com/mitchellh/copystructure v1.2.0 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
 	github.com/moby/spdystream v0.2.0 // indirect
-	github.com/moby/term v0.0.0-20220808134915-39b0c02b01ae // indirect
+	github.com/moby/term v0.0.0-20221205130635-1aeaba878587 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/morikuni/aec v1.0.0 // indirect
@@ -150,7 +151,7 @@ require (
 	github.com/pseudomuto/protoc-gen-doc v1.5.1 // indirect
 	github.com/pseudomuto/protokit v0.2.0 // indirect
 	github.com/rivo/uniseg v0.4.2 // indirect
-	github.com/rogpeppe/go-internal v1.9.0 // indirect
+	github.com/rogpeppe/go-internal v1.10.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/sourcegraph/log v0.0.0-20221206163500-7d93c6ad7037 // indirect
 	github.com/spf13/cobra v1.6.0 // indirect
@@ -178,13 +179,13 @@ require (
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/genproto v0.0.0-20230216225411-c8e22ba71e44 // indirect
 	google.golang.org/grpc v1.53.0 // indirect
-	gopkg.in/inf.v0 v0.9.1 // indirect
+	gopkg.in/inf.v0 v0.9.1 // direct
 	gopkg.in/yaml.v2 v2.4.0 // indirect
-	k8s.io/klog/v2 v2.80.1 // indirect
-	k8s.io/kube-openapi v0.0.0-20221012153701-172d655c2280 // indirect
-	k8s.io/utils v0.0.0-20221107191617-1a15be271d1d // indirect
+	k8s.io/klog/v2 v2.90.1 // indirect
+	k8s.io/kube-openapi v0.0.0-20230308215209-15aac26d736a // indirect
+	k8s.io/utils v0.0.0-20230209194617-a36077c30491 // indirect
 	mvdan.cc/gofumpt v0.4.0 // indirect
-	sigs.k8s.io/json v0.0.0-20220713155537-f223a00ba0e2 // indirect
+	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
 	sigs.k8s.io/yaml v1.3.0 // indirect
 )