ooni-probe-cli/internal/engine/experiment
Simone Basso 273b70bacc
refactor: interfaces and data types into the model package (#642)
## 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
2022-01-03 13:53:23 +01:00
..
dash refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
dnscheck refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
example refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
fbmessenger refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
hhfm refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
hirl refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
httphostheader refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
ndt7 refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
psiphon refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
riseupvpn refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
run refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
signal refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
sniblocking refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
stunreachability refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
telegram refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
tlstool refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
tor refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
torsf refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
urlgetter refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
webconnectivity refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
websteps refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
webstepsx refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
whatsapp refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +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.