273b70bacc
## Checklist - [x] I have read the [contribution guidelines](https://github.com/ooni/probe-cli/blob/master/CONTRIBUTING.md) - [x] reference issue for this pull request: https://github.com/ooni/probe/issues/1885 - [x] related ooni/spec pull request: N/A Location of the issue tracker: https://github.com/ooni/probe ## Description This PR contains a set of changes to move important interfaces and data types into the `./internal/model` package. The criteria for including an interface or data type in here is roughly that the type should be important and used by several packages. We are especially interested to move more interfaces here to increase modularity. An additional side effect is that, by reading this package, one should be able to understand more quickly how different parts of the codebase interact with each other. This is what I want to move in `internal/model`: - [x] most important interfaces from `internal/netxlite` - [x] everything that was previously part of `internal/engine/model` - [x] mocks from `internal/netxlite/mocks` should also be moved in here as a subpackage
85 lines
2.0 KiB
Go
85 lines
2.0 KiB
Go
// Package shellx runs external commands.
|
|
package shellx
|
|
|
|
import (
|
|
"errors"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/google/shlex"
|
|
"github.com/ooni/probe-cli/v3/internal/model"
|
|
"golang.org/x/sys/execabs"
|
|
)
|
|
|
|
// runconfig is the configuration for run.
|
|
type runconfig struct {
|
|
// args contains the command line arguments.
|
|
args []string
|
|
|
|
// command is the command to execute.
|
|
command string
|
|
|
|
// loginfof is the logging function.
|
|
loginfof func(format string, v ...interface{})
|
|
|
|
// stdout is the standard output.
|
|
stdout *os.File
|
|
|
|
// stderr is the standard error.
|
|
stderr *os.File
|
|
}
|
|
|
|
// run is the internal function for running commands.
|
|
func run(config runconfig) error {
|
|
config.loginfof(
|
|
"exec: %s %s", config.command, strings.Join(config.args, " "))
|
|
// implementation note: here we're using execabs because
|
|
// of https://blog.golang.org/path-security.
|
|
cmd := execabs.Command(config.command, config.args...)
|
|
cmd.Stdout = config.stdout
|
|
cmd.Stderr = config.stderr
|
|
err := cmd.Run()
|
|
config.loginfof("exec result: %+v", err)
|
|
return err
|
|
}
|
|
|
|
// Run executes the specified command with the specified args.
|
|
func Run(logger model.InfoLogger, name string, arg ...string) error {
|
|
return run(runconfig{
|
|
args: arg,
|
|
command: name,
|
|
loginfof: logger.Infof,
|
|
stdout: os.Stdout,
|
|
stderr: os.Stderr,
|
|
})
|
|
}
|
|
|
|
// quietInfof is an infof function that does nothing.
|
|
func quietInfof(format string, v ...interface{}) {}
|
|
|
|
// RunQuiet is like Run but it does not emit any output.
|
|
func RunQuiet(name string, arg ...string) error {
|
|
return run(runconfig{
|
|
args: arg,
|
|
command: name,
|
|
loginfof: quietInfof,
|
|
stdout: nil,
|
|
stderr: nil,
|
|
})
|
|
}
|
|
|
|
// ErrNoCommandToExecute means that the command line is empty.
|
|
var ErrNoCommandToExecute = errors.New("shellx: no command to execute")
|
|
|
|
// RunCommandline executes the given command line.
|
|
func RunCommandline(logger model.InfoLogger, cmdline string) error {
|
|
args, err := shlex.Split(cmdline)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if len(args) < 1 {
|
|
return ErrNoCommandToExecute
|
|
}
|
|
return Run(logger, args[0], args[1:]...)
|
|
}
|