Add -skip-errors flag to src campaign apply|preview (#395)

* Add -skip-errors flag to src campaign apply|preview

* Fix formatting of errors

* Add notice

* Remove notice

* Add changelog entry

Author: mrnugget

CHANGELOG.md

@@ -14,6 +14,7 @@ All notable changes to `src-cli` are documented in this file.
 ### Added
 
 - Campaign steps may now include environment variables from outside of the campaign spec using [array syntax](http://docs.sourcegraph.com/campaigns/references/campaign_spec_yaml_reference#environment-array). [#392](https://github.com/sourcegraph/src-cli/pull/392)
+- A new `-skip-errors` flag has been added to `src campaign [apply|preview]` to allow users to continue execution of and upload a campaign spec even if execution failed in some repositories. [#395](https://github.com/sourcegraph/src-cli/pull/395)
 
 ### Changed
 

cmd/src/campaigns_apply.go

@@ -78,6 +78,7 @@ Examples:
 
 		if err := doApply(ctx, out, svc, flags); err != nil {
 			printExecutionError(out, err)
+			out.Write("")
 			return &exitCodeError{nil, 1}
 		}
 

cmd/src/campaigns_common.go

@@ -42,6 +42,7 @@ type campaignsApplyFlags struct {
 	parallelism      int
 	timeout          time.Duration
 	cleanArchives    bool
+	skipErrors       bool
 }
 
 func newCampaignsApplyFlags(flagSet *flag.FlagSet, cacheDir, tempDir string) *campaignsApplyFlags {
@@ -95,6 +96,10 @@ func newCampaignsApplyFlags(flagSet *flag.FlagSet, cacheDir, tempDir string) *ca
 		&caf.cleanArchives, "clean-archives", true,
 		"If true, deletes downloaded repository archives after executing campaign steps.",
 	)
+	flagSet.BoolVar(
+		&caf.skipErrors, "skip-errors", false,
+		"If true, errors encountered while executing steps in a repository won't stop the execution of the campaign spec but only cause that repository to be skipped.",
+	)
 
 	flagSet.BoolVar(verbose, "v", false, "print verbose output")
 
@@ -235,11 +240,16 @@ func campaignsExecute(ctx context.Context, out *output.Output, svc *campaigns.Se
 	}
 
 	p := newCampaignProgressPrinter(out, *verbose, opts.Parallelism)
-	specs, err := svc.ExecuteCampaignSpec(ctx, repos, executor, campaignSpec, p.PrintStatuses)
-	if err != nil {
+	specs, err := svc.ExecuteCampaignSpec(ctx, repos, executor, campaignSpec, p.PrintStatuses, flags.skipErrors)
+	if err != nil && !flags.skipErrors {
 		return "", "", err
+
 	}
 	p.Complete()
+	if err != nil && flags.skipErrors {
+		printExecutionError(out, err)
+		out.WriteLine(output.Line(output.EmojiWarning, output.StyleWarning, "Skipping errors because -skip-errors was used."))
+	}
 
 	if logFiles := executor.LogFiles(); len(logFiles) > 0 && flags.keepLogs {
 		func() {
@@ -317,40 +327,54 @@ func campaignsParseSpec(out *output.Output, svc *campaigns.Service, input io.Rea
 func printExecutionError(out *output.Output, err error) {
 	out.Write("")
 
-	writeErr := func(block *output.Block, err error) {
-		if block == nil {
-			return
-		}
+	writeErrs := func(errs []error) {
+		var block *output.Block
 
-		if taskErr, ok := err.(campaigns.TaskExecutionErr); ok {
-			block.Write(formatTaskExecutionErr(taskErr))
+		if len(errs) > 1 {
+			block = out.Block(output.Linef(output.EmojiFailure, output.StyleWarning, "%d errors:", len(errs)))
 		} else {
-			block.Write(err.Error())
+			block = out.Block(output.Line(output.EmojiFailure, output.StyleWarning, "Error:"))
+		}
+
+		for _, e := range errs {
+			if taskErr, ok := e.(campaigns.TaskExecutionErr); ok {
+				block.Write(formatTaskExecutionErr(taskErr))
+			} else {
+				block.Writef("%s%s", output.StyleBold, e.Error())
+			}
+		}
+
+		if block != nil {
+			block.Close()
 		}
 	}
 
-	var block *output.Block
-	singleErrHeader := output.Line(output.EmojiFailure, output.StyleWarning, "Error:")
+	switch err := err.(type) {
+	case parallel.Errors, *multierror.Error:
+		writeErrs(flattenErrs(err))
 
-	if parErr, ok := err.(parallel.Errors); ok {
-		if len(parErr) > 1 {
-			block = out.Block(output.Linef(output.EmojiFailure, output.StyleWarning, "%d errors:", len(parErr)))
-		} else {
-			block = out.Block(singleErrHeader)
+	default:
+		writeErrs([]error{err})
+	}
+
+}
+
+func flattenErrs(err error) (result []error) {
+	switch errs := err.(type) {
+	case parallel.Errors:
+		for _, e := range errs {
+			result = append(result, flattenErrs(e)...)
 		}
 
-		for _, e := range parErr {
-			writeErr(block, e)
+	case *multierror.Error:
+		for _, e := range errs.Errors {
+			result = append(result, flattenErrs(e)...)
 		}
-	} else {
-		block = out.Block(singleErrHeader)
-		writeErr(block, err)
+	default:
+		result = append(result, errs)
 	}
 
-	if block != nil {
-		block.Close()
-	}
-	out.Write("")
+	return result
 }
 
 func formatTaskExecutionErr(err campaigns.TaskExecutionErr) string {

cmd/src/campaigns_preview.go

@@ -54,6 +54,7 @@ Examples:
 		_, url, err := campaignsExecute(ctx, out, svc, flags)
 		if err != nil {
 			printExecutionError(out, err)
+			out.Write("")
 			return &exitCodeError{nil, 1}
 		}
 

internal/campaigns/service.go

@@ -12,6 +12,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/hashicorp/go-multierror"
 	"github.com/pkg/errors"
 	"github.com/sourcegraph/src-cli/internal/api"
 	"github.com/sourcegraph/src-cli/internal/campaigns/graphql"
@@ -215,7 +216,7 @@ func (svc *Service) SetDockerImages(ctx context.Context, spec *CampaignSpec, pro
 	return nil
 }
 
-func (svc *Service) ExecuteCampaignSpec(ctx context.Context, repos []*graphql.Repository, x Executor, spec *CampaignSpec, progress func([]*TaskStatus)) ([]*ChangesetSpec, error) {
+func (svc *Service) ExecuteCampaignSpec(ctx context.Context, repos []*graphql.Repository, x Executor, spec *CampaignSpec, progress func([]*TaskStatus), skipErrors bool) ([]*ChangesetSpec, error) {
 	statuses := make([]*TaskStatus, 0, len(repos))
 	for _, repo := range repos {
 		ts := x.AddTask(repo, spec.Steps, spec.ChangesetTemplate)
@@ -242,21 +243,33 @@ func (svc *Service) ExecuteCampaignSpec(ctx context.Context, repos []*graphql.Re
 		}()
 	}
 
+	var errs *multierror.Error
+
 	x.Start(ctx)
 	specs, err := x.Wait()
 	if progress != nil {
 		progress(statuses)
 		done <- struct{}{}
 	}
 	if err != nil {
-		return nil, err
+		if skipErrors {
+			errs = multierror.Append(errs, err)
+		} else {
+			return nil, err
+		}
 	}
 
 	// Add external changeset specs.
 	for _, ic := range spec.ImportChangesets {
 		repo, err := svc.resolveRepositoryName(ctx, ic.Repository)
 		if err != nil {
-			return nil, errors.Wrapf(err, "resolving repository name %q", ic.Repository)
+			wrapped := errors.Wrapf(err, "resolving repository name %q", ic.Repository)
+			if skipErrors {
+				errs = multierror.Append(errs, wrapped)
+				continue
+			} else {
+				return nil, wrapped
+			}
 		}
 
 		for _, id := range ic.ExternalIDs {
@@ -284,7 +297,7 @@ func (svc *Service) ExecuteCampaignSpec(ctx context.Context, repos []*graphql.Re
 		}
 	}
 
-	return specs, nil
+	return specs, errs.ErrorOrNil()
 }
 
 func (svc *Service) ParseCampaignSpec(in io.Reader) (*CampaignSpec, string, error) {