databricks-cli/bundle/config/mutator/populate_locations.go

package mutator

import (
	"context"

	"github.com/databricks/cli/bundle"
	"github.com/databricks/cli/libs/diag"
	"github.com/databricks/cli/libs/dyn/dynloc"
)

type populateLocations struct{}

// PopulateLocations collects location information for the entire configuration tree
// and includes this as the [config.Root.Locations] property.
func PopulateLocations() bundle.Mutator {
	return &populateLocations{}
}

func (m *populateLocations) Name() string {
	return "PopulateLocations"
}

func (m *populateLocations) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics {
	locs, err := dynloc.Build(
		b.Config.Value(),

		// Make all paths relative to the bundle root.
		dynloc.WithBasePath(b.BundleRootPath),

		// Limit to maximum depth of 3.
		// The intent is to capture locations of all resources but not their configurations.
		dynloc.WithMaxDepth(3),
	)
	if err != nil {
		return diag.FromErr(err)
	}

	b.Config.Locations = &locs
	return nil
}