Integrate further with ooni/probe-engine: episode two (#46)
* utils/geoip.go: use github.com/ooni/probe-engine
Let's start using the engine by rewriting utils/geoip.go to
be just a thin wrapper around the engine functionality.
* Ready for review
* Checkpoint: the im tests are converted
Still have some doubts with respect to the variables that
are passed to MK via probe-engine. Will double check.
* fix(i/c/r/run.go): write the correct logic
* nettests: one more comment and also fix a format string
* Tweak previous
* progress
* Fix doofus
* better comment
* XXX => actionable comment
* Add glue to simplify test keys management
Making the concept of measurement more abstract in the engine is
not feasible because, when submitting a measurement, we need to
modify it to update the report ID and the measurement ID. Therefore,
returning a serialized measurement is not a good idea. We will
keep using a model.Measurement in the engine.
Changing model.Measurement.TestKeys's type from a `interface{}`
pointing to a well defined data structure to `map[string]interface{}`
is a regression because means that we are moving from code that
has a clear and defined structure to code that is more complicated
to parse and validate. Since we're already suffering havily from
the lack of a good schema, I'm not going to make the situation
worst by worsening the engine. At least for ndt7 and psiphon, we
now have a good schema and I don't want to lose that.
However, the current code in this repository is expecting the
test keys to be a `map[string]interface{}`. This choice was
dictated by the fact that we receive a JSON from Measurement Kit
and by the fact that there's not a clear schema.
To solve this tension, in this commit I am going to write glue
adapter code that makes sure that the TestKeys of a Measurement
are converted to `map[string]interface{}`. This will be done
using a type cast where possible and JSON serialization and parsing
otherwise. In a perfect world, glue is not a good idea, but in a
real world it may actually be useful.
When all tests in the engine will have a clear Go data structure,
we'll then remove the glue and just cast to the proper data
structure from `interface{}` where required.
* nettests/performance: use probe-engine
* go.{mod,sum}: upgrade to latest probe-engine
* nettests/middlebox: use ooni/probe-engine
* Update to the latest probe-engine
* web_connectivity: rewrite to use probe-engine
* Cosmetic change suggested by @hellais
* nettests/nettests.go: remove unused code
* nettests/nettests.go: fix progress
* nettests/nettests.go: remove go-measurement-kit code
* We don't depend on go-measurement-kit anymore
* Improve non-verbose output where possible
See also: https://github.com/measurement-kit/measurement-kit/issues/1856
* Make web_connectivity output pleasant
* Update to the latest probe-engine
* nettests/nettests.go: honour sharing settings
* Update to the latest probe-engine
* Use log.WithFields for probe-engine
* Update go.mod go.sum
* Revert "Update go.mod go.sum"
This reverts commit 5ecd38d8236f4a4e9b77ddb8e8a0d1e3cdd4b818.
* Revert "Revert "Update go.mod go.sum""
This reverts commit 6114b31eca98826112032776bd0feff02d763ecd.
* Upgrade ooni/probe-engine
* Unset GOPATH before running go build commands
* Dockefile: fix linux build by using latest
* Update to the latest ooni/probe-engine
```
go get -u github.com/ooni/probe-engine
go mod tidy
```
* Repair build
This commit is contained in:
committed by
Arturo Filastò
parent
df629237be
commit
b9b555ba68
@@ -1,6 +1,7 @@
|
||||
package run
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"strings"
|
||||
@@ -95,6 +96,22 @@ func init() {
|
||||
log.WithError(err).Error("Failed to create the network row")
|
||||
return err
|
||||
}
|
||||
if ctx.Config.Advanced.BouncerURL != "" {
|
||||
ctx.Session.AddAvailableHTTPSBouncer(ctx.Config.Advanced.BouncerURL)
|
||||
}
|
||||
if err := ctx.Session.MaybeLookupBackends(context.Background()); err != nil {
|
||||
log.WithError(err).Warn("Failed to discover available test helpers")
|
||||
// Rationale for falling through: some tests may be able to complete
|
||||
// with no test helpers, so stopping may be excessive here.
|
||||
}
|
||||
if ctx.Config.Sharing.UploadResults {
|
||||
if ctx.Config.Advanced.CollectorURL != "" {
|
||||
ctx.Session.AddAvailableHTTPSCollector(ctx.Config.Advanced.CollectorURL)
|
||||
} else if err := ctx.Session.MaybeLookupCollectors(context.Background()); err != nil {
|
||||
log.WithError(err).Error("Failed to discover available collectors")
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
if *nettestGroup == "" {
|
||||
log.Infof("Running %s tests", color.BlueString("all"))
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
// Package enginex contains ooni/probe-engine extensions.
|
||||
package enginex
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"github.com/apex/log"
|
||||
"github.com/ooni/probe-engine/model"
|
||||
)
|
||||
|
||||
// Logger is the logger used by the engine.
|
||||
var Logger = log.WithFields(log.Fields{
|
||||
"type": "engine",
|
||||
})
|
||||
|
||||
// MakeGenericTestKeys casts the m.TestKeys to a map[string]interface{}.
|
||||
//
|
||||
// Ideally, all tests should have a clear Go structure, well defined, that
|
||||
// will be stored in m.TestKeys as an interface. This is not already the
|
||||
// case and it's just valid for tests written in Go. Until all tests will
|
||||
// be written in Go, we'll keep this glue here to make sure we convert from
|
||||
// the engine format to the cli format.
|
||||
//
|
||||
// This function will first attempt to cast directly to map[string]interface{},
|
||||
// which is possible for MK tests, and then use JSON serialization and
|
||||
// de-serialization only if that's required.
|
||||
func MakeGenericTestKeys(m model.Measurement) (map[string]interface{}, error) {
|
||||
if result, ok := m.TestKeys.(map[string]interface{}); ok {
|
||||
return result, nil
|
||||
}
|
||||
data, err := json.Marshal(m.TestKeys)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var result map[string]interface{}
|
||||
err = json.Unmarshal(data, &result)
|
||||
return result, err
|
||||
}
|
||||
@@ -104,6 +104,9 @@ func logTable(w io.Writer, f log.Fields) error {
|
||||
// TypedLog is used for handling special "typed" logs to the CLI
|
||||
func (h *Handler) TypedLog(t string, e *log.Entry) error {
|
||||
switch t {
|
||||
case "engine":
|
||||
fmt.Fprintf(h.Writer, "[engine] %s\n", e.Message)
|
||||
return nil
|
||||
case "progress":
|
||||
perc := e.Fields.Get("percentage").(float64) * 100
|
||||
s := fmt.Sprintf(" %s %-25s",
|
||||
|
||||
Reference in New Issue
Block a user