fs: cleanup CommandReader implementation

This commit is contained in:
Michael Eischer 2023-10-01 15:07:51 +02:00
parent 37a312e505
commit 7d879705ad
2 changed files with 29 additions and 28 deletions

View file

@ -728,5 +728,5 @@ func prepareStdinCommand(ctx context.Context, args []string) (io.ReadCloser, err
if err := command.Start(); err != nil {
return nil, errors.Wrap(err, "command.Start")
}
return &fs.ReadCloserCommand{Cmd: command, Stdout: stdout}, nil
return fs.NewCommandReader(command, stdout), nil
}

View file

@ -1,17 +1,18 @@
package fs
import (
"github.com/restic/restic/internal/errors"
"io"
"os/exec"
"github.com/restic/restic/internal/errors"
)
// ReadCloserCommand wraps an exec.Cmd and its standard output to provide an
// CommandReader wraps an exec.Cmd and its standard output to provide an
// io.ReadCloser that waits for the command to terminate on Close(), reporting
// any error in the command.Wait() function back to the Close() caller.
type ReadCloserCommand struct {
Cmd *exec.Cmd
Stdout io.ReadCloser
type CommandReader struct {
cmd *exec.Cmd
stdout io.ReadCloser
// We should call exec.Wait() once. waitHandled is taking care of storing
// whether we already called that function in Read() to avoid calling it
@ -25,44 +26,36 @@ type ReadCloserCommand struct {
alreadyClosedReadErr error
}
func NewCommandReader(cmd *exec.Cmd, stdout io.ReadCloser) *CommandReader {
return &CommandReader{
cmd: cmd,
stdout: stdout,
}
}
// Read populate the array with data from the process stdout.
func (fp *ReadCloserCommand) Read(p []byte) (int, error) {
func (fp *CommandReader) Read(p []byte) (int, error) {
if fp.alreadyClosedReadErr != nil {
return 0, fp.alreadyClosedReadErr
}
b, err := fp.Stdout.Read(p)
b, err := fp.stdout.Read(p)
// If the error is io.EOF, the program terminated. We need to check the
// exit code here because, if the program terminated with no output, the
// error in `Close()` is ignored.
if errors.Is(err, io.EOF) {
// Check if the command terminated successfully. If not, return the
// error.
fp.waitHandled = true
errw := fp.Cmd.Wait()
if errw != nil {
// If we have information about the exit code, let's use it in the
// error message. Otherwise, send the error message along.
// In any case, use a fatal error to abort the snapshot.
var err2 *exec.ExitError
if errors.As(errw, &err2) {
err = errors.Fatalf("command terminated with exit code %d", err2.ExitCode())
} else {
err = errors.Fatal(errw.Error())
}
// check if the command terminated successfully, If not return the error.
if errw := fp.wait(); errw != nil {
err = errw
}
}
fp.alreadyClosedReadErr = err
return b, err
}
func (fp *ReadCloserCommand) Close() error {
if fp.waitHandled {
return nil
}
// No need to close fp.Stdout as Wait() closes all pipes.
err := fp.Cmd.Wait()
func (fp *CommandReader) wait() error {
err := fp.cmd.Wait()
if err != nil {
// If we have information about the exit code, let's use it in the
// error message. Otherwise, send the error message along.
@ -75,3 +68,11 @@ func (fp *ReadCloserCommand) Close() error {
}
return nil
}
func (fp *CommandReader) Close() error {
if fp.waitHandled {
return nil
}
return fp.wait()
}