Slight refactor of package structures (#586)

Author: eseliger

internal/batches/executor/changeset_specs.go

@@ -8,16 +8,17 @@ import (
 	"github.com/sourcegraph/go-diff/diff"
 	batcheslib "github.com/sourcegraph/sourcegraph/lib/batches"
 	"github.com/sourcegraph/src-cli/internal/batches"
+	"github.com/sourcegraph/src-cli/internal/batches/template"
 )
 
 var errOptionalPublishedUnsupported = errors.New(`This Sourcegraph version requires the "published" field to be specified in the batch spec; upgrade to version 3.30.0 or later to be able to omit the published field and control publication from the UI.`)
 
 func createChangesetSpecs(task *Task, result executionResult, features batches.FeatureFlags) ([]*batches.ChangesetSpec, error) {
 	repo := task.Repository.Name
 
-	tmplCtx := &ChangesetTemplateContext{
+	tmplCtx := &template.ChangesetTemplateContext{
 		BatchChangeAttributes: *task.BatchChangeAttributes,
-		Steps: StepsContext{
+		Steps: template.StepsContext{
 			Changes: result.ChangedFiles,
 			Path:    result.Path,
 		},
@@ -36,35 +37,35 @@ func createChangesetSpecs(task *Task, result executionResult, features batches.F
 		}
 	} else {
 		var err error
-		authorName, err = renderChangesetTemplateField("authorName", task.Template.Commit.Author.Name, tmplCtx)
+		authorName, err = template.RenderChangesetTemplateField("authorName", task.Template.Commit.Author.Name, tmplCtx)
 		if err != nil {
 			return nil, err
 		}
-		authorEmail, err = renderChangesetTemplateField("authorEmail", task.Template.Commit.Author.Email, tmplCtx)
+		authorEmail, err = template.RenderChangesetTemplateField("authorEmail", task.Template.Commit.Author.Email, tmplCtx)
 		if err != nil {
 			return nil, err
 		}
 	}
 
-	title, err := renderChangesetTemplateField("title", task.Template.Title, tmplCtx)
+	title, err := template.RenderChangesetTemplateField("title", task.Template.Title, tmplCtx)
 	if err != nil {
 		return nil, err
 	}
 
-	body, err := renderChangesetTemplateField("body", task.Template.Body, tmplCtx)
+	body, err := template.RenderChangesetTemplateField("body", task.Template.Body, tmplCtx)
 	if err != nil {
 		return nil, err
 	}
 
-	message, err := renderChangesetTemplateField("message", task.Template.Commit.Message, tmplCtx)
+	message, err := template.RenderChangesetTemplateField("message", task.Template.Commit.Message, tmplCtx)
 	if err != nil {
 		return nil, err
 	}
 
 	// TODO: As a next step, we should extend the ChangesetTemplateContext to also include
 	// TransformChanges.Group and then change validateGroups and groupFileDiffs to, for each group,
 	// render the branch name *before* grouping the diffs.
-	defaultBranch, err := renderChangesetTemplateField("branch", task.Template.Branch, tmplCtx)
+	defaultBranch, err := template.RenderChangesetTemplateField("branch", task.Template.Branch, tmplCtx)
 	if err != nil {
 		return nil, err
 	}

internal/batches/executor/changeset_specs_test.go

@@ -10,6 +10,7 @@ import (
 	batcheslib "github.com/sourcegraph/sourcegraph/lib/batches"
 	"github.com/sourcegraph/src-cli/internal/batches"
 	"github.com/sourcegraph/src-cli/internal/batches/git"
+	"github.com/sourcegraph/src-cli/internal/batches/template"
 )
 
 func TestCreateChangesetSpecs(t *testing.T) {
@@ -46,7 +47,7 @@ func TestCreateChangesetSpecs(t *testing.T) {
 	}
 
 	defaultTask := &Task{
-		BatchChangeAttributes: &BatchChangeAttributes{
+		BatchChangeAttributes: &template.BatchChangeAttributes{
 			Name:        "the name",
 			Description: "The description",
 		},

internal/batches/executor/coordinator_test.go

@@ -15,6 +15,7 @@ import (
 	"github.com/sourcegraph/src-cli/internal/batches/git"
 	"github.com/sourcegraph/src-cli/internal/batches/graphql"
 	"github.com/sourcegraph/src-cli/internal/batches/mock"
+	"github.com/sourcegraph/src-cli/internal/batches/template"
 )
 
 func TestCoordinator_Execute(t *testing.T) {
@@ -266,7 +267,7 @@ func TestCoordinator_Execute(t *testing.T) {
 			for _, t := range tc.tasks {
 				t.TransformChanges = tc.batchSpec.TransformChanges
 				t.Template = tc.batchSpec.ChangesetTemplate
-				t.BatchChangeAttributes = &BatchChangeAttributes{
+				t.BatchChangeAttributes = &template.BatchChangeAttributes{
 					Name:        tc.batchSpec.Name,
 					Description: tc.batchSpec.Description,
 				}
@@ -359,7 +360,7 @@ func TestCoordinator_Execute_StepCaching(t *testing.T) {
 			{Run: `echo "three"`},
 		},
 		Repository:            testRepo1,
-		BatchChangeAttributes: &BatchChangeAttributes{},
+		BatchChangeAttributes: &template.BatchChangeAttributes{},
 	}
 
 	executor := &dummyExecutor{}
@@ -530,9 +531,7 @@ func (d *dummyTaskExecutionUI) TaskFinished(t *Task, err error) {
 	d.mu.Lock()
 	defer d.mu.Unlock()
 
-	if _, ok := d.started[t]; ok {
-		delete(d.started, t)
-	}
+	delete(d.started, t)
 	if err != nil {
 		d.finishedWithErr[t] = struct{}{}
 	} else {

internal/batches/executor/executor_test.go

@@ -23,6 +23,7 @@ import (
 	"github.com/sourcegraph/src-cli/internal/batches/docker"
 	"github.com/sourcegraph/src-cli/internal/batches/git"
 	"github.com/sourcegraph/src-cli/internal/batches/mock"
+	"github.com/sourcegraph/src-cli/internal/batches/template"
 	"github.com/sourcegraph/src-cli/internal/batches/workspace"
 )
 
@@ -33,7 +34,7 @@ func TestExecutor_Integration(t *testing.T) {
 
 	addToPath(t, "testdata/dummydocker")
 
-	defaultBatchChangeAttributes := &BatchChangeAttributes{
+	defaultBatchChangeAttributes := &template.BatchChangeAttributes{
 		Name:        "integration-test-batch-change",
 		Description: "this is an integration test",
 	}
@@ -488,7 +489,7 @@ index 02a19af..c9644dd 100644
 `)
 
 		task := &Task{
-			BatchChangeAttributes: &BatchChangeAttributes{},
+			BatchChangeAttributes: &template.BatchChangeAttributes{},
 			Steps: []batcheslib.Step{
 				{Run: `echo -e "foobar\n" >> README.md`},
 			},
@@ -497,7 +498,7 @@ index 02a19af..c9644dd 100644
 				StepIndex:          0,
 				Diff:               cachedDiff,
 				Outputs:            map[string]interface{}{},
-				PreviousStepResult: StepResult{},
+				PreviousStepResult: template.StepResult{},
 			},
 			Repository: testRepo1,
 		}
@@ -594,7 +595,7 @@ index 0000000..257ae8e
 
 		task := &Task{
 			Repository:            testRepo1,
-			BatchChangeAttributes: &BatchChangeAttributes{},
+			BatchChangeAttributes: &template.BatchChangeAttributes{},
 			Steps: []batcheslib.Step{
 				{Run: `echo "this is step 1" >> README.txt`},
 				{Run: `echo "this is step 2" >> README.md`},
@@ -615,7 +616,7 @@ echo "previous_step.modified_files=${{ previous_step.modified_files }}" >> READM
 				Outputs: map[string]interface{}{
 					"myOutput": "my-output.txt",
 				},
-				PreviousStepResult: StepResult{
+				PreviousStepResult: template.StepResult{
 					Files: &git.Changes{
 						Modified: []string{"README.md"},
 						Added:    []string{"README.txt"},

internal/batches/executor/run_steps.go

@@ -17,6 +17,7 @@ import (
 	batcheslib "github.com/sourcegraph/sourcegraph/lib/batches"
 	"github.com/sourcegraph/src-cli/internal/batches/git"
 	"github.com/sourcegraph/src-cli/internal/batches/log"
+	"github.com/sourcegraph/src-cli/internal/batches/template"
 	"github.com/sourcegraph/src-cli/internal/batches/workspace"
 
 	yamlv3 "gopkg.in/yaml.v3"
@@ -33,7 +34,7 @@ type stepExecutionResult struct {
 	Outputs map[string]interface{} `json:"outputs"`
 	// PreviousStepResult is the StepResult of the step before Step, if Step !=
 	// 0.
-	PreviousStepResult StepResult `json:"previousStepResult"`
+	PreviousStepResult template.StepResult `json:"previousStepResult"`
 }
 
 type executionResult struct {
@@ -86,7 +87,7 @@ func runSteps(ctx context.Context, opts *executionOpts) (result executionResult,
 			Outputs:      make(map[string]interface{}),
 			Path:         opts.task.Path,
 		}
-		previousStepResult StepResult
+		previousStepResult template.StepResult
 		startStep          int
 	)
 
@@ -122,11 +123,11 @@ func runSteps(ctx context.Context, opts *executionOpts) (result executionResult,
 	for i := startStep; i < len(opts.task.Steps); i++ {
 		step := opts.task.Steps[i]
 
-		stepContext := StepContext{
+		stepContext := template.StepContext{
 			BatchChange: *opts.task.BatchChangeAttributes,
 			Repository:  *opts.task.Repository,
 			Outputs:     execResult.Outputs,
-			Steps: StepsContext{
+			Steps: template.StepsContext{
 				Path:    execResult.Path,
 				Changes: previousStepResult.Files,
 			},
@@ -145,7 +146,7 @@ func runSteps(ctx context.Context, opts *executionOpts) (result executionResult,
 			}
 		}
 
-		cond, err := evalStepCondition(step.IfCondition(), &stepContext)
+		cond, err := template.EvalStepCondition(step.IfCondition(), &stepContext)
 		if err != nil {
 			return execResult, nil, errors.Wrap(err, "evaluating step condition")
 		}
@@ -172,7 +173,7 @@ func runSteps(ctx context.Context, opts *executionOpts) (result executionResult,
 			return execResult, nil, errors.Wrap(err, "getting changed files in step")
 		}
 
-		result := StepResult{Files: changes, Stdout: &stdoutBuffer, Stderr: &stderrBuffer}
+		result := template.StepResult{Files: changes, Stdout: &stdoutBuffer, Stderr: &stderrBuffer}
 
 		// Set stepContext.Step to current step's results before rendering outputs
 		stepContext.Step = result
@@ -220,7 +221,7 @@ func executeSingleStep(
 	i int,
 	step batcheslib.Step,
 	imageDigest string,
-	stepContext *StepContext,
+	stepContext *template.StepContext,
 ) (bytes.Buffer, bytes.Buffer, error) {
 	// ----------
 	// PREPARATION
@@ -259,7 +260,7 @@ func executeSingleStep(
 	}
 
 	// Render the step.Env variables as templates.
-	env, err := renderStepMap(stepEnv, stepContext)
+	env, err := template.RenderStepMap(stepEnv, stepContext)
 	if err != nil {
 		return bytes.Buffer{}, bytes.Buffer{}, errors.Wrap(err, "parsing step environment")
 	}
@@ -334,11 +335,11 @@ func executeSingleStep(
 	return stdoutBuffer, stderrBuffer, nil
 }
 
-func setOutputs(stepOutputs batcheslib.Outputs, global map[string]interface{}, stepCtx *StepContext) error {
+func setOutputs(stepOutputs batcheslib.Outputs, global map[string]interface{}, stepCtx *template.StepContext) error {
 	for name, output := range stepOutputs {
 		var value bytes.Buffer
 
-		if err := renderStepTemplate("outputs-"+name, output.Value, &value, stepCtx); err != nil {
+		if err := template.RenderStepTemplate("outputs-"+name, output.Value, &value, stepCtx); err != nil {
 			return errors.Wrap(err, "parsing step run")
 		}
 
@@ -414,9 +415,9 @@ func probeImageForShell(ctx context.Context, image string) (shell, tempfile stri
 
 // createFilesToMount creates temporary files with the contents of Step.Files
 // that are to be mounted into the container that executes the step.
-func createFilesToMount(tempDir string, step batcheslib.Step, stepContext *StepContext) (map[string]*os.File, func(), error) {
+func createFilesToMount(tempDir string, step batcheslib.Step, stepContext *template.StepContext) (map[string]*os.File, func(), error) {
 	// Parse and render the step.Files.
-	files, err := renderStepMap(step.Files, stepContext)
+	files, err := template.RenderStepMap(step.Files, stepContext)
 	if err != nil {
 		return nil, nil, errors.Wrap(err, "parsing step files")
 	}
@@ -455,7 +456,7 @@ func createFilesToMount(tempDir string, step batcheslib.Step, stepContext *StepC
 // createRunScriptFile creates a temporary file and renders stepRun into it.
 //
 // It returns the location of the file, its content, a function to cleanup the file and possible errors.
-func createRunScriptFile(ctx context.Context, tempDir string, stepRun string, stepCtx *StepContext) (string, string, func(), error) {
+func createRunScriptFile(ctx context.Context, tempDir string, stepRun string, stepCtx *template.StepContext) (string, string, func(), error) {
 	// Set up a temporary file on the host filesystem to contain the
 	// script.
 	runScriptFile, err := ioutil.TempFile(tempDir, "")
@@ -468,7 +469,7 @@ func createRunScriptFile(ctx context.Context, tempDir string, stepRun string, st
 	// temp file we just created.
 	var runScript bytes.Buffer
 	out := io.MultiWriter(&runScript, runScriptFile)
-	if err := renderStepTemplate("step-run", stepRun, out, stepCtx); err != nil {
+	if err := template.RenderStepTemplate("step-run", stepRun, out, stepCtx); err != nil {
 		return "", "", nil, errors.Wrap(err, "parsing step run")
 	}
 

internal/batches/executor/task.go

@@ -4,6 +4,7 @@ import (
 	batcheslib "github.com/sourcegraph/sourcegraph/lib/batches"
 	"github.com/sourcegraph/src-cli/internal/batches"
 	"github.com/sourcegraph/src-cli/internal/batches/graphql"
+	"github.com/sourcegraph/src-cli/internal/batches/template"
 )
 
 type Task struct {
@@ -22,9 +23,9 @@ type Task struct {
 
 	// TODO(mrnugget): this should just be a single BatchSpec field instead, if
 	// we can make it work with caching
-	BatchChangeAttributes *BatchChangeAttributes        `json:"-"`
-	Template              *batcheslib.ChangesetTemplate `json:"-"`
-	TransformChanges      *batcheslib.TransformChanges  `json:"-"`
+	BatchChangeAttributes *template.BatchChangeAttributes `json:"-"`
+	Template              *batcheslib.ChangesetTemplate   `json:"-"`
+	TransformChanges      *batcheslib.TransformChanges    `json:"-"`
 
 	Archive batches.RepoZip `json:"-"`
 

internal/batches/service/main_test.go

@@ -0,0 +1,13 @@
+package service
+
+import "github.com/sourcegraph/src-cli/internal/batches/graphql"
+
+var testRepo1 = &graphql.Repository{
+	ID:            "src-cli",
+	Name:          "github.com/sourcegraph/src-cli",
+	DefaultBranch: &graphql.Branch{Name: "main", Target: graphql.Target{OID: "d34db33f"}},
+	FileMatches: map[string]bool{
+		"README.md": true,
+		"main.go":   true,
+	},
+}