Struct BrowserTestRunner 

pub struct BrowserTestRunner { /* private fields */ }

Runs crate::BrowserTest implementations through Chrome for Testing.

Implementations

impl BrowserTestRunner

pub fn new() -> Self

Create a runner using stable Chrome in headless mode.

pub fn with_channel(self, channel: Channel) -> Self

Select the Chrome release channel.

pub fn with_visibility( self, visibility: impl Into<BrowserTestVisibility>, ) -> Self

Configure Chrome visibility.

pub fn with_pause(self, pause: impl Into<PauseConfig>) -> Self

Pause before starting webdriver when the config is enabled.

If the pause is aborted, Self::run returns successfully without starting webdriver or running any tests. If stdin reaches EOF while waiting for a pause response, Self::run returns an error instead.

pub fn with_hint(self, hint: impl Display) -> Self

Set extra context shown when a manual pause prompt is enabled.

pub fn with_chrome_capabilities( self, setup: impl Fn(&mut ChromeCapabilities) -> WebDriverResult<()> + Send + Sync + 'static, ) -> Self

Add custom Chrome capability setup applied to every WebDriver session.

The runner applies its own visible/headless configuration first, then applies custom setup functions in the order they were added. The setup function must be thread-safe because parallel browser tests can create multiple sessions at the same time.

pub fn with_timeouts(self, timeouts: BrowserTimeouts) -> Self

Set timeouts applied to every session before running tests.

Individual crate::BrowserTest implementations can override this by returning Some from crate::BrowserTest::timeouts.

pub fn with_webdriver_timeouts(self, timeouts: BrowserTimeouts) -> Self

👎Deprecated since 0.1.0:

use with_timeouts instead

Deprecated name for Self::with_timeouts.

Use Self::with_timeouts in new code.

pub const fn with_element_query_wait(self, wait: ElementQueryWaitConfig) -> Self

Set the element query wait applied to every session before running tests.

Individual crate::BrowserTest implementations can override this by returning Some from crate::BrowserTest::element_query_wait.

pub fn with_test_parallelism( self, parallelism: impl Into<BrowserTestParallelism>, ) -> Self

Configure how browser tests are scheduled.

pub fn with_failure_policy( self, failure_policy: impl Into<BrowserTestFailurePolicy>, ) -> Self

Configure how browser test failures affect the rest of the run.

pub fn with_driver_output(self, config: impl Into<DriverOutputConfig>) -> Self

Capture recent browser-driver output for failure diagnostics.

This stores capture configuration and creates a fresh capture buffer for each Self::run call.

pub fn with_browser_driver_output( self, config: impl Into<DriverOutputConfig>, ) -> Self

👎Deprecated since 0.1.0:

use with_driver_output instead

Deprecated name for Self::with_driver_output.

Use Self::with_driver_output in new code.

pub async fn run<Context, TestError>( &self, context: &Context, tests: BrowserTests<Context, TestError>, ) -> Result<(), Report<BrowserTestError>>

where Context: Sync + ?Sized, TestError: ?Sized + 'static,

Run every test with a fresh WebDriver session.

The shared chromedriver process is always terminated, even when a test returns an error or panics. Test panics are converted into BrowserTestError::Panic reports instead of being resumed.

Tests run sequentially and stop on the first failure by default. Use Self::with_test_parallelism to run multiple fresh WebDriver sessions at once. Use Self::with_failure_policy to execute every test and return all failures as child reports on one aggregate report.

Non-empty runs require a multithreaded Tokio runtime because Chromedriver::run requires one. Use #[tokio::test(flavor = "multi_thread")] for browser tests.

Parameters

context: Given to each test.

Errors

Returns an error if chromedriver cannot be started or terminated, if a session cannot be created, or if any test fails.

Trait Implementations

impl Clone for BrowserTestRunner

fn clone(&self) -> BrowserTestRunner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BrowserTestRunner

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

Formats the value using the given formatter.

impl Default for BrowserTestRunner

fn default() -> Self

Returns the “default value” for a type.