JERSEY-2837: For empty stream, it should return -1 when read

Author: Nat Luengnaruemitchai

core-common/src/main/java/org/glassfish/jersey/internal/util/collection/ByteBufferInputStream.java

@@ -303,7 +303,7 @@ private int tryRead(final byte[] b, final int off, final int len, boolean block)
             }
         }
 
-        return i;
+        return i == 0 && eof ? -1 : i;
     }
 
     private int tryRead(boolean block) throws IOException {

core-common/src/test/java/org/glassfish/jersey/internal/util/collection/ByteBufferInputStreamTest.java

@@ -41,9 +41,12 @@
 
 import java.io.IOException;
 import java.nio.ByteBuffer;
+import java.util.Random;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
+import java.util.concurrent.Semaphore;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicBoolean;
 
 import org.glassfish.jersey.internal.LocalizationMessages;
 
@@ -52,6 +55,7 @@
 import static org.junit.Assert.assertNotEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 
 /**
@@ -61,6 +65,112 @@
  */
 public class ByteBufferInputStreamTest {
 
+    @Test
+    public void testBlockingReadAByteEmptyStream() throws Exception {
+        final ByteBufferInputStream bbis = new ByteBufferInputStream();
+        bbis.closeQueue();
+        assertEquals(-1, bbis.read());
+    }
+
+    @Test
+    public void testNonBlockingReadAByteEmptyStream() throws Exception {
+        final ByteBufferInputStream bbis = new ByteBufferInputStream();
+        bbis.closeQueue();
+        assertEquals(-1, bbis.tryRead());
+    }
+
+    @Test
+    public void testBlockingReadByteArrayEmptyStream() throws Exception {
+        final ByteBufferInputStream bbis = new ByteBufferInputStream();
+        bbis.closeQueue();
+        byte[] buf = new byte[1024];
+        assertEquals(-1, bbis.read(buf));
+    }
+
+    @Test
+    public void testNonBlockingReadByteArrayEmptyStream() throws Exception {
+        final ByteBufferInputStream bbis = new ByteBufferInputStream();
+        bbis.closeQueue();
+        byte[] buf = new byte[1024];
+        assertEquals(-1, bbis.tryRead(buf));
+    }
+
+    @Test
+    public void testBlockingReadByteArrayFromFinishedExactLengthStream() throws Exception {
+        final ByteBufferInputStream bbis = new ByteBufferInputStream();
+        byte[] sourceData = new byte[1024];
+        new Random().nextBytes(sourceData);
+        ByteBuffer byteBuf = ByteBuffer.wrap(sourceData);
+        bbis.put(byteBuf);
+        bbis.closeQueue();
+        byte[] buf = new byte[1024];
+        assertEquals(1024, bbis.read(buf));
+        // no more data to read; so it should return -1
+        assertEquals(-1, bbis.read(buf));
+    }
+
+    @Test
+    public void testNonBlockingReadByteArrayFromFinishedExactLengthStream() throws Exception {
+        final ByteBufferInputStream bbis = new ByteBufferInputStream();
+        byte[] sourceData = new byte[1024];
+        new Random().nextBytes(sourceData);
+        ByteBuffer byteBuf = ByteBuffer.wrap(sourceData);
+        bbis.put(byteBuf);
+        byte[] buf = new byte[1024];
+        assertEquals(1024, bbis.tryRead(buf));
+        // the queue has not been close; so it should return 0
+        assertEquals(0, bbis.tryRead(buf));
+        bbis.closeQueue();
+    }
+
+    @Test
+    public void testBlockingReadByteArrayFromUnfinishedExactLengthStream() throws Exception {
+        final ByteBufferInputStream bbis = new ByteBufferInputStream();
+        byte[] sourceData = new byte[1024];
+        new Random().nextBytes(sourceData);
+        ByteBuffer byteBuf = ByteBuffer.wrap(sourceData);
+        bbis.put(byteBuf);
+        final byte[] buf = new byte[1024];
+        assertEquals(1024, bbis.read(buf));
+        final AtomicBoolean closed = new AtomicBoolean(false);
+        final Semaphore s = new Semaphore(1);
+        s.acquire();
+        Thread t = new Thread(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    // it should return -1 since there is no more data
+                    assertEquals(-1, bbis.read(buf));
+                    // it should only reach here if the stream has been closed
+                    assertTrue(closed.get());
+                } catch (IOException e) {
+                    e.printStackTrace();
+                } finally {
+                    s.release();
+                }
+            }
+        });
+        t.start();
+        Thread.sleep(500);
+        closed.set(true);
+        bbis.closeQueue();
+        // wait until the job is done
+        s.acquire();
+    }
+
+    @Test
+    public void testNonBlockingReadByteArrayFromUnfinishedExactLengthStream() throws Exception {
+        final ByteBufferInputStream bbis = new ByteBufferInputStream();
+        byte[] sourceData = new byte[1024];
+        new Random().nextBytes(sourceData);
+        ByteBuffer byteBuf = ByteBuffer.wrap(sourceData);
+        bbis.put(byteBuf);
+        bbis.closeQueue();
+        byte[] buf = new byte[1024];
+        assertEquals(1024, bbis.tryRead(buf));
+        assertEquals(-1, bbis.tryRead(buf));
+    }
+
     /**
      * Test for non blocking single-byte read of the stream.
      *