terraform modules cmd human view

internal/command/modules.go

@@ -48,15 +48,6 @@ func (c *ModulesCommand) Run(rawArgs []string) int {
 	// Set up the command's view
 	view := views.NewModules(c.viewType, c.View)
 
-	// TODO: Remove this check once a human readable view is supported
-	// for this command
-	if c.viewType != arguments.ViewJSON {
-		c.Ui.Error(
-			"The `terraform modules` command requires the `-json` flag.\n")
-		c.Ui.Error(modulesCommandHelp)
-		return 1
-	}
-
 	rootModPath, err := ModulePath([]string{})
 	if err != nil {
 		diags = diags.Append(err)
@@ -129,8 +120,13 @@ func (c *ModulesCommand) internalManifest() (modsdir.Manifest, tfdiags.Diagnosti
 }
 
 const modulesCommandHelp = `
-Usage: terraform [global options] modules -json
+Usage: terraform [global options] modules [options]
 
   Prints out a list of all declared Terraform modules and their resolved versions
   in a Terraform working directory.
+
+Options:
+
+  -json            If specified, output declared Terraform modules and
+                   their resolved versions in a machine-readable format.
 `

internal/command/modules_test.go

@@ -11,15 +11,18 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/google/go-cmp/cmp"
+
 	"github.com/hashicorp/cli"
 	"github.com/hashicorp/terraform/internal/moduleref"
 )
 
 func TestModules_noJsonFlag(t *testing.T) {
 	dir := t.TempDir()
 	os.MkdirAll(dir, 0755)
+	testCopyDir(t, testFixturePath("modules-nested-dependencies"), dir)
 	ui := new(cli.MockUi)
-	view, _ := testView(t)
+	view, done := testView(t)
 	defer testChdir(t, dir)()
 
 	cmd := &ModulesCommand{
@@ -32,24 +35,51 @@ func TestModules_noJsonFlag(t *testing.T) {
 
 	args := []string{}
 	code := cmd.Run(args)
-	if code == 0 {
-		t.Fatal("expected an non zero exit status\n")
+	if code != 0 {
+		t.Fatalf("Got a non-zero exit code: %d\n", code)
 	}
 
-	output := ui.ErrorWriter.String()
-	if !strings.Contains(output, "The `terraform modules` command requires the `-json` flag.\n") {
-		t.Fatal("expected an error message about requiring -json flag.\n")
+	actual := done(t).All()
+
+	for _, part := range expectedOutputHuman {
+		if !strings.Contains(actual, part) {
+			t.Fatalf("unexpected output: %s\n", part)
+		}
 	}
+}
 
-	if !strings.Contains(output, modulesCommandHelp) {
-		t.Fatal("expected the modules command help to be displayed\n")
+func TestModules_noJsonFlag_noModules(t *testing.T) {
+	dir := t.TempDir()
+	os.MkdirAll(dir, 0755)
+	ui := new(cli.MockUi)
+	view, done := testView(t)
+	defer testChdir(t, dir)()
+
+	cmd := &ModulesCommand{
+		Meta: Meta{
+			testingOverrides: metaOverridesForProvider(testProvider()),
+			Ui:               ui,
+			View:             view,
+		},
+	}
+
+	args := []string{}
+	code := cmd.Run(args)
+	if code != 0 {
+		t.Fatalf("Got a non-zero exit code: %d\n", code)
+	}
+
+	actual := done(t).All()
+
+	if diff := cmp.Diff("No modules found in configuration.\n", actual); diff != "" {
+		t.Fatalf("unexpected output (-want +got):\n%s", diff)
 	}
 }
 
 func TestModules_fullCmd(t *testing.T) {
 	dir := t.TempDir()
 	os.MkdirAll(dir, 0755)
-	testCopyDir(t, testFixturePath("modules"), dir)
+	testCopyDir(t, testFixturePath("modules-nested-dependencies"), dir)
 
 	ui := new(cli.MockUi)
 	view, done := testView(t)
@@ -70,7 +100,7 @@ func TestModules_fullCmd(t *testing.T) {
 	}
 
 	output := done(t).All()
-	compareJSONOutput(t, output, expectedOutput)
+	compareJSONOutput(t, output, expectedOutputJSON)
 }
 
 func TestModules_fullCmd_unreferencedEntries(t *testing.T) {
@@ -96,7 +126,7 @@ func TestModules_fullCmd_unreferencedEntries(t *testing.T) {
 		t.Fatalf("Got a non-zero exit code: %d\n", code)
 	}
 	output := done(t).All()
-	compareJSONOutput(t, output, expectedOutput)
+	compareJSONOutput(t, output, expectedOutputJSON)
 }
 
 func TestModules_uninstalledModules(t *testing.T) {
@@ -154,4 +184,6 @@ func compareJSONOutput(t *testing.T, got string, want string) {
 	}
 }
 
-var expectedOutput = `{"format_version":"1.0","modules":[{"key":"child","source":"./child","version":""},{"key":"count_child","source":"./child","version":""}]}`
+var expectedOutputJSON = `{"format_version":"1.0","modules":[{"key":"test","source":"./mods/test","version":""},{"key":"test2","source":"./test2","version":""},{"key":"test3","source":"./test3","version":""},{"key":"other","source":"./mods/other","version":""}]}`
+
+var expectedOutputHuman = []string{"── \"other\"[./mods/other]", "── \"test\"[./mods/test]\n    └── \"test2\"[./test2]\n        └── \"test3\"[./test3]"}

internal/command/testdata/modules-nested-dependencies/.terraform/modules/modules.json

@@ -0,0 +1,29 @@
+{
+    "Modules": [
+        {
+            "Key": "",
+            "Source": "",
+            "Dir": "."
+        },
+        {
+            "Key": "other",
+            "Source": "./mods/other",
+            "Dir": "mods/other"
+        },
+        {
+            "Key": "test",
+            "Source": "./mods/test",
+            "Dir": "mods/test"
+        },
+        {
+            "Key": "test.test2",
+            "Source": "./test2",
+            "Dir": "mods/test/test2"
+        },
+        {
+            "Key": "test.test2.test3",
+            "Source": "./test3",
+            "Dir": "mods/test/test2/test3"
+        }
+    ]
+}

internal/command/testdata/modules-nested-dependencies/main.tf

@@ -0,0 +1,7 @@
+module "test" {
+  source = "./mods/test"
+}
+
+module "other" {
+  source = "./mods/other"
+}

internal/command/testdata/modules-nested-dependencies/mods/other/main.tf

@@ -0,0 +1,5 @@
+resource "test_instance" "test" {
+}
+output "myoutput" {
+  value = "bar"
+}

internal/command/testdata/modules-nested-dependencies/mods/test/main.tf

@@ -0,0 +1,3 @@
+module "test2" {
+  source = "./test2"
+}

internal/command/testdata/modules-nested-dependencies/mods/test/test2/main.tf

@@ -0,0 +1,3 @@
+module "test3" {
+  source = "./test3"
+}

internal/command/testdata/modules-nested-dependencies/mods/test/test2/test3/main.tf

@@ -0,0 +1,5 @@
+resource "test_instance" "test" {
+}
+output "myoutput" {
+  value = "bar"
+}

internal/command/views/modules.go

@@ -10,6 +10,7 @@ import (
 	"github.com/hashicorp/terraform/internal/command/arguments"
 	"github.com/hashicorp/terraform/internal/moduleref"
 	"github.com/hashicorp/terraform/internal/tfdiags"
+	"github.com/xlab/treeprint"
 )
 
 type Modules interface {
@@ -38,9 +39,34 @@ type ModulesHuman struct {
 var _ Modules = (*ModulesHuman)(nil)
 
 func (v *ModulesHuman) Display(manifest moduleref.Manifest) int {
+	if len(manifest.Records) == 0 {
+		v.view.streams.Println("No modules found in configuration.")
+		return 0
+	}
+	printRoot := treeprint.New()
+	populateTreeNode(printRoot, &moduleref.Record{
+		Children: manifest.Records,
+	})
+
+	v.view.streams.Println(fmt.Sprintf("\nModules declared by configuration:\n%s", printRoot.String()))
 	return 0
 }
 
+func populateTreeNode(tree treeprint.Tree, node *moduleref.Record) {
+	for _, childNode := range node.Children {
+		item := fmt.Sprintf("\"%s\"[%s]", childNode.Key, childNode.Source.String())
+		if childNode.Version != nil {
+			item += fmt.Sprintf(" %s", childNode.Version)
+			// Avoid rendering the version constraint if an exact version is given i.e. 'version = "1.2.3"'
+			if childNode.VersionConstraints != nil && childNode.VersionConstraints.String() != childNode.Version.String() {
+				item += fmt.Sprintf(" (%s)", childNode.VersionConstraints.String())
+			}
+		}
+		branch := tree.AddBranch(item)
+		populateTreeNode(branch, childNode)
+	}
+}
+
 func (v *ModulesHuman) Diagnostics(diags tfdiags.Diagnostics) {
 	v.view.Diagnostics(diags)
 }
@@ -54,7 +80,9 @@ var _ Modules = (*ModulesHuman)(nil)
 func (v *ModulesJSON) Display(manifest moduleref.Manifest) int {
 	var bytes []byte
 	var err error
-	if bytes, err = encJson.Marshal(manifest); err != nil {
+
+	flattenedManifest := flattenManifest(manifest)
+	if bytes, err = encJson.Marshal(flattenedManifest); err != nil {
 		v.view.streams.Eprintf("error marshalling manifest: %v", err)
 		return 1
 	}
@@ -63,6 +91,42 @@ func (v *ModulesJSON) Display(manifest moduleref.Manifest) int {
 	return 0
 }
 
+// FlattenManifest returns the nested contents of a moduleref.Manifest in
+// a flattened format with the VersionConstraints and Children attributes
+// ommited for the purposes of the json format of the modules command
+func flattenManifest(m moduleref.Manifest) map[string]interface{} {
+	var flatten func(records []*moduleref.Record)
+	var recordList []map[string]string
+	flatten = func(records []*moduleref.Record) {
+		for _, record := range records {
+			if record.Version != nil {
+				recordList = append(recordList, map[string]string{
+					"key":     record.Key,
+					"source":  record.Source.String(),
+					"version": record.Version.String(),
+				})
+			} else {
+				recordList = append(recordList, map[string]string{
+					"key":     record.Key,
+					"source":  record.Source.String(),
+					"version": "",
+				})
+			}
+
+			if len(record.Children) > 0 {
+				flatten(record.Children)
+			}
+		}
+	}
+
+	flatten(m.Records)
+	ret := map[string]interface{}{
+		"format_version": m.FormatVersion,
+		"modules":        recordList,
+	}
+	return ret
+}
+
 func (v *ModulesJSON) Diagnostics(diags tfdiags.Diagnostics) {
 	v.view.Diagnostics(diags)
 }

internal/moduleref/record.go

@@ -3,29 +3,34 @@
 
 package moduleref
 
-import "github.com/hashicorp/terraform/internal/modsdir"
+import (
+	"github.com/hashicorp/go-version"
+	"github.com/hashicorp/terraform/internal/addrs"
+)
 
 const FormatVersion = "1.0"
 
 // ModuleRecord is the implementation of a module entry defined in the module
 // manifest that is declared by configuration.
 type Record struct {
-	Key     string `json:"key"`
-	Source  string `json:"source"`
-	Version string `json:"version"`
+	Key                string
+	Source             addrs.ModuleSource
+	Version            *version.Version
+	VersionConstraints version.Constraints
+	Children           []*Record
 }
 
 // ModuleRecordManifest is the view implementation of module entries declared
 // in configuration
 type Manifest struct {
-	FormatVersion string   `json:"format_version"`
-	Records       []Record `json:"modules"`
+	FormatVersion string
+	Records       []*Record
 }
 
-func (m *Manifest) addModuleEntry(entry modsdir.Record) {
-	m.Records = append(m.Records, Record{
-		Key:     entry.Key,
-		Source:  entry.SourceAddr,
-		Version: entry.VersionStr,
-	})
+func (m *Manifest) addModuleEntry(entry *Record) {
+	m.Records = append(m.Records, entry)
+}
+
+func (r *Record) addChild(child *Record) {
+	r.Children = append(r.Children, child)
 }