Add PipelinePicker to ResolveFromRepository (#245)

* Add picker argument to resolver * Update resolver to use the picker * Add documentation for ResolveFromRepository * Add docs for PipelinePicker * Simplify * Add picker to config resolver
buildkite · May 13, 2024 · 1018ed9 · 1018ed9
1 parent ea8864b
commit 1018ed9
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 24 deletions.
diff --git a/internal/pipeline/resolver/config.go b/internal/pipeline/resolver/config.go
@@ -7,14 +7,14 @@ import (
 	"github.com/buildkite/cli/v3/internal/pipeline"
 )
 
-func ResolveFromConfig(conf *config.Config) PipelineResolverFn {
+func ResolveFromConfig(conf *config.Config, picker PipelinePicker) PipelineResolverFn {
 	return func(context.Context) (*pipeline.Pipeline, error) {
-		preferredPipelines := conf.PreferredPipelines()
+		pipelines := conf.PreferredPipelines()
 
-		if len(preferredPipelines) == 0 {
+		if len(pipelines) == 0 {
 			return nil, nil
 		}
 
-		return &preferredPipelines[0], nil
+		return picker(pipelines), nil
 	}
 }
diff --git a/internal/pipeline/resolver/config_test.go b/internal/pipeline/resolver/config_test.go
@@ -16,7 +16,7 @@ func TestResolvePipelineFromConfig(t *testing.T) {
 		t.Parallel()
 
 		conf := config.New(afero.NewMemMapFs(), nil)
-		resolve := ResolveFromConfig(conf)
+		resolve := ResolveFromConfig(conf, PassthruPicker)
 		selected, err := resolve(context.Background())
 		if err != nil {
 			t.Errorf("failed to resolve from config")
@@ -33,7 +33,7 @@ func TestResolvePipelineFromConfig(t *testing.T) {
 		pipelines := []pipeline.Pipeline{{Name: "pipeline1"}}
 		conf := config.New(afero.NewMemMapFs(), nil)
 		conf.SetPreferredPipelines(pipelines)
-		resolve := ResolveFromConfig(conf)
+		resolve := ResolveFromConfig(conf, PassthruPicker)
 		selected, err := resolve(context.Background())
 		if err != nil {
 			t.Errorf("failed to resolve from config")
@@ -54,7 +54,7 @@ func TestResolvePipelineFromConfig(t *testing.T) {
 		pipelines := []pipeline.Pipeline{{Name: "pipeline1"}, {Name: "pipeline2"}, {Name: "pipeline3"}}
 		conf := config.New(afero.NewMemMapFs(), nil)
 		conf.SetPreferredPipelines(pipelines)
-		resolve := ResolveFromConfig(conf)
+		resolve := ResolveFromConfig(conf, PassthruPicker)
 		selected, err := resolve(context.Background())
 		if err != nil {
 			t.Errorf("failed to resolve from config")

diff --git a/internal/pipeline/resolver/picker.go b/internal/pipeline/resolver/picker.go
@@ -7,6 +7,9 @@ import (
 	"github.com/buildkite/cli/v3/internal/pipeline"
 )
 
+// PipelinePicker is a function used to pick a pipeline from a list.
+//
+// It is indended to be used from pipeline resolvers that resolve multiple pipelines.
 type PipelinePicker func([]pipeline.Pipeline) *pipeline.Pipeline
 
 func PassthruPicker(p []pipeline.Pipeline) *pipeline.Pipeline {

diff --git a/internal/pipeline/resolver/repository.go b/internal/pipeline/resolver/repository.go
@@ -11,7 +11,11 @@ import (
 	"github.com/go-git/go-git/v5"
 )
 
-func ResolveFromRepository(f *factory.Factory) PipelineResolverFn {
+// ResolveFromRepository finds pipelines based on the current repository.
+//
+// It queries the API for all pipelines in the organization that match the repository's URL.
+// It delegates picking one from the list of matches to the `picker`.
+func ResolveFromRepository(f *factory.Factory, picker PipelinePicker) PipelineResolverFn {
 	return func(context.Context) (*pipeline.Pipeline, error) {
 		pipelines, err := resolveFromRepository(f)
 		if err != nil {
@@ -21,23 +25,20 @@ func ResolveFromRepository(f *factory.Factory) PipelineResolverFn {
 			return nil, nil
 		}
 
-		return &pipeline.Pipeline{
-			Name: pipelines[0],
-			Org:  f.Config.OrganizationSlug(),
-		}, nil
+		return picker(pipelines), nil
 	}
 }
 
-func resolveFromRepository(f *factory.Factory) ([]string, error) {
+func resolveFromRepository(f *factory.Factory) ([]pipeline.Pipeline, error) {
 	repos, err := getRepoURLs(f.GitRepository)
 	if err != nil {
 		return nil, err
 	}
 	return filterPipelines(repos, f.Config.OrganizationSlug(), f.RestAPIClient)
 }
 
-func filterPipelines(repoURLs []string, org string, client *buildkite.Client) ([]string, error) {
-	var currentPipelines []string
+func filterPipelines(repoURLs []string, org string, client *buildkite.Client) ([]pipeline.Pipeline, error) {
+	var currentPipelines []pipeline.Pipeline
 	page := 1
 	per_page := 30
 	for more_pipelines := true; more_pipelines; {
@@ -56,7 +57,7 @@ func filterPipelines(repoURLs []string, org string, client *buildkite.Client) ([
 			for _, u := range repoURLs {
 				gitUrl := u[strings.LastIndex(u, "/")+1:]
 				if strings.Contains(*p.Repository, gitUrl) {
-					currentPipelines = append(currentPipelines, *p.Slug)
+					currentPipelines = append(currentPipelines, pipeline.Pipeline{Name: *p.Slug, Org: org})
 				}
 			}
 		}

diff --git a/pkg/cmd/build/cancel.go b/pkg/cmd/build/cancel.go
@@ -32,8 +32,8 @@ func NewCmdBuildCancel(f *factory.Factory) *cobra.Command {
 			buildId := args[0]
 			resolvers := resolver.NewAggregateResolver(
 				resolver.ResolveFromPositionalArgument(args, 1, f.Config),
-				resolver.ResolveFromConfig(f.Config),
-				resolver.ResolveFromRepository(f),
+				resolver.ResolveFromConfig(f.Config, resolver.PassthruPicker),
+				resolver.ResolveFromRepository(f, resolver.PassthruPicker),
 			)
 			var pipeline pipeline.Pipeline
 			r := io.NewPendingCommand(func() tea.Msg {

diff --git a/pkg/cmd/build/new.go b/pkg/cmd/build/new.go
@@ -35,8 +35,8 @@ func NewCmdBuildNew(f *factory.Factory) *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			resolvers := resolver.NewAggregateResolver(
 				resolver.ResolveFromPositionalArgument(args, 0, f.Config),
-				resolver.ResolveFromConfig(f.Config),
-				resolver.ResolveFromRepository(f),
+				resolver.ResolveFromConfig(f.Config, resolver.PassthruPicker),
+				resolver.ResolveFromRepository(f, resolver.PassthruPicker),
 			)
 			var pipeline pipeline.Pipeline
 			r := io.NewPendingCommand(func() tea.Msg {

diff --git a/pkg/cmd/build/rebuild.go b/pkg/cmd/build/rebuild.go
@@ -32,8 +32,8 @@ func NewCmdBuildRebuild(f *factory.Factory) *cobra.Command {
 			buildId := args[0]
 			resolvers := resolver.NewAggregateResolver(
 				resolver.ResolveFromPositionalArgument(args, 1, f.Config),
-				resolver.ResolveFromConfig(f.Config),
-				resolver.ResolveFromRepository(f),
+				resolver.ResolveFromConfig(f.Config, resolver.PassthruPicker),
+				resolver.ResolveFromRepository(f, resolver.PassthruPicker),
 			)
 			var pipeline pipeline.Pipeline
 			r := io.NewPendingCommand(func() tea.Msg {

diff --git a/pkg/cmd/build/view.go b/pkg/cmd/build/view.go
@@ -42,8 +42,8 @@ func NewCmdBuildView(f *factory.Factory) *cobra.Command {
 
 			resolvers := resolver.NewAggregateResolver(
 				resolver.ResolveFromPositionalArgument(args, 1, f.Config),
-				resolver.ResolveFromConfig(f.Config),
-				resolver.ResolveFromRepository(f),
+				resolver.ResolveFromConfig(f.Config, resolver.PassthruPicker),
+				resolver.ResolveFromRepository(f, resolver.PassthruPicker),
 			)
 
 			var pipeline pipeline.Pipeline