c/ooni-probe-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(ooniprobe): use ooniprobe-cli-unattended for unattended runs (#714)

Browse Source 
This diff changes the software name used by unattended runs for which
we did not override the default software name (`ooniprobe-cli`).

It will become `ooniprobe-cli-unattended`. This software name is in line
with the one we use for Android, iOS, and desktop unattended runs.

While working in this diff, I introduced string constants for the run
types and a string constant for the default software name.

See https://github.com/ooni/probe/issues/2081.
This commit is contained in:
Simone Basso
2022-04-29 13:41:09 +02:00
committed by GitHub
parent 596bdf6e57
commit d3c5196474
19 changed files with 72 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/ooniprobe/internal/cli/geoip/geoip.go
+2 -1
View File
@@ -8,6 +8,7 @@ import (
"github.com/ooni/probe-cli/v3/cmd/ooniprobe/internal/cli/root"
"github.com/ooni/probe-cli/v3/cmd/ooniprobe/internal/ooni"
"github.com/ooni/probe-cli/v3/cmd/ooniprobe/internal/output"
"github.com/ooni/probe-cli/v3/internal/model"
)
func init() {
@@ -36,7 +37,7 @@ func dogeoip(config dogeoipconfig) error {
return err
}
engine, err := probeCLI.NewProbeEngine(context.Background())
engine, err := probeCLI.NewProbeEngine(context.Background(), model.RunTypeManual)
if err != nil {
return err
}
cmd/ooniprobe/internal/cli/root/root.go
+1 -1
View File
@@ -40,7 +40,7 @@ func init() {
softwareName := Cmd.Flag(
"software-name", "Override application name",
).Default("ooniprobe-cli").String()
).Default(ooni.DefaultSoftwareName).String()
softwareVersion := Cmd.Flag(
"software-version", "Override the application version",
).Default(version.Version).String()
cmd/ooniprobe/internal/cli/run/run.go
+6 -5
View File
@@ -8,6 +8,7 @@ import (
"github.com/ooni/probe-cli/v3/cmd/ooniprobe/internal/cli/root"
"github.com/ooni/probe-cli/v3/cmd/ooniprobe/internal/nettests"
"github.com/ooni/probe-cli/v3/cmd/ooniprobe/internal/ooni"
"github.com/ooni/probe-cli/v3/internal/model"
)
func init() {
@@ -32,7 +33,7 @@ func init() {
return nil
})
functionalRun := func(runType string, pred func(name string, gr nettests.Group) bool) error {
functionalRun := func(runType model.RunType, pred func(name string, gr nettests.Group) bool) error {
for name, group := range nettests.All {
if !pred(name, group) {
continue
@@ -52,7 +53,7 @@ func init() {
genRunWithGroupName := func(targetName string) func(*kingpin.ParseContext) error {
return func(*kingpin.ParseContext) error {
return functionalRun("manual", func(groupName string, gr nettests.Group) bool {
return functionalRun(model.RunTypeManual, func(groupName string, gr nettests.Group) bool {
return groupName == targetName
})
}
@@ -68,7 +69,7 @@ func init() {
Probe: probe,
InputFiles: *inputFile,
Inputs: *input,
RunType: "manual",
RunType: model.RunTypeManual,
})
})
@@ -80,14 +81,14 @@ func init() {
unattendedCmd := cmd.Command("unattended", "")
unattendedCmd.Action(func(_ *kingpin.ParseContext) error {
return functionalRun("timed", func(name string, gr nettests.Group) bool {
return functionalRun(model.RunTypeTimed, func(name string, gr nettests.Group) bool {
return gr.UnattendedOK
})
})
allCmd := cmd.Command("all", "").Default()
allCmd.Action(func(_ *kingpin.ParseContext) error {
return functionalRun("manual", func(name string, gr nettests.Group) bool {
return functionalRun(model.RunTypeManual, func(name string, gr nettests.Group) bool {
return true
})
})
cmd/ooniprobe/internal/nettests/nettests.go
+4 -4
View File
@@ -55,8 +55,8 @@ type Controller struct {
Inputs []string
// RunType contains the run_type hint for the CheckIn API. If
// not set, the underlying code defaults to "timed".
RunType string
// not set, the underlying code defaults to model.RunTypeTimed.
RunType model.RunType
// numInputs is the total number of inputs
numInputs int
@@ -154,7 +154,7 @@ func (c *Controller) Run(builder *engine.ExperimentBuilder, inputs []string) err
}
maxRuntime := time.Duration(c.Probe.Config().Nettests.WebsitesMaxRuntime) * time.Second
if c.RunType == "timed" && maxRuntime > 0 {
if c.RunType == model.RunTypeTimed && maxRuntime > 0 {
log.Debug("disabling maxRuntime when running in the background")
maxRuntime = 0
}
@@ -267,7 +267,7 @@ func (c *Controller) OnProgress(perc float64, msg string) {
maxRuntime := time.Duration(c.Probe.Config().Nettests.WebsitesMaxRuntime) * time.Second
_, isWebConnectivity := c.nt.(WebConnectivity)
userProvidedInput := len(c.Inputs) > 0 || len(c.InputFiles) > 0
if c.RunType == "manual" && maxRuntime > 0 && isWebConnectivity && !userProvidedInput {
if c.RunType == model.RunTypeManual && maxRuntime > 0 && isWebConnectivity && !userProvidedInput {
elapsed := time.Since(c.ntStartTime)
perc = float64(elapsed) / float64(maxRuntime)
eta := maxRuntime.Seconds() - elapsed.Seconds()
cmd/ooniprobe/internal/nettests/nettests_test.go
+2 -1
View File
@@ -9,6 +9,7 @@ import (
"github.com/ooni/probe-cli/v3/cmd/ooniprobe/internal/database"
"github.com/ooni/probe-cli/v3/cmd/ooniprobe/internal/ooni"
"github.com/ooni/probe-cli/v3/internal/model"
)
func copyfile(source, dest string) error {
@@ -45,7 +46,7 @@ func TestCreateContext(t *testing.T) {
func TestRun(t *testing.T) {
probe := newOONIProbe(t)
sess, err := probe.NewSession(context.Background())
sess, err := probe.NewSession(context.Background(), model.RunTypeManual)
if err != nil {
t.Fatal(err)
}
cmd/ooniprobe/internal/nettests/run.go
+3 -2
View File
@@ -8,6 +8,7 @@ import (
"github.com/apex/log"
"github.com/ooni/probe-cli/v3/cmd/ooniprobe/internal/database"
"github.com/ooni/probe-cli/v3/cmd/ooniprobe/internal/ooni"
"github.com/ooni/probe-cli/v3/internal/model"
"github.com/pkg/errors"
)
@@ -17,7 +18,7 @@ type RunGroupConfig struct {
InputFiles []string
Inputs []string
Probe *ooni.Probe
RunType string // hint for check-in API
RunType model.RunType // hint for check-in API
}
const websitesURLLimitRemoved = `WARNING: CONFIGURATION CHANGE REQUIRED:
@@ -58,7 +59,7 @@ func RunGroup(config RunGroupConfig) error {
return nil
}
sess, err := config.Probe.NewSession(context.Background())
sess, err := config.Probe.NewSession(context.Background(), config.RunType)
if err != nil {
log.WithError(err).Error("Failed to create a measurement session")
return err
cmd/ooniprobe/internal/ooni/ooni.go
+17 -5
View File
@@ -17,10 +17,14 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine"
"github.com/ooni/probe-cli/v3/internal/engine/legacy/assetsdir"
"github.com/ooni/probe-cli/v3/internal/kvstore"
"github.com/ooni/probe-cli/v3/internal/model"
"github.com/pkg/errors"
"upper.io/db.v3/lib/sqlbuilder"
)
// DefaultSoftwareName is the default software name.
const DefaultSoftwareName = "ooniprobe-cli"
// ProbeCLI is the OONI Probe CLI context.
type ProbeCLI interface {
Config() *config.Config
@@ -28,7 +32,7 @@ type ProbeCLI interface {
IsBatch() bool
Home() string
TempDir() string
NewProbeEngine(ctx context.Context) (ProbeEngine, error)
NewProbeEngine(ctx context.Context, runType model.RunType) (ProbeEngine, error)
}
// ProbeEngine is an instance of the OONI Probe engine.
@@ -199,7 +203,7 @@ func (p *Probe) Init(softwareName, softwareVersion string) error {
// NewSession creates a new ooni/probe-engine session using the
// current configuration inside the context. The caller must close
// the session when done using it, by calling sess.Close().
func (p *Probe) NewSession(ctx context.Context) (*engine.Session, error) {
func (p *Probe) NewSession(ctx context.Context, runType model.RunType) (*engine.Session, error) {
kvstore, err := kvstore.NewFS(
utils.EngineDir(p.home),
)
@@ -209,10 +213,18 @@ func (p *Probe) NewSession(ctx context.Context) (*engine.Session, error) {
if err := os.MkdirAll(p.tunnelDir, 0700); err != nil {
return nil, errors.Wrap(err, "creating tunnel dir")
}
// When the software name is the default software name and we're running
// in unattended mode, adjust the software name accordingly.
//
// See https://github.com/ooni/probe/issues/2081.
softwareName := p.softwareName
if runType == model.RunTypeTimed && softwareName == DefaultSoftwareName {
softwareName = DefaultSoftwareName + "-unattended"
}
return engine.NewSession(ctx, engine.SessionConfig{
KVStore: kvstore,
Logger: enginex.Logger,
SoftwareName: p.softwareName,
SoftwareName: softwareName,
SoftwareVersion: p.softwareVersion,
TempDir: p.tempDir,
TunnelDir: p.tunnelDir,
@@ -220,8 +232,8 @@ func (p *Probe) NewSession(ctx context.Context) (*engine.Session, error) {
}
// NewProbeEngine creates a new ProbeEngine instance.
func (p *Probe) NewProbeEngine(ctx context.Context) (ProbeEngine, error) {
sess, err := p.NewSession(ctx)
func (p *Probe) NewProbeEngine(ctx context.Context, runType model.RunType) (ProbeEngine, error) {
sess, err := p.NewSession(ctx, runType)
if err != nil {
return nil, err
}
cmd/ooniprobe/internal/oonitest/oonitest.go
+2 -1
View File
@@ -8,6 +8,7 @@ import (
"github.com/apex/log"
"github.com/ooni/probe-cli/v3/cmd/ooniprobe/internal/config"
"github.com/ooni/probe-cli/v3/cmd/ooniprobe/internal/ooni"
"github.com/ooni/probe-cli/v3/internal/model"
"upper.io/db.v3/lib/sqlbuilder"
)
@@ -61,7 +62,7 @@ func (cli *FakeProbeCLI) TempDir() string {
}
// NewProbeEngine implements ProbeCLI.NewProbeEngine
func (cli *FakeProbeCLI) NewProbeEngine(ctx context.Context) (ooni.ProbeEngine, error) {
func (cli *FakeProbeCLI) NewProbeEngine(ctx context.Context, runType model.RunType) (ooni.ProbeEngine, error) {
return cli.FakeProbeEnginePtr, cli.FakeProbeEngineErr
}