87e5234586
This change allows us to have all fasts tests together. They are mostly unit tests or integration tests that do not require the network. The advantage of this strategy is the following. We can now run all these tests with a single click in VSCode. In turn, doing that tells us which lines of code we are not covering. The tests requiring the network are in a separate file, so we can easily see which lines of code are testing without using the network and which ones instead depend on that. (Currently, 100% of the inputloader.go file is tested without using the network.) While there, rename the other file such that is clear that it contains tests requiring the network. We now have some tests in inputloader_test.go that are not strictly unit tests. This refactoring was identified as useful while working on https://github.com/ooni/probe/issues/1299.
OONI Probe Client Library and CLI
The next generation OONI Probe: client library and 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.16 and a C compiler (when developing for Windows, you need Mingw-w64 installed).
You need to download assets first using:
go run ./internal/cmd/getresources
Then you can build using:
go build -v ./cmd/ooniprobe
This will generate a binary called ooniprobe in the current directory.
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
internal/version/version.go; -
make sure you have updated dependencies;
-
run
./build.sh releaseand follow instructions.