Struct goose::GooseAttack

pub struct GooseAttack { /* fields omitted */ }

Global internal state for the load test.

Implementations

impl GooseAttack

Goose’s internal global state.

pub fn initialize() -> Result<GooseAttack, GooseError>

Load configuration and initialize a GooseAttack.

Example

use goose::prelude::*;

let mut goose_attack = GooseAttack::initialize();

pub fn initialize_with_config(
    configuration: GooseConfiguration
) -> Result<GooseAttack, GooseError>

Initialize a GooseAttack with an already loaded configuration.

This is generally used by Worker instances and tests.

Example

use goose::GooseAttack;
use goose::config::GooseConfiguration;
use gumdrop::Options;

let configuration = GooseConfiguration::parse_args_default_or_exit();
let mut goose_attack = GooseAttack::initialize_with_config(configuration);

pub fn set_scheduler(self, scheduler: GooseScheduler) -> Self

Define the order GooseTaskSets are allocated to new GooseUsers as they are launched.

By default, GooseTaskSets are allocated to new GooseUsers in a round robin style. For example, if TaskSet A has a weight of 5, TaskSet B has a weight of 3, and you launch 20 users, they will be launched in the following order: A, B, A, B, A, B, A, A, A, B, A, B, A, B, A, A, A, B, A, B

Note that the following pattern is repeated: A, B, A, B, A, B, A, A

If reconfigured to schedule serially, then they will instead be allocated in the following order: A, A, A, A, A, B, B, B, A, A, A, A, A, B, B, B, A, A, A, A

In the serial case, the following pattern is repeated: A, A, A, A, A, B, B, B

In the following example, GooseTaskSets are allocated to launching GooseUsers in a random order. This means running the test multiple times can generate different amounts of load, as depending on your weighting rules you may have a different number of GooseUsers running each GooseTaskSet each time.

Example

use goose::prelude::*;

fn main() -> Result<(), GooseError> {
    GooseAttack::initialize()?
        .set_scheduler(GooseScheduler::Random)
        .register_taskset(taskset!("A Tasks")
            .set_weight(5)?
            .register_task(task!(a_task_1))
        )
        .register_taskset(taskset!("B Tasks")
            .set_weight(3)?
            .register_task(task!(b_task_1))
        );

    Ok(())
}

async fn a_task_1(user: &GooseUser) -> GooseTaskResult {
    let _goose = user.get("/foo").await?;

    Ok(())
}

async fn b_task_1(user: &GooseUser) -> GooseTaskResult {
    let _goose = user.get("/bar").await?;

    Ok(())
}

pub fn register_taskset(self, taskset: GooseTaskSet) -> Self

A load test must contain one or more GooseTaskSets be registered into Goose’s global state with this method for it to run.

Example

use goose::prelude::*;

fn main() -> Result<(), GooseError> {
    GooseAttack::initialize()?
        .register_taskset(taskset!("ExampleTasks")
            .register_task(task!(example_task))
        )
        .register_taskset(taskset!("OtherTasks")
            .register_task(task!(other_task))
        );

    Ok(())
}

async fn example_task(user: &GooseUser) -> GooseTaskResult {
    let _goose = user.get("/foo").await?;

    Ok(())
}

async fn other_task(user: &GooseUser) -> GooseTaskResult {
    let _goose = user.get("/bar").await?;

    Ok(())
}

pub fn test_start(self, task: GooseTask) -> Self

Optionally define a task to run before users are started and all task sets start running. This is would generally be used to set up anything required for the load test.

The GooseUser used to run the test_start tasks is not preserved and does not otherwise affect the subsequent GooseUsers that run the rest of the load test. For example, if the GooseUser logs in during test_start, subsequent GooseUser do not retain this session and are therefor not already logged in.

When running in a distributed Gaggle, this task is only run one time by the Manager.

Example

use goose::prelude::*;

fn main() -> Result<(), GooseError> {
    GooseAttack::initialize()?
        .test_start(task!(setup));

    Ok(())
}

async fn setup(user: &GooseUser) -> GooseTaskResult {
    // do stuff to set up load test ...

    Ok(())
}

pub fn test_stop(self, task: GooseTask) -> Self

Optionally define a task to run after all users have finished running all defined task sets. This would generally be used to clean up anything that was specifically set up for the load test.

When running in a distributed Gaggle, this task is only run one time by the Manager.

Example

use goose::prelude::*;

fn main() -> Result<(), GooseError> {
    GooseAttack::initialize()?
        .test_stop(task!(teardown));

    Ok(())
}

async fn teardown(user: &GooseUser) -> GooseTaskResult {
    // do stuff to tear down the load test ...

    Ok(())
}

pub fn execute(self) -> Result<GooseMetrics, GooseError>

Execute the GooseAttack load test.

Example

use goose::prelude::*;

fn main() -> Result<(), GooseError> {
    let _goose_metrics = GooseAttack::initialize()?
        .register_taskset(taskset!("ExampleTasks")
            .register_task(task!(example_task).set_weight(2)?)
            .register_task(task!(another_example_task).set_weight(3)?)
            // Goose must run against a host, point to localhost so test starts.
            .set_host("http://localhost")
        )
        // Exit after one second so test doesn't run forever.
        .set_default(GooseDefault::RunTime, 1)?
        .execute()?;

    Ok(())
}

async fn example_task(user: &GooseUser) -> GooseTaskResult {
    let _goose = user.get("/foo").await?;

    Ok(())
}

async fn another_example_task(user: &GooseUser) -> GooseTaskResult {
    let _goose = user.get("/bar").await?;

    Ok(())
}

Trait Implementations

impl Clone for GooseAttack

fn clone(&self) -> GooseAttack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl GooseDefaultType<&'_ str> for GooseAttack

fn set_default(
    self,
    key: GooseDefault,
    value: &str
) -> Result<Box<Self>, GooseError>

Sets GooseDefault to a &str value.

impl GooseDefaultType<GooseCoordinatedOmissionMitigation> for GooseAttack

fn set_default(
    self,
    key: GooseDefault,
    value: GooseCoordinatedOmissionMitigation
) -> Result<Box<Self>, GooseError>

Sets GooseDefault to a GooseCoordinatedOmissionMitigation value.

impl GooseDefaultType<GooseLogFormat> for GooseAttack

fn set_default(
    self,
    key: GooseDefault,
    value: GooseLogFormat
) -> Result<Box<Self>, GooseError>

Sets GooseDefault to a GooseLogFormat value.

impl GooseDefaultType<bool> for GooseAttack

fn set_default(
    self,
    key: GooseDefault,
    value: bool
) -> Result<Box<Self>, GooseError>

Sets GooseDefault to a bool value.

impl GooseDefaultType<usize> for GooseAttack

fn set_default(
    self,
    key: GooseDefault,
    value: usize
) -> Result<Box<Self>, GooseError>

Sets GooseDefault to a usize value.