hakanai-lib 2.13.2

Client library for Hakanai, a secure secret sharing service.
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
// SPDX-License-Identifier: Apache-2.0

#[cfg(any(test, feature = "testing"))]
use std::sync::{Arc, Mutex};
#[cfg(any(test, feature = "testing"))]
use std::time::Duration;

#[cfg(any(test, feature = "testing"))]
use async_trait::async_trait;
#[cfg(any(test, feature = "testing"))]
use url::Url;

#[cfg(any(test, feature = "testing"))]
use crate::client::{Client, ClientError};
#[cfg(any(test, feature = "testing"))]
use crate::options::{SecretReceiveOptions, SecretSendOptions};

/// A generic mock client implementation using the builder pattern.
///
/// This mock client can be used to simulate both success and failure scenarios
/// for testing purposes. It supports any data type `T` that implements the required traits.
///
/// # Examples
///
/// ```
/// use hakanai_lib::client_mock::MockClient;
/// use url::Url;
///
/// // Create a mock client for Vec<u8>
/// let mock = MockClient::<Vec<u8>>::new()
///     .with_send_success(Url::parse("https://example.com/secret/123").unwrap())
///     .with_receive_success(b"test response".to_vec());
///
/// // Create a mock client that fails
/// let failing_mock = MockClient::<Vec<u8>>::new()
///     .with_send_failure("Network error".to_string())
///     .with_receive_failure("Not found".to_string());
/// ```
#[cfg(any(test, feature = "testing"))]
#[derive(Clone)]
pub struct MockClient<T> {
    // Data capture
    sent_data: Arc<Mutex<Option<T>>>,

    // Response configuration
    response_url: Option<Url>,
    response_data: Option<T>,

    // Error configuration
    send_should_fail: bool,
    send_error_message: Option<String>,
    receive_should_fail: bool,
    receive_error_message: Option<String>,
}

#[cfg(any(test, feature = "testing"))]
impl<T> MockClient<T>
where
    T: Clone + Send + Sync + 'static,
{
    /// Creates a new MockClient with default configuration.
    ///
    /// By default, the mock client will:
    /// - Return a default URL for send operations
    /// - Return default data for receive operations
    /// - Not fail unless explicitly configured to do so
    pub fn new() -> Self {
        Self {
            sent_data: Arc::new(Mutex::new(None)),
            response_url: Some(Url::parse("https://example.com/secret/123").unwrap()),
            response_data: None,
            send_should_fail: false,
            send_error_message: None,
            receive_should_fail: false,
            receive_error_message: None,
        }
    }

    /// Configure the mock to return a specific URL on successful send operations.
    pub fn with_send_success(mut self, url: Url) -> Self {
        self.response_url = Some(url);
        self.send_should_fail = false;
        self
    }

    /// Configure the mock to fail send operations with the given error message.
    pub fn with_send_failure(mut self, error_message: String) -> Self {
        self.send_should_fail = true;
        self.send_error_message = Some(error_message);
        self
    }

    /// Configure the mock to return specific data on successful receive operations.
    pub fn with_receive_success(mut self, data: T) -> Self {
        self.response_data = Some(data);
        self.receive_should_fail = false;
        self
    }

    /// Configure the mock to fail receive operations with the given error message.
    pub fn with_receive_failure(mut self, error_message: String) -> Self {
        self.receive_should_fail = true;
        self.receive_error_message = Some(error_message);
        self
    }

    /// Configure both the send URL and receive data for successful operations.
    pub fn with_success(mut self, url: Url, data: T) -> Self {
        self.response_url = Some(url);
        self.response_data = Some(data);
        self.send_should_fail = false;
        self.receive_should_fail = false;
        self
    }

    /// Configure the mock to fail all operations with the given error message.
    pub fn with_all_failures(mut self, error_message: String) -> Self {
        self.send_should_fail = true;
        self.send_error_message = Some(error_message.clone());
        self.receive_should_fail = true;
        self.receive_error_message = Some(error_message);
        self
    }

    /// Get the data that was sent to the mock client.
    ///
    /// This is useful for verifying that the correct data was passed to the client
    /// during testing.
    pub fn get_sent_data(&self) -> Option<T> {
        self.sent_data.lock().unwrap().clone()
    }

    /// Check if any data was sent to the mock client.
    pub fn was_send_called(&self) -> bool {
        self.sent_data.lock().unwrap().is_some()
    }

    /// Clear any captured sent data.
    pub fn clear_sent_data(&self) {
        *self.sent_data.lock().unwrap() = None;
    }
}

