Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only apply cache result progress if resulted in diff #778

Merged
merged 1 commit into from
Jun 14, 2022
+17 −7
Merged

Only apply cache result progress if resulted in diff #778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions internal/batches/executor/run_steps.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,12 @@ func runSteps(ctx context.Context, opts *executionOpts) (result execution.Result
stepContext.Steps.Changes = previousStepResult.Files
stepContext.Outputs = opts.task.CachedResult.Outputs

if err := ws.ApplyDiff(ctx, []byte(opts.task.CachedResult.Diff)); err != nil {
return execResult, nil, errors.Wrap(err, "getting changed files in step")
// If the previous steps made any modifications in the workspace yet,
// apply them.
if opts.task.CachedResult.Diff != "" {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there existing tests to cover when CachedResult.Diff is blank and not blank?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another PR just found this bug, and it has a test for it so will merge this and then in the next PR you'll get that test :)

if err := ws.ApplyDiff(ctx, []byte(opts.task.CachedResult.Diff)); err != nil {
return execResult, nil, errors.Wrap(err, "getting changed files in step")
}
}
}

Expand Down
4 changes: 2 additions & 2 deletions internal/batches/workspace/bind_workspace.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,8 @@ func (w *dockerBindWorkspace) ApplyDiff(ctx context.Context, diff []byte) error
}

// Apply diff
if _, err = runGitCmd(ctx, w.dir, "apply", "-p0", tmp.Name()); err != nil {
return errors.Wrap(err, "applying cached diff")
if out, err := runGitCmd(ctx, w.dir, "apply", "-p0", tmp.Name()); err != nil {
return errors.Wrapf(err, "applying cached diff: %s", string(out))
}

// Add all files to index
Expand Down
2 changes: 1 addition & 1 deletion internal/batches/workspace/git.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ func runGitCmd(ctx context.Context, dir string, args ...string) ([]byte, error)
cmd.Dir = dir
out, err := cmd.CombinedOutput()
if err != nil {
return nil, errors.Wrapf(err, "'git %s' failed: %s", strings.Join(args, " "), out)
return out, errors.Wrapf(err, "'git %s' failed: %s", strings.Join(args, " "), out)
}
return out, nil
}
10 changes: 8 additions & 2 deletions internal/batches/workspace/volume_workspace.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,8 @@ exec git diff --cached --no-prefix --binary
func (w *dockerVolumeWorkspace) ApplyDiff(ctx context.Context, diff []byte) error {
script := fmt.Sprintf(`#!/bin/sh

set -e

cat <<'EOF' | exec git apply -p0 -
%s
EOF
Expand Down Expand Up @@ -322,11 +324,15 @@ func (w *dockerVolumeWorkspace) runScript(ctx context.Context, target, script st
if _, err := f.WriteString(script); err != nil {
return nil, errors.Wrap(err, "writing run script")
}
f.Close()
if err := f.Close(); err != nil {
return nil, errors.Wrap(err, "closing run script")
}

// Sidestep any umask issues on the temporary file by always making it
// executable by everyone.
os.Chmod(name, 0755)
if err := os.Chmod(name, 0755); err != nil {
return nil, errors.Wrap(err, "chmodding run script")
}

common, err := w.DockerRunOpts(ctx, target)
if err != nil {
Expand Down