easyhttpmock 0.1.3

EasyHttpMock is a simple HTTP mock server for testing HTTP clients.
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use crate::{errors::EasyHttpMockError, mock::Mock};
use once_cell::sync::OnceCell;
use std::{
    collections::HashSet,
    future::Future,
    sync::{Arc, Mutex},
};

static PORTS_IN_USE: OnceCell<Mutex<HashSet<u16>>> = OnceCell::new();

/// Server adapter trait to allow different http server implementations
pub trait ServerAdapter {
    /// The configuration for the server adapter
    type Config: Clone;

    /// Create a new server adapter
    ///
    /// # Arguments
    ///
    /// * `config` - The configuration for the server adapter
    ///
    /// # Returns
    ///
    /// * `Result<Self, EasyHttpMockError>` - The server adapter or an error
    fn new(config: Self::Config) -> Result<Self, EasyHttpMockError>
    where
        Self: Sized;

    /// Get the hostname of the server
    ///
    /// # Returns
    ///
    /// * `String` - The hostname of the server
    fn hostname(&self) -> String;

    /// Get the base URL of the server
    ///
    /// # Returns
    ///
    /// * `String` - The base URL of the server
    ///
    fn base_url(&self) -> String;

    /// Get the configuration of the server
    ///
    /// # Returns
    ///
    /// * `&Self::Config` - The configuration of the server
    ///
    fn config(&self) -> &Self::Config;

    /// Get the configuration of the server
    ///
    /// # Returns
    ///
    /// * `&Self::Config` - The configuration of the server
    ///
    fn config_mut(&mut self) -> &mut Self::Config;

    /// Set the mocker to handle incoming requests
    ///
    /// # Arguments
    ///
    /// * `mocker` - The mocker to handle incoming requests
    ///
    /// # Returns
    ///
    /// * `Result<(), EasyHttpMockError>` - The result of the operation
    ///
    fn register_mock(&mut self, mock: Arc<Mock>);

    /// Start the server
    ///
    /// # Returns
    ///
    /// * `Result<(), EasyHttpMockError>` - The result of the operation
    ///
    fn start(&mut self) -> impl Future<Output = Result<(), EasyHttpMockError>>;

    /// Stop the server
    ///
    /// # Returns
    ///
    /// * `Result<(), EasyHttpMockError>` - The result of the operation
    ///
    fn stop(&mut self) -> impl Future<Output = Result<(), EasyHttpMockError>>;
}

/// Port generator trait to allow different port generation strategies
pub trait PortGenerator<S>
where
    S: ServerAdapter,
    S::Config: Clone,
{
    /// Generate a random port
    fn random_port() -> u16 {
        generate_randon_port()
    }

    /// Set the server to use a random port
    fn with_random_port(self) -> Self;
}

/// Generate a random port
pub fn generate_randon_port() -> u16 {
    let ports = PORTS_IN_USE.get_or_init(|| Mutex::new(HashSet::new()));

    match ports.lock() {
        Ok(mut ports) => {
            let mut port = rand::random_range(9000..65535);
            while ports.contains(&port) {
                port = rand::random_range(9000..65535);
            }
            ports.insert(port);
            port
        }
        Err(_) => rand::random_range(9000..65535),
    }
}