Commit Graph

50 Commits

Author SHA1 Message Date
Simone Basso
cfd3b8f9b2
feat(cli/run): read inputs from file/cmdline (#180)
This diff introduces the possibility of specifying --input-file file
multiple times to force ooniprobe to read inputs from file.

Like we do for miniooni, the file shall contain a single entry per
line and this entry should be a URL for websites.

Likewise, one can specify --input URL multiple times.

This implementation is a very simple, initial implementation and there
is a bunch of changes I'd like to add on top of it.

And also perhaps a bunch of cleanups.

I've chosen to expose these flag _only_ for websites for now.

Part of https://github.com/ooni/probe/issues/1283.
2020-12-01 07:21:33 +01:00
Simone Basso
fa803300bb refactor(ooni): introduce interfaces for testability 2020-11-20 12:19:51 +01:00
Simone Basso
9e238c27dd
refactor(internal/ooni): Context => Probe (#170)
Closes https://github.com/ooni/probe/issues/939
2020-11-13 19:01:06 +01:00
Simone Basso
163922e001
refactor: run go fmt ./... (#169) 2020-11-13 18:42:10 +01:00
Simone Basso
c81393b31a
refactor: move ooni into the internal package (#168)
With this commit we've reorganised the package structure. Now I will
go more in depth and perform further refactoring.
2020-11-13 17:47:29 +01:00
Simone Basso
a58dff3050
refactor: nettests is now an internal package (#165)
I'm moving everything into internal packages since this ain't a library.

While there, remove typo that was causing a build breakage.
2020-11-13 17:14:26 +01:00
Simone Basso
b4934b1619
Use ooni/probe-engine 0.12.0+patches (#133)
* nettests/groups.go: remove redundant struct names

* go.mod go.sum: update deps except probe-engine

* Update to ooni/probe-engine@e768161f91

The API has changed. Methods that used to change bits of the session have
been removed. Now the session is more immutable than before.

As such, we need to completely fill the config before using it.

* Set IncludeCountry to always true

Co-authored-by: Arturo Filastò <arturo@filasto.net>
2020-06-04 11:19:38 +02:00
Arturo Filastò
f2e62b7ad7 Always include the country code and drop include_probe_cc setting
Fixes: https://github.com/ooni/probe/issues/1183
2020-06-02 19:16:09 +02:00
Arturo Filastò
35016a183e Interrupt the nettestGroup loop early on termination
Fixes ooni/probe#1013
2020-02-20 12:24:24 +01:00
Simone Basso
040bee0ee6
Optionally treat EOF on stdin just like SIGTERM (#111)
* Optionally treat EOF on stdin just like SIGTERM

On Unix, Node.js allows us to gracefully kill a process. On Windows
this is more compex. You certainly cannot rely on the default `kill()`
function, which calls `TerminateProcess`.

There is a bunch of C/C++ extensions that in principle allow you to
attempt to gracefully shutdown a Windows process.

But, hey, here's a reality check. Node.js controls our stdin. Node.js
does IPC easy. Controlling uv_spawn flags and using the right not well maintained
C/C++ Node.js extension to kill a process is fragile.

So, treat EOF and any other error on stdin as equivalent to SIGTERM.

However, systemd.

The sane thing to do with systemd is `StandardInput=null`. With such
configuration, stdin immediately returns EOF.

Then, introduce the `OONI_STDIN_EOF_IMPLIES_SIGTERM` environment
variable. When it is `true`, this behaviour is enabled, e.g.:

```bash
export OONI_STDIN_EOF_IMPLIES_SIGTERM=true  # behaviour enabled
ooniprobe run
```

I want the default to be disabled because:

1. in the future we may find a better way to solve this problem and I
don't want the _default behaviour_ to change in such case

2. we know we need this knob for ooniprobe-desktop, and we will not
fail to provide it, so it won't suprise/damage us

3. a person trying to write a systemd unit for ooniprobe would be very
surprised to find out they need to disable this behaviour, if it was
enabled by default by this PR

Hence, I believe this design is consistent with designing for the
future and for trying to minimize surprises.

Also, why an environment variable and not a command line flag? Because:

1. we don't want such hypothetical flag to be available where it does not
make sense, e.g., for all subcommands but `run`

2. we don't want the ooni/probe-desktop app to write conditional
code because it needs to check the command we're using and then decide
whether to add such hypothetical flag

Also, why not enabling this only on Windows? Because again we don't
want the ooni/probe-desktop app to write conditional code.

To summarize: we want ooni/probe-desktop app to see the same behaviour
everywhere and we want others to be the least surprised.

Related to https://github.com/ooni/probe/issues/1005

* Update ooni.go
2020-02-13 14:53:06 +01:00
Arturo Filastò
20fb419126 Explicitly handle SIGINT 2020-02-07 15:33:37 +01:00
Simone Basso
259ab41b15 Implement the circumvention nettest group
Only Psiphon for now. Closes #87 #77.
2019-12-28 17:48:07 +01:00
Arturo Filastò
7bbbab8774 Handle the SIGINT and SIGTERM signals to support stopping a test cleanly (#84) 2019-12-27 11:32:08 +01:00
Arturo Filastò
274e533b2e Fix import for groups 2019-12-02 18:05:02 +02:00
Arturo Filastò
58199a020e Refactoring to reduce package count
* Consolidate util and utils into the same package
* Move internal/onboard into internal/cli/onboard
* Move maybeOnboard into the onboard package
2019-12-02 15:15:50 +02:00
Simone Basso
946289d6fe
Use more general ooni/probe-engine API (#67)
No functional change, just importing less stuff and meddling
much less with the internals of ooni/probe-engine.
2019-10-28 14:05:05 +01:00
Simone Basso
f3865d2ec0
Upgrade to ooni/probe-engine@v0.1.1 (#60) 2019-10-03 09:43:25 +02:00
Arturo Filastò
f425d3f007 Implement the show command (#53) 2019-10-02 18:23:14 +02:00
Simone Basso
b9b555ba68 Integrate further with ooni/probe-engine: episode two (#46)
* utils/geoip.go: use github.com/ooni/probe-engine

Let's start using the engine by rewriting utils/geoip.go to
be just a thin wrapper around the engine functionality.

* Ready for review

* Checkpoint: the im tests are converted

Still have some doubts with respect to the variables that
are passed to MK via probe-engine. Will double check.

* fix(i/c/r/run.go): write the correct logic

* nettests: one more comment and also fix a format string

* Tweak previous

* progress

* Fix doofus

* better comment

* XXX => actionable comment

* Add glue to simplify test keys management

Making the concept of measurement more abstract in the engine is
not feasible because, when submitting a measurement, we need to
modify it to update the report ID and the measurement ID. Therefore,
returning a serialized measurement is not a good idea. We will
keep using a model.Measurement in the engine.

Changing model.Measurement.TestKeys's type from a `interface{}`
pointing to a well defined data structure to `map[string]interface{}`
is a regression because means that we are moving from code that
has a clear and defined structure to code that is more complicated
to parse and validate. Since we're already suffering havily from
the lack of a good schema, I'm not going to make the situation
worst by worsening the engine. At least for ndt7 and psiphon, we
now have a good schema and I don't want to lose that.

However, the current code in this repository is expecting the
test keys to be a `map[string]interface{}`. This choice was
dictated by the fact that we receive a JSON from Measurement Kit
and by the fact that there's not a clear schema.

To solve this tension, in this commit I am going to write glue
adapter code that makes sure that the TestKeys of a Measurement
are converted to `map[string]interface{}`. This will be done
using a type cast where possible and JSON serialization and parsing
otherwise. In a perfect world, glue is not a good idea, but in a
real world it may actually be useful.

When all tests in the engine will have a clear Go data structure,
we'll then remove the glue and just cast to the proper data
structure from `interface{}` where required.

* nettests/performance: use probe-engine

* go.{mod,sum}: upgrade to latest probe-engine

* nettests/middlebox: use ooni/probe-engine

* Update to the latest probe-engine

* web_connectivity: rewrite to use probe-engine

* Cosmetic change suggested by @hellais

* nettests/nettests.go: remove unused code

* nettests/nettests.go: fix progress

* nettests/nettests.go: remove go-measurement-kit code

* We don't depend on go-measurement-kit anymore

* Improve non-verbose output where possible

See also: https://github.com/measurement-kit/measurement-kit/issues/1856

* Make web_connectivity output pleasant

* Update to the latest probe-engine

* nettests/nettests.go: honour sharing settings

* Update to the latest probe-engine

* Use log.WithFields for probe-engine

* Update go.mod go.sum

* Revert "Update go.mod go.sum"

This reverts commit 5ecd38d8236f4a4e9b77ddb8e8a0d1e3cdd4b818.

* Revert "Revert "Update go.mod go.sum""

This reverts commit 6114b31eca98826112032776bd0feff02d763ecd.

* Upgrade ooni/probe-engine

* Unset GOPATH before running go build commands

* Dockefile: fix linux build by using latest

* Update to the latest ooni/probe-engine

```
go get -u github.com/ooni/probe-engine
go mod tidy
```

* Repair build
2019-08-15 18:08:43 +02:00
Simone Basso
df629237be
Use ooni/probe-engine: episode 1 (#42) 2019-05-23 16:38:46 +02:00
Arturo Filastò
34556dcbf1 Add support for running all tests with ooni run 2018-09-27 18:38:37 +02:00
Arturo Filastò
a60f376846 Adjust the progress bars depending on the test type 2018-09-24 15:57:28 +02:00
Arturo Filastò
0d21186492 Add support for custom collectors and bouncers 2018-09-21 18:54:44 +02:00
Arturo Filastò
5cae6b0b83 Make it possible to disable uploading of results 2018-09-17 11:51:54 +02:00
Arturo Filastò
b29071f37b Replace summary with test_keys 2018-09-10 12:41:28 +02:00
Arturo Filastò
35bd334cfc Update the measurement, network and url creation to the new schema 2018-09-07 12:55:27 +02:00
Arturo Filastò
b75cee5e84 Progress on schema and fixing unittests 2018-09-06 16:13:04 +02:00
Arturo Filastò
d8cbfd1b90 One color package to rule them all. 2018-06-29 16:50:05 +02:00
Arturo Filastò
030ecacf80 Improve the help output of run 2018-06-22 14:55:00 +02:00
Arturo Filastò
1bba0c7899 Add basic unittests for the config related functionality 2018-06-22 11:01:15 +02:00
Arturo Filastò
a0be45e323 Fix paths to be windows friendly 2018-05-31 12:33:08 +02:00
Arturo Filastò
ecf3370f53 Implement result listing from CLI
Change the schema to include ASN and Network Name in the results table
2018-05-03 18:40:52 +02:00
Arturo Filastò
0c5b6aa37c Rename gooni to probe-cli
This is the command I used:
```
rg 'github.com/openobservatory/gooni' --files-with-matches \
    | xargs sed -i '' 's/github.com\/openobservatory\/gooni/github.com\/ooni\/probe-cli/g'
```
2018-05-03 14:59:55 +02:00
Arturo Filastò
00859e87a6 Get web_connectivity to work with dynamic URL fetching 2018-03-23 12:41:06 +01:00
Arturo Filastò
7fe1551951 Refactor how we create the context 2018-03-23 12:10:14 +01:00
Arturo Filastò
e852713ed7 Add functions for structured progress logging 2018-03-22 15:22:29 +01:00
Arturo Filastò
ce0e077175 Add hooks for generating result summaries 2018-03-20 14:19:19 +01:00
Arturo Filastò
e0bb4000e9 Implement most of the measurement & result DB workflow 2018-03-20 12:38:33 +01:00
Arturo Filastò
9f438ae068 Implement state tracking in database 2018-03-19 19:28:32 +01:00
Arturo Filastò
e2499dc4b0 Keep track of the measurement state in the database 2018-03-19 16:23:30 +01:00
Arturo Filastò
90c1c2de87 Start adding support for writing measurements to disk 2018-03-19 13:20:42 +01:00
Will Scott
1d40171e04 add a Dash Test. 2018-03-14 06:44:37 -07:00
Will Scott
41e56f6a41 Merge branch 'master' of github.com:openobservatory/gooni 2018-03-08 05:12:52 -08:00
Arturo Filastò
9cf8008c01 Fix MK integration 2018-03-08 13:46:21 +01:00
Will Scott
7e9a4fc3b7 implement db update 2018-03-08 02:53:04 -08:00
Arturo Filastò
3cdb927eb0 Implement handlers to normalise how logging is handled 2018-02-21 17:06:30 +02:00
Arturo Filastò
e7ee54436e Get some data into the database 2018-02-13 18:11:22 +02:00
Arturo Filastò
d3d3ce9d78 Get NDT test to run via gooni 2018-02-13 17:16:23 +02:00
Arturo Filastò
6008b5c7c5 Config file workflow management 2018-02-12 17:45:13 +02:00
Arturo Filastò
7327e1ff7f Start laying out the structure of gooni 2018-02-07 20:02:18 +02:00