LineReader#readLine() should never return null, fixes #265

jline · May 13, 2018 · 69471c7 · 69471c7
1 parent c5f68dd
commit 69471c7
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 15 deletions.
diff --git a/reader/src/main/java/org/jline/reader/impl/LineReaderImpl.java b/reader/src/main/java/org/jline/reader/impl/LineReaderImpl.java
@@ -521,7 +521,7 @@ public String readLine(String prompt, String rightPrompt, MaskingCallback maskin
                 }
                 Binding o = readBinding(getKeys(), local);
                 if (o == null) {
-                    return null;
+                    throw new EndOfFileException();
                 }
                 Log.trace("Binding: ", o);
                 if (buf.length() == 0 && getLastBinding().charAt(0) == originalAttributes.getControlChar(ControlChar.VEOF)) {

diff --git a/reader/src/test/java/org/jline/reader/impl/HistorySearchTest.java b/reader/src/test/java/org/jline/reader/impl/HistorySearchTest.java
@@ -2,6 +2,7 @@
 
 import java.io.ByteArrayInputStream;
 
+import org.jline.reader.EndOfFileException;
 import org.jline.reader.LineReader;
 import org.jline.reader.impl.history.DefaultHistory;
 import org.junit.Test;
@@ -10,6 +11,7 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
 
 public class HistorySearchTest extends ReaderTestSupport {
 
@@ -103,10 +105,13 @@ public void testSearchHistoryWithNoMatches() throws Exception {
     public void testAbortingSearchRetainsCurrentBufferAndPrintsDetails() throws Exception {
         DefaultHistory history = setupHistory();
 
-        String readLineResult;
         in.setIn(new ByteArrayInputStream(translate("f^Rf^G").getBytes()));
-        readLineResult = reader.readLine();
-        assertEquals(null, readLineResult);
+        try {
+            reader.readLine();
+            fail("Expected an EndOfFileException to be thrown");
+        } catch (EndOfFileException e) {
+            // expected
+        }
         assertEquals("f", reader.getBuffer().toString());
         assertEquals(3, history.size());
     }
@@ -121,8 +126,12 @@ public void testAbortingAfterSearchingPreviousLinesGivesBlank() throws Exception
         assertEquals("f", readLineResult);
         assertEquals(4, history.size());
 
-        readLineResult = reader.readLine();
-        assertEquals(null, readLineResult);
+        try {
+            reader.readLine();
+            fail("Expected an EndOfFileException to be thrown");
+        } catch (EndOfFileException e) {
+            // expected
+        }
         assertEquals("", reader.getBuffer().toString());
         assertEquals(4, history.size());
     }
@@ -132,9 +141,12 @@ public void testSearchOnEmptyHistory() throws Exception {
         DefaultHistory history = setupHistory();
         history.purge();
 
-        String readLineResult;
         in.setIn(new ByteArrayInputStream(translate("^Sa").getBytes()));
-        readLineResult = reader.readLine();
-        assertEquals(null, readLineResult);
+        try {
+            reader.readLine();
+            fail("Expected an EndOfFileException to be thrown");
+        } catch (EndOfFileException e) {
+            // expected
+        }
     }
 }
diff --git a/reader/src/test/java/org/jline/reader/impl/ReaderTestSupport.java b/reader/src/test/java/org/jline/reader/impl/ReaderTestSupport.java
@@ -21,6 +21,7 @@
 
 import org.jline.keymap.KeyMap;
 import org.jline.reader.Candidate;
+import org.jline.reader.EndOfFileException;
 import org.jline.terminal.Size;
 import org.jline.terminal.Terminal;
 import org.jline.terminal.impl.DumbTerminal;
@@ -103,9 +104,16 @@ protected void assertBuffer(final String expected, final TestBuffer buffer, fina
         //String line;
         //while ((line = reader.readLine((String) null)) != null) {
             //System.err.println("Read line: " + line);
-        while ((reader.readLine(null, null, mask, null)) != null) {
+        try {
+            while (true) {
+                reader.readLine(null, null, mask, null);
+            }
+        } catch (EndOfFileException e) {
             // noop
         }
+//        while ((reader.readLine(null, null, mask, null)) != null) {
+            // noop
+//        }
 
         assertEquals(expected, reader.getBuffer().toString());
     }
@@ -137,13 +145,16 @@ protected void assertLine(final String expected, final TestBuffer buffer,
 
         in.setIn(new ByteArrayInputStream(buffer.getBytes()));
 
-        String line;
-        String prevLine = null;
-        while ((line = reader.readLine(null, null, mask, null)) != null) {
-            prevLine = line;
+        String line = null;
+        try {
+            while (true) {
+                line = reader.readLine(null, null, mask, null);
+            }
+        } catch (EndOfFileException e) {
+            // ignore
         }
 
-        assertEquals(expected, prevLine);
+        assertEquals(expected, line);
     }
 
     private String getKeyForAction(final String key) {