storj/storagenode/pieces/lazyfilewalker/process.go
Clement Sam b64179c82a {storagenode/pieces,cmd/storagenode}: refactor lazyfilewalker commands and tests
With this change we are directly testing how the command
is executed when the args are passed

Change-Id: Ibb33926014c9d71c928e0fd374bf4edc5a8a1232
2023-06-02 00:11:53 +00:00

97 lines
2.5 KiB
Go

// Copyright (C) 2023 Storj Labs, Inc.
// See LICENSE for copying information.
package lazyfilewalker
import (
"bytes"
"context"
"encoding/json"
"errors"
"go.uber.org/zap"
"golang.org/x/sys/execabs"
"storj.io/storj/storagenode/pieces/lazyfilewalker/execwrapper"
)
// process is a subprocess that can be used to perform filewalker operations.
type process struct {
log *zap.Logger
executable string
args []string
cmd execwrapper.Command
}
// newProcess creates a new process.
// The cmd argument can be used to replace the subprocess with a runner for testing, it can be nil.
func newProcess(cmd execwrapper.Command, log *zap.Logger, executable string, args []string) *process {
return &process{
cmd: cmd,
log: log,
executable: executable,
args: args,
}
}
// run runs the process and decodes the response into the value pointed by `resp`.
// It returns an error if the Process fails to start, or if the Process exits with a non-zero status.
// NOTE: the `resp` value must be a pointer to a struct.
func (p *process) run(ctx context.Context, req, resp interface{}) (err error) {
defer mon.Task()(&ctx)(&err)
ctx, cancel := context.WithCancel(ctx)
defer cancel()
p.log.Info("starting subprocess")
var buf, outbuf bytes.Buffer
writer := &zapWrapper{p.log.Named("subprocess")}
// encode the struct and write it to the buffer
enc := json.NewEncoder(&buf)
if err := enc.Encode(req); err != nil {
return errLazyFilewalker.Wrap(err)
}
if p.cmd == nil {
p.cmd = execwrapper.CommandContext(ctx, p.executable, p.args...)
} else {
args := append([]string{p.executable}, p.args...)
p.cmd.SetArgs(args)
}
p.cmd.SetIn(&buf)
p.cmd.SetOut(&outbuf)
p.cmd.SetErr(writer)
if err := p.cmd.Start(); err != nil {
p.log.Error("failed to start subprocess", zap.Error(err))
return errLazyFilewalker.Wrap(err)
}
p.log.Info("subprocess started")
if err := p.cmd.Wait(); err != nil {
var exitErr *execabs.ExitError
if errors.As(err, &exitErr) {
p.log.Info("subprocess exited with status", zap.Int("status", exitErr.ExitCode()), zap.Error(exitErr))
} else {
p.log.Error("subprocess exited with error", zap.Error(err))
}
return errLazyFilewalker.Wrap(err)
}
p.log.Info("subprocess finished successfully")
// Decode and receive the response data struct from the subprocess
decoder := json.NewDecoder(&outbuf)
if err := decoder.Decode(&resp); err != nil {
p.log.Error("failed to decode response from subprocess", zap.Error(err))
return errLazyFilewalker.Wrap(err)
}
return nil
}