Enum goose::controller::GooseControllerCommand

pub enum GooseControllerCommand {
    Host,
    Users,
    HatchRate,
    RunTime,
    Config,
    ConfigJson,
    Metrics,
    MetricsJson,
    Help,
    Exit,
    Start,
    Stop,
    Shutdown,
}

All commands recognized by the Goose Controllers.

Commands are not case sensitive. When sending commands to the WebSocket Controller, they must be formatted as json as defined by GooseControllerWebSocketRequest.

GOOSE DEVELOPER NOTE: The following steps are required to add a new command:

1. Define the command here in the GooseControllerCommand enum.
2. Add the regular expression for matching the new command in the command regex::RegexSet in controller_main().
   1. If a value needs to be captured, define the regular expression in a variable outside the set, and add the variable to the top section of the set with the other regex variables.
   2. In the same function, also add the variable to the captures Vector, in the same order that it was added to the command RegexSet. Order is important as this is how the regex is later identified.
3. Check for a match to the new regex in get_match(), any additional validation beyond the regex must be performed here (for example, the regular expression for capturing hosts simply confirms that the host starts with http or https, then in get_match() it calls util::is_valid_host() to be sure it is truly a valid host before passing it to the parent process).
4. Add any parent process logic for the command to handle_controller_requests().
5. Handle the response in process_response(), returning a Result<String, String> succinctly describing success or failure.

Variants

Host

Configure the host to load test.

Example

Tells Goose to generate load against http://example.com/.

host http://example.com/

Goose must be idle to process this command.

Users

Configure how many GooseUsers are launched.

Example

Tells Goose to simulate 100 concurrent users.

users 100

Goose must be idle to process this command.

HatchRate

Configure how quickly new GooseUsers are launched.

Example

Tells Goose to launch a new user every 1.25 seconds.

hatchrate 1.25

Goose can be idle or running when processing this command.

RunTime

Configure how long the load test should run before stopping and returning to an idle state.

Example

Tells Goose to run the load test for 1 minute, before automatically stopping.

runtime 60

This can be configured when Goose is idle as well as when a Goose load test is running.

Config

Display the current GooseConfigurations.

Example

Returns the current Goose configuration.

config

ConfigJson

Display the current GooseConfigurations in json format.

Example

Returns the current Goose configuration in json format.

configjson

This command can be run at any time.

Metrics

Display the current GooseMetrics.

Example

Returns the current Goose metrics.

metrics

This command can be run at any time.

MetricsJson

Display the current GooseMetrics in json format.

Example

Returns the current Goose metrics in json format.

metricsjson

This command can be run at any time.

Help

Displays a list of all commands supported by the Controller.

Example

Returns the a list of all supported Controller commands.

help

This command can be run at any time.

Exit

Disconnect from the Controller.

Example

Disconnects from the Controller.

exit

This command can be run at any time.

Start

Start an idle test.

Example

Starts an idle load test.

start

Goose must be idle to process this command.

Stop

Stop a running test, putting it into an idle state.

Example

Stops a running (or stating) load test.

stop

Goose must be running (or starting) to process this command.

Shutdown

Tell the load test to shut down (which will disconnect the controller).

Example

Terminates the Goose process, cleanly shutting down the load test if running.

shutdown

Goose can process this command at any time.

Trait Implementations

impl Clone for GooseControllerCommand

fn clone(&self) -> GooseControllerCommand

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GooseControllerCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<GooseControllerCommand> for GooseControllerCommand

fn eq(&self, other: &GooseControllerCommand) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralPartialEq for GooseControllerCommand