Skip to content

Latest commit

 

History

History
89 lines (64 loc) · 3.93 KB

options.md

File metadata and controls

89 lines (64 loc) · 3.93 KB
Raw

DAQ Configuration Options

Command Line Arguments.

Basic arguments can either be specified with the short form (-s) on the command line, or with the more verbose long-form (single_shot=true).

  • -b, build_tests: Build/pull images as needed.
  • -c, use_console: Escape to console rather than exit.
  • -d, debug_mode: Shorthand for enabling debug mode options.
  • -e, event_trigger: Wait for port up trigger to start.
  • -f, fail_mode: Fail test run immediately when any test fails.
  • -h, show_help: Show help information.
  • -k, keep_hold: Add a hold test that keeps running for debugging.
  • -l, result_linger: Keep services in place on failure.
  • -n, no_test: Do not test devices, just put them on the network.
  • -s, single_shot: Don't repeat tests, only do one run.

Local Configuration File local/system.yaml

Additional long-form options are documented in the config/system/default.yaml file, and can also be included on the command-line to overwrite options in the config file.

e.g.: cmd/run build_tests=true keep_hold=true

Config files may also inherit from other config files but inheritance must be explicity stated by using "include" with path relative to the config file. Other configurations specified in the same config file will overwrite inherited options.

e.g. Assuming the following config file is located at daq/local/system.yaml

include: ../config/system/default.yaml

The referenced file should exist at daq/config/system/default.yaml.

Common Configuration Options

Debugging

  • daq_loglevel: Set log-level for daq-based logging commands.
  • mininet_loglevel: Set log-level for underlying mininet commands.
  • run_limit: Set number of test runs to do before exit.

e.g.: cmd/run daq_loglevel=debug run_limit=10

Timeout setting

  • default_timeout_sec: Set default global module timeout. Applies to all modules.

DHCP settings

  • initial_dhcp_lease_time: Set the initial DHCP lease time. Lease time must be greater than 120s.
  • dhcp_lease_time: Set the ongoing DHCP lease time for when all devices are running test modules.
  • long_dhcp_response_sec: Stops DHCP for X seconds for device using long DHCP mode. More on DHCP mode

Common Run Invocation Examples

cmd/run: Run tests in a continuous loop, for any device that is plugged into a switch port or adapter. This is the default background run state for continuous testing.

cmd/run -s: Run tests once for each device, and then terminate when there are no more active tests. This represents an imperative mode when the goal is to "test this device right now."

cmd/run -n: Activate a device so that it is on the network, but do not run the tests. Useful for setup and functional validation of devices.

cmd/run -l: Keep the system configured in an active state after a test run. This is useful for debugging a system setup after testing (e.g. to see why a test failed).

cmd/run -e: Only run tests when there is a specific port-up event (e.g. plugging in a device to a network switch). This is useful to control the flow of testing in a test-lab environment to reduce activity.

cmd/run -f: Fail a test run immediately when any individual test failes. Useful for debugging the state of a single test when it fails, separating it out from something run with a complete test suite.

More on configurations

  1. Site wide configurations
  2. Device specific configurations
  3. External switch configurations
  4. Configure test modules to run
  5. Faux devices configurations
  6. Both YAML and Conf are supported as local configurations files, but only one of them may exist under local directory. Additionally, yaml files may include conf files; conf files may include yaml files.

More usecase setups

  1. Device Qualification
  2. Test lab