Extend version command to help troubleshoot porter

cmd/porter/version.go

@@ -7,7 +7,7 @@ import (
 )
 
 func buildVersionCommand(p *porter.Porter) *cobra.Command {
-	opts := version.Options{}
+	opts := porter.VersionOpts{}
 	cmd := &cobra.Command{
 		Use:   "version",
 		Short: "Print the application version",
@@ -25,6 +25,7 @@ func buildVersionCommand(p *porter.Porter) *cobra.Command {
 	f := cmd.Flags()
 	f.StringVarP(&opts.RawFormat, "output", "o", string(version.DefaultVersionFormat),
 		"Specify an output format.  Allowed values: json, plaintext")
+	f.BoolVarP(&opts.System, "system", "s", false, "Print system debug information")
 
 	return cmd
 }

docs/content/cli/version.md

@@ -20,6 +20,7 @@ porter version [flags]
 ```
   -h, --help            help for version
   -o, --output string   Specify an output format.  Allowed values: json, plaintext (default "plaintext")
+  -s, --system          Print system debug information
 ```
 
 ### Options inherited from parent commands

pkg/porter/version.go

@@ -1,18 +1,111 @@
 package porter
 
 import (
+	"bytes"
+	"fmt"
 	"github.com/deislabs/porter/pkg"
+	"github.com/deislabs/porter/pkg/context"
 	"github.com/deislabs/porter/pkg/mixin"
 	"github.com/deislabs/porter/pkg/porter/version"
+	"github.com/deislabs/porter/pkg/printer"
+	"github.com/pkg/errors"
+	"runtime"
+	"text/template"
 )
 
-func (p *Porter) PrintVersion(opts version.Options) error {
+type VersionOpts struct {
+	version.Options
+	System bool
+}
+
+type SystemInfo struct {
+	OS   string
+	Arch string
+}
+
+type Mixins []mixin.Metadata
+
+type SystemDebugInfo struct {
+	Version mixin.Metadata   `json:"version"`
+	SysInfo SystemInfo       `json:"system"`
+	Mixins  Mixins `json:"mixins"`
+}
+
+func (mixins Mixins) PrintMixinsTable() string {
+	buffer := &bytes.Buffer{}
+	printMixinRow :=
+		func(v interface{}) []interface{} {
+			m, ok := v.(mixin.Metadata)
+			if !ok {
+				return nil
+			}
+			return []interface{}{m.Name, m.VersionInfo.Version, m.VersionInfo.Author}
+		}
+	err := printer.PrintTable(buffer, mixins, printMixinRow, "Name", "Version", "Author")
+	if err != nil {
+		return ""
+	}
+	return buffer.String()
+}
+
+func (p *Porter) PrintVersion(opts VersionOpts) error {
 	metadata := mixin.Metadata{
 		Name: "porter",
 		VersionInfo: mixin.VersionInfo{
 			Version: pkg.Version,
 			Commit:  pkg.Commit,
 		},
 	}
-	return version.PrintVersion(p.Context, opts, metadata)
+
+	if opts.System {
+		return p.PrintDebugInfo(p.Context, opts, metadata)
+	}
+
+	return version.PrintVersion(p.Context, opts.Options, metadata)
+}
+
+func getSystemInfo() *SystemInfo {
+	return &SystemInfo{
+		OS:   runtime.GOOS,
+		Arch: runtime.GOARCH,
+	}
+}
+
+func (p *Porter) PrintDebugInfo(ctx *context.Context, opts VersionOpts, versionMetadata mixin.Metadata) error {
+	opts.RawFormat = string(printer.FormatPlaintext)
+	mixins, err := p.ListMixins()
+	sysInfo := getSystemInfo()
+	if err != nil {
+		_ = errors.Wrap(err, "Failed to get list of mixins")
+	}
+	sysDebugInfo := SystemDebugInfo{
+		Version: versionMetadata,
+		SysInfo: *sysInfo,
+		Mixins:  mixins,
+	}
+
+	switch opts.Format {
+	case printer.FormatJson:
+		return printer.PrintJson(ctx.Out, sysDebugInfo)
+	case printer.FormatPlaintext:
+		plaintextTmpl := `{{.Version.Name}} {{.Version.VersionInfo.Version}} ({{.Version.VersionInfo.Commit}})
+
+System
+-------
+os: {{.SysInfo.OS}}
+arch: {{.SysInfo.Arch}}
+{{if .Mixins}}
+Mixins
+-------
+{{.Mixins.PrintMixinsTable}}{{end}}
+`
+		tmpl, err := template.New("systemDebugInfo").Parse(plaintextTmpl)
+		if err != nil {
+			_ = errors.Wrap(err, "Failed to print system debug information")
+		}
+		err = tmpl.Execute(ctx.Out, sysDebugInfo)
+		return err
+	default:
+		return fmt.Errorf("unsupported format: %s", opts.Format)
+	}
 }

pkg/porter/version_test.go

@@ -1,11 +1,13 @@
 package porter
 
 import (
+	"fmt"
+	"github.com/stretchr/testify/assert"
+	"runtime"
 	"strings"
 	"testing"
 
 	"github.com/deislabs/porter/pkg"
-	"github.com/deislabs/porter/pkg/porter/version"
 	"github.com/deislabs/porter/pkg/printer"
 	"github.com/stretchr/testify/require"
 )
@@ -16,7 +18,7 @@ func TestPrintVersion(t *testing.T) {
 
 	p := NewTestPorter(t)
 
-	opts := version.Options{}
+	opts := VersionOpts{}
 	err := opts.Validate()
 	require.NoError(t, err)
 	p.PrintVersion(opts)
@@ -34,7 +36,7 @@ func TestPrintJsonVersion(t *testing.T) {
 
 	p := NewTestPorter(t)
 
-	opts := version.Options{}
+	opts := VersionOpts{}
 	opts.RawFormat = string(printer.FormatJson)
 	err := opts.Validate()
 	require.NoError(t, err)
@@ -51,3 +53,62 @@ func TestPrintJsonVersion(t *testing.T) {
 		t.Fatalf("invalid output:\nWANT:\t%q\nGOT:\t%q\n", wantOutput, gotOutput)
 	}
 }
+
+func TestPrintDebugInfoJsonVersion(t *testing.T) {
+	pkg.Commit = "abc123"
+	pkg.Version = "v1.2.3"
+
+	p := NewTestPorter(t)
+
+	opts := VersionOpts{System: true}
+	p.TestConfig.SetupPorterHome()
+	opts.RawFormat = string(printer.FormatJson)
+	err := opts.Validate()
+	require.Nil(t, err)
+	p.PrintVersion(opts)
+
+	gotOutput := p.TestConfig.TestContext.GetOutput()
+	wantOutput := fmt.Sprintf(`{
+  "version": {
+    "name": "porter",
+    "version": "v1.2.3",
+    "commit": "abc123"
+  },
+  "system": {
+    "OS": "%s",
+    "Arch": "%s"
+  },
+  "mixins": [
+    {
+      "name": "exec",
+      "version": "v1.0",
+      "commit": "abc123",
+      "author": "Deis Labs"
+    }
+  ]
+}
+`, runtime.GOOS, runtime.GOARCH)
+	assert.Equal(t, wantOutput, gotOutput)
+}
+
+func TestPrintDebugInfoPlainTextVersion(t *testing.T) {
+	pkg.Commit = "abc123"
+	pkg.Version = "v1.2.3"
+
+	p := NewTestPorter(t)
+
+	opts := VersionOpts{System: true}
+	p.TestConfig.SetupPorterHome()
+	err := opts.Validate()
+	require.Nil(t, err)
+	p.PrintVersion(opts)
+
+	versionOutput := "porter v1.2.3 (abc123)"
+	mixinsOutput := "exec   v1.0      Deis Labs"
+	systemOutput := fmt.Sprintf("os: %s\narch: %s", runtime.GOOS, runtime.GOARCH)
+
+	gotOutput := p.TestConfig.TestContext.GetOutput()
+	assert.Contains(t, gotOutput, versionOutput)
+	assert.Contains(t, gotOutput, mixinsOutput)
+	assert.Contains(t, gotOutput, systemOutput)
+}