Skip to content

Commit 5a8df41

Browse files
lahodajlahodaj
committedMay 13, 2024
8331535: Incorrect prompt for Console.readLine
8331681: Test that jdk.internal.io.JdkConsole does not interpret prompts Reviewed-by: naoto, asotona
1 parent 3e3f7cf commit 5a8df41

File tree

6 files changed

+296
-5
lines changed

6 files changed

+296
-5
lines changed
 

‎src/jdk.internal.le/share/classes/jdk/internal/org/jline/JdkConsoleProviderImpl.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ public JdkConsole printf(String format, Object ... args) {
9898
public String readLine(String fmt, Object ... args) {
9999
try {
100100
initJLineIfNeeded();
101-
return jline.readLine(fmt.formatted(args));
101+
return jline.readLine(fmt.formatted(args).replace("%", "%%"));
102102
} catch (EndOfFileException eofe) {
103103
return null;
104104
}
@@ -113,7 +113,8 @@ public String readLine() {
113113
public char[] readPassword(String fmt, Object ... args) {
114114
try {
115115
initJLineIfNeeded();
116-
return jline.readLine(fmt.formatted(args), '\0').toCharArray();
116+
return jline.readLine(fmt.formatted(args).replace("%", "%%"), '\0')
117+
.toCharArray();
117118
} catch (EndOfFileException eofe) {
118119
return null;
119120
} finally {

‎src/jdk.jshell/share/classes/jdk/internal/jshell/tool/ConsoleIOContext.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -1007,7 +1007,7 @@ private synchronized String doReadUserLine(String prompt, Character mask) throws
10071007
input.setState(State.WAIT);
10081008
Display.DISABLE_CR = true;
10091009
in.setHistory(userInputHistory);
1010-
return in.readLine(prompt, mask);
1010+
return in.readLine(prompt.replace("%", "%%"), mask);
10111011
} catch (UserInterruptException ex) {
10121012
throw new InterruptedIOException();
10131013
} finally {

‎test/jdk/java/io/Console/ConsolePromptTest.java

+104
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
/*
2+
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation.
8+
*
9+
* This code is distributed in the hope that it will be useful, but WITHOUT
10+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12+
* version 2 for more details (a copy is included in the LICENSE file that
13+
* accompanied this code).
14+
*
15+
* You should have received a copy of the GNU General Public License version
16+
* 2 along with this work; if not, write to the Free Software Foundation,
17+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18+
*
19+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20+
* or visit www.oracle.com if you need additional information or have any
21+
* questions.
22+
*/
23+
24+
/**
25+
* @test
26+
* @bug 8331681
27+
* @summary Verify the java.base's console provider handles the prompt correctly.
28+
* @library /test/lib
29+
* @run main/othervm --limit-modules java.base ConsolePromptTest
30+
* @run main/othervm -Djdk.console=java.base ConsolePromptTest
31+
*/
32+
33+
import java.lang.reflect.Method;
34+
import java.util.Objects;
35+
36+
import jdk.test.lib.process.OutputAnalyzer;
37+
import jdk.test.lib.process.ProcessTools;
38+
39+
public class ConsolePromptTest {
40+
41+
public static void main(String... args) throws Throwable {
42+
for (Method m : ConsolePromptTest.class.getDeclaredMethods()) {
43+
if (m.getName().startsWith("test")) {
44+
m.invoke(new ConsolePromptTest());
45+
}
46+
}
47+
}
48+
49+
void testCorrectOutputReadLine() throws Exception {
50+
doRunConsoleTest("testCorrectOutputReadLine", "inp", "%s");
51+
}
52+
53+
void testCorrectOutputReadPassword() throws Exception {
54+
doRunConsoleTest("testCorrectOutputReadPassword", "inp", "%s");
55+
}
56+
57+
void doRunConsoleTest(String testName,
58+
String input,
59+
String expectedOut) throws Exception {
60+
ProcessBuilder builder =
61+
ProcessTools.createTestJavaProcessBuilder(ConsoleTest.class.getName(),
62+
testName);
63+
OutputAnalyzer output = ProcessTools.executeProcess(builder, input);
64+
65+
output.waitFor();
66+
67+
if (output.getExitValue() != 0) {
68+
throw new AssertionError("Unexpected return value: " + output.getExitValue() +
69+
", actualOut: " + output.getStdout() +
70+
", actualErr: " + output.getStderr());
71+
}
72+
73+
String actualOut = output.getStdout();
74+
75+
if (!Objects.equals(expectedOut, actualOut)) {
76+
throw new AssertionError("Unexpected stdout content. " +
77+
"Expected: '" + expectedOut + "'" +
78+
", got: '" + actualOut + "'");
79+
}
80+
81+
String expectedErr = "";
82+
String actualErr = output.getStderr();
83+
84+
if (!Objects.equals(expectedErr, actualErr)) {
85+
throw new AssertionError("Unexpected stderr content. " +
86+
"Expected: '" + expectedErr + "'" +
87+
", got: '" + actualErr + "'");
88+
}
89+
}
90+
91+
public static class ConsoleTest {
92+
public static void main(String... args) {
93+
switch (args[0]) {
94+
case "testCorrectOutputReadLine" ->
95+
System.console().readLine("%%s");
96+
case "testCorrectOutputReadPassword" ->
97+
System.console().readPassword("%%s");
98+
default -> throw new UnsupportedOperationException(args[0]);
99+
}
100+
101+
System.exit(0);
102+
}
103+
}
104+
}

‎test/jdk/jdk/internal/jline/JLineConsoleProviderTest.java

+104
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
/*
2+
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation.
8+
*
9+
* This code is distributed in the hope that it will be useful, but WITHOUT
10+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12+
* version 2 for more details (a copy is included in the LICENSE file that
13+
* accompanied this code).
14+
*
15+
* You should have received a copy of the GNU General Public License version
16+
* 2 along with this work; if not, write to the Free Software Foundation,
17+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18+
*
19+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20+
* or visit www.oracle.com if you need additional information or have any
21+
* questions.
22+
*/
23+
24+
/**
25+
* @test
26+
* @bug 8331535
27+
* @summary Verify the jdk.internal.le's console provider works properly.
28+
* @modules jdk.internal.le
29+
* @library /test/lib
30+
* @run main/othervm -Djdk.console=jdk.internal.le JLineConsoleProviderTest
31+
*/
32+
33+
import java.lang.reflect.Method;
34+
import java.util.Objects;
35+
36+
import jdk.test.lib.process.OutputAnalyzer;
37+
import jdk.test.lib.process.ProcessTools;
38+
39+
public class JLineConsoleProviderTest {
40+
41+
public static void main(String... args) throws Throwable {
42+
for (Method m : JLineConsoleProviderTest.class.getDeclaredMethods()) {
43+
if (m.getName().startsWith("test")) {
44+
m.invoke(new JLineConsoleProviderTest());
45+
}
46+
}
47+
}
48+
49+
void testCorrectOutputReadLine() throws Exception {
50+
doRunConsoleTest("testCorrectOutputReadLine", "inp", "%s");
51+
}
52+
53+
void testCorrectOutputReadPassword() throws Exception {
54+
doRunConsoleTest("testCorrectOutputReadPassword", "inp", "%s");
55+
}
56+
57+
void doRunConsoleTest(String testName,
58+
String input,
59+
String expectedOut) throws Exception {
60+
ProcessBuilder builder =
61+
ProcessTools.createTestJavaProcessBuilder(ConsoleTest.class.getName(),
62+
testName);
63+
OutputAnalyzer output = ProcessTools.executeProcess(builder, input);
64+
65+
output.waitFor();
66+
67+
if (output.getExitValue() != 0) {
68+
throw new AssertionError("Unexpected return value: " + output.getExitValue() +
69+
", actualOut: " + output.getStdout() +
70+
", actualErr: " + output.getStderr());
71+
}
72+
73+
String actualOut = output.getStdout();
74+
75+
if (!Objects.equals(expectedOut, actualOut)) {
76+
throw new AssertionError("Unexpected stdout content. " +
77+
"Expected: '" + expectedOut + "'" +
78+
", got: '" + actualOut + "'");
79+
}
80+
81+
String expectedErr = "";
82+
String actualErr = output.getStderr();
83+
84+
if (!Objects.equals(expectedErr, actualErr)) {
85+
throw new AssertionError("Unexpected stderr content. " +
86+
"Expected: '" + expectedErr + "'" +
87+
", got: '" + actualErr + "'");
88+
}
89+
}
90+
91+
public static class ConsoleTest {
92+
public static void main(String... args) {
93+
switch (args[0]) {
94+
case "testCorrectOutputReadLine" ->
95+
System.console().readLine("%%s");
96+
case "testCorrectOutputReadPassword" ->
97+
System.console().readPassword("%%s");
98+
default -> throw new UnsupportedOperationException(args[0]);
99+
}
100+
101+
System.exit(0);
102+
}
103+
}
104+
}

‎test/langtools/jdk/jshell/ConsoleToolTest.java

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
/*
2+
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation.
8+
*
9+
* This code is distributed in the hope that it will be useful, but WITHOUT
10+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12+
* version 2 for more details (a copy is included in the LICENSE file that
13+
* accompanied this code).
14+
*
15+
* You should have received a copy of the GNU General Public License version
16+
* 2 along with this work; if not, write to the Free Software Foundation,
17+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18+
*
19+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20+
* or visit www.oracle.com if you need additional information or have any
21+
* questions.
22+
*/
23+
24+
/*
25+
* @test
26+
* @bug 8331535
27+
* @summary Test the JShell tool Console handling
28+
* @modules jdk.internal.le/jdk.internal.org.jline.reader
29+
* jdk.jshell/jdk.internal.jshell.tool:+open
30+
* @build ConsoleToolTest ReplToolTesting
31+
* @run testng ConsoleToolTest
32+
*/
33+
34+
35+
import org.testng.annotations.Test;
36+
37+
public class ConsoleToolTest extends ReplToolTesting {
38+
39+
@Test
40+
public void testOutput() {
41+
test(
42+
a -> {assertCommandWithOutputAndTerminal(a,
43+
"System.console().readLine(\"%%s\");\ninput", //newline automatically appended
44+
"$1 ==> \"input\"",
45+
"""
46+
\u0005System.console().readLine(\"%%s\");
47+
%sinput
48+
""");},
49+
a -> {assertCommandWithOutputAndTerminal(a,
50+
"System.console().readPassword(\"%%s\");\ninput!", //newline automatically appended
51+
"$2 ==> char[6] { 'i', 'n', 'p', 'u', 't', '!' }",
52+
"""
53+
\u0005System.console().readPassword(\"%%s\");
54+
%s
55+
""");}
56+
);
57+
}
58+
59+
void assertCommandWithOutputAndTerminal(boolean a, String command, String out, String terminalOut) {
60+
assertCommand(a, command, out, null, null, null, null, terminalOut);
61+
}
62+
63+
}

‎test/langtools/jdk/jshell/ReplToolTesting.java

+21-2
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,12 @@ public String getUserErrorOutput() {
221221
return s;
222222
}
223223

224+
public String getTerminalOutput() {
225+
String s = normalizeLineEndings("\r\n", console.data.toString());
226+
console.data.reset();
227+
return s;
228+
}
229+
224230
public void test(ReplTest... tests) {
225231
test(new String[0], tests);
226232
}
@@ -476,6 +482,7 @@ public void dropMethod(boolean after, String cmd, String name, String output) {
476482

477483
public void dropClass(boolean after, String cmd, String name, String output) {
478484
dropKey(after, cmd, name, classes, output);
485+
479486
}
480487

481488
public void dropImport(boolean after, String cmd, String name, String output) {
@@ -532,6 +539,11 @@ public void assertCommandCheckUserOutput(boolean after, String cmd, Consumer<Str
532539

533540
public void assertCommand(boolean after, String cmd, String out, String err,
534541
String userinput, String print, String usererr) {
542+
assertCommand(after, cmd, out, err, userinput, print, usererr, null);
543+
}
544+
545+
public void assertCommand(boolean after, String cmd, String out, String err,
546+
String userinput, String print, String usererr, String terminalOut) {
535547
if (!after) {
536548
if (userinput != null) {
537549
setUserInput(userinput);
@@ -546,6 +558,7 @@ public void assertCommand(boolean after, String cmd, String out, String err,
546558
assertOutput(getCommandErrorOutput(), err, "command error: " + cmd);
547559
assertOutput(getUserOutput(), print, "user output: " + cmd);
548560
assertOutput(getUserErrorOutput(), usererr, "user error: " + cmd);
561+
assertOutput(getTerminalOutput(), terminalOut, "terminal output: " + cmd);
549562
}
550563
}
551564

@@ -565,7 +578,11 @@ public void assertOutput(String got, String expected, String display) {
565578
}
566579

567580
private String normalizeLineEndings(String text) {
568-
return ANSI_CODE_PATTERN.matcher(text.replace(System.getProperty("line.separator"), "\n")).replaceAll("");
581+
return normalizeLineEndings(System.getProperty("line.separator"), text);
582+
}
583+
584+
private String normalizeLineEndings(String lineSeparator, String text) {
585+
return ANSI_CODE_PATTERN.matcher(text.replace(lineSeparator, "\n")).replaceAll("");
569586
}
570587
private static final Pattern ANSI_CODE_PATTERN = Pattern.compile("\033\\[[\060-\077]*[\040-\057]*[\100-\176]");
571588

@@ -846,6 +863,7 @@ public synchronized void close() throws IOException {
846863

847864
class PromptedCommandOutputStream extends OutputStream {
848865
private final ReplTest[] tests;
866+
private final ByteArrayOutputStream data = new ByteArrayOutputStream();
849867
private int index = 0;
850868
PromptedCommandOutputStream(ReplTest[] tests) {
851869
this.tests = tests;
@@ -861,7 +879,8 @@ public synchronized void write(int b) {
861879
fail("Did not exit Repl tool after test");
862880
}
863881
++index;
864-
} // For now, anything else is thrown away
882+
}
883+
data.write(b);
865884
}
866885

867886
@Override

0 commit comments

Comments
 (0)
Please sign in to comment.