2018-03-14 14:44:37 +01:00
|
|
|
package performance
|
|
|
|
|
|
|
|
import (
|
2018-09-27 11:40:57 +02:00
|
|
|
"github.com/pkg/errors"
|
|
|
|
|
2018-05-03 14:59:55 +02:00
|
|
|
"github.com/ooni/probe-cli/nettests"
|
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
2019-08-15 18:08:43 +02:00
|
|
|
"github.com/ooni/probe-engine/experiment/dash"
|
2018-03-14 14:44:37 +01:00
|
|
|
)
|
|
|
|
|
|
|
|
// Dash test implementation
|
|
|
|
type Dash struct {
|
|
|
|
}
|
|
|
|
|
|
|
|
// Run starts the test
|
|
|
|
func (d Dash) Run(ctl *nettests.Controller) error {
|
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
2019-08-15 18:08:43 +02:00
|
|
|
experiment := dash.NewExperiment(
|
|
|
|
ctl.Ctx.Session, dash.Config{},
|
|
|
|
)
|
|
|
|
return ctl.Run(experiment, []string{""})
|
2018-03-14 14:44:37 +01:00
|
|
|
}
|
|
|
|
|
2018-09-10 12:41:28 +02:00
|
|
|
// DashTestKeys for the test
|
2018-03-14 14:44:37 +01:00
|
|
|
// TODO: process 'receiver_data' to provide an array of performance for a chart.
|
2018-09-10 12:41:28 +02:00
|
|
|
type DashTestKeys struct {
|
|
|
|
Latency float64 `json:"connect_latency"`
|
2018-09-27 11:40:57 +02:00
|
|
|
Bitrate float64 `json:"median_bitrate"`
|
2018-09-10 12:41:28 +02:00
|
|
|
Delay float64 `json:"min_playout_delay"`
|
|
|
|
IsAnomaly bool `json:"-"`
|
2018-03-14 14:44:37 +01:00
|
|
|
}
|
|
|
|
|
2018-09-10 12:41:28 +02:00
|
|
|
// GetTestKeys generates a summary for a test run
|
2018-09-27 11:40:57 +02:00
|
|
|
func (d Dash) GetTestKeys(tk map[string]interface{}) (interface{}, error) {
|
|
|
|
var err error
|
|
|
|
|
|
|
|
testKeys := DashTestKeys{IsAnomaly: false}
|
|
|
|
|
|
|
|
simple, ok := tk["simple"].(map[string]interface{})
|
|
|
|
if !ok {
|
|
|
|
return testKeys, errors.New("simple key is not of the expected type")
|
|
|
|
}
|
|
|
|
|
|
|
|
latency, ok := simple["connect_latency"].(float64)
|
|
|
|
if !ok {
|
|
|
|
err = errors.Wrap(err, "connect_latency is invalid")
|
|
|
|
}
|
|
|
|
testKeys.Latency = latency
|
|
|
|
|
|
|
|
bitrate, ok := simple["median_bitrate"].(float64)
|
|
|
|
if !ok {
|
|
|
|
err = errors.Wrap(err, "median_bitrate is invalid")
|
|
|
|
}
|
|
|
|
testKeys.Bitrate = bitrate
|
|
|
|
|
|
|
|
delay, ok := simple["min_playout_delay"].(float64)
|
|
|
|
if !ok {
|
|
|
|
err = errors.Wrap(err, "min_playout_delay is invalid")
|
2018-03-14 14:44:37 +01:00
|
|
|
}
|
2018-09-27 11:40:57 +02:00
|
|
|
testKeys.Delay = delay
|
|
|
|
return testKeys, err
|
2018-03-14 14:44:37 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// LogSummary writes the summary to the standard output
|
|
|
|
func (d Dash) LogSummary(s string) error {
|
|
|
|
return nil
|
|
|
|
}
|