ooni-probe-cli/internal/engine/experiment
Simone Basso 2e0118d1a6
refactor(netxlite): hide details without breaking the rest of the tree (#454)
## Description

This PR continues the refactoring of `netx` under the following principles:

1. do not break the rest of the tree and do not engage in extensive tree-wide refactoring yet
2. move under `netxlite` clearly related subpackages (e.g., `iox`, `netxmocks`)
3. move into `internal/netxlite/internal` stuff that is clearly private of `netxlite`
4. hide implementation details in `netxlite` pending new factories
5. refactor `tls` code in `netxlite` to clearly separate `crypto/tls` code from `utls` code

After each commit, I run `go test -short -race ./...` locally. Each individual commit explains what it does. I will squash, but this operation will preserve the original commit titles, so this will give further insight on each step.

## Commits

* refactor: rename netxmocks -> netxlite/mocks

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

* refactor: rename quicx -> netxlite/quicx

See https://github.com/ooni/probe/issues/1591

* refactor: rename iox -> netxlite/iox

Regenerate sources and make sure the tests pass.

See https://github.com/ooni/probe/issues/1591.

* refactor(iox): move MockableReader to netxlite/mocks

See https://github.com/ooni/probe/issues/1591

* refactor(netxlite): generator is an implementation detail

See https://github.com/ooni/probe/issues/1591

* refactor(netxlite): separate tls and utls code

See https://github.com/ooni/probe/issues/1591

* refactor(netxlite): hide most types but keep old names as legacy

With this change we avoid breaking the rest of the tree, but we start
hiding some implementation details a bit. Factories will follow.

See https://github.com/ooni/probe/issues/1591
2021-09-05 14:49:38 +02:00
..
dash refactor(netxlite): hide details without breaking the rest of the tree (#454) 2021-09-05 14:49:38 +02:00
dnscheck feat: tutorial on how to write the torsf experiment (#390) 2021-06-22 00:12:03 +02:00
example feat: tutorial on how to write the torsf experiment (#390) 2021-06-22 00:12:03 +02:00
fbmessenger refactor: move i/e/n/errorx to i/errorsx (#416) 2021-07-01 16:34:36 +02:00
hhfm refactor(netxlite): hide details without breaking the rest of the tree (#454) 2021-09-05 14:49:38 +02:00
hirl refactor: move i/e/n/errorx to i/errorsx (#416) 2021-07-01 16:34:36 +02:00
httphostheader feat: tutorial on how to write the torsf experiment (#390) 2021-06-22 00:12:03 +02:00
ndt7 refactor(netxlite): hide details without breaking the rest of the tree (#454) 2021-09-05 14:49:38 +02:00
psiphon feat: tutorial on how to write the torsf experiment (#390) 2021-06-22 00:12:03 +02:00
riseupvpn refactor: move i/e/n/errorx to i/errorsx (#416) 2021-07-01 16:34:36 +02:00
run feat: tutorial on how to write the torsf experiment (#390) 2021-06-22 00:12:03 +02:00
signal refactor: move i/e/n/errorx to i/errorsx (#416) 2021-07-01 16:34:36 +02:00
sniblocking refactor: move i/e/n/errorx to i/errorsx (#416) 2021-07-01 16:34:36 +02:00
stunreachability refactor: move i/e/n/errorx to i/errorsx (#416) 2021-07-01 16:34:36 +02:00
telegram refactor: move i/e/n/errorx to i/errorsx (#416) 2021-07-01 16:34:36 +02:00
tlstool feat: tutorial on how to write the torsf experiment (#390) 2021-06-22 00:12:03 +02:00
tor refactor: move i/e/n/errorx to i/errorsx (#416) 2021-07-01 16:34:36 +02:00
torsf feat: tutorial on how to write the torsf experiment (#390) 2021-06-22 00:12:03 +02:00
urlgetter refactor(netxlite): hide details without breaking the rest of the tree (#454) 2021-09-05 14:49:38 +02:00
webconnectivity refactor: move i/e/n/errorx to i/errorsx (#416) 2021-07-01 16:34:36 +02:00
websteps refactor(netxlite): hide details without breaking the rest of the tree (#454) 2021-09-05 14:49:38 +02:00
whatsapp feat: tutorial on how to write the torsf experiment (#390) 2021-06-22 00:12:03 +02: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.