f53b3be66e
* feat: add end-to-end testing to this repository Part of https://github.com/ooni/probe-engine/issues/1181 Motivation: we want to run this check from the repository where we work the most, such that it's unlikely it pauses due to inactivity, as it may happen for less frequently touched upon repositories. Code adapted from https://github.com/ooni/e2etesting/ * fix: correct name for main branch
OONI Probe CLI
The next generation OONI Probe Command Line Interface.
User setup
Please, follow the instructions at ooni.org/install/cli
to install ooniprobe. If we do not support your use case, please let us know.
Once ooniprobe is installed, try ooniprobe help to get interactive help.
Reporting issues
Please, report issues with this codebase at github.com/ooni/probe.
Please, make sure you tag such issues using the ooni/probe-cli label.
Repository organization
Every top-level directory contains an explanatory README file.
Development setup
Be sure you have golang >= 1.14 and a C compiler (when developing for Windows, you need Mingw-w64 installed). The most basic build command is:
go build -v ./cmd/ooniprobe
This will generate a binary called ooniprobe in the current directory.
Update bundled assets
To update bundled assets use:
./updatebindata.sh
Then commit the changes.
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.
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.
Updating dependencies
go get -u -v ./... && go mod tidy
Releasing
-
update binary data as described above;
-
update
version/version.go; -
make sure you have updated dependencies;
-
run
./build.sh releaseand follow instructions.