authorgravatar for kubkon@jakubkonka.comJakub Konka <kubkon@jakubkonka.com> 2020-05-18 17:10:02+02:00
committergravatar for kubkon@jakubkonka.comJakub Konka <kubkon@jakubkonka.com> 2020-05-18 17:10:49+02:00
log2a59ecd7eca7318e9a66d856b04dd9fa45b2d69d
tree9c3e45de923fc01c2fe9d836c7b815ef35e042bc
parentf26ab568aaf60543d9fa09b53461458e5cdaddb3

Integrate getTestDir with tmpDir logic

3 files changed, 100 insertions(+), 73 deletions(-)

lib/std/io/test.zig+28-19
......@@ -11,17 +11,18 @@ const mem = std.mem;
1111const fs = std.fs;
1212const File = std.fs.File;
1313
14const getTestDir = std.testing.getTestDir;
14const tmpDir = std.testing.tmpDir;
1515
1616test "write a file, read it, then delete it" {
17 const test_dir = getTestDir();
17 var tmp = tmpDir(.{});
18 defer tmp.cleanup();
1819
1920 var data: [1024]u8 = undefined;
2021 var prng = DefaultPrng.init(1234);
2122 prng.random.bytes(data[0..]);
2223 const tmp_file_name = "temp_test_file.txt";
2324 {
24 var file = try test_dir.createFile(tmp_file_name, .{});
25 var file = try tmp.dir.createFile(tmp_file_name, .{});
2526 defer file.close();
2627
2728 var buf_stream = io.bufferedOutStream(file.outStream());
......@@ -34,7 +35,7 @@ test "write a file, read it, then delete it" {
3435
3536 {
3637 // Make sure the exclusive flag is honored.
37 if (test_dir.createFile(tmp_file_name, .{ .exclusive = true })) |file| {
38 if (tmp.dir.createFile(tmp_file_name, .{ .exclusive = true })) |file| {
3839 unreachable;
3940 } else |err| {
4041 std.debug.assert(err == File.OpenError.PathAlreadyExists);
......@@ -42,7 +43,7 @@ test "write a file, read it, then delete it" {
4243 }
4344
4445 {
45 var file = try test_dir.openFile(tmp_file_name, .{});
46 var file = try tmp.dir.openFile(tmp_file_name, .{});
4647 defer file.close();
4748
4849 const file_size = try file.getEndPos();
......@@ -58,14 +59,16 @@ test "write a file, read it, then delete it" {
5859 expect(mem.eql(u8, contents["begin".len .. contents.len - "end".len], &data));
5960 expect(mem.eql(u8, contents[contents.len - "end".len ..], "end"));
6061 }
61 try test_dir.deleteFile(tmp_file_name);
62 try tmp.dir.deleteFile(tmp_file_name);
6263}
6364
6465test "BitStreams with File Stream" {
65 var test_dir = getTestDir();
66 var tmp = tmpDir(.{});
67 defer tmp.cleanup();
68
6669 const tmp_file_name = "temp_test_file.txt";
6770 {
68 var file = try test_dir.createFile(tmp_file_name, .{});
71 var file = try tmp.dir.createFile(tmp_file_name, .{});
6972 defer file.close();
7073
7174 var bit_stream = io.bitOutStream(builtin.endian, file.outStream());
......@@ -79,7 +82,7 @@ test "BitStreams with File Stream" {
7982 try bit_stream.flushBits();
8083 }
8184 {
82 var file = try test_dir.openFile(tmp_file_name, .{});
85 var file = try tmp.dir.openFile(tmp_file_name, .{});
8386 defer file.close();
8487
8588 var bit_stream = io.bitInStream(builtin.endian, file.inStream());
......@@ -101,16 +104,18 @@ test "BitStreams with File Stream" {
101104
102105 expectError(error.EndOfStream, bit_stream.readBitsNoEof(u1, 1));
103106 }
104 try test_dir.deleteFile(tmp_file_name);
107 try tmp.dir.deleteFile(tmp_file_name);
105108}
106109
107110test "File seek ops" {
108 var test_dir = getTestDir();
111 var tmp = tmpDir(.{});
112 defer tmp.cleanup();
113
109114 const tmp_file_name = "temp_test_file.txt";
110 var file = try test_dir.createFile(tmp_file_name, .{});
115 var file = try tmp.dir.createFile(tmp_file_name, .{});
111116 defer {
112117 file.close();
113 test_dir.deleteFile(tmp_file_name) catch {};
118 tmp.dir.deleteFile(tmp_file_name) catch {};
114119 }
115120
116121 try file.writeAll(&([_]u8{0x55} ** 8192));
......@@ -133,12 +138,14 @@ test "setEndPos" {
133138 // https://github.com/ziglang/zig/issues/5127
134139 if (std.Target.current.cpu.arch == .mips) return error.SkipZigTest;
135140
136 var test_dir = getTestDir();
141 var tmp = tmpDir(.{});
142 defer tmp.cleanup();
143
137144 const tmp_file_name = "temp_test_file.txt";
138 var file = try test_dir.createFile(tmp_file_name, .{});
145 var file = try tmp.dir.createFile(tmp_file_name, .{});
139146 defer {
140147 file.close();
141 test_dir.deleteFile(tmp_file_name) catch {};
148 tmp.dir.deleteFile(tmp_file_name) catch {};
142149 }
143150
144151 // Verify that the file size changes and the file offset is not moved
......@@ -157,12 +164,14 @@ test "setEndPos" {
157164}
158165
159166test "updateTimes" {
160 var test_dir = getTestDir();
167 var tmp = tmpDir(.{});
168 defer tmp.cleanup();
169
161170 const tmp_file_name = "just_a_temporary_file.txt";
162 var file = try test_dir.createFile(tmp_file_name, .{ .read = true });
171 var file = try tmp.dir.createFile(tmp_file_name, .{ .read = true });
163172 defer {
164173 file.close();
165 test_dir.deleteFile(tmp_file_name) catch {};
174 tmp.dir.deleteFile(tmp_file_name) catch {};
166175 }
167176 var stat_old = try file.stat();
168177 // Set atime and mtime to 5s before
lib/std/os/test.zig+55-38
......@@ -15,15 +15,18 @@ const a = std.testing.allocator;
1515const builtin = @import("builtin");
1616const AtomicRmwOp = builtin.AtomicRmwOp;
1717const AtomicOrder = builtin.AtomicOrder;
18const getTestDir = std.testing.getTestDir;
18const tmpDir = std.testing.tmpDir;
19const Dir = std.fs.Dir;
1920
2021test "makePath, put some files in it, deleteTree" {
21 var test_dir = getTestDir();
22 try test_dir.makePath("os_test_tmp" ++ fs.path.sep_str ++ "b" ++ fs.path.sep_str ++ "c");
23 try test_dir.writeFile("os_test_tmp" ++ fs.path.sep_str ++ "b" ++ fs.path.sep_str ++ "c" ++ fs.path.sep_str ++ "file.txt", "nonsense");
24 try test_dir.writeFile("os_test_tmp" ++ fs.path.sep_str ++ "b" ++ fs.path.sep_str ++ "file2.txt", "blah");
25 try test_dir.deleteTree("os_test_tmp");
26 if (test_dir.openDir("os_test_tmp", .{})) |dir| {
22 var tmp = tmpDir(.{});
23 defer tmp.cleanup();
24
25 try tmp.dir.makePath("os_test_tmp" ++ fs.path.sep_str ++ "b" ++ fs.path.sep_str ++ "c");
26 try tmp.dir.writeFile("os_test_tmp" ++ fs.path.sep_str ++ "b" ++ fs.path.sep_str ++ "c" ++ fs.path.sep_str ++ "file.txt", "nonsense");
27 try tmp.dir.writeFile("os_test_tmp" ++ fs.path.sep_str ++ "b" ++ fs.path.sep_str ++ "file2.txt", "blah");
28 try tmp.dir.deleteTree("os_test_tmp");
29 if (tmp.dir.openDir("os_test_tmp", .{})) |dir| {
2730 @panic("expected error");
2831 } else |err| {
2932 expect(err == error.FileNotFound);
......@@ -33,17 +36,19 @@ test "makePath, put some files in it, deleteTree" {
3336test "access file" {
3437 if (builtin.os.tag == .wasi) return error.SkipZigTest;
3538
36 var test_dir = getTestDir();
37 try test_dir.makePath("os_test_tmp");
38 if (test_dir.access("os_test_tmp" ++ fs.path.sep_str ++ "file.txt", .{})) |ok| {
39 var tmp = tmpDir(.{});
40 defer tmp.cleanup();
41
42 try tmp.dir.makePath("os_test_tmp");
43 if (tmp.dir.access("os_test_tmp" ++ fs.path.sep_str ++ "file.txt", .{})) |ok| {
3944 @panic("expected error");
4045 } else |err| {
4146 expect(err == error.FileNotFound);
4247 }
4348
44 try test_dir.writeFile("os_test_tmp" ++ fs.path.sep_str ++ "file.txt", "");
45 try test_dir.access("os_test_tmp" ++ fs.path.sep_str ++ "file.txt", .{});
46 try test_dir.deleteTree("os_test_tmp");
49 try tmp.dir.writeFile("os_test_tmp" ++ fs.path.sep_str ++ "file.txt", "");
50 try tmp.dir.access("os_test_tmp" ++ fs.path.sep_str ++ "file.txt", .{});
51 try tmp.dir.deleteTree("os_test_tmp");
4752}
4853
4954fn testThreadIdFn(thread_id: *Thread.Id) void {
......@@ -51,11 +56,13 @@ fn testThreadIdFn(thread_id: *Thread.Id) void {
5156}
5257
5358test "sendfile" {
54 var test_dir = getTestDir();
55 try test_dir.makePath("os_test_tmp");
56 defer test_dir.deleteTree("os_test_tmp") catch {};
59 var tmp = tmpDir(.{});
60 defer tmp.cleanup();
61
62 try tmp.dir.makePath("os_test_tmp");
63 defer tmp.dir.deleteTree("os_test_tmp") catch {};
5764
58 var dir = try test_dir.openDir("os_test_tmp", .{});
65 var dir = try tmp.dir.openDir("os_test_tmp", .{});
5966 defer dir.close();
6067
6168 const line1 = "line1\n";
......@@ -119,23 +126,24 @@ test "fs.copyFile" {
119126 const dest_file = "tmp_test_copy_file2.txt";
120127 const dest_file2 = "tmp_test_copy_file3.txt";
121128
122 const test_dir = getTestDir();
129 var tmp = tmpDir(.{});
130 defer tmp.cleanup();
123131
124 try test_dir.writeFile(src_file, data);
125 defer test_dir.deleteFile(src_file) catch {};
132 try tmp.dir.writeFile(src_file, data);
133 defer tmp.dir.deleteFile(src_file) catch {};
126134
127 try test_dir.copyFile(src_file, test_dir, dest_file, .{});
128 defer test_dir.deleteFile(dest_file) catch {};
135 try tmp.dir.copyFile(src_file, tmp.dir, dest_file, .{});
136 defer tmp.dir.deleteFile(dest_file) catch {};
129137
130 try test_dir.copyFile(src_file, test_dir, dest_file2, .{ .override_mode = File.default_mode });
131 defer test_dir.deleteFile(dest_file2) catch {};
138 try tmp.dir.copyFile(src_file, tmp.dir, dest_file2, .{ .override_mode = File.default_mode });
139 defer tmp.dir.deleteFile(dest_file2) catch {};
132140
133 try expectFileContents(dest_file, data);
134 try expectFileContents(dest_file2, data);
141 try expectFileContents(tmp.dir, dest_file, data);
142 try expectFileContents(tmp.dir, dest_file2, data);
135143}
136144
137fn expectFileContents(file_path: []const u8, data: []const u8) !void {
138 const contents = try getTestDir().readFileAlloc(testing.allocator, file_path, 1000);
145fn expectFileContents(dir: Dir, file_path: []const u8, data: []const u8) !void {
146 const contents = try dir.readFileAlloc(testing.allocator, file_path, 1000);
139147 defer testing.allocator.free(contents);
140148
141149 testing.expectEqualSlices(u8, data, contents);
......@@ -199,18 +207,21 @@ test "AtomicFile" {
199207 \\ hello!
200208 \\ this is a test file
201209 ;
202 var test_dir = getTestDir();
210
211 var tmp = tmpDir(.{});
212 defer tmp.cleanup();
213
203214 {
204 var af = try test_dir.atomicFile(test_out_file, .{});
215 var af = try tmp.dir.atomicFile(test_out_file, .{});
205216 defer af.deinit();
206217 try af.file.writeAll(test_content);
207218 try af.finish();
208219 }
209 const content = try test_dir.readFileAlloc(testing.allocator, test_out_file, 9999);
220 const content = try tmp.dir.readFileAlloc(testing.allocator, test_out_file, 9999);
210221 defer testing.allocator.free(content);
211222 expect(mem.eql(u8, content, test_content));
212223
213 try test_dir.deleteFile(test_out_file);
224 try tmp.dir.deleteFile(test_out_file);
214225}
215226
216227test "thread local storage" {
......@@ -365,6 +376,9 @@ test "mmap" {
365376 if (builtin.os.tag == .windows or builtin.os.tag == .wasi)
366377 return error.SkipZigTest;
367378
379 var tmp = tmpDir(.{});
380 defer tmp.cleanup();
381
368382 // Simple mmap() call with non page-aligned size
369383 {
370384 const data = try os.mmap(
......@@ -393,7 +407,7 @@ test "mmap" {
393407
394408 // Create a file used for testing mmap() calls with a file descriptor
395409 {
396 const file = try fs.cwd().createFile(test_out_file, .{});
410 const file = try tmp.dir.createFile(test_out_file, .{});
397411 defer file.close();
398412
399413 const stream = file.outStream();
......@@ -406,7 +420,7 @@ test "mmap" {
406420
407421 // Map the whole file
408422 {
409 const file = try fs.cwd().openFile(test_out_file, .{});
423 const file = try tmp.dir.openFile(test_out_file, .{});
410424 defer file.close();
411425
412426 const data = try os.mmap(
......@@ -430,7 +444,7 @@ test "mmap" {
430444
431445 // Map the upper half of the file
432446 {
433 const file = try fs.cwd().openFile(test_out_file, .{});
447 const file = try tmp.dir.openFile(test_out_file, .{});
434448 defer file.close();
435449
436450 const data = try os.mmap(
......@@ -452,7 +466,7 @@ test "mmap" {
452466 }
453467 }
454468
455 try fs.cwd().deleteFile(test_out_file);
469 try tmp.dir.deleteFile(test_out_file);
456470}
457471
458472test "getenv" {
......@@ -467,12 +481,15 @@ test "fcntl" {
467481 if (builtin.os.tag == .windows or builtin.os.tag == .wasi)
468482 return error.SkipZigTest;
469483
484 var tmp = tmpDir(.{});
485 defer tmp.cleanup();
486
470487 const test_out_file = "os_tmp_test";
471488
472 const file = try fs.cwd().createFile(test_out_file, .{});
489 const file = try tmp.dir.createFile(test_out_file, .{});
473490 defer {
474491 file.close();
475 fs.cwd().deleteFile(test_out_file) catch {};
492 tmp.dir.deleteFile(test_out_file) catch {};
476493 }
477494
478495 // Note: The test assumes createFile opens the file with O_CLOEXEC
lib/std/testing.zig+17-16
......@@ -14,21 +14,6 @@ pub var failing_allocator_instance = FailingAllocator.init(&base_allocator_insta
1414pub var base_allocator_instance = std.heap.ThreadSafeFixedBufferAllocator.init(allocator_mem[0..]);
1515var allocator_mem: [2 * 1024 * 1024]u8 = undefined;
1616
17/// This function is intended to be used only in tests. It should be used in any testcase
18/// where we intend to test WASI and should be used a replacement for `std.fs.cwd()` in WASI.
19pub fn getTestDir() std.fs.Dir {
20 if (@import("builtin").os.tag == .wasi) {
21 var preopens = std.fs.wasi.PreopenList.init(allocator);
22 defer preopens.deinit();
23 preopens.populate() catch unreachable;
24
25 const preopen = preopens.find(".") orelse unreachable;
26 return std.fs.Dir{ .fd = preopen.fd };
27 } else {
28 return std.fs.cwd();
29 }
30}
31
3217/// This function is intended to be used only in tests. It prints diagnostics to stderr
3318/// and then aborts when actual_error_union is not expected_error.
3419pub fn expectError(expected_error: anyerror, actual_error_union: var) void {
......@@ -224,6 +209,21 @@ pub const TmpDir = struct {
224209 }
225210};
226211
212fn getCwdOrWasiPreopen() std.fs.Dir {
213 if (@import("builtin").os.tag == .wasi) {
214 var preopens = std.fs.wasi.PreopenList.init(allocator);
215 defer preopens.deinit();
216 preopens.populate() catch
217 @panic("unable to make tmp dir for testing: unable to populate preopens");
218 const preopen = preopens.find(".") orelse
219 @panic("unable to make tmp dir for testing: didn't find '.' in the preopens");
220
221 return std.fs.Dir{ .fd = preopen.fd };
222 } else {
223 return std.fs.cwd();
224 }
225}
226
227227pub fn tmpDir(opts: std.fs.Dir.OpenDirOptions) TmpDir {
228228 var random_bytes: [TmpDir.random_bytes_count]u8 = undefined;
229229 std.crypto.randomBytes(&random_bytes) catch
......@@ -231,7 +231,8 @@ pub fn tmpDir(opts: std.fs.Dir.OpenDirOptions) TmpDir {
231231 var sub_path: [TmpDir.sub_path_len]u8 = undefined;
232232 std.fs.base64_encoder.encode(&sub_path, &random_bytes);
233233
234 var cache_dir = std.fs.cwd().makeOpenPath("zig-cache", .{}) catch
234 var cwd = getCwdOrWasiPreopen();
235 var cache_dir = cwd.makeOpenPath("zig-cache", .{}) catch
235236 @panic("unable to make tmp dir for testing: unable to make and open zig-cache dir");
236237 defer cache_dir.close();
237238 var parent_dir = cache_dir.makeOpenPath("tmp", .{}) catch