kickball / ooniprobe Goto Github PK

Currently the container will run ooniprobe run unattended which performs a one off run of all the ooniprobe tests.

This would work well if the use case for the container is configured as a one off (e.g. Nomad periodics, Kubernetes jobs), but would not be suitable if the container is desired to be ran in a persistent way (e.g. Nomad services, Kubernetes pods).

The container should be rewritten to be configurable for either of these use-cases at run time.

Linters are a useful tool to ensure that this repo's code is following best practices and avoids common errors/security risks.

The following linters should be configured to trigger on any push:

• ShellCheck for the various shell scripts in the repository
• MarkDown Linter, MDL for the markdown files in the repoistory.
• Hadolint for the Dockerfile in the repository.

Some exceptions may need to be configured to document known workarounds and avoid issue spam.

Issue #3 will add the functionality to disable test results being uploaded to OONI. If that is used then the user would likely want their test results accessible locally.

To resolve this issue the following should be added:

• Functionality to specify where the test results should be saved / exported to. (not possible within the software)
• Documentation for accessing these results (e.g. configuration of a volume at run time).

Currently the README lists an optional variable for the container image UPLOAD_RESULTS, which changes whether the results are publicly uploaded to OONI.

This doesn't currently exist in the Dockerfile.

Major complication is that the configuration for the OONI Probe is handled via a JSON file rather than CLI commands.

Dependabot is useful for maintaining the versions of GitHub actions used in this project, It should be setup.