/*

 * Copyright (c) 2007, 2012, 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 5030233 6214916 6356475 6571029 6684582 6742159 4459600 6758881 6753938

 *      6894719 6968053 7151434 7146424

 * @summary Argument parsing validation.

 * @compile -XDignore.symbol.file Arrrghs.java

 * @run main/othervm Arrrghs

 */

import java.io.BufferedReader;

import java.io.File;

import java.io.FileNotFoundException;

import java.io.IOException;

import java.io.InputStream;

import java.io.InputStreamReader;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.regex.Matcher;

import java.util.regex.Pattern;

public class Arrrghs extends TestHelper {

    private Arrrghs(){}

    /**

     * This class provides various tests for arguments processing.

     * A group of tests to ensure that arguments are passed correctly to

     * a child java process upon a re-exec, this typically happens when

     * a version other than the one being executed is requested by the user.

     *

     * History: these set of tests  were part of Arrrghs.sh. The MKS shell

     * implementations were notoriously buggy. Implementing these tests purely

     * in Java is not only portable but also robust.

     *

     */

    // The version string to force a re-exec

    final static String VersionStr = "-version:1.1+";

    // The Cookie or the pattern we match in the debug output.

    final static String Cookie = "ReExec Args: ";

    /*

     * SIGH, On Windows all strings are quoted, we need to unwrap it

     */

    private static String removeExtraQuotes(String in) {

        if (isWindows) {

            // Trim the string and remove the enclosed quotes if any.

            in = in.trim();

            if (in.startsWith("\"") && in.endsWith("\"")) {

                return in.substring(1, in.length()-1);

            }

        }

        return in;

    }

    /*

     * This method detects the cookie in the output stream of the process.

     */

    private boolean detectCookie(InputStream istream,

            String expectedArguments) throws IOException {

        BufferedReader rd = new BufferedReader(new InputStreamReader(istream));

        boolean retval = false;

        String in = rd.readLine();

        while (in != null) {

            if (debug) System.out.println(in);

            if (in.startsWith(Cookie)) {

                String detectedArgument = removeExtraQuotes(in.substring(Cookie.length()));

                if (expectedArguments.equals(detectedArgument)) {

                    retval = true;

                } else {

                    System.out.println("Error: Expected Arguments\t:'" +

                            expectedArguments + "'");

                    System.out.println(" Detected Arguments\t:'" +

                            detectedArgument + "'");

                }

                // Return the value asap if not in debug mode.

                if (!debug) {

                    rd.close();

                    istream.close();

                    return retval;

                }

            }

            in = rd.readLine();

        }

        return retval;

    }

    private boolean doReExecTest0(ProcessBuilder pb, String expectedArguments) {

        boolean retval = false;

        try {

            pb.redirectErrorStream(true);

            Process p = pb.start();

            retval = detectCookie(p.getInputStream(), expectedArguments);

            p.waitFor();

            p.destroy();

        } catch (Exception ex) {

            ex.printStackTrace();

            throw new RuntimeException(ex.getMessage());

        }

        return retval;

    }

    /**

     * This method returns true  if the expected and detected arguments are the same.

     * Quoting could cause dissimilar testArguments and expected arguments.

     */

    int doReExecTest(String testArguments, String expectedPattern) {

        ProcessBuilder pb = new ProcessBuilder(javaCmd,

                VersionStr, testArguments);

        Map<String, String> env = pb.environment();

        env.put(JLDEBUG_KEY, "true");

        return doReExecTest0(pb, testArguments) ? 0 : 1;

    }

    /**

     * A convenience method for identical test pattern and expected arguments

     */

    int doReExecTest(String testPattern) {

        return doReExecTest(testPattern, testPattern);

    }

    @Test

