From d9ed3d186dc09cab05b841b924664fc886077275 Mon Sep 17 00:00:00 2001
From: Wink Saville <wink@saville.com>
Date: Fri, 14 Sep 2018 14:14:58 -0700
Subject: [PATCH] Add test for Queue.dump

To make dump testable added dumpToSteam which takes a stream as input
and added the stream as a paraemter to dumpRecursive.

Added test "std.atomic.Queue dump"

And to make the test more robust SliceOutStream.pos is now public. This
allows the user of SliceOutStream to know the length of the data captured.
---
 std/atomic/queue.zig | 93 +++++++++++++++++++++++++++++++++++++-------
 std/io.zig           |  2 +-
 2 files changed, 80 insertions(+), 15 deletions(-)

diff --git a/std/atomic/queue.zig b/std/atomic/queue.zig
index eea77d55342d5d9e6378624fb7bbc41e2a1a9a47..2aa1d3193454dd7af2aa3d1e09e557c1f4c08d21 100644
--- a/std/atomic/queue.zig
+++ b/std/atomic/queue.zig
@@ -103,24 +103,29 @@ pub fn Queue(comptime T: type) type {
         }
 
         pub fn dump(self: *Self) void {
-            const held = self.mutex.acquire();
-            defer held.release();
-
-            std.debug.warn("head: ");
-            dumpRecursive(self.head, 0);
-            std.debug.warn("tail: ");
-            dumpRecursive(self.tail, 0);
-        }
-
-        fn dumpRecursive(optional_node: ?*Node, indent: usize) void {
             var stderr_file = std.io.getStdErr() catch return;
             const stderr = &std.io.FileOutStream.init(stderr_file).stream;
-            stderr.writeByteNTimes(' ', indent) catch return;
+
+            self.dumpToStream(stderr) catch return;
+        }
+
+        pub fn dumpToStream(self: *Self, stream: var) !void {
+            const held = self.mutex.acquire();
+            defer held.release();
+
+            try stream.print("head: ");
+            try dumpRecursive(stream, self.head, 0);
+            try stream.print("tail: ");
+            try dumpRecursive(stream, self.tail, 0);
+        }
+
+        fn dumpRecursive(stream: var, optional_node: ?*Node, indent: usize) error!void {
+            try stream.writeByteNTimes(' ', indent);
             if (optional_node) |node| {
-                std.debug.warn("0x{x}={}\n", @ptrToInt(node), node.data);
-                dumpRecursive(node.next, indent + 1);
+                try stream.print("0x{x}={}\n", @ptrToInt(node), node.data);
+                try dumpRecursive(stream, node.next, indent + 1);
             } else {
-                std.debug.warn("(null)\n");
+                try stream.print("(null)\n");
             }
         }
     };
@@ -274,3 +279,63 @@ test "std.atomic.Queue single-threaded" {
 
     assert(queue.get() == null);
 }
+
+test "std.atomic.Queue dump" {
+    const mem = std.mem;
+    const SliceOutStream = std.io.SliceOutStream;
+    var buffer: [1024]u8 = undefined;
+    var expected_buffer: [1024]u8 = undefined;
+    var sos = SliceOutStream.init(buffer[0..]);
+
+    var queue = Queue(i32).init();
+
+    // Test empty stream
+    sos.reset();
+    try queue.dumpToStream(&sos.stream);
+    assert(mem.eql(u8, buffer[0..sos.pos],
+        \\head: (null)
+        \\tail: (null)
+        \\
+        ));
+
+    // Test a stream with one element
+    var node_0 = Queue(i32).Node {
+        .data = 1,
+        .next = undefined,
+        .prev = undefined,
+    };
+    queue.put(&node_0);
+
+    sos.reset();
+    try queue.dumpToStream(&sos.stream);
+
+    var expected = try std.fmt.bufPrint(expected_buffer[0..],
+        \\head: 0x{x}=1
+        \\ (null)
+        \\tail: 0x{x}=1
+        \\ (null)
+        \\
+        , @ptrToInt(queue.head), @ptrToInt(queue.tail));
+    assert(mem.eql(u8, buffer[0..sos.pos], expected));
+
+    // Test a stream with two elements
+    var node_1 = Queue(i32).Node {
+        .data = 2,
+        .next = undefined,
+        .prev = undefined,
+    };
+    queue.put(&node_1);
+
+    sos.reset();
+    try queue.dumpToStream(&sos.stream);
+
+    expected = try std.fmt.bufPrint(expected_buffer[0..],
+        \\head: 0x{x}=1
+        \\ 0x{x}=2
+        \\  (null)
+        \\tail: 0x{x}=2
+        \\ (null)
+        \\
+        , @ptrToInt(queue.head), @ptrToInt(queue.head.?.next), @ptrToInt(queue.tail));
+    assert(mem.eql(u8, buffer[0..sos.pos], expected));
+}
diff --git a/std/io.zig b/std/io.zig
index c10fdcbbe24d5131ff230a5fb332d4f4c16c63d0..ae514c4b01d7c71d7220397cdd257d670a3f0f36 100644
--- a/std/io.zig
+++ b/std/io.zig
@@ -461,7 +461,7 @@ pub const SliceOutStream = struct {
 
     pub stream: Stream,
 
-    pos: usize,
+    pub pos: usize,
     slice: []u8,
 
     pub fn init(slice: []u8) SliceOutStream {
-- 
2.54.0