Improve the unit tests of terminal io.

Author: Aleksi Salmela

src/main/java/fi/helsinki/cs/tmc/cli/io/TerminalIo.java

@@ -3,6 +3,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.io.Console;
 import java.util.Scanner;
 
 public class TerminalIo extends Io {
@@ -16,55 +17,44 @@ public void print(String str) {
 
     @Override
     public String readLine(String prompt) {
-        System.out.print(prompt);
+        print(prompt);
 
         try (Scanner scanner = new Scanner(System.in)) {
             return scanner.nextLine();
         }
     }
 
-    @Override
-    public boolean readConfirmation(String prompt, boolean defaultToYes) {
-        String yesNo;
-        String input;
-        if (defaultToYes) {
-            yesNo = " [Y/n] ";
-        } else {
-            yesNo = " [y/N] ";
-        }
-        System.out.print(prompt + yesNo);
-        try (Scanner scanner = new Scanner(System.in)) {
-            input = scanner.nextLine().toLowerCase();
-        }
-        if (input.isEmpty()) {
-            return defaultToYes;
-        } else if (input.charAt(0) == 'y') {
-            return true;
-        } else if (input.charAt(0) == 'n') {
-            return false;
-        }
-        return defaultToYes;
-    }
-
     @Override
     public String readPassword(String prompt) {
-        if (System.console() != null) {
-            char[] pwd;
+        Console console = System.console();
+        if (console != null) {
             try {
-                pwd = System.console().readPassword(prompt);
+                return new String(console.readPassword(prompt));
             } catch (Exception e) {
                 logger.warn("Password could not be read.", e);
-                return null;
             }
-            return new String(pwd);
+        } else {
+           logger.warn("Failed to read password due to System.console()");
         }
-
-        // Read the password in cleartext if no console is present (might happen
-        // in some IDEs?)
-        logger.warn("Failed to read password");
-        println("System.console is not present, unable to read password "
-                + "securely. Reading password in cleartext.");
+        println("Unable to read password securely. Reading password in cleartext.");
+        println("Press Ctrl+C to abort");
         return readLine(prompt);
     }
 
+    @Override
+    public boolean readConfirmation(String prompt, boolean defaultToYes) {
+        String yesNo = (defaultToYes) ? " [Y/n] " : " [y/N] ";
+        String input = readLine(prompt + yesNo).toLowerCase();
+
+        switch (input) {
+            case "y": //fall through
+            case "yes":
+                return true;
+            case "n": //fall through
+            case "no":
+                return false;
+            default:
+                return defaultToYes;
+        }
+    }
 }

src/test/java/fi/helsinki/cs/tmc/cli/io/TerminalIoTest.java

@@ -1,25 +1,56 @@
 package fi.helsinki.cs.tmc.cli.io;
 
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
+import static org.junit.matchers.JUnitMatchers.containsString;
+import static org.mockito.Matchers.anyString;
+import static org.powermock.api.mockito.PowerMockito.mock;
+import static org.powermock.api.mockito.PowerMockito.spy;
+import static org.powermock.api.mockito.PowerMockito.when;
 
+import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.powermock.core.classloader.annotations.PrepareForTest;
+import org.powermock.modules.junit4.PowerMockRunner;
 
+import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
+import java.io.Console;
+import java.io.InputStream;
 import java.io.OutputStream;
 import java.io.PrintStream;
+import java.nio.charset.StandardCharsets;
 
+@RunWith(PowerMockRunner.class)
+@PrepareForTest({TerminalIo.class, Console.class, System.class})
 public class TerminalIoTest {
 
     Io io;
     OutputStream os;
+    InputStream oldInputStream;
 
     @Before
-    public void setUp() {
+    public void setUp() throws Exception {
+        oldInputStream = System.in;
         io = new TerminalIo();
         os = new ByteArrayOutputStream();
         PrintStream ps = new PrintStream(os);
         System.setOut(ps);
+
+        spy(System.class);
+    }
+
+    @After
+    public void cleanUp() {
+        System.setIn(oldInputStream);
+    }
+
+    public void writeString(String string) {
+        byte[] bytes = string.getBytes(StandardCharsets.UTF_8);
+        System.setIn(new ByteArrayInputStream(bytes));
     }
 
     @Test
@@ -45,4 +76,114 @@ public void printInteger() {
         io.print(5);
         assertTrue(os.toString().equals("5"));
     }
+
+    @Test
+    public void readLine() {
+        writeString("test");
+        assertEquals("test", io.readLine("abc "));
+        assertEquals("abc ", os.toString());
+    }
+
+    @Test
+    public void readLineIgnoresRestOfTheLines() {
+        writeString("test\nawugwufgv");
+        assertEquals("test", io.readLine("abc "));
+        assertEquals("abc ", os.toString());
+    }
+
+    @Test
+    public void readPassword() {
+        Console mockConsole = mock(Console.class);
+        when(mockConsole.readPassword(anyString())).thenReturn("password".toCharArray());
+        when(System.console()).thenReturn(mockConsole);
+        assertEquals("password", io.readPassword("abc "));
+    }
+
+    @Test
+    public void failToReadPasswordBecauseException() {
+        Console mockConsole = mock(Console.class);
+        when(mockConsole.readPassword(anyString())).thenThrow(new RuntimeException());
+        writeString("password");
+        when(System.console()).thenReturn(mockConsole);
+        assertEquals("password", io.readPassword("abc "));
+        assertThat(os.toString(),
+                containsString("Unable to read password"));
+    }
+
+    @Test
+    public void failToReadPasswordBecauseConsoleIsNull() {
+        when(System.console()).thenReturn(null);
+        writeString("password");
+        assertEquals("password", io.readPassword("abc "));
+        assertThat(os.toString(),
+                containsString("Unable to read password"));
+    }
+
+    @Test
+    public void printConfimationDialogWhenDefaultIsYes() {
+        writeString("\n");
+        io.readConfirmation("abc", true);
+        assertEquals("abc [Y/n] ", os.toString());
+    }
+
+    @Test
+    public void printConfimationDialogWhenDefaultIsNo() {
+        writeString("\n");
+        io.readConfirmation("abc", false);
+        assertEquals("abc [y/N] ", os.toString());
+    }
+
+    @Test
+    public void readUppercaseConfirmation() {
+        writeString("YES");
+        assertEquals(true, io.readConfirmation("abc ", false));
+    }
+
+    @Test
+    public void readYesConfirmation() {
+        writeString("yes");
+        assertEquals(true, io.readConfirmation("abc ", false));
+    }
+
+    @Test
+    public void readYConfirmation() {
+        writeString("y");
+        assertEquals(true, io.readConfirmation("abc ", false));
+    }
+
+    @Test
+    public void readNoConfirmation() {
+        writeString("no");
+        assertEquals(false, io.readConfirmation("abc ", true));
+    }
+
+    @Test
+    public void readNConfirmation() {
+        writeString("n");
+        assertEquals(false, io.readConfirmation("abc ", true));
+    }
+
+    @Test
+    public void readUnknownConfirmationAsDefaultYes() {
+        writeString("def");
+        assertEquals(true, io.readConfirmation("abc ", true));
+    }
+
+    @Test
+    public void readUnknownConfirmationAsDefaultNo() {
+        writeString("def");
+        assertEquals(false, io.readConfirmation("abc ", false));
+    }
+
+    @Test
+    public void readEmptyConfirmationAsDefaultYes() {
+        writeString("\n");
+        assertEquals(true, io.readConfirmation("abc ", true));
+    }
+
+    @Test
+    public void readEmptyConfirmationAsDefaultNo() {
+        writeString("\n");
+        assertEquals(false, io.readConfirmation("abc ", false));
+    }
 }