Struct goose_eggs::drupal::LoginBuilder

pub struct LoginBuilder<'a> { /* private fields */ }

Used to build a Login object, necessary to invoke the log_in function.

Sets parameters that define how to log into a Drupal website and validate that the user loged in successfully.

This object is passed to the log_in function.

The defined username and/or password can be dynamically overridden by setting the GOOSE_USER and/or GOOSE_PASS environment variables when starting the load test.

Example

use goose_eggs::drupal::Login;

fn examples() {
    // Manually build a Login structure with custom default username and password,
    // and a custom log in path.
    let _login = Login::builder()
        .username("foo")
        .password("bar")
        .url("custom/user/login")
        .build();
}

Implementations

impl<'a> LoginBuilder<'a>

pub fn username(self, username: impl Into<&'a str>) -> Self

Used with Login::builder to configure login parameters.

Defaults to username.

Once built, the resulting object is passed to the log_in function. The username and password can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

// Login with username "foo", and the default password of "password".
let _login = Login::builder()
    .username("foo")
    .build();

pub fn password(self, password: impl Into<&'a str>) -> Self

Used with Login::builder to configure login parameters.

Defaults to password.

Once built, the resulting object is passed to the log_in function. The username and password can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

// Login with username "bar", and the default username of "username".
let _login = Login::builder()
    .password("bar")
    .build();

pub fn url(self, url: impl Into<&'a str>) -> Self

Used with Login::builder to configure login parameters.

Defaults to user/login.

Once built, the resulting object is passed to the log_in function.

Example

use goose_eggs::drupal::Login;

// Login at a custom path.
let _login = Login::builder()
    .password("custom/user/login")
    .build();

pub fn log_in_page_validation(self, validation: &'a Validate<'_>) -> Self

Used with Login::builder to tell the log_in function to perform extra validation of the page containing the log in form.

Defaults to None, so no extra validation is performed. By default it will still validate that <form class="user-login-form" exists on the log in page, and it will load all static assets on the page with the log in form.

What validation should be performed is defined by passing a reference to a Validate object.

Once built, the resulting object is passed to the log_in function.

Example

use goose_eggs::{drupal, Validate};

// This validation is done by default.
let validate = Validate::builder()
    .text(r#"<form class="user-login-form"#)
    .build();
let _login = drupal::Login::builder()
    .log_in_page_validation(&validate)
    .build();

pub fn logged_in_page_validation(self, validation: &'a Validate<'_>) -> Self

Used with Login::builder to tell the log_in function to perform extra validation of the page returned once the user logs in.

Defaults to None, so no extra validation is performed. By default it will still validate that the username of the user that logged in is in the title, and will load all static assets on the returned page.

What validation should be performed is defined by passing a reference to a Validate object.

Once built, the resulting object is passed to the log_in function.

Example

use goose_eggs::drupal::SearchParams;

// Use Drupal's default search form to search for "foo bar".
let search_params = SearchParams::builder()
    .keys("foo bar")
    .build();

Example

use goose_eggs::{drupal, Validate};

let username = "foo";

// This validation is done by default.
let validate = Validate::builder()
    .title(username)
    .build();
let _login = drupal::Login::builder()
    .username(username)
    .logged_in_page_validation(&validate)
    .build();

pub fn build(self) -> Login<'a>

Build the Login object which is then passed to the log_in function.

Example

use goose_eggs::drupal::SearchParams;

// Use the default search form to search for `example keys`.
let search_params = SearchParams::builder()
    .keys("example keys")
    .build();