e4ef279b80
When the input is /dev/null, every read returns EOF. In general, it may also happen that read doesn't work as intended. So, the robust thing to do here is to ensure that we check the return values. By doing that we notice of io.EOF errors and we don't proceed with the onboarding. This diff fixes the issue described by https://github.com/ooni/probe/issues/1281 however it may be that we also want (in the near or not-so-near future) to stop onboarding if the input terminal is not a tty. This is however a possible future evolution that should not prevent us for committing and merging this simple fix that unblocks creating a Debian package.
OONI Probe CLI
The next generation OONI Probe Command Line Interface.
User setup
-
Go into the releases and download the release for your architecture and platform
-
Extract the tarball with
tar xvzf ooniprobe_*.tar.gz -
Copy the
ooniprobebinary into a location in your$PATH, for example/usr/local/bin/ooniprobe -
Run
ooniprobe runto perform all the tests
Optional:
Add a crontab entry (on linux) to run ooniprobe daily at a random time:
(crontab -l 2>/dev/null; echo "$(( ( RANDOM % 60 ) + 1 )) $(( ( RANDOM % 24 ) + 1 )) * * * ooniprobe run") | crontab -
On macOS you can configure OONI Probe to run automatically using launchd.
Below is a sample launchd script, that should be placed inside of
~/Library/LaunchAgents/org.ooni.probe.cli.plist.
Be sure to replace /PATH/TO/BINARY/ooniprobe with the actual install location of the
ooniprobe binary and /PATH/TO/CONFIG/config-100sites.json with the location of a file
which limits the testing to 100 URLs.
You may also want to adjust the locations of the logs.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Label</key>
<string>org.ooni.probe.daily-run</string>
<key>KeepAlive</key>
<false/>
<key>RunAtLoad</key>
<true/>
<key>Program</key>
<string>/PATH/TO/BINARY/ooniprobe</string>
<key>ProgramArguments</key>
<array>
<string>--config="/PATH/TO/CONFIG/config-100sites.json"</string>
<string>--batch</string>
<string>run</string>
</array>
<key>StartInterval</key>
<integer>3600</integer>
<key>StandardErrorPath</key>
<string>/tmp/ooniprobe-cli.err</string>
<key>StandardOutPath</key>
<string>/tmp/ooniprobe-cli.out</string>
</dict>
</plist>
Once you have written the file, you can enable ooniprobe to run automatically by
doing: launchctl load org.ooni.probe.cli.plist.
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
To compile a release used the build.sh script. For more information
./build.sh help
The output generated by this command should provide you with updated information
regarding the pre-requisites for building (and cross-building) ooniprobe as well
as useful information regarding cross compiling.
To update bundled binary data use:
./updatebindata.sh
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.