Add visual step for resolving repositories (#314)

* Add visual step for resolving repositories

Also fixes unsupported repositories aborting the workflow. We now simply skip those and let the user know.

* Use helper functions to print resolve-repos progress

* Add changelog entry

* Update CHANGELOG.md

Co-authored-by: Adam Harvey <[email protected]>

* Print which repositories are being skipped

Co-authored-by: Thorsten Ball <[email protected]>
Co-authored-by: Adam Harvey <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -20,6 +20,7 @@ All notable changes to `src-cli` are documented in this file.
 
 - Repositories without a default branch are skipped when applying/previewing a campaign spec. [#312](https://github.com/sourcegraph/src-cli/pull/312)
 - Log files produced when applying/previewing a campaign spec now have the `.log` file extension for easier opening. [#315](https://github.com/sourcegraph/src-cli/pull/315)
+- Campaign specs that apply to unsupported repositories will no longer generate an error. Instead, those repositories will be skipped by default and the campaign will be applied to the supported repositories only. [#314](https://github.com/sourcegraph/src-cli/pull/314)
 
 ### Fixed
 

cmd/src/campaigns_common.go

@@ -201,8 +201,26 @@ func campaignsExecute(ctx context.Context, out *output.Output, svc *campaigns.Se
 	}
 	imageProgress.Complete()
 
+	pending = campaignsCreatePending(out, "Resolving repositories")
+	repos, err := svc.ResolveRepositories(ctx, campaignSpec)
+	if err != nil {
+		if repoSet, ok := err.(campaigns.UnsupportedRepoSet); ok {
+			campaignsCompletePending(pending, "Resolved repositories.")
+
+			block := out.Block(output.Line(" ", output.StyleWarning, "Some repositories are hosted on unsupported code hosts and will be skipped. Use the -allow-unsupported flag to avoid skipping them."))
+			for repo := range repoSet {
+				block.Write(repo.Name)
+			}
+			block.Close()
+		} else {
+			return "", "", errors.Wrap(err, "resolving repositories")
+		}
+	} else {
+		campaignsCompletePending(pending, "Resolved repositories.")
+	}
+
 	var progress output.Progress
-	specs, err := svc.ExecuteCampaignSpec(ctx, executor, campaignSpec, func(statuses []*campaigns.TaskStatus) {
+	specs, err := svc.ExecuteCampaignSpec(ctx, repos, executor, campaignSpec, func(statuses []*campaigns.TaskStatus) {
 		if progress == nil {
 			progress = out.Progress([]output.ProgressBar{{
 				Label: "Executing steps",

internal/campaigns/errors.go

@@ -7,12 +7,12 @@ import (
 	"github.com/sourcegraph/src-cli/internal/campaigns/graphql"
 )
 
-// unsupportedRepoSet provides a set to manage repositories that are on
+// UnsupportedRepoSet provides a set to manage repositories that are on
 // unsupported code hosts. This type implements error to allow it to be
 // returned directly as an error value if needed.
-type unsupportedRepoSet map[*graphql.Repository]struct{}
+type UnsupportedRepoSet map[*graphql.Repository]struct{}
 
-func (e unsupportedRepoSet) Error() string {
+func (e UnsupportedRepoSet) Error() string {
 	repos := []string{}
 	typeSet := map[string]struct{}{}
 	for repo := range e {
@@ -32,10 +32,10 @@ func (e unsupportedRepoSet) Error() string {
 	)
 }
 
-func (e unsupportedRepoSet) appendRepo(repo *graphql.Repository) {
+func (e UnsupportedRepoSet) appendRepo(repo *graphql.Repository) {
 	e[repo] = struct{}{}
 }
 
-func (e unsupportedRepoSet) hasUnsupported() bool {
+func (e UnsupportedRepoSet) hasUnsupported() bool {
 	return len(e) > 0
 }

internal/campaigns/service.go

@@ -165,12 +165,7 @@ func (svc *Service) SetDockerImages(ctx context.Context, spec *CampaignSpec, pro
 	return nil
 }
 
-func (svc *Service) ExecuteCampaignSpec(ctx context.Context, x Executor, spec *CampaignSpec, progress func([]*TaskStatus)) ([]*ChangesetSpec, error) {
-	repos, err := svc.ResolveRepositories(ctx, spec)
-	if err != nil {
-		return nil, errors.Wrap(err, "resolving repositories")
-	}
-
+func (svc *Service) ExecuteCampaignSpec(ctx context.Context, repos []*graphql.Repository, x Executor, spec *CampaignSpec, progress func([]*TaskStatus)) ([]*ChangesetSpec, error) {
 	statuses := make([]*TaskStatus, 0, len(repos))
 	for _, repo := range repos {
 		ts := x.AddTask(repo, spec.Steps, spec.ChangesetTemplate)
@@ -290,7 +285,7 @@ func (svc *Service) ResolveNamespace(ctx context.Context, namespace string) (str
 func (svc *Service) ResolveRepositories(ctx context.Context, spec *CampaignSpec) ([]*graphql.Repository, error) {
 	final := []*graphql.Repository{}
 	seen := map[string]struct{}{}
-	unsupported := unsupportedRepoSet{}
+	unsupported := UnsupportedRepoSet{}
 
 	// TODO: this could be trivially parallelised in the future.
 	for _, on := range spec.On {
@@ -304,21 +299,23 @@ func (svc *Service) ResolveRepositories(ctx context.Context, spec *CampaignSpec)
 				if repo.DefaultBranch == nil {
 					continue
 				}
+				seen[repo.ID] = struct{}{}
 				switch st := strings.ToLower(repo.ExternalRepository.ServiceType); st {
 				case "github", "gitlab", "bitbucketserver":
-
 				default:
 					unsupported.appendRepo(repo)
+					if !svc.allowUnsupported {
+						continue
+					}
 				}
 
-				seen[repo.ID] = struct{}{}
 				final = append(final, repo)
 			}
 		}
 	}
 
 	if unsupported.hasUnsupported() && !svc.allowUnsupported {
-		return nil, unsupported
+		return final, unsupported
 	}
 
 	return final, nil