d1vyank/probe-engine

Go engine for probe-cli, probe-android, probe-ios

OONI probe measurement engine

This repository contains OONI probe's measurement engine. That is, the piece of software that implements OONI nettests as well as all the required functionality to run such nettests.

We expect you to use the Go version indicated in go.mod.

Integrating ooni/probe-engine

We recommend pinning to a specific version of probe-engine:

go get -v github.com/ooni/probe-engine@VERSION

See also the workflows/using.yml test where we check that the latest commit can be imported by a third party.

We do not provide any API stability guarantee.

Building miniooni

miniooni is a small command line client used for research and quality assurance testing. Build using:

go build -v ./cmd/miniooni/

We don't provide any miniooni command line flags stability guarantee.

See

./miniooni --help

for more help.

Building Android bindings

./build-android.bash

We automatically build Android bindings whenever commits are pushed to the mobile-staging branch. Such builds could be integrated by using:

implementation "org.ooni:oonimkall:VERSION"

Where VERSION is like 2020.03.30-231914 corresponding to the time when the build occurred.

Building iOS bindings

./build-ios.bash

We automatically build iOS bindings whenever commits are pushed to the mobile-staging branch. Such builds could be integrated by using:

pod 'oonimkall', :podspec => 'https://dl.bintray.com/ooni/ios/oonimkall-VERSION.podspec'

Where VERSION is like 2020.03.30-231914 corresponding to the time when the build occurred.

Release procedure

1. make sure that dependencies are up to date

2. make sure that resources are up to date

3. commit, tag, and push

4. create new release on GitHub

Updating dependencies

1. update direct dependencies using:

for name in `grep -v indirect go.mod | awk '/^\t/{print $1}'`; do \
  go get -u -v $name;                                             \
done

2. pin to a specific psiphon version (we usually track the staging-client branch) using:

go get -v github.com/Psiphon-Labs/psiphon-tunnel-core@COMMITHASH

3. clone psiphon-tunnel-core, checkout the tip of the staging-client branch and generate a go.mod by running go mod init && go mod tidy in the toplevel dir

4. rewrite go.mod such that it contains only your direct dependencies followed by the exact content of psiphon-tunnel-core's go.mod

5. run go mod tidy

6. make sure you don't downgrade bolt and goselect because this will break downstream builds on MIPS:

go get -u -v github.com/Psiphon-Labs/bolt github.com/creack/goselect

The above procedure allows us to pin all psiphon dependencies precisely.