starter testsuite for std.tar

Author: ignask

lib/std/tar.zig

@@ -196,3 +196,7 @@ test stripComponents {
 
 const std = @import("std.zig");
 const assert = std.debug.assert;
+
+test {
+    _ = @import("tar/test.zig");
+}

lib/std/tar/test.zig

@@ -0,0 +1,80 @@
+const std = @import("../std.zig");
+
+const readTestScenario = struct {
+    data: []const u8,
+    expect: std.StringHashMap(metadata),
+};
+
+const metadata = struct {
+    md5: []const u8,
+    mode: usize,
+    size: u64,
+    mtime: i128,
+};
+
+test "gnu tar" {
+    var expect = std.StringHashMap(metadata).init(std.testing.allocator);
+    defer expect.deinit();
+    try expect.put("small.txt", metadata{
+        .md5 = "e38b27eaccb4391bdec553a7f3ae6b2f",
+        .mode = 0o640,
+        .size = 5,
+        .mtime = 1244428340 * std.time.ns_per_s,
+    });
+    try expect.put("small2.txt", metadata{
+        .md5 = "c65bd2e50a56a2138bf1716f2fd56fe9",
+        .mode = 0o640,
+        .size = 11,
+        .mtime = 1244436044 * std.time.ns_per_s,
+    });
+
+    readTest(.{
+        .data = @embedFile("testdata/gnu.tar"),
+        .expect = expect,
+    }) catch {
+        return error.SkipZigTest;
+    };
+}
+
+fn readTest(scenario: readTestScenario) !void {
+    var file_stream = std.io.fixedBufferStream(scenario.data);
+
+    var tmp = std.testing.tmpIterableDir(.{});
+    defer tmp.cleanup();
+
+    try std.tar.pipeToFileSystem(
+        tmp.iterable_dir.dir,
+        file_stream.reader(),
+        .{ .mode_mode = .ignore },
+    );
+
+    var iter = tmp.iterable_dir.iterate();
+
+    var elements: u8 = 0;
+    while (try iter.next()) |entry| {
+        var expectFile = scenario.expect.get(entry.name) orelse return error.TestFailure;
+        var f = try tmp.iterable_dir.dir.openFile(
+            entry.name,
+            .{ .mode = .read_only },
+        );
+        defer f.close();
+
+        const content = try f.readToEndAlloc(std.testing.allocator, std.math.maxInt(u32));
+        defer std.testing.allocator.free(content);
+
+        var md5Hash: [std.crypto.hash.Md5.digest_length]u8 = undefined;
+        std.crypto.hash.Md5.hash(content, &md5Hash, .{});
+        var b: [2 * std.crypto.hash.Md5.digest_length]u8 = undefined;
+        _ = try std.fmt.bufPrint(&b, "{s}", .{std.fmt.fmtSliceHexLower(&md5Hash)});
+        try std.testing.expectEqualStrings(expectFile.md5, &b);
+        elements += 1;
+
+        var stat = try f.stat();
+        try std.testing.expectEqual(expectFile.size, stat.size);
+        // TODO: fix possibly broken behavior.
+        try std.testing.expectEqual(expectFile.mtime, stat.mtime);
+        try std.testing.expectEqual(expectFile.mode, stat.mode);
+    }
+
+    try std.testing.expectEqual(scenario.expect.count(), elements);
+}

lib/std/tar/testdata/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2009 The Go Authors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+   * Neither the name of Google Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.