1 #![warn(rust_2018_idioms)]
2 #![cfg(all(feature = "full", not(target_os = "wasi")))] // WASI does not support all fs operations
3 
4 use std::io::prelude::*;
5 use std::io::IoSlice;
6 use tempfile::NamedTempFile;
7 use tokio::fs::File;
8 use tokio::io::{AsyncReadExt, AsyncSeekExt, AsyncWriteExt, SeekFrom};
9 use tokio_test::task;
10 
11 const HELLO: &[u8] = b"hello world...";
12 
13 #[tokio::test]
basic_read()14 async fn basic_read() {
15     let mut tempfile = tempfile();
16     tempfile.write_all(HELLO).unwrap();
17 
18     let mut file = File::open(tempfile.path()).await.unwrap();
19 
20     let mut buf = [0; 1024];
21     let n = file.read(&mut buf).await.unwrap();
22 
23     assert_eq!(n, HELLO.len());
24     assert_eq!(&buf[..n], HELLO);
25 }
26 
27 #[tokio::test]
basic_write()28 async fn basic_write() {
29     let tempfile = tempfile();
30 
31     let mut file = File::create(tempfile.path()).await.unwrap();
32 
33     file.write_all(HELLO).await.unwrap();
34     file.flush().await.unwrap();
35 
36     let file = std::fs::read(tempfile.path()).unwrap();
37     assert_eq!(file, HELLO);
38 }
39 
40 #[tokio::test]
basic_write_and_shutdown()41 async fn basic_write_and_shutdown() {
42     let tempfile = tempfile();
43 
44     let mut file = File::create(tempfile.path()).await.unwrap();
45 
46     file.write_all(HELLO).await.unwrap();
47     file.shutdown().await.unwrap();
48 
49     let file = std::fs::read(tempfile.path()).unwrap();
50     assert_eq!(file, HELLO);
51 }
52 
53 #[tokio::test]
write_vectored()54 async fn write_vectored() {
55     let tempfile = tempfile();
56 
57     let mut file = File::create(tempfile.path()).await.unwrap();
58 
59     let ret = file
60         .write_vectored(&[IoSlice::new(HELLO), IoSlice::new(HELLO)])
61         .await
62         .unwrap();
63     assert_eq!(ret, HELLO.len() * 2);
64     file.flush().await.unwrap();
65 
66     let file = std::fs::read(tempfile.path()).unwrap();
67     assert_eq!(file, [HELLO, HELLO].concat());
68 }
69 
70 #[tokio::test]
write_vectored_and_shutdown()71 async fn write_vectored_and_shutdown() {
72     let tempfile = tempfile();
73 
74     let mut file = File::create(tempfile.path()).await.unwrap();
75 
76     let ret = file
77         .write_vectored(&[IoSlice::new(HELLO), IoSlice::new(HELLO)])
78         .await
79         .unwrap();
80     assert_eq!(ret, HELLO.len() * 2);
81     file.shutdown().await.unwrap();
82 
83     let file = std::fs::read(tempfile.path()).unwrap();
84     assert_eq!(file, [HELLO, HELLO].concat());
85 }
86 
87 #[tokio::test]
rewind_seek_position()88 async fn rewind_seek_position() {
89     let tempfile = tempfile();
90 
91     let mut file = File::create(tempfile.path()).await.unwrap();
92 
93     file.seek(SeekFrom::Current(10)).await.unwrap();
94 
95     file.rewind().await.unwrap();
96 
97     assert_eq!(file.stream_position().await.unwrap(), 0);
98 }
99 
100 #[tokio::test]
coop()101 async fn coop() {
102     let mut tempfile = tempfile();
103     tempfile.write_all(HELLO).unwrap();
104 
105     let mut task = task::spawn(async {
106         let mut file = File::open(tempfile.path()).await.unwrap();
107 
108         let mut buf = [0; 1024];
109 
110         loop {
111             let _ = file.read(&mut buf).await.unwrap();
112             file.seek(std::io::SeekFrom::Start(0)).await.unwrap();
113         }
114     });
115 
116     for _ in 0..1_000 {
117         if task.poll().is_pending() {
118             return;
119         }
120     }
121 
122     panic!("did not yield");
123 }
124 
125 #[tokio::test]
write_to_clone()126 async fn write_to_clone() {
127     let tempfile = tempfile();
128 
129     let file = File::create(tempfile.path()).await.unwrap();
130     let mut clone = file.try_clone().await.unwrap();
131 
132     clone.write_all(HELLO).await.unwrap();
133     clone.flush().await.unwrap();
134 
135     let contents = std::fs::read(tempfile.path()).unwrap();
136     assert_eq!(contents, HELLO);
137 }
138 
139 #[tokio::test]
write_into_std()140 async fn write_into_std() {
141     let tempfile = tempfile();
142 
143     let file = File::create(tempfile.path()).await.unwrap();
144     let mut std_file = file.into_std().await;
145 
146     std_file.write_all(HELLO).unwrap();
147 
148     let contents = std::fs::read(tempfile.path()).unwrap();
149     assert_eq!(contents, HELLO);
150 }
151 
152 #[tokio::test]
write_into_std_immediate()153 async fn write_into_std_immediate() {
154     let tempfile = tempfile();
155 
156     let file = File::create(tempfile.path()).await.unwrap();
157     let mut std_file = file.try_into_std().unwrap();
158 
159     std_file.write_all(HELLO).unwrap();
160 
161     let contents = std::fs::read(tempfile.path()).unwrap();
162     assert_eq!(contents, HELLO);
163 }
164 
165 #[tokio::test]
read_file_from_std()166 async fn read_file_from_std() {
167     let mut tempfile = tempfile();
168     tempfile.write_all(HELLO).unwrap();
169 
170     let std_file = std::fs::File::open(tempfile.path()).unwrap();
171     let mut file = File::from(std_file);
172 
173     let mut buf = [0; 1024];
174     let n = file.read(&mut buf).await.unwrap();
175     assert_eq!(n, HELLO.len());
176     assert_eq!(&buf[..n], HELLO);
177 }
178 
tempfile() -> NamedTempFile179 fn tempfile() -> NamedTempFile {
180     NamedTempFile::new().unwrap()
181 }
182 
183 #[tokio::test]
set_max_buf_size_read()184 async fn set_max_buf_size_read() {
185     let mut tempfile = tempfile();
186     tempfile.write_all(HELLO).unwrap();
187     let mut file = File::open(tempfile.path()).await.unwrap();
188     let mut buf = [0; 1024];
189     file.set_max_buf_size(1);
190 
191     // A single read operation reads a maximum of 1 byte.
192     assert_eq!(file.read(&mut buf).await.unwrap(), 1);
193 }
194 
195 #[tokio::test]
set_max_buf_size_write()196 async fn set_max_buf_size_write() {
197     let tempfile = tempfile();
198     let mut file = File::create(tempfile.path()).await.unwrap();
199     file.set_max_buf_size(1);
200 
201     // A single write operation writes a maximum of 1 byte.
202     assert_eq!(file.write(HELLO).await.unwrap(), 1);
203 }
204 
205 #[tokio::test]
206 #[cfg_attr(miri, ignore)]
207 #[cfg(unix)]
file_debug_fmt()208 async fn file_debug_fmt() {
209     let tempfile = tempfile();
210 
211     let file = File::open(tempfile.path()).await.unwrap();
212 
213     assert_eq!(
214         &format!("{file:?}")[0..33],
215         "tokio::fs::File { std: File { fd:"
216     );
217 }
218 
219 #[tokio::test]
220 #[cfg(windows)]
file_debug_fmt()221 async fn file_debug_fmt() {
222     let tempfile = tempfile();
223 
224     let file = File::open(tempfile.path()).await.unwrap();
225 
226     assert_eq!(
227         &format!("{:?}", file)[0..37],
228         "tokio::fs::File { std: File { handle:"
229     );
230 }
231 
232 #[tokio::test]
233 #[cfg(unix)]
unix_fd_is_valid()234 async fn unix_fd_is_valid() {
235     use std::os::unix::io::AsRawFd;
236     let tempfile = tempfile();
237 
238     let file = File::create(tempfile.path()).await.unwrap();
239     assert!(file.as_raw_fd() as u64 > 0);
240 }
241 
242 #[tokio::test]
243 #[cfg(unix)]
read_file_from_unix_fd()244 async fn read_file_from_unix_fd() {
245     use std::os::unix::io::{FromRawFd, IntoRawFd};
246 
247     let mut tempfile = tempfile();
248     tempfile.write_all(HELLO).unwrap();
249 
250     let file1 = File::open(tempfile.path()).await.unwrap();
251     let raw_fd = file1.into_std().await.into_raw_fd();
252     assert!(raw_fd > 0);
253 
254     let mut file2 = unsafe { File::from_raw_fd(raw_fd) };
255 
256     let mut buf = [0; 1024];
257     let n = file2.read(&mut buf).await.unwrap();
258     assert_eq!(n, HELLO.len());
259     assert_eq!(&buf[..n], HELLO);
260 }
261 
262 #[tokio::test]
263 #[cfg(windows)]
windows_handle()264 async fn windows_handle() {
265     use std::os::windows::io::AsRawHandle;
266     let tempfile = tempfile();
267 
268     let file = File::create(tempfile.path()).await.unwrap();
269     assert!(file.as_raw_handle() as u64 > 0);
270 }
271