Skip to main content

WebSocketTestClient

Struct WebSocketTestClient 

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

WebSocket test client for integration testing

Provides high-level API for WebSocket connection management, message sending/receiving, and authentication.

Implementations§

Source§

impl WebSocketTestClient

Source

pub async fn connect(url: &str) -> Result<Self, WsError>

Connect to WebSocket server

§Example
use reinhardt_test::websocket::WebSocketTestClient;

#[tokio::test]
async fn test_connect() {
    let client = WebSocketTestClient::connect("ws://localhost:8080/ws")
        .await
        .unwrap();
}
Source

pub async fn connect_with_token(url: &str, token: &str) -> Result<Self, WsError>

Connect to WebSocket server with Bearer token authentication

Adds Authorization: Bearer <token> header to the WebSocket handshake request.

§Example
use reinhardt_test::websocket::WebSocketTestClient;

#[tokio::test]
async fn test_auth() {
    let client = WebSocketTestClient::connect_with_token(
        "ws://localhost:8080/ws",
        "my-secret-token"
    )
    .await
    .unwrap();
}
Source

pub async fn connect_with_query_token( url: &str, token: &str, ) -> Result<Self, WsError>

Connect to WebSocket server with query parameter authentication

Appends ?token=<token> to the URL.

§Example
use reinhardt_test::websocket::WebSocketTestClient;

#[tokio::test]
async fn test_query_auth() {
    let client = WebSocketTestClient::connect_with_query_token(
        "ws://localhost:8080/ws",
        "my-token"
    )
    .await
    .unwrap();
}

Connect to WebSocket server with cookie authentication

Adds Cookie: <cookie_name>=<cookie_value> header to the WebSocket handshake request.

§Example
use reinhardt_test::websocket::WebSocketTestClient;

#[tokio::test]
async fn test_cookie_auth() {
    let client = WebSocketTestClient::connect_with_cookie(
        "ws://localhost:8080/ws",
        "session_id",
        "abc123"
    )
    .await
    .unwrap();
}
Source

pub async fn send_text(&mut self, text: &str) -> Result<(), WsError>

Send text message to WebSocket server

§Example
use reinhardt_test::websocket::WebSocketTestClient;

#[tokio::test]
async fn test_send() {
    let mut client = WebSocketTestClient::connect("ws://localhost:8080/ws")
        .await
        .unwrap();
    client.send_text("Hello").await.unwrap();
}
Source

pub async fn send_binary(&mut self, data: &[u8]) -> Result<(), WsError>

Send binary message to WebSocket server

Source

pub async fn send_ping(&mut self, payload: &[u8]) -> Result<(), WsError>

Send ping message to WebSocket server

Source

pub async fn send_pong(&mut self, payload: &[u8]) -> Result<(), WsError>

Send pong message to WebSocket server

Source

pub async fn receive(&mut self) -> Option<Result<Message, WsError>>

Receive next message from WebSocket server

Returns None if connection is closed.

Source

pub async fn receive_text(&mut self) -> Result<String, WsError>

Receive text message from WebSocket server with timeout

§Example
use reinhardt_test::websocket::WebSocketTestClient;

#[tokio::test]
async fn test_receive() {
    let mut client = WebSocketTestClient::connect("ws://localhost:8080/ws")
        .await
        .unwrap();
    let text = client.receive_text().await.unwrap();
    assert_eq!(text, "Welcome");
}
Source

pub async fn receive_text_with_timeout( &mut self, duration: Duration, ) -> Result<String, WsError>

Receive text message with custom timeout

Source

pub async fn receive_binary(&mut self) -> Result<Vec<u8>, WsError>

Receive binary message from WebSocket server with timeout

Source

pub async fn receive_binary_with_timeout( &mut self, duration: Duration, ) -> Result<Vec<u8>, WsError>

Receive binary message with custom timeout

Source

pub async fn close(self) -> Result<(), WsError>

Close WebSocket connection

Source

pub fn url(&self) -> &str

Get WebSocket URL

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> Any for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Source§

fn type_name(&self) -> &'static str

Source§

impl<T> AnySync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

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> Chain<T> for T

Source§

fn len(&self) -> usize

The number of items that this chain link consists of.
Source§

fn append_to(self, v: &mut Vec<T>)

Append the elements in this link to the chain.
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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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