Murakami provides a collection of test runners, which are Python script wrappers around various internet measurement tools. If there is a measurement tool that you would like included in Murakami, you can add it!
To add new measurement tools to Murakami, do the following in a fork or branch:
- The tool should be built or included in Dockerfile and Dockerfile.template. Two Dockerfiles are needed to support the two types of Murakami deployments: standalone installs (Dockerfile) and Balena.io managed installs (Dockerfile.template)
- Add a Python wrapper for the new tool in murakami/runners/
- If the new test runner requires an additional configuration file, provide an example in murakami/configs/.
- Register the test runner for the new tool in pyproject.toml
- Document the new test runner:
- Add a brief description of the new test runner in murakami/README.md
- Describe the new test runner in murakami/docs/SUPPORTED-TEST-RUNNERS.md
- Add the new runner's default configuration to Murakami's example config files:
- Add a sample output file for the new test runner in:
- If the new test runner requires additional configuration, such as a
configuration file in
murakami/configs, summarize this additional configuration in murakami/docs/CONFIGURING-MURAKAMI.md
- Test the new runner and open a Pull Request for your branch or fork, and request a review!