feat: add terramate.path/name metadata (#87)

Author: katcipis

cmd/terramate/cli/cli.go

@@ -68,6 +68,9 @@ type cliSpec struct {
 	Generate struct {
 		Basedir string `short:"b" optional:"true" help:"Generate code for stacks inside basedir."`
 	} `cmd:"" help:"Generate terraform code for stacks."`
+
+	Metadata struct {
+	} `cmd:"" help:"shows metadata available on the project"`
 }
 
 // Run will run terramate with the provided flags defined on args from the
@@ -220,6 +223,8 @@ func (c *cli) run() error {
 		return c.runOnStacks(basedir)
 	case "generate":
 		return terramate.Generate(c.wd)
+	case "metadata":
+		return c.printMetadata()
 	default:
 		return fmt.Errorf("unexpected command sequence: %s", c.ctx.Command())
 	}
@@ -291,6 +296,23 @@ func (c *cli) printStacks(basedir string) error {
 	return nil
 }
 
+func (c *cli) printMetadata() error {
+	metadata, err := terramate.LoadMetadata(c.wd)
+	if err != nil {
+		return err
+	}
+
+	c.log("Available metadata:")
+
+	for _, stack := range metadata.Stacks {
+		c.log("\nstack %q:", stack.Path)
+		c.log("\tterraform.name=%q", stack.Name)
+		c.log("\tterraform.path=%q", stack.Path)
+	}
+
+	return nil
+}
+
 func (c *cli) runOnStacks(basedir string) error {
 	var nErrors int
 

docs/metadata.md

@@ -6,6 +6,11 @@ accessed through the variable namespace **terramate**.
 This can be referenced from any terramate code to reference
 information like the path of the stack that is being evaluated.
 
+To see all metadata available on your project run:
+
+```
+terramate metadata
+```
 
 ## terramate.path (string) 
 

metadata.go

@@ -0,0 +1,52 @@
+// Copyright 2021 Mineiros GmbH
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package terramate
+
+import (
+	"path/filepath"
+	"strings"
+)
+
+// StackMetadata has all metadata loaded per stack
+type StackMetadata struct {
+	Name string
+	Path string
+}
+
+// Metadata has all metadata loader per project
+type Metadata struct {
+	// Stacks is a lexycographicaly sorted (by stack path) list of stack metadata
+	Stacks []StackMetadata
+}
+
+// LoadMetadata loads the project metadata given the project basedir.
+func LoadMetadata(basedir string) (Metadata, error) {
+	stacks, err := ListStacks(basedir)
+	if err != nil {
+		return Metadata{}, err
+	}
+
+	stacksMetadata := make([]StackMetadata, len(stacks))
+	for i, stack := range stacks {
+		stacksMetadata[i] = StackMetadata{
+			Name: filepath.Base(stack.Dir),
+			Path: strings.TrimPrefix(stack.Dir, basedir),
+		}
+	}
+
+	return Metadata{
+		Stacks: stacksMetadata,
+	}, nil
+}

metadata_test.go

@@ -0,0 +1,166 @@
+// Copyright 2021 Mineiros GmbH
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package terramate_test
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+	"github.com/madlambda/spells/assert"
+	"github.com/mineiros-io/terramate"
+	"github.com/mineiros-io/terramate/test/sandbox"
+)
+
+func TestLoadMetadata(t *testing.T) {
+
+	type testcase struct {
+		name    string
+		layout  []string
+		want    terramate.Metadata
+		wantErr error
+	}
+
+	tcases := []testcase{
+		{
+			name:   "no stacks",
+			layout: []string{},
+			want: terramate.Metadata{
+				Stacks: []terramate.StackMetadata{},
+			},
+		},
+		{
+			name:   "single stacks",
+			layout: []string{"s:stack"},
+			want: terramate.Metadata{
+				Stacks: []terramate.StackMetadata{
+					{
+						Name: "stack",
+						Path: "/stack",
+					},
+				},
+			},
+		},
+		{
+			name: "two stacks",
+			layout: []string{
+				"s:stack-1",
+				"s:stack-2",
+			},
+			want: terramate.Metadata{
+				Stacks: []terramate.StackMetadata{
+					{
+						Name: "stack-1",
+						Path: "/stack-1",
+					},
+					{
+						Name: "stack-2",
+						Path: "/stack-2",
+					},
+				},
+			},
+		},
+		{
+			name: "stack and some non-stack dirs",
+			layout: []string{
+				"s:stack",
+				"d:non-stack",
+				"d:non-stack-2",
+			},
+			want: terramate.Metadata{
+				Stacks: []terramate.StackMetadata{
+					{
+						Name: "stack",
+						Path: "/stack",
+					},
+				},
+			},
+		},
+		{
+			name: "stacks nested",
+			layout: []string{
+				"s:envs/prod/stack-1",
+				"s:envs/staging/stack-1",
+			},
+			want: terramate.Metadata{
+				Stacks: []terramate.StackMetadata{
+					{
+						Name: "stack-1",
+						Path: "/envs/prod/stack-1",
+					},
+					{
+						Name: "stack-1",
+						Path: "/envs/staging/stack-1",
+					},
+				},
+			},
+		},
+		{
+			// TODO(katcipis): update to give error when we merge strict stack list logic
+			name: "single invalid stack",
+			layout: []string{
+				fmt.Sprintf("f:invalid-stack/%s:data=notvalidhcl", terramate.ConfigFilename),
+			},
+			want: terramate.Metadata{
+				Stacks: []terramate.StackMetadata{
+					{
+						Name: "invalid-stack",
+						Path: "/invalid-stack",
+					},
+				},
+			},
+			//wantErr: hcl.ErrMalformedTerramateBlock,
+		},
+		{
+			// TODO(katcipis): update to give error when we merge strict stack list logic
+			name: "valid stack with invalid stack",
+			layout: []string{
+				"s:stack-valid-1",
+				fmt.Sprintf("f:invalid-stack/%s:data=notvalidhcl", terramate.ConfigFilename),
+			},
+			want: terramate.Metadata{
+				Stacks: []terramate.StackMetadata{
+					{
+						Name: "invalid-stack",
+						Path: "/invalid-stack",
+					},
+					{
+						Name: "stack-valid-1",
+						Path: "/stack-valid-1",
+					},
+				},
+			},
+			//wantErr: hcl.ErrMalformedTerramateBlock,
+		},
+	}
+
+	for _, tcase := range tcases {
+		t.Run(tcase.name, func(t *testing.T) {
+			s := sandbox.New(t)
+			s.BuildTree(tcase.layout)
+
+			metadata, err := terramate.LoadMetadata(s.BaseDir())
+
+			if tcase.wantErr != nil {
+				assert.IsError(t, err, tcase.wantErr)
+				return
+			}
+
+			if diff := cmp.Diff(tcase.want, metadata); diff != "" {
+				t.Fatalf("want %v != got %v.\ndiff:\n%s", tcase.want, metadata, diff)
+			}
+		})
+	}
+}