c/ooni-probe-cli
Watch
1
0
Fork
You've already forked ooni-probe-cli
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

chore: merge probe-engine into probe-cli (#201)

Browse source 
This is how I did it:

1. `git clone https://github.com/ooni/probe-engine internal/engine`

2. ```
(cd internal/engine && git describe --tags)
v0.23.0
```

3. `nvim go.mod` (merging `go.mod` with `internal/engine/go.mod`

4. `rm -rf internal/.git internal/engine/go.{mod,sum}`

5. `git add internal/engine`

6. `find . -type f -name \*.go -exec sed -i 's@/ooni/probe-engine@/ooni/probe-cli/v3/internal/engine@g' {} \;`

7. `go build ./...` (passes)

8. `go test -race ./...` (temporary failure on RiseupVPN)

9. `go mod tidy`

10. this commit message

Once this piece of work is done, we can build a new version of `ooniprobe` that
is using `internal/engine` directly. We need to do more work to ensure all the
other functionality in `probe-engine` (e.g. making mobile packages) are still WAI.

Part of https://github.com/ooni/probe/issues/1335
This commit is contained in:
Simone Basso 2021-02-02 12:05:47 +01:00 • committed by GitHub
commit d57c78bc71
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
535 changed files with 66182 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

24
internal/engine/experiment/README.md Normal file
View file

@ -0,0 +1,24 @@
# 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](
https://github.com/ooni/spec/tree/master/nettests).
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](
https://github.com/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](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](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.