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

20
internal/engine/oonimkall/README.md Normal file
View file

@ -0,0 +1,20 @@
# Package github.com/ooni/probe-engine/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](https://github.com/measurement-kit/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.