Add support for templated campaign specs

Author: mrnugget

internal/campaigns/executor_test.go

@@ -93,6 +93,23 @@ func TestExecutor_Integration(t *testing.T) {
 			executorTimeout: 20 * time.Millisecond,
 			wantErrInclude:  "execution in github.com/sourcegraph/src-cli failed: Timeout reached. Execution took longer than 20ms.",
 		},
+		{
+			name:  "templated",
+			repos: []*graphql.Repository{srcCLIRepo},
+			archives: []mockRepoArchive{
+				{repo: srcCLIRepo, files: map[string]string{
+					"README.md": "# Welcome to the README\n",
+					"main.go":   "package main\n\nfunc main() {\n\tfmt.Println(     \"Hello World\")\n}\n",
+				}},
+			},
+			steps: []Step{
+				{Run: `go fmt main.go`, Container: "doesntmatter:13"},
+				{Run: `touch modified-${{ modified_files }}.md`, Container: "alpine:13"},
+			},
+			wantFilesChanged: map[string][]string{
+				srcCLIRepo.ID: []string{"main.go", "modified-main.go.md"},
+			},
+		},
 	}
 
 	for _, tc := range tests {
@@ -149,6 +166,7 @@ func TestExecutor_Integration(t *testing.T) {
 					t.Fatalf("wrong number of commits. want=%d, have=%d", want, have)
 				}
 
+				t.Logf("diff=%s\n", spec.Commits[0].Diff)
 				fileDiffs, err := diff.ParseMultiFileDiff([]byte(spec.Commits[0].Diff))
 				if err != nil {
 					t.Fatalf("failed to parse diff: %s", err)
@@ -165,8 +183,13 @@ func TestExecutor_Integration(t *testing.T) {
 
 				diffsByName := map[string]*diff.FileDiff{}
 				for _, fd := range fileDiffs {
-					diffsByName[fd.OrigName] = fd
+					if fd.NewName == "/dev/null" {
+						diffsByName[fd.OrigName] = fd
+					} else {
+						diffsByName[fd.NewName] = fd
+					}
 				}
+
 				for _, file := range wantFiles {
 					if _, ok := diffsByName[file]; !ok {
 						t.Errorf("%s was not changed", file)

internal/campaigns/run_steps.go

@@ -10,6 +10,7 @@ import (
 	"os"
 	"os/exec"
 	"strings"
+	"text/template"
 	"time"
 
 	"github.com/hashicorp/go-multierror"
@@ -57,6 +58,8 @@ func runSteps(ctx context.Context, wc *WorkspaceCreator, repo *graphql.Repositor
 		return nil, errors.Wrap(err, "git commit failed")
 	}
 
+	results := make([]StepResult, len(steps))
+
 	for i, step := range steps {
 		logger.Logf("[Step %d] docker run %s %q", i+1, step.Container, step.Run)
 
@@ -89,8 +92,18 @@ func runSteps(ctx context.Context, wc *WorkspaceCreator, repo *graphql.Repositor
 		}
 		hostTemp := fp.Name()
 		defer os.Remove(hostTemp)
-		if _, err := fp.WriteString(step.Run); err != nil {
-			return nil, errors.Wrapf(err, "writing to temporary file %q", hostTemp)
+
+		stepContext := StepContext{Repository: repo}
+		if i > 0 {
+			stepContext.PreviousStep = results[i-1]
+		}
+		tmpl, err := parseStepRun(stepContext, step.Run)
+		if err != nil {
+			return nil, errors.Wrap(err, "parsing step run")
+		}
+
+		if err := tmpl.Execute(fp, stepContext); err != nil {
+			return nil, errors.Wrap(err, "executing template")
 		}
 		fp.Close()
 
@@ -137,10 +150,22 @@ func runSteps(ctx context.Context, wc *WorkspaceCreator, repo *graphql.Repositor
 		}
 
 		logger.Logf("[Step %d] complete in %s", i+1, elapsed)
-	}
 
-	if _, err := runGitCmd("add", "--all"); err != nil {
-		return nil, errors.Wrap(err, "git add failed")
+		if _, err := runGitCmd("add", "--all"); err != nil {
+			return nil, errors.Wrap(err, "git add failed")
+		}
+
+		statusOut, err := runGitCmd("status", "--porcelain")
+		if err != nil {
+			return nil, errors.Wrap(err, "git status failed")
+		}
+
+		changes, err := parseGitStatus(statusOut)
+		if err != nil {
+			return nil, errors.Wrap(err, "parsing git status output")
+		}
+
+		results[i] = StepResult{Changes: changes}
 	}
 
 	// As of Sourcegraph 3.14 we only support unified diff format.
@@ -157,6 +182,67 @@ func runSteps(ctx context.Context, wc *WorkspaceCreator, repo *graphql.Repositor
 	return diffOut, err
 }
 
+func parseStepRun(stepCtx StepContext, run string) (*template.Template, error) {
+	t := template.New("step-run").Delims("${{", "}}")
+
+	funcMap := template.FuncMap{
+		"repository_name": func() string { return stepCtx.Repository.Name },
+	}
+
+	funcMap["modified_files"] = stepCtx.PreviousStep.ModifiedFiles
+
+	t.Funcs(funcMap)
+
+	return t.Parse(run)
+}
+
+type StepContext struct {
+	PreviousStep StepResult
+	Repository   *graphql.Repository
+}
+
+type StepChanges struct {
+	Modified []string
+	Added    []string
+	Deleted  []string
+}
+
+type StepResult struct {
+	Changes StepChanges
+}
+
+func (r StepResult) ModifiedFiles() string { return strings.Join(r.Changes.Modified, " ") }
+func (r StepResult) AddedFiles() string    { return strings.Join(r.Changes.Added, " ") }
+func (r StepResult) DeletedFiles() string  { return strings.Join(r.Changes.Deleted, " ") }
+
+func parseGitStatus(out []byte) (StepChanges, error) {
+	result := StepChanges{}
+
+	stripped := strings.TrimSpace(string(out))
+	if len(stripped) == 0 {
+		return result, nil
+	}
+
+	for _, line := range strings.Split(stripped, "\n") {
+		if len(line) < 4 {
+			return result, fmt.Errorf("git status line has unrecognized format: %q", line)
+		}
+
+		file := line[3:len(line)]
+
+		switch line[0] {
+		case 'M':
+			result.Modified = append(result.Modified, file)
+		case 'A':
+			result.Added = append(result.Added, file)
+		case 'D':
+			result.Deleted = append(result.Deleted, file)
+		}
+	}
+
+	return result, nil
+}
+
 func probeImageForShell(ctx context.Context, image string) (shell, tempfile string, err error) {
 	// We need to know two things to be able to run a shell script:
 	//

internal/campaigns/run_steps_test.go

@@ -0,0 +1,80 @@
+package campaigns
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+	"github.com/sourcegraph/src-cli/internal/campaigns/graphql"
+)
+
+func TestParseGitStatus(t *testing.T) {
+	const input = `M  README.md
+M  another_file.go
+A  new_file.txt
+A  barfoo/new_file.txt
+D  to_be_deleted.txt
+`
+	parsed, err := parseGitStatus([]byte(input))
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	want := StepChanges{
+		Modified: []string{"README.md", "another_file.go"},
+		Added:    []string{"new_file.txt", "barfoo/new_file.txt"},
+		Deleted:  []string{"to_be_deleted.txt"},
+	}
+
+	if !cmp.Equal(want, parsed) {
+		t.Fatalf("wrong output:\n%s", cmp.Diff(want, parsed))
+	}
+}
+
+func TestParseStepRun(t *testing.T) {
+	tests := []struct {
+		stepCtx StepContext
+		run     string
+		want    string
+	}{
+		{
+			stepCtx: StepContext{
+				Repository: &graphql.Repository{Name: "github.com/sourcegraph/src-cli"},
+				PreviousStep: StepResult{
+					Changes: StepChanges{
+						Modified: []string{"go.mod"},
+						Added:    []string{"main.go.swp"},
+						Deleted:  []string{".DS_Store"},
+					},
+				},
+			},
+
+			run:  `${{ modified_files }} ${{ repository_name }}`,
+			want: `go.mod github.com/sourcegraph/src-cli`,
+		},
+		{
+			stepCtx: StepContext{
+				Repository: &graphql.Repository{Name: "github.com/sourcegraph/src-cli"},
+			},
+
+			run:  `${{ modified_files }} ${{ repository_name }}`,
+			want: ` github.com/sourcegraph/src-cli`,
+		},
+	}
+
+	for _, tc := range tests {
+		parsed, err := parseStepRun(tc.stepCtx, tc.run)
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		var out bytes.Buffer
+		if err := parsed.Execute(&out, tc.stepCtx); err != nil {
+			t.Fatalf("executing template failed: %s", err)
+		}
+
+		if out.String() != tc.want {
+			t.Fatalf("wrong output:\n%s", cmp.Diff(tc.want, out.String()))
+		}
+	}
+}