apalis_core::test_utils

Struct TestWrapper

Source
pub struct TestWrapper<B, Req, Res> { /* private fields */ }
Expand description

A generic backend wrapper that polls and executes jobs

Implementations§

Source§

impl<B, Req, Res, Ctx> TestWrapper<B, Request<Req, Ctx>, Res>
where B: Backend<Request<Req, Ctx>, Res> + Send + Sync + 'static + Clone, Req: Send + 'static, Ctx: Send, B::Stream: Send + 'static + Stream<Item = Result<Option<Request<Req, Ctx>>, Error>> + Unpin,

A test wrapper to allow you to test without requiring a worker. Important for testing backends and jobs

§Example

#[cfg(tests)]
mod tests {
   use crate::{
       error::Error, memory::MemoryStorage, mq::MessageQueue, service_fn::service_fn,
   };

   use super::*;

   async fn is_even(req: usize) -> Result<(), Error> {
       if req % 2 == 0 {
           Ok(())
       } else {
           Err(Error::Abort("Not an even number".to_string()))
       }
   }

   #[tokio::test]
   async fn test_accepts_even() {
       let backend = MemoryStorage::new();
       let (mut tester, poller) = TestWrapper::new_with_service(backend, service_fn(is_even));
       tokio::spawn(poller);
       tester.enqueue(42usize).await.unwrap();
       assert_eq!(tester.size().await.unwrap(), 1);
       let (_, resp) = tester.execute_next().await;
       assert_eq!(resp, Ok("()".to_string()));
   }
}
Source

pub fn new_with_service<S>( backend: B, service: S, ) -> (Self, BoxFuture<'static, ()>)
where S: Service<Request<Req, Ctx>, Response = Res> + Send + 'static, B::Layer: Layer<S>, <<B as Backend<Request<Req, Ctx>, Res>>::Layer as Layer<S>>::Service: Service<Request<Req, Ctx>> + Send + 'static, <<<B as Backend<Request<Req, Ctx>, Res>>::Layer as Layer<S>>::Service as Service<Request<Req, Ctx>>>::Response: Send + Debug, <<<B as Backend<Request<Req, Ctx>, Res>>::Layer as Layer<S>>::Service as Service<Request<Req, Ctx>>>::Error: Send + Into<BoxDynError> + Sync, <<<B as Backend<Request<Req, Ctx>, Res>>::Layer as Layer<S>>::Service as Service<Request<Req, Ctx>>>::Future: Send + 'static,

Build a new instance provided a custom service

Source

pub fn stop(self)

Stop polling

Source

pub async fn execute_next(&mut self) -> (TaskId, Result<String, String>)

Gets the current state of results

Trait Implementations§

Source§

impl<B: Debug, Req: Debug, Res: Debug> Debug for TestWrapper<B, Req, Res>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<B, Req, Res, Ctx> Deref for TestWrapper<B, Request<Req, Ctx>, Res>
where B: Backend<Request<Req, Ctx>, Res>,

Source§

type Target = B

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<B, Req, Ctx, Res> DerefMut for TestWrapper<B, Request<Req, Ctx>, Res>
where B: Backend<Request<Req, Ctx>, Res>,

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

Auto Trait Implementations§

§

impl<B, Req, Res> Freeze for TestWrapper<B, Req, Res>
where B: Freeze,

§

impl<B, Req, Res> !RefUnwindSafe for TestWrapper<B, Req, Res>

§

impl<B, Req, Res> Send for TestWrapper<B, Req, Res>
where B: Send, Req: Send, Res: Send,

§

impl<B, Req, Res> Sync for TestWrapper<B, Req, Res>
where B: Sync, Req: Sync, Res: Sync,

§

impl<B, Req, Res> Unpin for TestWrapper<B, Req, Res>
where B: Unpin, Req: Unpin, Res: Unpin,

§

impl<B, Req, Res> !UnwindSafe for TestWrapper<B, Req, Res>

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, 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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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