test/langtools/jdk/jshell/StartOptionTest.java - master - githubmirror/panama-vector

test/langtools/jdk/jshell/StartOptionTest.java
607 строк23 KB
Jan Lahoda
8365776: Convert JShell tests to use JUnit instead of TestNG
08 сен 2025, 07:35
08 сен 2025, 07:35b0ca9bf
/*
 * Copyright (c) 2015, 2025, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

 /*
 * @test
 * @bug 8151754 8080883 8160089 8170162 8166581 8172102 8171343 8178023 8186708 8179856 8185840 8190383 8341631 8341833 8344706
 * @summary Testing startExCe-up options.
 * @modules jdk.compiler/com.sun.tools.javac.api
 *          jdk.compiler/com.sun.tools.javac.main
 *          jdk.jdeps/com.sun.tools.javap
 *          jdk.jshell/jdk.internal.jshell.tool
 *          jdk.jshell/jdk.internal.jshell.tool.resources:+open
 * @library /tools/lib
 * @build Compiler toolbox.ToolBox
 * @run junit/othervm --patch-module jdk.jshell=${test.src}/StartOptionTest-module-patch StartOptionTest
 */
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Path;
import java.text.MessageFormat;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;
import java.util.function.Consumer;

import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Pattern;
import jdk.jshell.JShell;

import jdk.jshell.tool.JavaShellToolBuilder;
import org.junit.jupiter.api.AfterEach;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

public class StartOptionTest {

    protected ByteArrayOutputStream cmdout;
    protected ByteArrayOutputStream cmderr;
    protected ByteArrayOutputStream console;
    protected ByteArrayOutputStream userout;
    protected ByteArrayOutputStream usererr;
    protected InputStream cmdInStream;
    private Map<String, String> testPersistence;

    private JavaShellToolBuilder builder() {
        // turn on logging of launch failures
        Logger.getLogger("jdk.jshell.execution").setLevel(Level.ALL);
        return JavaShellToolBuilder
                .builder()
                .out(new PrintStream(cmdout), new PrintStream(console), new PrintStream(userout))
                .err(new PrintStream(cmderr), new PrintStream(usererr))
                .in(cmdInStream, null)
                .persistence(getThisTestPersistence())
                .env(new HashMap<>())
                .locale(Locale.ROOT);
    }

    protected Map<String, String> getThisTestPersistence() {
        return testPersistence != null ? testPersistence
                                       : new HashMap<>();
    }

    protected int runShell(String... args) {
        cmdout.reset();
        cmderr.reset();
        console.reset();
        userout.reset();
        usererr.reset();

        try {
            return builder()
                    .start(Presets.addExecutionIfMissing(args));
        } catch (Exception ex) {
            fail("Repl tool died with exception", ex);
        }
        return -1; // for compiler
    }

    protected void check(ByteArrayOutputStream str, Consumer<String> checkOut, String label) {
        try {
            byte[] bytes = str.toByteArray();
            str.reset();
            String out = new String(bytes, StandardCharsets.UTF_8);
            out = stripAnsi(out);
            out = out.replaceAll("[\r\n]+", "\n");
            if (checkOut != null) {
                checkOut.accept(out);
            } else {
                assertEquals("", out, label + ": Expected empty -- ");
            }
        } catch (Throwable t) {
            logOutput("cmdout", cmdout);
            logOutput("cmderr", cmderr);
            logOutput("console", console);
            logOutput("userout", userout);
            logOutput("usererr", usererr);

            throw t;
        }
    }

    private void logOutput(String outName, ByteArrayOutputStream out) {
        System.err.println(outName + ": " +
                           new String(out.toByteArray(),
                                      StandardCharsets.UTF_8));
    }

    protected void checkExit(int ec, Consumer<Integer> checkCode) {
        if (checkCode != null) {
            checkCode.accept(ec);
        } else {
            assertEquals(0, ec, "Expected standard exit code (0), but found: " + ec);
        }
    }

