99b28c1d95
* refactor: start building an Android package Part of https://github.com/ooni/probe/issues/1335. This seems also a good moment to move some packages out of the engine, e.g., oonimkall. This package, for example, is a consumer of the engine, so it makes sense it's not _inside_ it. * fix: committed some stuff I didn't need to commit * fix: oonimkall needs to be public to build The side effect is that we will probably need to bump the major version number every time we change one of these APIs. (We can also of course choose to violate the basic guidelines of Go software, but I believe this is bad form.) I have no problem in bumping the major quite frequently and in any case this monorepo solution is convinving me more than continuing to keep a split between engine and cli. The need to embed assets to make the probe more reliable trumps the negative effects of having to ~frequently bump major because we expose a public API. * fix: let's not forget about libooniffi Honestly, I don't know what to do with this library. I added it to provide a drop in replacement for MK but I have no idea whether it's used and useful. I would not feel comfortable exposing it, unlike oonimkall, since we're not using it. It may be that the right thing to do here is just to delete the package and reduce the amount of code we're maintaining? * woops, we're still missing the publish android script * fix(publish-android.bash): add proper API key * ouch fix another place where the name changed
74 lines
2.9 KiB
Go
74 lines
2.9 KiB
Go
package tasks
|
|
|
|
// Settings contains settings for a task. This structure derives from
|
|
// the one described by MK v0.10.9 FFI API (https://git.io/Jv4Rv), yet
|
|
// since 2020-12-03 we're not backwards compatible anymore.
|
|
type Settings struct {
|
|
// Annotations contains the annotations to be added
|
|
// to every measurements performed by the task.
|
|
Annotations map[string]string `json:"annotations,omitempty"`
|
|
|
|
// AssetsDir is the directory where to store assets. This
|
|
// field is an extension of MK's specification. If
|
|
// this field is empty, the task won't start.
|
|
AssetsDir string `json:"assets_dir"`
|
|
|
|
// DisabledEvents contains disabled events. See
|
|
// https://git.io/Jv4Rv for the events names.
|
|
DisabledEvents []string `json:"disabled_events,omitempty"`
|
|
|
|
// Inputs contains the inputs. The task will fail if it
|
|
// requires input and you provide no input.
|
|
Inputs []string `json:"inputs,omitempty"`
|
|
|
|
// LogLevel contains the logs level. See https://git.io/Jv4Rv
|
|
// for the names of the available log levels.
|
|
LogLevel string `json:"log_level,omitempty"`
|
|
|
|
// Name contains the task name. By https://git.io/Jv4Rv the
|
|
// names are in camel case, e.g. `Ndt`.
|
|
Name string `json:"name"`
|
|
|
|
// Options contains the task options.
|
|
Options SettingsOptions `json:"options"`
|
|
|
|
// StateDir is the directory where to store persistent data. This
|
|
// field is an extension of MK's specification. If
|
|
// this field is empty, the task won't start.
|
|
StateDir string `json:"state_dir"`
|
|
|
|
// TempDir is the temporary directory. This field is an extension of MK's
|
|
// specification. If this field is empty, we will pick the tempdir that
|
|
// ioutil.TempDir uses by default, which may not work on mobile. According
|
|
// to our experiments as of 2020-06-10, leaving the TempDir empty works
|
|
// for iOS and does not work for Android.
|
|
TempDir string `json:"temp_dir"`
|
|
|
|
// Version indicates the version of this structure.
|
|
Version int64 `json:"version"`
|
|
}
|
|
|
|
// SettingsOptions contains the settings options
|
|
type SettingsOptions struct {
|
|
// MaxRuntime is the maximum runtime expressed in seconds. A negative
|
|
// value for this field disables the maximum runtime. Using
|
|
// a zero value will also mean disabled. This is not the
|
|
// original behaviour of Measurement Kit, which used to run
|
|
// for zero time in such case.
|
|
MaxRuntime float64 `json:"max_runtime,omitempty"`
|
|
|
|
// NoCollector indicates whether to use a collector
|
|
NoCollector bool `json:"no_collector,omitempty"`
|
|
|
|
// ProbeServicesBaseURL contains the probe services base URL.
|
|
ProbeServicesBaseURL string `json:"probe_services_base_url,omitempty"`
|
|
|
|
// SoftwareName is the software name. If this option is not
|
|
// present, then the library startup will fail.
|
|
SoftwareName string `json:"software_name,omitempty"`
|
|
|
|
// SoftwareVersion is the software version. If this option is not
|
|
// present, then the library startup will fail.
|
|
SoftwareVersion string `json:"software_version,omitempty"`
|
|
}
|