Decouple repository root resolver from internal logic

cmd/benchmark.go

@@ -25,6 +25,7 @@ import (
 	"github.com/elastic/elastic-package/internal/cobraext"
 	"github.com/elastic/elastic-package/internal/common"
 	"github.com/elastic/elastic-package/internal/elasticsearch"
+	"github.com/elastic/elastic-package/internal/files"
 	"github.com/elastic/elastic-package/internal/install"
 	"github.com/elastic/elastic-package/internal/logger"
 	"github.com/elastic/elastic-package/internal/packages"
@@ -302,6 +303,11 @@ func rallyCommandAction(cmd *cobra.Command, args []string) error {
 		}
 	}
 
+	repoRoot, err := files.FindRepositoryRoot()
+	if err != nil {
+		return fmt.Errorf("locating repository root failed: %w", err)
+	}
+
 	profile, err := cobraext.GetProfileFlag(cmd)
 	if err != nil {
 		return err
@@ -336,6 +342,7 @@ func rallyCommandAction(cmd *cobra.Command, args []string) error {
 		rally.WithRallyDryRun(rallyDryRun),
 		rally.WithRallyPackageFromRegistry(packageName, packageVersion),
 		rally.WithRallyCorpusAtPath(corpusAtPath),
+		rally.WithRepoRoot(repoRoot),
 	}
 
 	esMetricsClient, err := initializeESMetricsClient(ctx)
@@ -473,6 +480,11 @@ func streamCommandAction(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("locating package root failed: %w", err)
 	}
 
+	repoRoot, err := files.FindRepositoryRoot()
+	if err != nil {
+		return fmt.Errorf("locating repository root failed: %w", err)
+	}
+
 	profile, err := cobraext.GetProfileFlag(cmd)
 	if err != nil {
 		return err
@@ -507,6 +519,7 @@ func streamCommandAction(cmd *cobra.Command, args []string) error {
 		stream.WithESAPI(esClient.API),
 		stream.WithKibanaClient(kc),
 		stream.WithProfile(profile),
+		stream.WithRepoRoot(repoRoot),
 	}
 
 	runner := stream.NewStreamBenchmark(stream.NewOptions(withOpts...))

cmd/build.go

@@ -61,6 +61,17 @@ func buildCommandAction(cmd *cobra.Command, args []string) error {
 		}
 	}
 
+	repoRoot, err := files.FindRepositoryRoot()
+	if err != nil {
+		return fmt.Errorf("locating repository root failed: %w", err)
+	}
+	defer repoRoot.Close()
+
+	linksFilePath, err := docs.LinksDefinitionsFilePath(repoRoot)
+	if err != nil {
+		return fmt.Errorf("locating links file failed: %w", err)
+	}
+
 	packageRoot, err := packages.MustFindPackageRoot()
 	if err != nil {
 		return fmt.Errorf("locating package root failed: %w", err)
@@ -72,7 +83,7 @@ func buildCommandAction(cmd *cobra.Command, args []string) error {
 	}
 	logger.Debugf("Use build directory: %s", buildDir)
 
-	targets, err := docs.UpdateReadmes(packageRoot, buildDir)
+	targets, err := docs.UpdateReadmes(linksFilePath, packageRoot, buildDir)
 	if err != nil {
 		return fmt.Errorf("updating files failed: %w", err)
 	}
@@ -88,6 +99,7 @@ func buildCommandAction(cmd *cobra.Command, args []string) error {
 		CreateZip:      createZip,
 		SignPackage:    signPackage,
 		SkipValidation: skipValidation,
+		RepoRoot:       repoRoot,
 	})
 	if err != nil {
 		return fmt.Errorf("building package failed: %w", err)

cmd/install.go

@@ -11,6 +11,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/elastic/elastic-package/internal/cobraext"
+	"github.com/elastic/elastic-package/internal/files"
 	"github.com/elastic/elastic-package/internal/install"
 	"github.com/elastic/elastic-package/internal/kibana"
 	"github.com/elastic/elastic-package/internal/packages"
@@ -82,11 +83,17 @@ func installCommandAction(cmd *cobra.Command, _ []string) error {
 		}
 	}
 
+	repoRoot, err := files.FindRepositoryRoot()
+	if err != nil {
+		return fmt.Errorf("locating repository root failed: %w", err)
+	}
+
 	installer, err := installer.NewForPackage(cmd.Context(), installer.Options{
 		Kibana:         kibanaClient,
 		RootPath:       packageRootPath,
 		SkipValidation: skipValidation,
 		ZipPath:        zipPathFile,
+		RepoRoot:       repoRoot,
 	})
 	if err != nil {
 		return fmt.Errorf("package installation failed: %w", err)

cmd/links.go

@@ -7,7 +7,6 @@ package cmd
 import (
 	"fmt"
 	"os"
-	"path/filepath"
 
 	"github.com/spf13/cobra"
 
@@ -56,8 +55,14 @@ func linksCheckCommandAction(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return fmt.Errorf("reading current working directory failed: %w", err)
 	}
+	// Find the repository root to create the links filesystem reference tied to the repository root
+	repoRoot, err := files.FindRepositoryRoot()
+	if err != nil {
+		return fmt.Errorf("finding repository root: %w", err)
+	}
+	defer repoRoot.Close()
 
-	linksFS, err := files.CreateLinksFSFromPath(pwd)
+	linksFS, err := files.CreateLinksFSFromPath(repoRoot, pwd)
 	if err != nil {
 		return fmt.Errorf("creating links filesystem failed: %w", err)
 	}
@@ -68,7 +73,7 @@ func linksCheckCommandAction(cmd *cobra.Command, args []string) error {
 	}
 	for _, f := range linkedFiles {
 		if !f.UpToDate {
-			cmd.Printf("%s is outdated.\n", filepath.Join(f.WorkDir, f.LinkFilePath))
+			cmd.Printf("%s is outdated.\n", f.LinkFilePath)
 		}
 	}
 	if len(linkedFiles) > 0 {
@@ -95,7 +100,14 @@ func linksUpdateCommandAction(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("reading current working directory failed: %w", err)
 	}
 
-	linksFS, err := files.CreateLinksFSFromPath(pwd)
+	// Find the repository root to create the links filesystem reference tied to the repository root
+	repoRoot, err := files.FindRepositoryRoot()
+	if err != nil {
+		return fmt.Errorf("finding repository root: %w", err)
+	}
+	defer repoRoot.Close()
+
+	linksFS, err := files.CreateLinksFSFromPath(repoRoot, pwd)
 	if err != nil {
 		return fmt.Errorf("creating links filesystem failed: %w", err)
 	}
@@ -135,7 +147,14 @@ func linksListCommandAction(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("reading current working directory failed: %w", err)
 	}
 
-	linksFS, err := files.CreateLinksFSFromPath(pwd)
+	// Find the repository root to create the links filesystem reference tied to the repository root
+	repoRoot, err := files.FindRepositoryRoot()
+	if err != nil {
+		return fmt.Errorf("finding repository root: %w", err)
+	}
+	defer repoRoot.Close()
+
+	linksFS, err := files.CreateLinksFSFromPath(repoRoot, pwd)
 	if err != nil {
 		return fmt.Errorf("creating links filesystem failed: %w", err)
 	}

cmd/lint.go

@@ -12,6 +12,7 @@ import (
 
 	"github.com/elastic/elastic-package/internal/cobraext"
 	"github.com/elastic/elastic-package/internal/docs"
+	"github.com/elastic/elastic-package/internal/files"
 	"github.com/elastic/elastic-package/internal/logger"
 	"github.com/elastic/elastic-package/internal/packages"
 	"github.com/elastic/elastic-package/internal/validation"
@@ -45,7 +46,19 @@ func setupLintCommand() *cobraext.Command {
 
 func lintCommandAction(cmd *cobra.Command, args []string) error {
 	cmd.Println("Lint the package")
-	readmeFiles, err := docs.AreReadmesUpToDate()
+
+	repoRoot, err := files.FindRepositoryRoot()
+	if err != nil {
+		return fmt.Errorf("locating repository root failed: %w", err)
+	}
+	defer repoRoot.Close()
+
+	linksFilePath, err := docs.LinksDefinitionsFilePath(repoRoot)
+	if err != nil {
+		return fmt.Errorf("locating links file failed: %w", err)
+	}
+
+	readmeFiles, err := docs.AreReadmesUpToDate(linksFilePath)
 	if err != nil {
 		for _, f := range readmeFiles {
 			if !f.UpToDate {

cmd/testrunner.go

@@ -17,6 +17,7 @@ import (
 
 	"github.com/elastic/elastic-package/internal/cobraext"
 	"github.com/elastic/elastic-package/internal/common"
+	"github.com/elastic/elastic-package/internal/files"
 	"github.com/elastic/elastic-package/internal/install"
 	"github.com/elastic/elastic-package/internal/logger"
 	"github.com/elastic/elastic-package/internal/packages"
@@ -153,6 +154,11 @@ func testRunnerAssetCommandAction(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("locating package root failed: %w", err)
 	}
 
+	repoRoot, err := files.FindRepositoryRoot()
+	if err != nil {
+		return fmt.Errorf("locating repository root failed: %w", err)
+	}
+
 	manifest, err := packages.ReadPackageManifestFromPackageRoot(packageRootPath)
 	if err != nil {
 		return fmt.Errorf("reading package manifest failed (path: %s): %w", packageRootPath, err)
@@ -177,6 +183,7 @@ func testRunnerAssetCommandAction(cmd *cobra.Command, args []string) error {
 		GlobalTestConfig: globalTestConfig.Asset,
 		WithCoverage:     testCoverage,
 		CoverageType:     testCoverageFormat,
+		RepoRoot:         repoRoot,
 	})
 
 	results, err := testrunner.RunSuite(ctx, runner)
@@ -494,6 +501,11 @@ func testRunnerSystemCommandAction(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("locating package root failed: %w", err)
 	}
 
+	repoRoot, err := files.FindRepositoryRoot()
+	if err != nil {
+		return fmt.Errorf("locating repository root failed: %w", err)
+	}
+
 	runSetup, err := cmd.Flags().GetBool(cobraext.SetupFlagName)
 	if err != nil {
 		return cobraext.FlagParsingError(err, cobraext.SetupFlagName)
@@ -578,6 +590,7 @@ func testRunnerSystemCommandAction(cmd *cobra.Command, args []string) error {
 		GlobalTestConfig:   globalTestConfig.System,
 		WithCoverage:       testCoverage,
 		CoverageType:       testCoverageFormat,
+		RepoRoot:           repoRoot,
 	})
 
 	logger.Debugf("Running suite...")
@@ -658,6 +671,10 @@ func testRunnerPolicyCommandAction(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return fmt.Errorf("locating package root failed: %w", err)
 	}
+	repoRoot, err := files.FindRepositoryRoot()
+	if err != nil {
+		return fmt.Errorf("locating repository root failed: %w", err)
+	}
 
 	dataStreams, err := getDataStreamsFlag(cmd, packageRootPath)
 	if err != nil {
@@ -691,6 +708,7 @@ func testRunnerPolicyCommandAction(cmd *cobra.Command, args []string) error {
 		GlobalTestConfig:   globalTestConfig.Policy,
 		WithCoverage:       testCoverage,
 		CoverageType:       testCoverageFormat,
+		RepoRoot:           repoRoot,
 	})
 
 	results, err := testrunner.RunSuite(ctx, runner)

internal/benchrunner/runners/rally/options.go

@@ -5,6 +5,7 @@
 package rally
 
 import (
+	"os"
 	"time"
 
 	"github.com/elastic/elastic-package/internal/elasticsearch"
@@ -29,6 +30,7 @@ type Options struct {
 	PackageName         string
 	PackageVersion      string
 	CorpusAtPath        string
+	RepoRoot            *os.Root
 }
 
 type ClientOptions struct {
@@ -118,3 +120,9 @@ func WithRallyCorpusAtPath(c string) OptionFunc {
 		opts.CorpusAtPath = c
 	}
 }
+
+func WithRepoRoot(r *os.Root) OptionFunc {
+	return func(opts *Options) {
+		opts.RepoRoot = r
+	}
+}

internal/benchrunner/runners/rally/runner.go

@@ -489,6 +489,7 @@ func (r *runner) installPackageFromPackageRoot(ctx context.Context) error {
 		Kibana:         r.options.KibanaClient,
 		RootPath:       r.options.PackageRootPath,
 		SkipValidation: true,
+		RepoRoot:       r.options.RepoRoot,
 	})
 	if err != nil {
 		return fmt.Errorf("failed to initialize package installer: %w", err)

internal/benchrunner/runners/stream/options.go

@@ -5,6 +5,7 @@
 package stream
 
 import (
+	"os"
 	"time"
 
 	"github.com/elastic/elastic-package/internal/elasticsearch"
@@ -25,6 +26,7 @@ type Options struct {
 	PackageRootPath string
 	Variant         string
 	Profile         *profile.Profile
+	RepoRoot        *os.Root
 }
 
 type ClientOptions struct {
@@ -107,3 +109,9 @@ func WithTimestampField(t string) OptionFunc {
 		opts.TimestampField = t
 	}
 }
+
+func WithRepoRoot(r *os.Root) OptionFunc {
+	return func(opts *Options) {
+		opts.RepoRoot = r
+	}
+}

internal/benchrunner/runners/stream/runner.go

@@ -256,6 +256,7 @@ func (r *runner) installPackageFromPackageRoot(ctx context.Context) error {
 		Kibana:         r.options.KibanaClient,
 		RootPath:       r.options.PackageRootPath,
 		SkipValidation: true,
+		RepoRoot:       r.options.RepoRoot,
 	})
 
 	if err != nil {