    void testQuoteParsingThroughReExec() {

        /*

         * Tests for 6214916

         * These tests require that a JVM (any JVM) be installed in the system registry.

         * If none is installed, skip this test.

         */

        TestResult tr = doExec(javaCmd, VersionStr, "-version");

        if (!tr.isOK()) {

            System.err.println("Warning:Argument Passing Tests were skipped, " +

                    "no java found in system registry.");

            return;

        }

        // Basic test

        testExitValue += doReExecTest("-a -b -c -d");

        // Basic test with many spaces

        testExitValue += doReExecTest("-a    -b      -c       -d");

        // Quoted whitespace does matter ?

        testExitValue += doReExecTest("-a \"\"-b      -c\"\" -d");

        // Escaped quotes outside of quotes as literals

        testExitValue += doReExecTest("-a \\\"-b -c\\\" -d");

        // Check for escaped quotes inside of quotes as literal

        testExitValue += doReExecTest("-a \"-b \\\"stuff\\\"\" -c -d");

        // A quote preceeded by an odd number of slashes is a literal quote

        testExitValue += doReExecTest("-a -b\\\\\\\" -c -d");

        // A quote preceeded by an even number of slashes is a literal quote

        // see 6214916.

        testExitValue += doReExecTest("-a -b\\\\\\\\\" -c -d");

        // Make sure that whitespace doesn't interfere with the removal of the

        // appropriate tokens. (space-tab-space preceeds -jre-restict-search).

        testExitValue += doReExecTest("-a -b  \t -jre-restrict-search -c -d", "-a -b -c -d");

        // Make sure that the mJRE tokens being stripped, aren't stripped if

        // they happen to appear as arguments to the main class.

        testExitValue += doReExecTest("foo -version:1.1+");

        System.out.println("Completed arguments quoting tests with "

                + testExitValue + " errors");

    }

    // the pattern we hope to see in the output

    static final Pattern ArgPattern = Pattern.compile("\\s*argv\\[[0-9]*\\].*=.*");

    void checkArgumentParsing(String inArgs, String... expArgs) throws IOException {

        List<String> scratchpad = new ArrayList<>();

        scratchpad.add("set " + JLDEBUG_KEY + "=true");

        // GAK, -version needs to be added so that windows can flush its stderr

        // exiting the process prematurely can terminate the stderr.

        scratchpad.add(javaCmd + " -version " + inArgs);

        File batFile = new File("atest.bat");

        createAFile(batFile, scratchpad);

        TestResult tr = doExec(batFile.getName());

        ArrayList<String> expList = new ArrayList<>();

        expList.add(javaCmd);

        expList.add("-version");

        expList.addAll(Arrays.asList(expArgs));

        List<String> gotList = new ArrayList<>();

        for (String x : tr.testOutput) {

            Matcher m = ArgPattern.matcher(x);

            if (m.matches()) {

                String a[] = x.split("=");

                gotList.add(a[a.length - 1].trim());

            }

        }

        if (!gotList.equals(expList)) {

            System.out.println(tr);

            System.out.println("Expected args:");

            System.out.println(expList);

            System.out.println("Obtained args:");

            System.out.println(gotList);

            throw new RuntimeException("Error: args do not match");

        }

        System.out.println("\'" + inArgs + "\'" + " - Test passed");

    }

    /*

     * This tests general quoting and are specific to Windows, *nixes

     * need not worry about this, these have been tested with Windows

     * implementation and those that are known to work are used against

     * the java implementation. Note that the ProcessBuilder gets in the

     * way when testing some of these arguments, therefore we need to

     * create and execute a .bat file containing the arguments.

     */

    @Test