#[cfg(any(test, feature = "testing"))]
impl<T> Default for MockClient<T>
where
    T: Clone + Send + Sync + 'static,
{
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(any(test, feature = "testing"))]
#[async_trait]
impl<T> Client<T> for MockClient<T>
where
    T: Clone + Send + Sync + 'static,
{
    async fn send_secret(
        &self,
        _base_url: Url,
        data: T,
        _ttl: Duration,
        _token: String,
        _opts: Option<SecretSendOptions>,
    ) -> Result<Url, ClientError> {
        // Capture the sent data
        *self.sent_data.lock().unwrap() = Some(data);

        // Return configured response
        if self.send_should_fail {
            let error_msg = self
                .send_error_message
                .clone()
                .unwrap_or_else(|| "Mock send error".to_string());
            Err(ClientError::Custom(error_msg))
        } else {
            Ok(self
                .response_url
                .clone()
                .unwrap_or_else(|| Url::parse("https://example.com/secret/default").unwrap()))
        }
    }

    async fn receive_secret(
        &self,
        _url: Url,
        _opts: Option<SecretReceiveOptions>,
    ) -> Result<T, ClientError> {
        if self.receive_should_fail {
            let error_msg = self
                .receive_error_message
                .clone()
                .unwrap_or_else(|| "Mock receive error".to_string());
            Err(ClientError::Custom(error_msg))
        } else {
            self.response_data
                .clone()
                .ok_or_else(|| ClientError::Custom("No response data configured".to_string()))
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::models::Payload;
    use std::error::Error;

    type Result<T> = std::result::Result<T, Box<dyn Error>>;

    #[tokio::test]
    async fn test_mock_client_vec_u8_send_success() -> Result<()> {
        let mock = MockClient::<Vec<u8>>::new()
            .with_send_success(Url::parse("https://test.com/secret/456").unwrap());

        let test_data = b"test data".to_vec();
        let result = mock
            .send_secret(
                Url::parse("https://example.com").unwrap(),
                test_data.clone(),
                Duration::from_secs(3600),
                "token".to_string(),
                None,
            )
            .await;

        let url = result?;
        assert_eq!(url.as_str(), "https://test.com/secret/456");
        assert_eq!(mock.get_sent_data(), Some(test_data));
        Ok(())
    }

    #[tokio::test]
    async fn test_mock_client_vec_u8_send_failure() -> Result<()> {
        let mock = MockClient::<Vec<u8>>::new().with_send_failure("Network error".to_string());

        let test_data = b"test data".to_vec();
        let result = mock
            .send_secret(
                Url::parse("https://example.com").unwrap(),
                test_data.clone(),
                Duration::from_secs(3600),
                "token".to_string(),
                None,
            )
            .await;

        assert!(result.is_err(), "Expected send error, got: {:?}", result);
        match result.unwrap_err() {
            ClientError::Custom(msg) => assert_eq!(msg, "Network error"),
            _ => panic!("Expected Custom error"),
        }
        assert_eq!(mock.get_sent_data(), Some(test_data));
        Ok(())
    }

    #[tokio::test]
    async fn test_mock_client_vec_u8_receive_success() -> Result<()> {
        let response_data = b"response data".to_vec();
        let mock = MockClient::<Vec<u8>>::new().with_receive_success(response_data.clone());

        let result = mock
            .receive_secret(Url::parse("https://example.com/secret/123").unwrap(), None)
            .await;

        let data = result?;
        assert_eq!(data, response_data);
        Ok(())
    }

    #[tokio::test]
    async fn test_mock_client_vec_u8_receive_failure() -> Result<()> {
        let mock = MockClient::<Vec<u8>>::new().with_receive_failure("Not found".to_string());

        let result = mock
            .receive_secret(Url::parse("https://example.com/secret/123").unwrap(), None)
            .await;

        assert!(result.is_err(), "Expected receive error, got: {:?}", result);
        match result.unwrap_err() {
            ClientError::Custom(msg) => assert_eq!(msg, "Not found"),
            _ => panic!("Expected Custom error"),
        }
        Ok(())
    }

    #[tokio::test]
    async fn test_mock_client_payload_type() -> Result<()> {
        let payload = Payload::from_bytes(b"test payload", Some("test.txt".to_string()));
        let mock = MockClient::<Payload>::new().with_receive_success(payload.clone());

        let result = mock
            .receive_secret(Url::parse("https://example.com/secret/123").unwrap(), None)
            .await;

        let received = result?;
        assert_eq!(received.data, payload.data);
        assert_eq!(received.filename, payload.filename);
        Ok(())
    }

    #[tokio::test]
    async fn test_mock_client_builder_pattern() -> Result<()> {
        let test_url = Url::parse("https://test.com/secret/abc").unwrap();
        let test_data = b"test response".to_vec();

        let mock = MockClient::new().with_success(test_url.clone(), test_data.clone());

        // Test send
        let send_result = mock
            .send_secret(
                Url::parse("https://example.com").unwrap(),
                b"send data".to_vec(),
                Duration::from_secs(3600),
                "token".to_string(),
                None,
            )
            .await;

        let send_url = send_result?;
        assert_eq!(send_url, test_url);

        // Test receive
        let receive_result = mock
            .receive_secret(Url::parse("https://example.com/secret/123").unwrap(), None)
            .await;

        let receive_data = receive_result?;
        assert_eq!(receive_data, test_data);
        Ok(())
    }

    #[tokio::test]
    async fn test_mock_client_all_failures() -> Result<()> {
        let mock = MockClient::<Vec<u8>>::new().with_all_failures("Everything fails".to_string());

        // Test send failure
        let send_result = mock
            .send_secret(
                Url::parse("https://example.com").unwrap(),
                b"test".to_vec(),
                Duration::from_secs(3600),
                "token".to_string(),
                None,
            )
            .await;

        assert!(
            send_result.is_err(),
            "Expected send failure, got: {:?}",
            send_result
        );

        // Test receive failure
        let receive_result = mock
            .receive_secret(Url::parse("https://example.com/secret/123").unwrap(), None)
            .await;

        assert!(
            receive_result.is_err(),
            "Expected receive failure, got: {:?}",
            receive_result
        );
        Ok(())
    }

    #[tokio::test]
    async fn test_mock_client_data_capture() -> Result<()> {
        let mock = MockClient::<Vec<u8>>::new();

        assert!(!mock.was_send_called());
        assert_eq!(mock.get_sent_data(), None);

        let test_data = b"captured data".to_vec();
        let _ = mock
            .send_secret(
                Url::parse("https://example.com").unwrap(),
                test_data.clone(),
                Duration::from_secs(3600),
                "token".to_string(),
                None,
            )
            .await;

        assert!(mock.was_send_called());
        assert_eq!(mock.get_sent_data(), Some(test_data));

        mock.clear_sent_data();
        assert!(!mock.was_send_called());
        assert_eq!(mock.get_sent_data(), None);
        Ok(())
    }

    #[tokio::test]
    async fn test_mock_client_default_impl() -> Result<()> {
        let mock = MockClient::<Vec<u8>>::default();

        let result = mock
            .send_secret(
                Url::parse("https://example.com").unwrap(),
                b"test".to_vec(),
                Duration::from_secs(3600),
                "token".to_string(),
                None,
            )
            .await;

        let url = result?;
        assert_eq!(url.as_str(), "https://example.com/secret/123");
        Ok(())
    }
}