src debug command

.gitignore

@@ -1,4 +1,6 @@
 ./src
+./cmd/src/src
+*.zip
 release
 ./vendor
 .idea

CHANGELOG.md

@@ -12,7 +12,7 @@ All notable changes to `src-cli` are documented in this file.
 ## Unreleased
 
 ### Added
-
+- New command `src debug` dumps context from Sourcegraph instance, executing common `docker` and `kubectl` cli introspection commands and writing returns to a zip archive file. [#731](https://github.com/sourcegraph/src-cli/pull/731)
 - `src lsif upload` now supports the `-gitlab-token` flag. [#721](https://github.com/sourcegraph/src-cli/pull/721)
 - Batch Changes can be applied to Bitbucket Cloud when `src` is used with Sourcegraph 3.40 or later. [#725](https://github.com/sourcegraph/src-cli/pull/725)
 

cmd/src/debug.go

@@ -0,0 +1,42 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+)
+
+var debugCommands commander
+
+func init() {
+	usage := `'src debug' gathers and bundles debug data from a Sourcegraph deployment for troubleshooting.
+
+Usage:
+
+	src debug command [command options]
+
+The commands are:
+
+	kube                 dumps context from k8s deployments
+	compose              dumps context from docker-compose deployments
+	server               dumps context from single-container deployments
+
+
+Use "src debug [command] -h" for more information about a subcommands.
+src debug has access to flags on src -- Ex: src -v kube -o foo.zip
+
+`
+
+	flagSet := flag.NewFlagSet("debug", flag.ExitOnError)
+	handler := func(args []string) error {
+		debugCommands.run(flagSet, "src debug", usage, args)
+		return nil
+	}
+
+	// Register the command.
+	commands = append(commands, &command{
+		flagSet:   flagSet,
+		aliases:   []string{},
+		handler:   handler,
+		usageFunc: func() { fmt.Println(usage) },
+	})
+}

cmd/src/debug_common.go

@@ -0,0 +1,123 @@
+package main
+
+import (
+	"archive/zip"
+	"context"
+	"encoding/json"
+	"fmt"
+	"log"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/sourcegraph/src-cli/internal/exec"
+
+	"github.com/sourcegraph/sourcegraph/lib/errors"
+)
+
+type archiveFile struct {
+	name string
+	data []byte
+	err  error
+}
+
+func archiveFileFromCommand(ctx context.Context, path, cmd string, args ...string) *archiveFile {
+	f := &archiveFile{name: path}
+	f.data, f.err = exec.CommandContext(ctx, cmd, args...).CombinedOutput()
+	if f.err != nil {
+		f.err = errors.Wrapf(f.err, "executing command: %s %s: received error: %s", cmd, strings.Join(args, " "), f.data)
+	}
+	return f
+}
+
+// This function prompts the user to confirm they want to run the command
+func verify(confirmationText string) (bool, error) {
+	input := ""
+	for strings.ToLower(input) != "y" && strings.ToLower(input) != "n" {
+		fmt.Printf("%s [y/N]: ", confirmationText)
+		if _, err := fmt.Scanln(&input); err != nil {
+			return false, err
+		}
+	}
+
+	return strings.ToLower(input) == "y", nil
+}
+
+func processBaseDir(base string) (string, string) {
+	if !strings.HasSuffix(base, ".zip") {
+		return base + ".zip", base
+	}
+
+	return base, strings.TrimSuffix(base, ".zip")
+}
+
+// write all the outputs from an archive command passed on the channel to to the zip writer
+func writeChannelContentsToZip(zw *zip.Writer, ch <-chan *archiveFile, verbose bool) error {
+	for f := range ch {
+		if verbose {
+			log.Printf("archiving file %q with %d bytes", f.name, len(f.data))
+		}
+
+		if f.err != nil {
+			return f.err
+		}
+
+		zf, err := zw.Create(f.name)
+		if err != nil {
+			return errors.Wrapf(err, "failed to create %q", f.name)
+		}
+
+		if _, err := zf.Write(f.data); err != nil {
+			return errors.Wrapf(err, "failed to write to %q", f.name)
+		}
+	}
+	return nil
+}
+
+// TODO: Currently external services and site configs are pulled using the SRC_ENDPOINT env var,
+// if theres a way to validate that the env var is pointing at the same instance as the docker and kubectl commands,
+// it should be implemented.
+
+// TODO: file issue on the existence of OAuth signKey which needs to be redacted
+
+// getExternalServicesConfig calls src extsvc list with the format flag -f,
+// and then returns an archiveFile to be consumed
+func getExternalServicesConfig(ctx context.Context, baseDir string) *archiveFile {
+	const fmtStr = `{{range .Nodes}}{{.id}} | {{.kind}} | {{.displayName}}{{"\n"}}{{.config}}{{"\n---\n"}}{{end}}`
+	return archiveFileFromCommand(
+		ctx,
+		filepath.Join(baseDir, "config", "external_services.txt"),
+		os.Args[0], "extsvc", "list", "-f", fmtStr,
+	)
+}
+
+// getSiteConfig calls src api -query=... to query the api for site config json
+func getSiteConfig(ctx context.Context, baseDir string) *archiveFile {
+	const siteConfigStr = `query { site { configuration { effectiveContents } } }`
+	f := archiveFileFromCommand(ctx,
+		filepath.Join(baseDir, "config", "siteConfig.json"),
+		os.Args[0], "api", "-query", siteConfigStr,
+	)
+
+	if f.err != nil {
+		return f
+	}
+
+	var siteConfig struct {
+		Data struct {
+			Site struct {
+				Configuration struct {
+					EffectiveContents string
+				}
+			}
+		}
+	}
+
+	if err := json.Unmarshal(f.data, &siteConfig); err != nil {
+		f.err = err
+		return f
+	}
+
+	f.data = []byte(siteConfig.Data.Site.Configuration.EffectiveContents)
+	return f
+}