Line data Source code
1 : use anyhow::Context;
2 : use camino::Utf8Path;
3 : use remote_storage::RemotePath;
4 : use std::sync::Arc;
5 : use std::{collections::HashSet, num::NonZeroU32};
6 : use test_context::test_context;
7 : use tracing::debug;
8 :
9 : use crate::common::{download_to_vec, upload_stream, wrap_stream};
10 :
11 : use super::{
12 : MaybeEnabledStorage, MaybeEnabledStorageWithSimpleTestBlobs, MaybeEnabledStorageWithTestBlobs,
13 : };
14 :
15 : /// Tests that S3 client can list all prefixes, even if the response come paginated and requires multiple S3 queries.
16 : /// Uses real S3 and requires [`ENABLE_REAL_S3_REMOTE_STORAGE_ENV_VAR_NAME`] and related S3 cred env vars specified.
17 : /// See the client creation in [`create_s3_client`] for details on the required env vars.
18 : /// If real S3 tests are disabled, the test passes, skipping any real test run: currently, there's no way to mark the test ignored in runtime with the
19 : /// deafult test framework, see https://github.com/rust-lang/rust/issues/68007 for details.
20 : ///
21 : /// First, the test creates a set of S3 objects with keys `/${random_prefix_part}/${base_prefix_str}/sub_prefix_${i}/blob_${i}` in [`upload_remote_data`]
22 : /// where
23 : /// * `random_prefix_part` is set for the entire S3 client during the S3 client creation in [`create_s3_client`], to avoid multiple test runs interference
24 : /// * `base_prefix_str` is a common prefix to use in the client requests: we would want to ensure that the client is able to list nested prefixes inside the bucket
25 : ///
26 : /// Then, verifies that the client does return correct prefixes when queried:
27 : /// * with no prefix, it lists everything after its `${random_prefix_part}/` — that should be `${base_prefix_str}` value only
28 : /// * with `${base_prefix_str}/` prefix, it lists every `sub_prefix_${i}`
29 : ///
30 : /// With the real S3 enabled and `#[cfg(test)]` Rust configuration used, the S3 client test adds a `max-keys` param to limit the response keys.
31 : /// This way, we are able to test the pagination implicitly, by ensuring all results are returned from the remote storage and avoid uploading too many blobs to S3,
32 : /// since current default AWS S3 pagination limit is 1000.
33 : /// (see https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html#API_ListObjectsV2_RequestSyntax)
34 : ///
35 : /// Lastly, the test attempts to clean up and remove all uploaded S3 files.
36 : /// If any errors appear during the clean up, they get logged, but the test is not failed or stopped until clean up is finished.
37 4 : #[test_context(MaybeEnabledStorageWithTestBlobs)]
38 4 : #[tokio::test]
39 8 : async fn pagination_should_work(ctx: &mut MaybeEnabledStorageWithTestBlobs) -> anyhow::Result<()> {
40 4 : let ctx = match ctx {
41 0 : MaybeEnabledStorageWithTestBlobs::Enabled(ctx) => ctx,
42 4 : MaybeEnabledStorageWithTestBlobs::Disabled => return Ok(()),
43 0 : MaybeEnabledStorageWithTestBlobs::UploadsFailed(e, _) => {
44 0 : anyhow::bail!("S3 init failed: {e:?}")
45 : }
46 : };
47 :
48 0 : let test_client = Arc::clone(&ctx.enabled.client);
49 0 : let expected_remote_prefixes = ctx.remote_prefixes.clone();
50 :
51 0 : let base_prefix = RemotePath::new(Utf8Path::new(ctx.enabled.base_prefix))
52 0 : .context("common_prefix construction")?;
53 0 : let root_remote_prefixes = test_client
54 0 : .list_prefixes(None)
55 0 : .await
56 0 : .context("client list root prefixes failure")?
57 0 : .into_iter()
58 0 : .collect::<HashSet<_>>();
59 0 : assert_eq!(
60 0 : root_remote_prefixes, HashSet::from([base_prefix.clone()]),
61 0 : "remote storage root prefixes list mismatches with the uploads. Returned prefixes: {root_remote_prefixes:?}"
62 : );
63 :
64 0 : let nested_remote_prefixes = test_client
65 0 : .list_prefixes(Some(&base_prefix))
66 0 : .await
67 0 : .context("client list nested prefixes failure")?
68 0 : .into_iter()
69 0 : .collect::<HashSet<_>>();
70 0 : let remote_only_prefixes = nested_remote_prefixes
71 0 : .difference(&expected_remote_prefixes)
72 0 : .collect::<HashSet<_>>();
73 0 : let missing_uploaded_prefixes = expected_remote_prefixes
74 0 : .difference(&nested_remote_prefixes)
75 0 : .collect::<HashSet<_>>();
76 0 : assert_eq!(
77 0 : remote_only_prefixes.len() + missing_uploaded_prefixes.len(), 0,
78 0 : "remote storage nested prefixes list mismatches with the uploads. Remote only prefixes: {remote_only_prefixes:?}, missing uploaded prefixes: {missing_uploaded_prefixes:?}",
79 : );
80 :
81 0 : Ok(())
82 4 : }
83 :
84 : /// Tests that S3 client can list all files in a folder, even if the response comes paginated and requirees multiple S3 queries.
85 : /// Uses real S3 and requires [`ENABLE_REAL_S3_REMOTE_STORAGE_ENV_VAR_NAME`] and related S3 cred env vars specified. Test will skip real code and pass if env vars not set.
86 : /// See `s3_pagination_should_work` for more information.
87 : ///
88 : /// First, create a set of S3 objects with keys `random_prefix/folder{j}/blob_{i}.txt` in [`upload_remote_data`]
89 : /// Then performs the following queries:
90 : /// 1. `list_files(None)`. This should return all files `random_prefix/folder{j}/blob_{i}.txt`
91 : /// 2. `list_files("folder1")`. This should return all files `random_prefix/folder1/blob_{i}.txt`
92 4 : #[test_context(MaybeEnabledStorageWithSimpleTestBlobs)]
93 4 : #[tokio::test]
94 8 : async fn list_files_works(ctx: &mut MaybeEnabledStorageWithSimpleTestBlobs) -> anyhow::Result<()> {
95 4 : let ctx = match ctx {
96 0 : MaybeEnabledStorageWithSimpleTestBlobs::Enabled(ctx) => ctx,
97 4 : MaybeEnabledStorageWithSimpleTestBlobs::Disabled => return Ok(()),
98 0 : MaybeEnabledStorageWithSimpleTestBlobs::UploadsFailed(e, _) => {
99 0 : anyhow::bail!("S3 init failed: {e:?}")
100 : }
101 : };
102 0 : let test_client = Arc::clone(&ctx.enabled.client);
103 0 : let base_prefix =
104 0 : RemotePath::new(Utf8Path::new("folder1")).context("common_prefix construction")?;
105 0 : let root_files = test_client
106 0 : .list_files(None, None)
107 0 : .await
108 0 : .context("client list root files failure")?
109 0 : .into_iter()
110 0 : .collect::<HashSet<_>>();
111 0 : assert_eq!(
112 0 : root_files,
113 0 : ctx.remote_blobs.clone(),
114 0 : "remote storage list_files on root mismatches with the uploads."
115 : );
116 :
117 : // Test that max_keys limit works. In total there are about 21 files (see
118 : // upload_simple_remote_data call in test_real_s3.rs).
119 0 : let limited_root_files = test_client
120 0 : .list_files(None, Some(NonZeroU32::new(2).unwrap()))
121 0 : .await
122 0 : .context("client list root files failure")?;
123 0 : assert_eq!(limited_root_files.len(), 2);
124 :
125 0 : let nested_remote_files = test_client
126 0 : .list_files(Some(&base_prefix), None)
127 0 : .await
128 0 : .context("client list nested files failure")?
129 0 : .into_iter()
130 0 : .collect::<HashSet<_>>();
131 0 : let trim_remote_blobs: HashSet<_> = ctx
132 0 : .remote_blobs
133 0 : .iter()
134 0 : .map(|x| x.get_path())
135 0 : .filter(|x| x.starts_with("folder1"))
136 0 : .map(|x| RemotePath::new(x).expect("must be valid path"))
137 0 : .collect();
138 : assert_eq!(
139 : nested_remote_files, trim_remote_blobs,
140 0 : "remote storage list_files on subdirrectory mismatches with the uploads."
141 : );
142 0 : Ok(())
143 4 : }
144 :
145 4 : #[test_context(MaybeEnabledStorage)]
146 4 : #[tokio::test]
147 8 : async fn delete_non_exising_works(ctx: &mut MaybeEnabledStorage) -> anyhow::Result<()> {
148 4 : let ctx = match ctx {
149 0 : MaybeEnabledStorage::Enabled(ctx) => ctx,
150 4 : MaybeEnabledStorage::Disabled => return Ok(()),
151 : };
152 :
153 0 : let path = RemotePath::new(Utf8Path::new(
154 0 : format!("{}/for_sure_there_is_nothing_there_really", ctx.base_prefix).as_str(),
155 0 : ))
156 0 : .with_context(|| "RemotePath conversion")?;
157 :
158 0 : ctx.client.delete(&path).await.expect("should succeed");
159 0 :
160 0 : Ok(())
161 4 : }
162 :
163 4 : #[test_context(MaybeEnabledStorage)]
164 4 : #[tokio::test]
165 8 : async fn delete_objects_works(ctx: &mut MaybeEnabledStorage) -> anyhow::Result<()> {
166 4 : let ctx = match ctx {
167 0 : MaybeEnabledStorage::Enabled(ctx) => ctx,
168 4 : MaybeEnabledStorage::Disabled => return Ok(()),
169 : };
170 :
171 0 : let path1 = RemotePath::new(Utf8Path::new(format!("{}/path1", ctx.base_prefix).as_str()))
172 0 : .with_context(|| "RemotePath conversion")?;
173 :
174 0 : let path2 = RemotePath::new(Utf8Path::new(format!("{}/path2", ctx.base_prefix).as_str()))
175 0 : .with_context(|| "RemotePath conversion")?;
176 :
177 0 : let path3 = RemotePath::new(Utf8Path::new(format!("{}/path3", ctx.base_prefix).as_str()))
178 0 : .with_context(|| "RemotePath conversion")?;
179 :
180 0 : let (data, len) = upload_stream("remote blob data1".as_bytes().into());
181 0 : ctx.client.upload(data, len, &path1, None).await?;
182 :
183 0 : let (data, len) = upload_stream("remote blob data2".as_bytes().into());
184 0 : ctx.client.upload(data, len, &path2, None).await?;
185 :
186 0 : let (data, len) = upload_stream("remote blob data3".as_bytes().into());
187 0 : ctx.client.upload(data, len, &path3, None).await?;
188 :
189 0 : ctx.client.delete_objects(&[path1, path2]).await?;
190 :
191 0 : let prefixes = ctx.client.list_prefixes(None).await?;
192 :
193 0 : assert_eq!(prefixes.len(), 1);
194 :
195 0 : ctx.client.delete_objects(&[path3]).await?;
196 :
197 0 : Ok(())
198 4 : }
199 :
200 4 : #[test_context(MaybeEnabledStorage)]
201 4 : #[tokio::test]
202 8 : async fn upload_download_works(ctx: &mut MaybeEnabledStorage) -> anyhow::Result<()> {
203 4 : let MaybeEnabledStorage::Enabled(ctx) = ctx else {
204 4 : return Ok(());
205 : };
206 :
207 0 : let path = RemotePath::new(Utf8Path::new(format!("{}/file", ctx.base_prefix).as_str()))
208 0 : .with_context(|| "RemotePath conversion")?;
209 :
210 0 : let orig = bytes::Bytes::from_static("remote blob data here".as_bytes());
211 0 :
212 0 : let (data, len) = wrap_stream(orig.clone());
213 0 :
214 0 : ctx.client.upload(data, len, &path, None).await?;
215 :
216 : // Normal download request
217 0 : let dl = ctx.client.download(&path).await?;
218 0 : let buf = download_to_vec(dl).await?;
219 0 : assert_eq!(&buf, &orig);
220 :
221 : // Full range (end specified)
222 0 : let dl = ctx
223 0 : .client
224 0 : .download_byte_range(&path, 0, Some(len as u64))
225 0 : .await?;
226 0 : let buf = download_to_vec(dl).await?;
227 0 : assert_eq!(&buf, &orig);
228 :
229 : // partial range (end specified)
230 0 : let dl = ctx.client.download_byte_range(&path, 4, Some(10)).await?;
231 0 : let buf = download_to_vec(dl).await?;
232 0 : assert_eq!(&buf, &orig[4..10]);
233 :
234 : // partial range (end beyond real end)
235 0 : let dl = ctx
236 0 : .client
237 0 : .download_byte_range(&path, 8, Some(len as u64 * 100))
238 0 : .await?;
239 0 : let buf = download_to_vec(dl).await?;
240 0 : assert_eq!(&buf, &orig[8..]);
241 :
242 : // Partial range (end unspecified)
243 0 : let dl = ctx.client.download_byte_range(&path, 4, None).await?;
244 0 : let buf = download_to_vec(dl).await?;
245 0 : assert_eq!(&buf, &orig[4..]);
246 :
247 : // Full range (end unspecified)
248 0 : let dl = ctx.client.download_byte_range(&path, 0, None).await?;
249 0 : let buf = download_to_vec(dl).await?;
250 0 : assert_eq!(&buf, &orig);
251 :
252 0 : debug!("Cleanup: deleting file at path {path:?}");
253 0 : ctx.client
254 0 : .delete(&path)
255 0 : .await
256 0 : .with_context(|| format!("{path:?} removal"))?;
257 :
258 0 : Ok(())
259 4 : }
260 :
261 4 : #[test_context(MaybeEnabledStorage)]
262 4 : #[tokio::test]
263 8 : async fn copy_works(ctx: &mut MaybeEnabledStorage) -> anyhow::Result<()> {
264 4 : let MaybeEnabledStorage::Enabled(ctx) = ctx else {
265 4 : return Ok(());
266 : };
267 :
268 0 : let path = RemotePath::new(Utf8Path::new(
269 0 : format!("{}/file_to_copy", ctx.base_prefix).as_str(),
270 0 : ))
271 0 : .with_context(|| "RemotePath conversion")?;
272 0 : let path_dest = RemotePath::new(Utf8Path::new(
273 0 : format!("{}/file_dest", ctx.base_prefix).as_str(),
274 0 : ))
275 0 : .with_context(|| "RemotePath conversion")?;
276 :
277 0 : let orig = bytes::Bytes::from_static("remote blob data content".as_bytes());
278 0 :
279 0 : let (data, len) = wrap_stream(orig.clone());
280 0 :
281 0 : ctx.client.upload(data, len, &path, None).await?;
282 :
283 : // Normal download request
284 0 : ctx.client.copy_object(&path, &path_dest).await?;
285 :
286 0 : let dl = ctx.client.download(&path_dest).await?;
287 0 : let buf = download_to_vec(dl).await?;
288 0 : assert_eq!(&buf, &orig);
289 :
290 0 : debug!("Cleanup: deleting file at path {path:?}");
291 0 : ctx.client
292 0 : .delete_objects(&[path.clone(), path_dest.clone()])
293 0 : .await
294 0 : .with_context(|| format!("{path:?} removal"))?;
295 :
296 0 : Ok(())
297 4 : }
|
