ooni-probe-cli/internal/shellx/shellx.go
Simone Basso 33de701263
refactor: flatten and separate (#353)
* refactor(atomicx): move outside the engine package

After merging probe-engine into probe-cli, my impression is that we have
too much unnecessary nesting of packages in this repository.

The idea of this commit and of a bunch of following commits will instead
be to reduce the nesting and simplify the structure.

While there, improve the documentation.

* fix: always use the atomicx package

For consistency, never use sync/atomic and always use ./internal/atomicx
so we can just grep and make sure we're not risking to crash if we make
a subtle mistake on a 32 bit platform.

While there, mention in the contributing guidelines that we want to
always prefer the ./internal/atomicx package over sync/atomic.

* fix(atomicx): remove unnecessary constructor

We don't need a constructor here. The default constructed `&Int64{}`
instance is already usable and the constructor does not add anything to
what we are doing, rather it just creates extra confusion.

* cleanup(atomicx): we are not using Float64

Because atomicx.Float64 is unused, we can safely zap it.

* cleanup(atomicx): simplify impl and improve tests

We can simplify the implementation by using defer and by letting
the Load() method call Add(0).

We can improve tests by making many goroutines updated the
atomic int64 value concurrently.

* refactor(fsx): can live in the ./internal pkg

Let us reduce the amount of nesting. While there, ensure that the
package only exports the bare minimum, and improve the documentation
of the tests, to ease reading the code.

* refactor: move runtimex to ./internal

* refactor: move shellx into the ./internal package

While there, remove unnecessary dependency between packages.

While there, specify in the contributing guidelines that
one should use x/sys/execabs instead of os/exec.

* refactor: move ooapi into the ./internal pkg

* refactor(humanize): move to ./internal and better docs

* refactor: move platform to ./internal

* refactor(randx): move to ./internal

* refactor(multierror): move into the ./internal pkg

* refactor(kvstore): all kvstores in ./internal

Rather than having part of the kvstore inside ./internal/engine/kvstore
and part in ./internal/engine/kvstore.go, let us put every piece of code
that is kvstore related into the ./internal/kvstore package.

* fix(kvstore): always return ErrNoSuchKey on Get() error

It should help to use the kvstore everywhere removing all the
copies that are lingering around the tree.

* sessionresolver: make KVStore mandatory

Simplifies implementation. While there, use the ./internal/kvstore
package rather than having our private implementation.

* fix(ooapi): use the ./internal/kvstore package

* fix(platform): better documentation
2021-06-04 10:34:18 +02:00

83 lines
1.9 KiB
Go

// Package shellx runs external commands.
package shellx
import (
"errors"
"os"
"strings"
"github.com/apex/log"
"github.com/google/shlex"
"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(name string, arg ...string) error {
return run(runconfig{
args: arg,
command: name,
loginfof: log.Log.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,
})
}
// RunCommandline is like Run but its only argument is a command
// line that will be splitted using the google/shlex package.
func RunCommandline(cmdline string) error {
args, err := shlex.Split(cmdline)
if err != nil {
return err
}
if len(args) < 1 {
return errors.New("shellx: no command to execute")
}
return Run(args[0], args[1:]...)
}