main man page
main - run the NG9-1-1 conformance test suite
sudo python3 -m main run \
--launch path/launch_config.yaml \
[ --gen_rc /path/run_config.yaml | --use_rc /path/run_config.yaml ]
The main() command is used to execute the NG9-1-1 conformance test suite. It reads the launch_config file to learn where to find additional information and configuration details, generates a run_config.yaml, and then executes the test suite. The main() command requires root privileges to properly bind network interfaces, capture packets to/from the FEs within the environment and start/stop various services; hence the pre-requisite to have sudo rights configured prior to execution. This can lead to results, logs and/or reports being saved to the output directory with owner=root and group=root. If you have trouble accessing output data execute:
sudo chown -R $USER:$USER <output_dir>
Advanced users can use the "gen-rc" option to generate a run_config file without running the test suite. This run_config can be edited to add or remove tests. Then the "use-rc" option can be used to execute the test suite with the modified run_config file.
One or more info or config files can be listed in the same command.
--launch /path/launch_config.yaml
Use the launch_config located at the specified path and filename to define the operating parameters of the test suite.
Example: sudo python3 -m run main --launch /path/launch_config.yaml
This will execute the test suite using the values defined in the specified launch_config file.
--gen-rc /path/run_config.yaml
Generate a run_config file and place it in the specified location.
Example: python3 -m run main --launch /path/launch_config.yaml --gen-rc /path/new_run_config.yaml
This will generate a run_config file and save it to "path/new_run_config.yaml". The advanced user can then edit the run_config to:
- delete test variations, such as when the test operator wishes to focus on only one or a few tests when diagnosing a problem.
- add test variations, such as when the test operator wishes to add a situation encountered in the wild that was not previously defined.
--use-rc /path/run_config.yaml
Run the test suite using the identified run_config file, instead of the default run config that the test suite would generate.
Example: python3 -m run main --launch /path/launch_config.yaml --use-rc /path/run_config.yaml
