fix: Improving integration into catalog

cli/commands/catalog/action.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"strings"
 
 	"github.com/gruntwork-io/terragrunt/cli/commands/catalog/module"
 	"github.com/gruntwork-io/terragrunt/cli/commands/catalog/tui"
@@ -41,9 +42,26 @@ func Run(ctx context.Context, opts *options.TerragruntOptions, repoURL string) e
 	allowCAS := opts.Experiments.Evaluate(experiment.CAS)
 
 	for _, repoURL := range repoURLs {
-		tempDir := filepath.Join(os.TempDir(), fmt.Sprintf(tempDirFormat, util.EncodeBase64Sha1(repoURL)))
+		path := util.EncodeBase64Sha1(repoURL)
+
+		// NOTE: We do this check again later, but it's just to make sure that we're leaving
+		// the separation of concerns for the directory destination and repo cloning.
+		if strings.HasPrefix(repoURL, "cas://") {
+			if !allowCAS {
+				return errors.Errorf("cas:// protocol is not allowed without using the `cas` experiment. Please enable the experiment and try again.")
+			}
+
+			homeDir, err := os.UserHomeDir()
+			if err != nil {
+				return err
+			}
+
+			path = filepath.Join(homeDir, ".cache", "terragrunt", "cas", "catalog", path)
+		} else {
+			path = filepath.Join(os.TempDir(), fmt.Sprintf(tempDirFormat, path))
+		}
 
-		repo, err := module.NewRepo(ctx, opts.Logger, repoURL, tempDir, walkWithSymlinks, allowCAS)
+		repo, err := module.NewRepo(ctx, opts.Logger, repoURL, path, walkWithSymlinks, allowCAS)
 		if err != nil {
 			return err
 		}

cli/commands/catalog/module/repo.go

@@ -34,7 +34,7 @@ const (
 
 var (
 	gitHeadBranchNameReg    = regexp.MustCompile(`^.*?([^/]+)$`)
-	repoNameFromCloneURLReg = regexp.MustCompile(`(?i)^.*?([-a-z_.]+)[^/]*?(?:\.git)?$`)
+	repoNameFromCloneURLReg = regexp.MustCompile(`(?i)^.*?([-a-z0-9_.]+)[^/]*?(?:\.git)?$`)
 
 	modulesPaths = []string{"modules"}
 
@@ -54,7 +54,7 @@ type Repo struct {
 	useCAS           bool
 }
 
-func NewRepo(ctx context.Context, logger log.Logger, cloneURL, tempDir string, walkWithSymlinks bool, allowCAS bool) (*Repo, error) {
+func NewRepo(ctx context.Context, logger log.Logger, cloneURL, path string, walkWithSymlinks bool, allowCAS bool) (*Repo, error) {
 	useCAS := false
 
 	if strings.HasPrefix(cloneURL, "cas://") {
@@ -70,7 +70,7 @@ func NewRepo(ctx context.Context, logger log.Logger, cloneURL, tempDir string, w
 	repo := &Repo{
 		logger:           logger,
 		cloneURL:         cloneURL,
-		path:             tempDir,
+		path:             path,
 		walkWithSymlinks: walkWithSymlinks,
 		useCAS:           useCAS,
 	}
@@ -212,7 +212,13 @@ func (repo *Repo) clone(ctx context.Context) error {
 		return err
 	}
 
-	return repo.performClone(&opts)
+	if repo.cloneCompleted() {
+		repo.logger.Debugf("The repo dir exists and %q exists. Skipping cloning.", cloneCompleteSentinel)
+
+		return nil
+	}
+
+	return repo.performClone(ctx, &opts)
 }
 
 func (repo *Repo) resolveCloneURL() (string, error) {
@@ -221,6 +227,7 @@ func (repo *Repo) resolveCloneURL() (string, error) {
 		if err != nil {
 			return "", errors.New(err)
 		}
+
 		return currentDir, nil
 	}
 
@@ -233,6 +240,7 @@ func (repo *Repo) handleLocalDir(repoPath string) error {
 		if err != nil {
 			return errors.New(err)
 		}
+
 		repo.logger.Debugf("Converting relative path %q to absolute %q", repoPath, absRepoPath)
 		repo.path = absRepoPath
 
@@ -255,6 +263,7 @@ func (repo *Repo) prepareCloneDirectory(opts *CloneOptions) error {
 	// Clean up incomplete clones
 	if repo.shouldCleanupIncompleteClone() {
 		repo.logger.Debugf("The repo dir exists but %q does not. Removing the repo dir for cloning from the remote source.", cloneCompleteSentinel)
+
 		if err := os.RemoveAll(repo.path); err != nil {
 			return errors.New(err)
 		}
@@ -273,10 +282,14 @@ func (repo *Repo) extractRepoName() string {
 }
 
 func (repo *Repo) shouldCleanupIncompleteClone() bool {
-	return files.FileExists(repo.path) && !files.FileExists(filepath.Join(repo.path, cloneCompleteSentinel))
+	return files.FileExists(repo.path) && !repo.cloneCompleted()
+}
+
+func (repo *Repo) cloneCompleted() bool {
+	return files.FileExists(filepath.Join(repo.path, cloneCompleteSentinel))
 }
 
-func (repo *Repo) performClone(opts *CloneOptions) error {
+func (repo *Repo) performClone(ctx context.Context, opts *CloneOptions) error {
 	if repo.useCAS {
 		c, err := cas.New(opts.SourceURL, cas.Options{
 			Dir:              repo.path,
@@ -286,7 +299,7 @@ func (repo *Repo) performClone(opts *CloneOptions) error {
 			return err
 		}
 
-		if err := c.Clone(); err != nil {
+		if err := c.Clone(ctx); err != nil {
 			return err
 		}
 
@@ -315,7 +328,8 @@ func (repo *Repo) performClone(opts *CloneOptions) error {
 	if err := getter.Get(
 		repo.path,
 		strings.Trim(sourceURL.String(), "/"),
-		getter.WithContext(opts.Context),
+		// TODO: Resolve this context issue
+		getter.WithContext(opts.Context), //nolint:contextcheck
 		getter.WithMode(getter.ClientModeDir),
 	); err != nil {
 		return err

internal/cas/cas.go

@@ -6,6 +6,7 @@
 package cas
 
 import (
+	"context"
 	"crypto/sha1"
 	"encoding/hex"
 	"fmt"
@@ -73,7 +74,7 @@ func New(url string, opts Options) (*CAS, error) {
 }
 
 // Clone performs the clone operation
-func (c *CAS) Clone() error {
+func (c *CAS) Clone(ctx context.Context) error {
 	c.cloneLock.Lock()
 	defer c.cloneLock.Unlock()
 
@@ -118,7 +119,7 @@ func (c *CAS) Clone() error {
 		return err
 	}
 
-	if err := tree.LinkTree(c.store, targetDir); err != nil {
+	if err := tree.LinkTree(ctx, c.store, targetDir); err != nil {
 		return err
 	}
 

internal/cas/tree.go

@@ -92,8 +92,8 @@ func ParseTree(output, path string) (*Tree, error) {
 }
 
 // LinkTree writes the tree to a target directory
-func (t *Tree) LinkTree(store *Store, targetDir string) error {
-	ctx, cancel := context.WithCancel(context.Background())
+func (t *Tree) LinkTree(ctx context.Context, store *Store, targetDir string) error {
+	ctx, cancel := context.WithCancel(ctx)
 	defer cancel()
 
 	var (
@@ -165,7 +165,7 @@ func (t *Tree) LinkTree(store *Store, targetDir string) error {
 
 				subTargetDir := filepath.Join(targetDir, entry.Path)
 
-				if err := subTree.LinkTree(store, subTargetDir); err != nil {
+				if err := subTree.LinkTree(ctx, store, subTargetDir); err != nil {
 					errMu.Lock()
 					errs = append(errs, wrapError("link_subtree", subTargetDir, err))
 					errMu.Unlock()
@@ -179,6 +179,7 @@ func (t *Tree) LinkTree(store *Store, targetDir string) error {
 	wg.Wait()
 
 	if len(errs) > 0 {
+
 		return errors.Join(errs...)
 	}