pdk-unit 1.8.0

PDK Unit Test Framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

// Copyright (c) 2026, Salesforce, Inc.,
// All rights reserved.
// For full license text, see the LICENSE.txt file

use crate::{Backend, UnitHttpRequest, UnitHttpResponse};
use std::cell::RefCell;
use std::collections::VecDeque;

/// A [Backend] that stores the incoming requests to be later retrieved by the test.
/// Delegates the response generation to the function provided in the constructor.
/// This classes uses the interior mutability pattern to allow the test to retrieve the requests.
///
/// # Example
///
/// ```ignore
///        let back = Rc::new(TraceBackend::new(echo_backend));
///
///         let mut tester = UnitTestBuilder::default()
///             .with_config(config)
///             .with_backend(Rc::clone(&back))
///             .with_entrypoint(crate::configure);
///
///         let response = tester.request(req.clone());
///         let request = back.next().unwrap();
/// ```
pub struct TraceBackend<B: Backend> {
    response: B,
    calls: RefCell<VecDeque<UnitHttpRequest>>,
}

impl<B: Backend> TraceBackend<B> {
    /// Creates a new instance with the provided backend for response generation.
    pub fn new(response: B) -> Self {
        Self {
            response,
            calls: Default::default(),
        }
    }

    /// Removes and returns the next request that reached the backend.
    pub fn next(&self) -> Option<UnitHttpRequest> {
        self.calls.borrow_mut().pop_front()
    }
}

impl<B: Backend> Backend for TraceBackend<B> {
    fn call(&self, req: UnitHttpRequest) -> UnitHttpResponse {
        self.calls.borrow_mut().push_back(req.clone());
        self.response.call(req)
    }
}