    // Start and check the resultant: exit code (Ex), command output (Co),
    // user output (Uo), command error (Ce), and console output (Cn)
    protected void startExCoUoCeCn(Consumer<Integer> checkExitCode,
            Consumer<String> checkCmdOutput,
            Consumer<String> checkUserOutput,
            Consumer<String> checkError,
            Consumer<String> checkConsole,
            String... args) {
        int ec = runShell(args);
        checkExit(ec, checkExitCode);
        check(cmdout, checkCmdOutput, "cmdout");
        check(cmderr, checkError, "cmderr");
        check(console, checkConsole, "console");
        check(userout, checkUserOutput, "userout");
        check(usererr, null, "usererr");
    }

    protected void startCheckUserOutput(Consumer<String> checkUserOutput,
            String... args) {
        runShell(args);
        check(userout, checkUserOutput, "userout");
        check(cmderr, null, "cmderr");
        check(usererr, null, "usererr");
    }

    protected void startCheckCommandUserOutput(Consumer<String> checkCommandOutput,
            Consumer<String> checkUserOutput,
            Consumer<String> checkCombinedCommandUserOutput,
            String... args) {
        runShell(args);
        check(cmdout, checkCommandOutput, "cmdout");
        check(userout, checkUserOutput, "userout");
        check(usererr, null, "usererr");
    }

    protected void startCheckError(Consumer<String> checkError,
            String... args) {
        runShell(args);
        check(cmderr, checkError, "userout");
        check(userout, null, "userout");
        check(usererr, null, "usererr");
    }

    // Start with an exit code and command error check
    protected void startExCe(int eec, Consumer<String> checkError, String... args) {
        StartOptionTest.this.startExCoUoCeCn((Integer ec) -> assertEquals(eec, (int) ec,
                        "Expected error exit code (" + eec + "), but found: " + ec),
                null, null, checkError, null, args);
    }

    // Start with a command output check
    protected void startCo(Consumer<String> checkCmdOutput, String... args) {
        StartOptionTest.this.startExCoUoCeCn(null, checkCmdOutput, null, null, null, args);
    }

    private Consumer<String> assertOrNull(String expected, String label) {
        return expected == null
                ? null
                : s -> assertEquals(expected.trim(), s.replaceAll("\\r\\n?", "\n").trim(), label);
    }

    // Start and check the resultant: exit code (Ex), command output (Co),
    // user output (Uo), command error (Ce), and console output (Cn)
    protected void startExCoUoCeCn(int expectedExitCode,
            String expectedCmdOutput,
            String expectedUserOutput,
            String expectedError,
            String expectedConsole,
            String... args) {
        startExCoUoCeCn(expectedExitCode == 0
                        ? null
                        : (Integer i) -> assertEquals(expectedExitCode, (int) i,
                        "Expected exit code (" + expectedExitCode + "), but found: " + i),
                assertOrNull(expectedCmdOutput, "cmdout: "),
                assertOrNull(expectedUserOutput, "userout: "),
                assertOrNull(expectedError, "cmderr: "),
                assertOrNull(expectedConsole, "console: "),
                args);
    }

    // Start with an expected exit code and command error
    protected void startExCe(int ec, String expectedError, String... args) {
        startExCoUoCeCn(ec, null, null, expectedError, null, args);
    }

    // Start with an expected command output
    protected void startCo(String expectedCmdOutput, String... args) {
        startExCoUoCeCn(0, expectedCmdOutput, null, null, null, args);
    }

    // Start with an expected user output
    protected void startUo(String expectedUserOutput, String... args) {
        startExCoUoCeCn(0, null, expectedUserOutput, null, null, args);
    }

    @BeforeEach
    public void setUp() {
        cmdout = new ByteArrayOutputStream();
        cmderr = new ByteArrayOutputStream();
        console = new ByteArrayOutputStream();
        userout = new ByteArrayOutputStream();
        usererr = new ByteArrayOutputStream();
        setIn("/exit\n");
    }

    protected String writeToFile(String stuff) {
        return writeToFile("doit.repl", stuff);
    }

    protected String writeToFile(String fileName, String stuff) {
        Compiler compiler = new Compiler();
        Path p = compiler.getPath(fileName);
        compiler.writeToFile(p, stuff);
        return p.toString();
    }