    void testArgumentParsing() throws IOException {

        if (!isWindows)

            return;

        // no quotes

        checkArgumentParsing("a b c d", "a", "b", "c", "d");

        // single quotes

        checkArgumentParsing("\"a b c d\"", "a b c d");

        //double quotes

        checkArgumentParsing("\"\"a b c d\"\"", "a", "b", "c", "d");

        // triple quotes

        checkArgumentParsing("\"\"\"a b c d\"\"\"", "\"a b c d\"");

        // a literal within single quotes

        checkArgumentParsing("\"a\"b c d\"e\"", "ab", "c", "de");

        // a literal within double quotes

        checkArgumentParsing("\"\"a\"b c d\"e\"\"", "ab c de");

        // a literal quote

        checkArgumentParsing("a\\\"b", "a\"b");

        // double back-slash

        checkArgumentParsing("\"a b c d\\\\\"", "a b c d\\");

        // triple back-slash

        checkArgumentParsing("a\\\\\\\"b", "a\\\"b");

        // dangling quote

        checkArgumentParsing("\"a b c\"\"", "a b c\"");

        // expansions of white space separators

        checkArgumentParsing("a b", "a", "b");

        checkArgumentParsing("a\tb", "a", "b");

        checkArgumentParsing("a \t b", "a", "b");

        checkArgumentParsing("\"C:\\TEST A\\\\\"", "C:\\TEST A\\");

        checkArgumentParsing("\"\"C:\\TEST A\\\\\"\"", "C:\\TEST", "A\\");

        // MS Windows tests

        // triple back-slash

        checkArgumentParsing("a\\\\\\d", "a\\\\\\d");

        // triple back-slash in quotes

        checkArgumentParsing("\"a\\\\\\d\"", "a\\\\\\d");

        // slashes separating characters

        checkArgumentParsing("X\\Y\\Z", "X\\Y\\Z");

        checkArgumentParsing("\\X\\Y\\Z", "\\X\\Y\\Z");

        // literals within dangling quotes, etc.

        checkArgumentParsing("\"a b c\" d e", "a b c", "d", "e");

        checkArgumentParsing("\"ab\\\"c\"  \"\\\\\"  d", "ab\"c", "\\", "d");

        checkArgumentParsing("a\\\\\\c d\"e f\"g h", "a\\\\\\c", "de fg", "h");

        checkArgumentParsing("a\\\\\\\"b c d", "a\\\"b", "c", "d");

        checkArgumentParsing("a\\\\\\\\\"g c\" d e", "a\\\\g c", "d", "e");

        // treatment of back-slashes

        checkArgumentParsing("*\\", "*\\");

        checkArgumentParsing("*/", "*/");

        checkArgumentParsing(".\\*", ".\\*");

        checkArgumentParsing("./*", "./*");

        checkArgumentParsing("..\\..\\*", "..\\..\\*");

        checkArgumentParsing("../../*", "../../*");

        checkArgumentParsing("..\\..\\", "..\\..\\");

        checkArgumentParsing("../../", "../../");

    }

    private void initEmptyDir(File emptyDir) throws IOException {

        if (emptyDir.exists()) {

            recursiveDelete(emptyDir);

        }

        emptyDir.mkdir();

    }

    private void initDirWithJavaFiles(File libDir) throws IOException {

        if (libDir.exists()) {

            recursiveDelete(libDir);

        }

        libDir.mkdirs();

        ArrayList<String> scratchpad = new ArrayList<>();

        scratchpad.add("package lib;");

        scratchpad.add("public class Fbo {");

        scratchpad.add("public static void main(String... args){Foo.f();}");

        scratchpad.add("public static void f(){}");

        scratchpad.add("}");

        createFile(new File(libDir, "Fbo.java"), scratchpad);

        scratchpad.clear();

        scratchpad.add("package lib;");

        scratchpad.add("public class Foo {");

        scratchpad.add("public static void main(String... args){");

        scratchpad.add("for (String x : args) {");

        scratchpad.add("System.out.println(x);");

        scratchpad.add("}");

        scratchpad.add("Fbo.f();");

        scratchpad.add("}");

        scratchpad.add("public static void f(){}");

        scratchpad.add("}");

        createFile(new File(libDir, "Foo.java"), scratchpad);

    }

    void checkArgumentWildcard(String inArgs, String... expArgs) throws IOException {

        String[] in = {inArgs};

        checkArgumentWildcard(in, expArgs);

        // now add arbitrary arguments before and after

        String[] outInArgs = { "-Q", inArgs, "-R"};

        String[] outExpArgs = new String[expArgs.length + 2];

        outExpArgs[0] = "-Q";

        System.arraycopy(expArgs, 0, outExpArgs, 1, expArgs.length);

        outExpArgs[expArgs.length + 1] = "-R";

        checkArgumentWildcard(outInArgs, outExpArgs);

    }

    void checkArgumentWildcard(String[] inArgs, String[] expArgs) throws IOException {

        ArrayList<String> argList = new ArrayList<>();

        argList.add(javaCmd);

        argList.add("-cp");

        argList.add("lib" + File.separator + "*");

        argList.add("lib.Foo");

        argList.addAll(Arrays.asList(inArgs));

        String[] cmds = new String[argList.size()];

        argList.toArray(cmds);

        TestResult tr = doExec(cmds);

        if (!tr.isOK()) {

            System.out.println(tr);

            throw new RuntimeException("Error: classpath single entry wildcard entry");

        }

        ArrayList<String> expList = new ArrayList<>();

        expList.addAll(Arrays.asList(expArgs));

        List<String> gotList = new ArrayList<>();

        for (String x : tr.testOutput) {

            gotList.add(x.trim());

        }

        if (!gotList.equals(expList)) {

            System.out.println(tr);

            System.out.println("Expected args:");

            System.out.println(expList);

            System.out.println("Obtained args:");

            System.out.println(gotList);

            throw new RuntimeException("Error: args do not match");

        }

        System.out.print("\'");

        for (String x : inArgs) {

            System.out.print(x + " ");

        }

        System.out.println("\'" + " - Test passed");

    }

