ooni-probe-cli/pkg/oonimkall
Simone Basso 97864b324f
refactor(engine): more abstract Experiment{,Builder} (#838)
This diff modifies the engine package to make Experiment and
ExperimentBuilder interfaces rather than structs.

The previosuly existing structs are now named experiment{,Builder}.

This diff helps https://github.com/ooni/probe/issues/2184
because it allows us to write unit tests more easily.

There should be no functional change.

While there, I removed a bunch of deprecated functions, which were
unnecessarily complicate the implementation and could be easily
replaced by passing them a context.Context or context.Background().
2022-07-08 12:29:23 +02:00
..
.gitignore refactor: we don't wanna export pkg/oonimkall/tasks (#216) 2021-02-03 19:48:23 +01:00
doc.go doc: publish the step-by-step design document (#814) 2022-06-14 14:38:29 +02:00
experiment_test.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
experiment.go refactor(engine): more abstract Experiment{,Builder} (#838) 2022-07-08 12:29:23 +02:00
README.md refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
session_integration_test.go cleanup: mark more integration tests as !short mode (#755) 2022-05-24 21:01:15 +02:00
session_test.go refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
session.go cleanup: move legacy from internal/engine to internal (#759) 2022-05-25 10:19:03 +02:00
sessioncontext_test.go cleanup: mark more integration tests as !short mode (#755) 2022-05-24 21:01:15 +02:00
sessioncontext.go refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
sessionlogger_test.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
sessionlogger.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
task_test.go cleanup: mark more integration tests as !short mode (#755) 2022-05-24 21:01:15 +02:00
task.go [forwardport] fix(oonimkall): ensure we can submit last measurement (#699) 2022-02-23 12:38:58 +01:00
taskemitter_test.go forwardport: pull the patches mentioned in ooni/probe#1908 (#629) 2021-12-02 12:47:07 +01:00
taskemitter.go forwardport: pull the patches mentioned in ooni/probe#1908 (#629) 2021-12-02 12:47:07 +01:00
tasklogger_test.go cleanup: mark more integration tests as !short mode (#755) 2022-05-24 21:01:15 +02:00
tasklogger.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
taskmocks_test.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
taskmodel.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
taskrunner_test.go fix(oonimkall): only set annotations on success (#821) 2022-07-01 09:54:35 +02:00
taskrunner.go fix(oonimkall): only set annotations on success (#821) 2022-07-01 09:54:35 +02:00
tasksession_test.go forwardport: pull the patches mentioned in ooni/probe#1908 (#629) 2021-12-02 12:47:07 +01:00
tasksession.go refactor(engine): more abstract Experiment{,Builder} (#838) 2022-07-08 12:29:23 +02:00
uuid_test.go refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
uuid.go refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
webconnectivity_integration_test.go oonimkall: mobile api for running WebConnectivity (#223) 2021-03-18 08:44:58 +01:00
webconnectivity_test.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
webconnectivity.go refactor: flatten and separate (#353) 2021-06-04 10:34:18 +02:00

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.