0f61778e7a
* poc: mobile api for running WebConnectivity Yesterday we had a team meeting where we discussed the importance of stopping using MK wrappers for running experiments. Here's a PoC showing how we can do that for WebConnectivity. It seems to me we probably want to add more tests and merge this code such that we can experiment with it quite soon. There seems to be opportunities for auto-generating code, BTW. While working on this PoC, I've also took a chance to revamp the external documentation of pkg/oonimkall. * feat: start making the code more abstract * chore: write unit tests for new code * fix(oonimkall): improve naming * refactor: cosmetic changes * fix: explain |
||
|---|---|---|
| .. | ||
| internal/tasks | ||
| .gitignore | ||
| experiment_test.go | ||
| experiment.go | ||
| README.md | ||
| session_integration_test.go | ||
| session_test.go | ||
| session.go | ||
| sessioncontext_test.go | ||
| sessioncontext.go | ||
| sessionlogger_test.go | ||
| sessionlogger.go | ||
| task_integration_test.go | ||
| task_internal_test.go | ||
| task.go | ||
| uuid_test.go | ||
| uuid.go | ||
| webconnectivity_integration_test.go | ||
| webconnectivity_test.go | ||
| webconnectivity.go | ||
Package github.com/ooni/probe-cli/pkg/oonimkall
Package oonimkall implements APIs used by OONI mobile apps. We expose these APIs to mobile apps using gomobile.
We expose two APIs: the task API, which is derived from the
API originally exposed by Measurement Kit, and the session API,
which is a Go API that mobile apps can use via gomobile.
This package is named oonimkall because it contains a partial reimplementation of the mkall API implemented by Measurement Kit in, e.g., mkall-ios.
The basic tenet of the task API is that you define an experiment task you wanna run using a JSON, then you start a task for it, and you receive events as serialized JSONs. In addition to this functionality, we also include extra APIs used by OONI mobile.
The basic tenet of the session API is that you create an instance
of Session and use it to perform the operations you need.