    // Set the input from a String
    protected void setIn(String s) {
        cmdInStream = new ByteArrayInputStream(s.getBytes());
    }

    // Test load files
    @Test
    public void testCommandFile() {
        String fn = writeToFile("String str = \"Hello \"\n" +
                "/list\n" +
                "System.out.println(str + str)\n" +
                "/exit\n");
        startExCoUoCeCn(0,
                "1 : String str = \"Hello \";\n",
                "Hello Hello",
                null,
                null,
                "--no-startup", fn, "-s");
    }

    // Test that the usage message is printed
    @Test
    public void testUsage() {
        for (String opt : new String[]{"-?", "-h", "--help"}) {
            startCo(s -> {
                assertTrue(s.split("\n").length >= 7, "Not enough usage lines: " + s);
                assertTrue(s.startsWith("Usage:   jshell <option>..."), "Unexpect usage start: " + s);
                assertTrue(s.contains("--show-version"), "Expected help: " + s);
                assertFalse(s.contains("Welcome"), "Unexpected start: " + s);
            }, opt);
        }
    }

    // Test the --help-extra message
    @Test
    public void testHelpExtra() {
        for (String opt : new String[]{"-X", "--help-extra"}) {
            startCo(s -> {
                assertTrue(s.split("\n").length >= 5, "Not enough help-extra lines: " + s);
                assertTrue(s.contains("--add-exports"), "Expected --add-exports: " + s);
                assertTrue(s.contains("--execution"), "Expected --execution: " + s);
                assertFalse(s.contains("Welcome"), "Unexpected start: " + s);
            }, opt);
        }
    }

    // Test handling of bogus options
    @Test
    public void testUnknown() {
        startExCe(1, "Unknown option: u", "-unknown");
        startExCe(1, "Unknown option: unknown", "--unknown");
    }

    // Test that input is read with "-" and there is no extra output.
    @Test
    public void testHypenFile() {
        setIn("System.out.print(\"Hello\");\n");
        startUo("Hello", "-");
        setIn("System.out.print(\"Hello\");\n");
        startUo("Hello", "-", "-");
        String fn = writeToFile("System.out.print(\"===\");");
        setIn("System.out.print(\"Hello\");\n");
        startUo("===Hello===", fn, "-", fn);
        // check that errors go to standard error
        setIn(") Foobar");
        startExCe(0, s -> assertTrue(s.contains("illegal start of expression"),
                "cmderr: illegal start of expression"),
                "-");
    }

    // Test that user specified exit codes are propagated
    @Test
    public void testExitCode() {
        setIn("/exit 57\n");
        startExCoUoCeCn(57, null, null, null, "-> /exit 57", "-s");
        setIn("int eight = 8\n" +
                "/exit eight + \n" +
                " eight\n");
        startExCoUoCeCn(16, null, null, null,
                "-> int eight = 8\n" +
                "-> /exit eight + \n" +
                ">>  eight",
                "-s");
    }

    // Test that non-existent load file sends output to stderr and does not startExCe (no welcome).
    @Test
    public void testUnknownLoadFile() {
        startExCe(1, "File 'UNKNOWN' for 'jshell' is not found.", "UNKNOWN");
    }

    // Test bad usage of the --startup option
    @Test
    public void testStartup() {
        String fn = writeToFile("");
        startExCe(1, "Argument to startup missing.", "--startup");
        startExCe(1, "Conflicting options: both --startup and --no-startup were used.", "--no-startup", "--startup", fn);
        startExCe(1, "Conflicting options: both --startup and --no-startup were used.", "--startup", fn, "--no-startup");
        startExCe(1, "Argument to startup missing.", "--no-startup", "--startup");
    }

    // Test an option that causes the back-end to fail is propagated
    @Test
    public void testStartupFailedOption() {
        startExCe(1, s -> assertTrue(s.contains("Unrecognized option: -hoge-foo-bar"), "cmderr: " + s),
                "-R-hoge-foo-bar");
    }

