Add command line option workspace list -json to output workspaces in

json format
Signed-off-by: S.Cavallo <[email protected]>

Author: smcavallo

Diff for: internal/command/workspace_command_test.go

@@ -108,6 +108,57 @@ func TestWorkspace_createAndList(t *testing.T) {
 	if actual != expected {
 		t.Fatalf("\nexpected: %q\nactual:  %q", expected, actual)
 	}
+
+	// Json without env override
+
+	// Make sure an override does not exist
+	defer os.Unsetenv("TF_WORKSPACE")
+	if _, ok := os.LookupEnv("TF_WORKSPACE"); ok {
+		t.Fatalf("TF_WORKSPACE must not be set.")
+	}
+
+	args := []string{
+		"-json",
+	}
+	listCmd = &WorkspaceListCommand{}
+	ui = new(cli.MockUi)
+	listCmd.Meta = Meta{Ui: ui}
+
+	if code := listCmd.Run(args); code != 0 {
+		t.Fatalf("bad: %d\n\n%s", code, ui.ErrorWriter)
+	}
+
+	actual = strings.TrimSpace(ui.OutputWriter.String())
+	expected = "{\"terraform_version\":\"0.13.0-dev\",\"workspaces\":[{\"name\":\"default\",\"selected\":false},{\"name\":\"test_a\",\"selected\":false},{\"name\":\"test_b\",\"selected\":false},{\"name\":\"test_c\",\"selected\":true}],\"is_overridden\":false,\"overridden_note\":\"\"}"
+
+	if actual != expected {
+		t.Fatalf("\nexpected: %q\nactual:  %q", expected, actual)
+	}
+
+	// With workspace override
+
+	// Set the workspace override
+	defer os.Unsetenv("TF_WORKSPACE")
+	os.Setenv("TF_WORKSPACE", "test_a")
+
+	args = []string{
+		"-json",
+	}
+	listCmd = &WorkspaceListCommand{}
+	ui = new(cli.MockUi)
+	listCmd.Meta = Meta{Ui: ui}
+
+	if code := listCmd.Run(args); code != 0 {
+		t.Fatalf("bad: %d\n\n%s", code, ui.ErrorWriter)
+	}
+
+	actual = strings.TrimSpace(ui.OutputWriter.String())
+	expected = "{\"terraform_version\":\"0.13.0-dev\",\"workspaces\":[{\"name\":\"default\",\"selected\":false},{\"name\":\"test_a\",\"selected\":true},{\"name\":\"test_b\",\"selected\":false},{\"name\":\"test_c\",\"selected\":false}],\"is_overridden\":true,\"overridden_note\":\"\\n\\nThe active workspace is being overridden using the TF_WORKSPACE environment\\nvariable.\\n\"}"
+
+	if actual != expected {
+		t.Fatalf("\nexpected: %q\nactual:  %q", expected, actual)
+	}
+
 }
 
 // Create some workspaces and test the show output.

Diff for: internal/command/workspace_list.go

@@ -2,7 +2,9 @@ package command
 
 import (
 	"bytes"
+	"encoding/json"
 	"fmt"
+	tfversion "github.com/hashicorp/terraform/version"
 	"strings"
 
 	"github.com/hashicorp/terraform/internal/tfdiags"
@@ -14,11 +16,25 @@ type WorkspaceListCommand struct {
 	LegacyName bool
 }
 
+type WorkspaceList struct {
+	Name     string `json:"name"`
+	Selected bool   `json:"selected"`
+}
+
+type WorkspaceListOutput struct {
+	TerraformVersion string          `json:"terraform_version"`
+	WorkspaceList    []WorkspaceList `json:"workspaces"`
+	IsOverridden     bool            `json:"is_overridden"`
+	OverriddenNote   string          `json:"overridden_note"`
+}
+
 func (c *WorkspaceListCommand) Run(args []string) int {
 	args = c.Meta.process(args)
 	envCommandShowWarning(c.Ui, c.LegacyName)
 
 	cmdFlags := c.Meta.defaultFlagSet("workspace list")
+	var jsonOutput bool
+	cmdFlags.BoolVar(&jsonOutput, "json", false, "produce JSON output")
 	cmdFlags.Usage = func() { c.Ui.Error(c.Help()) }
 	if err := cmdFlags.Parse(args); err != nil {
 		c.Ui.Error(fmt.Sprintf("Error parsing command-line flags: %s\n", err.Error()))
@@ -62,6 +78,31 @@ func (c *WorkspaceListCommand) Run(args []string) int {
 
 	env, isOverridden := c.WorkspaceOverridden()
 
+	// If json
+	if jsonOutput == true {
+		var wsOutput WorkspaceListOutput
+		wsOutput.TerraformVersion = tfversion.String()
+		wsOutput.IsOverridden = isOverridden
+		if isOverridden {
+			wsOutput.OverriddenNote = envIsOverriddenNote
+		}
+
+		for _, s := range states {
+			ws := WorkspaceList{Name: s, Selected: s == env}
+			wsOutput.WorkspaceList = append(wsOutput.WorkspaceList, ws)
+		}
+
+		jsonOutput, err := json.Marshal(wsOutput)
+
+		if err != nil {
+			c.Ui.Error(fmt.Sprintf("Failed to marshal workspace list to json: %s", err))
+			return 1
+		}
+		c.Ui.Output(string(jsonOutput))
+		return 0
+	}
+
+	// If not json
 	var out bytes.Buffer
 	for _, s := range states {
 		if s == env {
@@ -91,10 +132,14 @@ func (c *WorkspaceListCommand) AutocompleteFlags() complete.Flags {
 
 func (c *WorkspaceListCommand) Help() string {
 	helpText := `
-Usage: terraform [global options] workspace list
+Usage: terraform [global options] workspace list [options] 
 
   List Terraform workspaces.
 
+Options:
+
+  -json               If specified, output to a machine-readable form.
+
 `
 	return strings.TrimSpace(helpText)
 }