    /*

     * These tests are not expected to work on *nixes, and are ignored.

     */

    @Test

    void testWildCardArgumentProcessing() throws IOException {

        if (!isWindows)

            return;

        File cwd = new File(".");

        File libDir = new File(cwd, "lib");

        initDirWithJavaFiles(libDir);

        initEmptyDir(new File(cwd, "empty"));

        // test if javac (the command) can compile *.java

        TestResult tr = doExec(javacCmd, libDir.getName() + File.separator + "*.java");

        if (!tr.isOK()) {

            System.out.println(tr);

            throw new RuntimeException("Error: compiling java wildcards");

        }

        // use the jar cmd to create jars using the ? wildcard

        File jarFoo = new File(libDir, "Foo.jar");

        tr = doExec(jarCmd, "cvf", jarFoo.getAbsolutePath(), "lib" + File.separator + "F?o.class");

        if (!tr.isOK()) {

            System.out.println(tr);

            throw new RuntimeException("Error: creating jar with wildcards");

        }

        // now the litmus test!, this should work

        checkArgumentWildcard("a", "a");

        // test for basic expansion

        checkArgumentWildcard("lib\\F*java", "lib\\Fbo.java", "lib\\Foo.java");

        // basic expansion in quotes

        checkArgumentWildcard("\"lib\\F*java\"", "lib\\F*java");

        checkArgumentWildcard("lib\\**", "lib\\Fbo.class", "lib\\Fbo.java",

                              "lib\\Foo.class", "lib\\Foo.jar", "lib\\Foo.java");

        checkArgumentWildcard("lib\\*?", "lib\\Fbo.class", "lib\\Fbo.java",

                              "lib\\Foo.class", "lib\\Foo.jar", "lib\\Foo.java");

        checkArgumentWildcard("lib\\?*", "lib\\Fbo.class", "lib\\Fbo.java",

                "lib\\Foo.class", "lib\\Foo.jar", "lib\\Foo.java");

        checkArgumentWildcard("lib\\?", "lib\\?");

        // test for basic expansion

        checkArgumentWildcard("lib\\*java", "lib\\Fbo.java", "lib\\Foo.java");

        // basic expansion in quotes

        checkArgumentWildcard("\"lib\\*.java\"", "lib\\*.java");

        // suffix expansion

        checkArgumentWildcard("lib\\*.class", "lib\\Fbo.class", "lib\\Foo.class");

        // suffix expansion in quotes

        checkArgumentWildcard("\"lib\\*.class\"", "lib\\*.class");

        // check for ? expansion now

        checkArgumentWildcard("lib\\F?o.java", "lib\\Fbo.java", "lib\\Foo.java");

        // check ? in quotes

        checkArgumentWildcard("\"lib\\F?o.java\"", "lib\\F?o.java");

        // check ? as suffixes

        checkArgumentWildcard("lib\\F?o.????", "lib\\Fbo.java", "lib\\Foo.java");

        // check ? in a leading role

        checkArgumentWildcard("lib\\???.java", "lib\\Fbo.java", "lib\\Foo.java");

        checkArgumentWildcard("\"lib\\???.java\"", "lib\\???.java");

        // check ? prefixed with -

        checkArgumentWildcard("-?", "-?");

        // check * prefixed with -

        checkArgumentWildcard("-*", "-*");

        // check on empty directory

        checkArgumentWildcard("empty\\*", "empty\\*");

        checkArgumentWildcard("empty\\**", "empty\\**");

        checkArgumentWildcard("empty\\?", "empty\\?");

        checkArgumentWildcard("empty\\??", "empty\\??");

        checkArgumentWildcard("empty\\*?", "empty\\*?");

        checkArgumentWildcard("empty\\?*", "empty\\?*");

    }

    void doArgumentCheck(String inArgs, String... expArgs) {

        Map<String, String> env = new HashMap<>();

        env.put(JLDEBUG_KEY, "true");

        TestResult tr = doExec(env, javaCmd, inArgs);

        System.out.println(tr);

        int sindex = tr.testOutput.indexOf("Command line args:");

        if (sindex < 0) {

            System.out.println(tr);

            throw new RuntimeException("Error: no output");

        }