ooni-probe-cli/internal/engine/experiment
Simone Basso 99b28c1d95
refactor: start building an Android package (#205)
* refactor: start building an Android package

Part of https://github.com/ooni/probe/issues/1335.

This seems also a good moment to move some packages out of the
engine, e.g., oonimkall. This package, for example, is a consumer
of the engine, so it makes sense it's not _inside_ it.

* fix: committed some stuff I didn't need to commit

* fix: oonimkall needs to be public to build

The side effect is that we will probably need to bump the major
version number every time we change one of these APIs.

(We can also of course choose to violate the basic guidelines of Go
software, but I believe this is bad form.)

I have no problem in bumping the major quite frequently and in
any case this monorepo solution is convinving me more than continuing
to keep a split between engine and cli. The need to embed assets to
make the probe more reliable trumps the negative effects of having to
~frequently bump major because we expose a public API.

* fix: let's not forget about libooniffi

Honestly, I don't know what to do with this library. I added it
to provide a drop in replacement for MK but I have no idea whether
it's used and useful. I would not feel comfortable exposing it,
unlike oonimkall, since we're not using it.

It may be that the right thing to do here is just to delete the
package and reduce the amount of code we're maintaining?

* woops, we're still missing the publish android script

* fix(publish-android.bash): add proper API key

* ouch fix another place where the name changed
2021-02-03 10:51:14 +01:00
..
dash chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
dnscheck refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
example chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
fbmessenger chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
hhfm chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
hirl chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
httphostheader chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
ndt7 chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
psiphon chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
riseupvpn chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
run chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
sniblocking chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
stunreachability chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
telegram chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
tlstool refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
tor refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
urlgetter refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
webconnectivity refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
whatsapp refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
README.md chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00

Directory github.com/ooni/probe-engine/experiment

This directory contains the implementation of all the supported experiments, one for each directory. The OONI spec repository contains a description of all the specified experiments.

Note that in the OONI spec repository experiments are called nettests. Originally, they were also called nettests here but that created confusion with nettests in ooni/probe-cli. Therefore, we now use the term experiment to indicate the implementation and the term nettest to indicate the user facing view of such implementation.

Note that some experiments implemented here are not part of the OONI specification. For example, the urlgetter experiment is not in the OONI spec repository. The reason why this happens is that urlgetter is an experiment "library" that other experiments use to implement their functionality.

Likewise, the example experiment is a minimal experiment that does nothing and you could use to bootstrap the implementation of a new experiment. Of course, this experiment is not part of the OONI specification.