Skip to content

Modules

Kyle MacMillan edited this page Jun 3, 2022 · 3 revisions

Netrics refers to network measurement tests as modules. Modules are executables that follow a contract with the Netrics controller.

Controller - Module Contract

Config

A module may have a set of input parameters that the user can configure. The user may set these parameters in the appropriate config file. Upon execution, the controller will pass these parameters to the module.

The module should define a set of default parameters in the event that input parameters are not supplied and/or they are misconfigured. This also implies that modules check the user-supplied parameters and confirm that they are well-defined.

Output of Module

Following execution, the module must write the test output to stdout, write any errors to stderr, and return an exit code.

Global Error Codes

The following exit codes are interpreted by the controller as such:

  • 20: Config file error. Type problem with value inserted into config file.
Clone this wiki locally