Skip to main content

Chromedriver

Struct Chromedriver 

Source
pub struct Chromedriver { /* private fields */ }
Expand description

A handle to a spawned chromedriver process plus its resolved Chrome / ChromeDriver binaries.

Terminates automatically when dropped, using the budget configured via ChromedriverRunConfig::graceful_shutdown. The on-drop automation keeps tests safe in the face of panics. Call Self::terminate to drive the same shutdown explicitly and surface any error.

Drive browser sessions through Self::session. Sessions are independent, so multiple of them can run concurrently against the same chromedriver via tokio::join! or tokio::spawn on a multi-thread runtime.

Implementations§

Source§

impl Chromedriver

Source

pub async fn run_default() -> Result<Chromedriver, Report<ChromeForTestingManagerError>>

Convenience: resolve, download, and launch chromedriver using ChromedriverRunConfig::default. Equivalent to Chromedriver::run(ChromedriverRunConfig::default()).await.

§Errors

Returns an error if the runtime is not multithreaded, version resolution fails, the download fails, or the chromedriver process cannot be spawned.

Source

pub async fn run( config: ChromedriverRunConfig, ) -> Result<Chromedriver, Report<ChromeForTestingManagerError>>

Resolve, download, and launch a chromedriver process.

§Errors

Returns an error if the runtime is not multithreaded, version resolution fails, the download fails, or the chromedriver process cannot be spawned.

Source

pub fn port(&self) -> Port

The port the chromedriver process is listening on.

When constructed with PortRequest::Any this reflects the OS-assigned port.

Source

pub async fn terminate( self, ) -> Result<ExitStatus, Report<ChromeForTestingManagerError>>

Gracefully terminate the chromedriver process with the configured GracefulShutdown, configurable via the graceful_shutdown field of ChromedriverRunConfig.

§Errors

Returns an error if the process cannot be terminated within the configured graceful-shutdown budget.

Source

pub fn session(&self) -> SessionBuilder<'_, DefaultCaps, DefaultConfig>

Start building a scoped thirtyfour crate::Session against this chromedriver.

This is the primary entry point for running a browser test. The returned SessionBuilder is a fluent, chainable builder with three steps:

  1. (optional) SessionBuilder::with_caps mutates the thirtyfour::ChromeCapabilities used to create the session (e.g. unset headless, add Chrome args, register extensions).
  2. (optional) SessionBuilder::with_config receives the thirtyfour::WebDriverBuilder and may set client-side options such as the element poller, request timeout, user-agent, or keep-alive flag before the session is opened.
  3. (required, terminal) SessionBuilder::run opens the session, awaits the user closure, and tears the session down once the closure resolves or panics.

Sessions are independent. Multiple sessions can run concurrently against the same Chromedriver via tokio::join! or tokio::spawn on a multi-thread runtime.

§Examples

Smallest case (default headless capabilities, default client config):

use chrome_for_testing_manager::Chromedriver;
use rootcause::Report;

Chromedriver::run_default()
    .await?
    .session()
    .run(async |session| {
        session.goto("https://wikipedia.org").await?;
        Ok::<(), thirtyfour::error::WebDriverError>(())
    })
    .await?;

With both setup steps:

use chrome_for_testing_manager::Chromedriver;
use rootcause::Report;
use std::time::Duration;
use thirtyfour::ChromiumLikeCapabilities;

Chromedriver::run_default()
    .await?
    .session()
    .with_caps(ChromiumLikeCapabilities::unset_headless)
    .with_config(|b| b.request_timeout(Duration::from_secs(30)))
    .run(async |session| {
        session.goto("https://wikipedia.org").await?;
        Ok::<(), thirtyfour::error::WebDriverError>(())
    })
    .await?;

Trait Implementations§

Source§

impl Debug for Chromedriver

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<O> ObjectMarkerFor<Local> for O
where O: 'static,

Source§

impl<O> ObjectMarkerFor<SendSync> for O
where O: 'static + Send + Sync,

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Sink for T
where T: Send + 'static,