fix: fail if root config is not at project root (#459)

Co-authored-by: Tiago Cesar Katcipis <tiagokatcipis@gmail.com>

cmd/terramate/cli/cli.go

@@ -1142,6 +1142,11 @@ func lookupProject(wd string) (prj project, found bool, err error) {
 
 	logger.Trace().Msg("Create new git wrapper.")
 
+	rootcfg, rootpath, rootfound, err := config.TryLoadRootConfig(wd)
+	if err != nil {
+		return project{}, false, err
+	}
+
 	gw, err := newGit(wd, false)
 	if err == nil {
 		logger.Trace().Msg("Get root of git repo.")
@@ -1169,6 +1174,13 @@ func lookupProject(wd string) (prj project, found bool, err error) {
 
 			root := filepath.Dir(gitabs)
 
+			if rootfound && strings.HasPrefix(rootpath, root) && rootpath != root {
+				return project{}, false, errors.E(
+					"terramate root config found at %q but it must be at the root dir %q",
+					rootpath, root,
+				)
+			}
+
 			logger.Trace().Msg("Load root config.")
 
 			cfg, err := hcl.ParseDir(root, root)
@@ -1185,31 +1197,14 @@ func lookupProject(wd string) (prj project, found bool, err error) {
 		}
 	}
 
-	dir := wd
-
-	for {
-		logger.Trace().Msg("Load root config.")
-
-		cfg, ok, err := config.TryLoadRootConfig(dir)
-		if err != nil {
-			return project{}, false, err
-		}
-
-		if ok {
-			prj.root = dir
-			prj.rootcfg = cfg
-
-			return prj, true, nil
-		}
-
-		if dir == "/" {
-			break
-		}
-
-		dir = filepath.Dir(dir)
+	if !rootfound {
+		return project{}, false, nil
 	}
 
-	return project{}, false, nil
+	prj.root = rootpath
+	prj.rootcfg = rootcfg
+	return prj, true, nil
+
 }
 
 func configureLogging(logLevel string, logFmt string, output io.Writer) {

cmd/terramate/e2etests/general_test.go

@@ -16,6 +16,7 @@ package e2etest
 
 import (
 	"fmt"
+	"path/filepath"
 	"strings"
 	"testing"
 
@@ -466,6 +467,22 @@ func TestCommandsNotRequiringGitSafeguards(t *testing.T) {
 	}
 }
 
+func TestE2ETerramateFailIfRootConfigIsNotAtProjectRoot(t *testing.T) {
+	s := sandbox.New(t)
+	s.BuildTree([]string{
+		"s:stacks/stack",
+	})
+
+	stacksDir := filepath.Join(s.RootDir(), "stacks")
+	test.WriteRootConfig(t, stacksDir)
+
+	cli := newCLI(t, stacksDir)
+	assertRunResult(t, cli.listStacks(), runExpected{
+		Status:      1,
+		StderrRegex: "terramate root config found at",
+	})
+}
+
 func setupLocalMainBranchBehindOriginMain(git *sandbox.Git, changeFiles func()) {
 	// dance below makes local main branch behind origin/main by 1 commit.
 	//   - a "temp" branch is created to record current commit.

config/config.go

@@ -15,6 +15,8 @@
 package config
 
 import (
+	"path/filepath"
+
 	"github.com/mineiros-io/terramate/hcl"
 	"github.com/rs/zerolog/log"
 )
@@ -24,23 +26,37 @@ const (
 	DefaultFilename = "terramate.tm.hcl"
 )
 
-// TryLoadRootConfig loads Terramate root config. If no configuration is found
-// it returns false, nil.
-func TryLoadRootConfig(dir string) (cfg hcl.Config, found bool, err error) {
-	logger := log.With().
-		Str("action", "TryLoadRootConfig()").
-		Str("path", dir).
-		Logger()
+// TryLoadRootConfig try to load the Terramate root config. It looks for the
+// the config in fromdir and all parent directories until / is reached.
+// If the configuration is found, it returns configpath != "" and found as true.
+func TryLoadRootConfig(fromdir string) (cfg hcl.Config, configpath string, found bool, err error) {
+	for {
+		logger := log.With().
+			Str("action", "TryLoadRootConfig()").
+			Str("path", fromdir).
+			Logger()
 
-	logger.Trace().Msg("Parse Terramate config.")
+		logger.Trace().Msg("Parse Terramate config.")
 
-	cfg, err = hcl.ParseDir(dir, dir)
-	if err != nil {
-		return hcl.Config{}, false, err
-	}
+		cfg, err = hcl.ParseDir(fromdir, fromdir)
+		if err != nil {
+			return hcl.Config{}, "", false, err
+		}
+
+		if cfg.Terramate != nil && cfg.Terramate.Config != nil {
+			return cfg, fromdir, true, nil
+		}
 
-	if cfg.Terramate != nil && cfg.Terramate.Config != nil {
-		return cfg, true, nil
+		parent, ok := parentDir(fromdir)
+		if !ok {
+			break
+		}
+		fromdir = parent
 	}
-	return hcl.Config{}, false, nil
+	return hcl.Config{}, "", false, nil
+}
+
+func parentDir(dir string) (string, bool) {
+	parent := filepath.Dir(dir)
+	return parent, parent != dir
 }