Merge pull request #92 from ooni/develop

Release 3.0.0-rc.5

.gitignore

@@ -1,5 +1,5 @@
 /dist
-/ooni.cov
+/ooniprobe
 /coverage.cov
 /testdata/gotmp
 *.njson

go.mod

@@ -13,7 +13,7 @@ require (
 	github.com/kr/pty v1.1.8 // indirect
 	github.com/mattn/go-colorable v0.1.4
 	github.com/mattn/go-isatty v0.0.11 // indirect
-	github.com/ooni/probe-engine v0.3.0
+	github.com/ooni/probe-engine v0.4.0
 	github.com/pkg/errors v0.8.1
 	github.com/rubenv/sql-migrate v0.0.0-20191213152630-06338513c237
 	golang.org/x/sys v0.0.0-20191224085550-c709ea063b76 // indirect

internal/cli/run/run.go

@@ -149,6 +149,10 @@ func init() {
 	middleboxCmd.Action(func(_ *kingpin.ParseContext) error {
 		return runNettestGroup("middlebox", ctx, network)
 	})
+	circumventionCmd := cmd.Command("circumvention", "")
+	circumventionCmd.Action(func(_ *kingpin.ParseContext) error {
+		return runNettestGroup("circumvention", ctx, network)
+	})
 	allCmd := cmd.Command("all", "").Default()
 	allCmd.Action(func(_ *kingpin.ParseContext) error {
 		log.Infof("Running %s tests", color.BlueString("all"))

internal/log/handlers/cli/cli.go

@@ -110,10 +110,13 @@ func (h *Handler) TypedLog(t string, e *log.Entry) error {
 	case "progress":
 		perc := e.Fields.Get("percentage").(float64) * 100
 		eta := e.Fields.Get("eta").(float64)
-		s := fmt.Sprintf("   %s %-25s (%ss left)",
+		var etaMessage string
+		if eta >= 0 {
+			etaMessage = fmt.Sprintf("(%ss left)", bold.Sprintf("%.2f", eta))
+		}
+		s := fmt.Sprintf("   %s %-25s %s",
 			bold.Sprintf("%.2f%%", perc),
-			e.Message,
-			bold.Sprintf("%.2f", eta))
+			e.Message, etaMessage)
 		fmt.Fprint(h.Writer, s)
 		fmt.Fprintln(h.Writer)
 		return nil

internal/log/handlers/cli/results.go

@@ -69,6 +69,13 @@ var summarizers = map[string]func(uint64, uint64, string) []string{
 			"",
 		}
 	},
+	"circumvention": func(totalCount uint64, anomalyCount uint64, ss string) []string {
+		return []string{
+			fmt.Sprintf("Detected: %v", anomalyCount > 0),
+			"",
+			"",
+		}
+	},
 }
 
 func makeSummary(name string, totalCount uint64, anomalyCount uint64, ss string) []string {

nettests/groups.go

@@ -36,4 +36,10 @@ var NettestGroups = map[string]NettestGroup{
 			WhatsApp{},
 		},
 	},
+	"circumvention": NettestGroup{
+		Label: "Circumvention Tools",
+		Nettests: []Nettest{
+			Psiphon{},
+		},
+	},
 }

nettests/nettests.go

@@ -192,12 +192,14 @@ func (c *Controller) OnProgress(perc float64, msg string) {
 	log.Debugf("OnProgress: %f - %s", perc, msg)
 	var eta float64
 	eta = -1.0
-	if c.numInputs >= 1 {
+	if c.numInputs > 1 {
 		// make the percentage relative to the current input over all inputs
 		floor := (float64(c.curInputIdx) / float64(c.numInputs))
 		step := 1.0 / float64(c.numInputs)
 		perc = floor + perc*step
-		eta = (float64(time.Now().Sub(c.ntStartTime).Seconds()) / float64(c.curInputIdx)) * float64(c.numInputs-c.curInputIdx)
+		if c.curInputIdx > 0 {
+			eta = (time.Now().Sub(c.ntStartTime).Seconds() / float64(c.curInputIdx)) * float64(c.numInputs-c.curInputIdx)
+		}
 	}
 	if c.ntCount > 0 {
 		// make the percentage relative to the current nettest over all nettests

nettests/psiphon.go

@@ -0,0 +1,33 @@
+package nettests
+
+// Psiphon test implementation
+type Psiphon struct {
+}
+
+// Run starts the test
+func (h Psiphon) Run(ctl *Controller) error {
+	builder, err := ctl.Ctx.Session.NewExperimentBuilder(
+		"psiphon",
+	)
+	if err != nil {
+		return err
+	}
+	return ctl.Run(builder, []string{""})
+}
+
+// PsiphonTestKeys contains the test keys
+type PsiphonTestKeys struct {
+	IsAnomaly bool `json:"-"`
+}
+
+// GetTestKeys generates a summary for a test run
+func (h Psiphon) GetTestKeys(tk map[string]interface{}) (interface{}, error) {
+	return PsiphonTestKeys{
+		IsAnomaly: tk["failure"] != nil,
+	}, nil
+}
+
+// LogSummary writes the summary to the standard output
+func (h Psiphon) LogSummary(s string) error {
+	return nil
+}

nettests/telegram.go

@@ -12,9 +12,6 @@ func (h Telegram) Run(ctl *Controller) error {
 	if err != nil {
 		return err
 	}
-	if err := builder.SetOptionString("LogLevel", "INFO"); err != nil {
-		return err
-	}
 	return ctl.Run(builder, []string{""})
 }
 

ooni.go

@@ -92,7 +92,15 @@ func (c *Context) Init() error {
 	}
 	c.TempDir = tempDir
 
+	kvstore, err := engine.NewFileSystemKVStore(
+		utils.EngineDir(c.Home),
+	)
+	if err != nil {
+		return errors.Wrap(err, "creating engine's kvstore")
+	}
+
 	sess, err := engine.NewSession(engine.SessionConfig{
+		KVStore:         kvstore,
 		Logger:          enginex.Logger,
 		SoftwareName:    "ooniprobe-desktop",
 		SoftwareVersion: version.Version,

utils/paths.go

@@ -30,6 +30,12 @@ func AssetsDir(home string) string {
 	return filepath.Join(home, "assets")
 }
 
+// EngineDir returns the directory where ooni/probe-engine should
+// store its private data given a specific OONI Home.
+func EngineDir(home string) string {
+	return filepath.Join(home, "engine")
+}
+
 // DBDir returns the database dir for the given name
 func DBDir(home string, name string) string {
 	return filepath.Join(home, "db", fmt.Sprintf("%s.sqlite3", name))

version/version.go

@@ -3,7 +3,7 @@ package version
 
 const (
 	// Version is the software version
-	Version = "3.0.0-rc.4"
+	Version = "3.0.0-rc.5"
 
 	// UserAgent is the OONI user-agent header
 	UserAgent = "ooniprobe-desktop/" + Version