mithril_aggregator/file_uploaders/
dumb_uploader.rs

1use anyhow::anyhow;
2use async_trait::async_trait;
3use mithril_common::{entities::FileUri, StdResult};
4use std::{path::Path, sync::RwLock};
5
6use crate::file_uploaders::{FileUploadRetryPolicy, FileUploader};
7
8/// Dummy uploader for test purposes.
9///
10/// It actually does NOT upload any file but keep the history of all the files it
11/// was asked to upload. This is intended to by used by integration tests.
12pub struct DumbUploader {
13    uploads_history: RwLock<Vec<FileUri>>,
14    retry_policy: FileUploadRetryPolicy,
15}
16
17impl DumbUploader {
18    /// Create a new instance with a custom retry policy.
19    pub fn new(retry_policy: FileUploadRetryPolicy) -> Self {
20        Self {
21            uploads_history: RwLock::new(Vec::new()),
22            retry_policy,
23        }
24    }
25
26    /// Return the last upload that was triggered.
27    pub fn get_last_upload(&self) -> StdResult<Option<FileUri>> {
28        let last_upload = self.get_last_n_uploads(1)?;
29        Ok(last_upload.first().cloned())
30    }
31
32    /// Return the last `n` uploads that were triggered in anti-chronological order.
33    pub fn get_last_n_uploads(&self, n: usize) -> StdResult<Vec<FileUri>> {
34        let value = self
35            .uploads_history
36            .read()
37            .map_err(|e| anyhow!(e.to_string()).context("Error while reading filepath location"))?;
38
39        Ok(value
40            .iter()
41            .rev()
42            .take(n)
43            .cloned()
44            .collect::<Vec<FileUri>>())
45    }
46}
47
48impl Default for DumbUploader {
49    fn default() -> Self {
50        Self::new(FileUploadRetryPolicy::never())
51    }
52}
53
54#[async_trait]
55impl FileUploader for DumbUploader {
56    /// Upload a file
57    async fn upload_without_retry(&self, filepath: &Path) -> StdResult<FileUri> {
58        let mut uploads_history = self
59            .uploads_history
60            .write()
61            .map_err(|e| anyhow!("Error while saving filepath location: {e}"))?;
62
63        let location = FileUri(filepath.to_string_lossy().to_string());
64        uploads_history.push(location.clone());
65
66        Ok(location)
67    }
68
69    fn retry_policy(&self) -> FileUploadRetryPolicy {
70        self.retry_policy.clone()
71    }
72}
73
74#[cfg(test)]
75mod tests {
76    use std::time::Duration;
77
78    use super::*;
79
80    #[tokio::test]
81    async fn test_dumb_uploader() {
82        let uploader = DumbUploader::default();
83        assert!(uploader
84            .get_last_upload()
85            .expect("uploader should not fail")
86            .is_none());
87        let res = uploader
88            .upload(Path::new("/tmp/whatever"))
89            .await
90            .expect("uploading with a dumb uploader should not fail");
91        assert_eq!(res, FileUri("/tmp/whatever".to_string()));
92        assert_eq!(
93            Some(FileUri("/tmp/whatever".to_string())),
94            uploader
95                .get_last_upload()
96                .expect("getting dumb uploader last value after a fake download should not fail")
97        );
98    }
99
100    #[tokio::test]
101    async fn get_history_of_multiple_uploads() {
102        let uploader = DumbUploader::default();
103        assert_eq!(
104            Vec::<FileUri>::new(),
105            uploader.get_last_n_uploads(usize::MAX).unwrap()
106        );
107
108        uploader.upload(Path::new("/tmp/whatever")).await.unwrap();
109        uploader.upload(Path::new("/tmp/whatever2")).await.unwrap();
110        uploader.upload(Path::new("/tmp/whatever3")).await.unwrap();
111
112        assert_eq!(
113            vec![
114                FileUri("/tmp/whatever3".to_string()),
115                FileUri("/tmp/whatever2".to_string()),
116                FileUri("/tmp/whatever".to_string()),
117            ],
118            uploader.get_last_n_uploads(usize::MAX).unwrap()
119        );
120
121        assert_eq!(
122            vec![
123                FileUri("/tmp/whatever3".to_string()),
124                FileUri("/tmp/whatever2".to_string()),
125            ],
126            uploader.get_last_n_uploads(2).unwrap()
127        );
128    }
129
130    #[tokio::test]
131    async fn retry_policy_from_file_uploader_trait_should_be_implemented() {
132        let expected_policy = FileUploadRetryPolicy {
133            attempts: 10,
134            delay_between_attempts: Duration::from_millis(123),
135        };
136
137        let uploader: Box<dyn FileUploader> = Box::new(DumbUploader::new(expected_policy.clone()));
138
139        assert_eq!(expected_policy, uploader.retry_policy());
140    }
141}
mithril_aggregator/file_uploaders/dumb_uploader.rs

mithril_aggregator/file_uploaders/
dumb_uploader.rs
