273b70bacc
## Checklist - [x] I have read the [contribution guidelines](https://github.com/ooni/probe-cli/blob/master/CONTRIBUTING.md) - [x] reference issue for this pull request: https://github.com/ooni/probe/issues/1885 - [x] related ooni/spec pull request: N/A Location of the issue tracker: https://github.com/ooni/probe ## Description This PR contains a set of changes to move important interfaces and data types into the `./internal/model` package. The criteria for including an interface or data type in here is roughly that the type should be important and used by several packages. We are especially interested to move more interfaces here to increase modularity. An additional side effect is that, by reading this package, one should be able to understand more quickly how different parts of the codebase interact with each other. This is what I want to move in `internal/model`: - [x] most important interfaces from `internal/netxlite` - [x] everything that was previously part of `internal/engine/model` - [x] mocks from `internal/netxlite/mocks` should also be moved in here as a subpackage |
||
|---|---|---|
| .. | ||
| .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_test.go | ||
| task.go | ||
| taskemitter_test.go | ||
| taskemitter.go | ||
| tasklogger_test.go | ||
| tasklogger.go | ||
| taskmocks_test.go | ||
| taskmodel.go | ||
| taskrunner_test.go | ||
| taskrunner.go | ||
| tasksession_test.go | ||
| tasksession.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.