    // Test the use of non-existant files with the --startup option
    @Test
    public void testStartupUnknown() {
        startExCe(1, "File 'UNKNOWN' for '--startup' is not found.", "--startup", "UNKNOWN");
        startExCe(1, "File 'UNKNOWN' for '--startup' is not found.", "--startup", "DEFAULT", "--startup", "UNKNOWN");
    }

    // Test bad usage of --class-path option
    @Test
    public void testClasspath() {
        for (String cp : new String[]{"--class-path"}) {
            startExCe(1, "Only one --class-path option may be used.", cp, ".", "--class-path", ".");
            startExCe(1, "Argument to class-path missing.", cp);
        }
    }

    // Test bogus module on --add-modules option
    @Test
    public void testUnknownModule() {
        startExCe(1, s -> assertTrue(s.contains("rror") && s.contains("unKnown"), "cmderr: " + s),
                "--add-modules", "unKnown");
    }

    // Test that muliple feedback options fail
    @Test
    public void testFeedbackOptionConflict() {
        startExCe(1, "Only one feedback option (--feedback, -q, -s, or -v) may be used.",
                "--feedback", "concise", "--feedback", "verbose");
        startExCe(1, "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "--feedback", "concise", "-s");
        startExCe(1, "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "--feedback", "verbose", "-q");
        startExCe(1, "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "--feedback", "concise", "-v");
        startExCe(1, "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "-v", "--feedback", "concise");
        startExCe(1, "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "-q", "-v");
        startExCe(1, "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "-s", "-v");
        startExCe(1, "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "-v", "-q");
        startExCe(1, "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "-q", "-s");
    }

    // Test bogus arguments to the --feedback option
    @Test
    public void testNegFeedbackOption() {
        startExCe(1, "Argument to feedback missing.", "--feedback");
        startExCe(1, "Does not match any current feedback mode: blorp -- --feedback blorp", "--feedback", "blorp");
    }

    // Test --version
    @Test
    public void testVersion() {
        startCo(s -> {
            assertTrue(s.startsWith("jshell"), "unexpected version: " + s);
            assertFalse(s.contains("Welcome"), "Unexpected start: " + s);
        },
                "--version");
    }

    // Test --show-version
    @Test
    public void testShowVersion() {
        startExCoUoCeCn(null,
                s -> {
                    assertTrue(s.startsWith("jshell"), "unexpected version: " + s);
                    assertTrue(s.contains("Welcome"), "Expected start (but got no welcome): " + s);
                },
                null,
                null,
                s -> assertTrue(s.trim().startsWith("jshell>"), "Expected prompt, got: " + s),
                "--show-version");
    }

    @Test
    public void testPreviewEnabled() {
        String fn = writeToFile(
                """
                System.out.println(\"prefix\");
                System.out.println(MethodHandle.class.getName());
                System.out.println(\"suffix\");
                /exit
                """);
        startCheckUserOutput(s -> assertEquals("prefix\njava.lang.invoke.MethodHandle\nsuffix\n", s),
                             fn);
        String fn24 = writeToFile(
                """
                System.out.println(\"test\");
                /exit
                """);
        startCheckUserOutput(s -> assertEquals("test\n", s),
                             "-C--release", "-C24", fn24);
        startCheckUserOutput(s -> assertEquals("test\n", s),
                             "-C--source", "-C24", fn24);
        startCheckUserOutput(s -> assertEquals("test\n", s),
                             "-C-source", "-C24", fn24);
        //JDK-8341631:
        String fn2 = writeToFile(
                """
                System.out.println(\"prefix\");
                IO.println(\"test\");
                System.out.println(\"suffix\");
                /exit
                """);
        startCheckUserOutput(s -> assertEquals("prefix\ntest\nsuffix\n", s),
                             fn2);
        //verify the correct resource is selected when --enable-preview, relies on
        //--patch-module jdk.jshell=${test.src}/StartOptionTest-module-patch
        String fn2Preview = writeToFile(
                """
                System.out.println(\"prefix\");
                sayHello();
                System.out.println(\"suffix\");
                /exit
                """);
        startCheckUserOutput(s -> assertEquals("prefix\nHello!\nsuffix\n", s),
                             "--enable-preview", fn2Preview,
                             "-");

        testPersistence = new HashMap<>();

        String newStartupScript = writeToFile("test-startup.repl",
                """
                System.out.println("Custom start script");
                """);
        String setStartup = writeToFile(
                """
                /set start -retain {file}
                /exit
                """.replace("{file}", newStartupScript));
        startCheckUserOutput(s -> {}, setStartup);
        String exit = writeToFile(
                """
                /exit
                """);
        startCheckUserOutput(s -> assertEquals("Custom start script\n", s),
                             exit);
        String clearStartup = writeToFile(
                """
                /set start -retain -default
                /exit
                """);
        startCheckUserOutput(s -> {}, clearStartup);
        String retainTest = writeToFile(
                """
                /set start
                System.out.println(\"prefix\");
                System.out.println(MethodHandle.class.getName());
                System.out.println(\"suffix\");
                /exit
                """);
        startCheckCommandUserOutput(s -> assertEquals("/set start -retain -default\n", s),
                                    s -> assertEquals("prefix\njava.lang.invoke.MethodHandle\nsuffix\n", s),
                                    s -> assertEquals("/set start -retain -default\nprefix\njava.lang.invoke.MethodHandle\nsuffix\n", s),
                                    retainTest);
        String retainTest24 = writeToFile(
                """
                System.out.println(\"test\");
                /exit
                """);
        startCheckUserOutput(s -> assertEquals("test\n", s),
                             "-C--release", "-C24", retainTest24);

        String set24DefaultTest = writeToFile(
                """
                /set start -default -retain
                /exit
                """);
        startCheckUserOutput(s -> {},
                             "-C--release", "-C24", set24DefaultTest);

        String checkDefaultAfterSet24Test = writeToFile(
                """
                /set start
                System.out.println(\"prefix\");
                System.out.println(MethodHandle.class.getName());
                System.out.println(\"suffix\");
                /exit
                """);
        startCheckCommandUserOutput(s -> assertEquals("/set start -retain -default\n", s),
                                    s -> assertEquals("prefix\njava.lang.invoke.MethodHandle\nsuffix\n", s),
                                    s -> assertEquals("/set start -retain -default\nprefix\njava.lang.invoke.MethodHandle\nsuffix\n", s),
                                    checkDefaultAfterSet24Test);
    }

    @Test
    public void testInput() {
        //readLine(String):
        String readLinePrompt = writeToFile(
                """
                var v = System.console().readLine("prompt: ");
                System.out.println(v);
                /exit
                """);
        startCheckUserOutput(s -> assertEquals("prompt: null\n", s),
                             readLinePrompt);
        //readPassword(String):
        String readPasswordPrompt = writeToFile(
                """
                var v = System.console().readPassword("prompt: ");
                System.out.println(java.util.Arrays.toString(v));
                /exit
                """);
        startCheckUserOutput(s -> assertEquals("prompt: null\n", s),
                             readPasswordPrompt);
    }

    @Test
    public void testErroneousFile() {
        String code = """
                      var v = (
                      System.console().readLine("prompt: ");
                      /exit
                      """;
        String readLinePrompt = writeToFile(code);
        String expectedErrorFormat =
                ResourceBundle.getBundle("jdk.internal.jshell.tool.resources.l10n",
                                         Locale.getDefault(),
                                         JShell.class.getModule())
                              .getString("jshell.err.incomplete.input");
        String expectedError =
                new MessageFormat(expectedErrorFormat).format(new Object[] {code});
        startCheckError(s -> assertEquals(expectedError, s),
                        readLinePrompt);
    }


    @AfterEach
    public void tearDown() {
        cmdout = null;
        cmderr = null;
        console = null;
        userout = null;
        usererr = null;
        cmdInStream = null;
    }

    private static String stripAnsi(String str) {
        if (str == null) return "";
        return ANSI_CODE_PATTERN.matcher(str).replaceAll("");
    }

    public static final Pattern ANSI_CODE_PATTERN = Pattern.compile("\033\\[[\060-\077]*[\040-\057]*[\100-\176]");
}