/*
 * Copyright (c) 2000, 2018, 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.
 */

package nsk.jdi.ReferenceType.methodsByName_s;

import nsk.share.*;
import nsk.share.jpda.*;
import nsk.share.jdi.*;

import com.sun.jdi.*;
import java.util.*;
import java.io.*;

/**
 * This test checks the method <code>methodsByName(String name)</code>
 * of the JDI interface <code>ReferenceType</code> of com.sun.jdi package
 */

public class methbyname_s004 extends Log {
    static java.io.PrintStream out_stream;
    static boolean verbose_mode = false;  // test argument -vbs or -verbose switches to static
                                          // - for more easy failure evaluation

    /** The main class names of the debugger & debugee applications. */
    private final static String
        package_prefix = "nsk.jdi.ReferenceType.methodsByName_s.",
//        package_prefix = "",    //  for DEBUG without package
        thisClassName = package_prefix + "methbyname_s004",
        debugeeName   = thisClassName + "a";

    /** Debugee's classes for check **/
    private final static String class_for_check = package_prefix + "methbyname_s004aClassForCheck";
    private final static String super_class_for_check = package_prefix + "methbyname_s004aSuperClassForCheck";
    private final static String interface_for_check = package_prefix + "methbyname_s004aInterfaceForCheck";
    private static String methods_for_check[][] = {

//        method name                   returned methods expected number

        {"s_overloaded_method",        "4"                             },
        {"i_overloaded_method",        "4"                             },
        {"i_super_overloaded_method",  "2"                             },
        {"i_interf_overloaded_method", "2"                             }

    };

    private static String expected_methods_full_list[][] = {

//        method name                  declaring class      signature

        {"s_overloaded_method",        class_for_check,       "()V"                                     },
        {"s_overloaded_method",        class_for_check,       "(Ljava/lang/String;)Ljava/lang/String;"  },
        {"s_overloaded_method",        class_for_check,       "(Ljava/lang/Object;)Ljava/lang/Object;"  },
        {"s_overloaded_method",        class_for_check,       "(JLjava/lang/String;)Ljava/lang/Object;" },
        {"i_overloaded_method",        class_for_check,       "()V"                                     },
        {"i_overloaded_method",        class_for_check,       "(Ljava/lang/Object;)J"                   },
        {"i_overloaded_method",        class_for_check,       "(Ljava/lang/String;)Ljava/lang/String;"  },
        {"i_overloaded_method",        class_for_check,       "(JLjava/lang/String;)Ljava/lang/Object;" },
        {"i_super_overloaded_method",  class_for_check,       "(JLjava/lang/String;)Ljava/lang/Object;" },
        {"i_super_overloaded_method",  super_class_for_check, "(J)Ljava/lang/Object;"                   },
        {"i_interf_overloaded_method", class_for_check,       "(JLjava/lang/String;)Ljava/lang/Object;" },
        {"i_interf_overloaded_method", interface_for_check,   "(J)Ljava/lang/Object;"                   }

    };

    /**
     * Re-call to <code>run(args,out)</code>, and exit with
     * either status 95 or 97 (JCK-like exit status).
     */
    public static void main (String argv[]) {
        int exitCode = run(argv,System.out);
        System.exit(exitCode + 95/*STATUS_TEMP*/);
    }

    /**
     * JCK-like entry point to the test: perform testing, and
     * return exit code 0 (PASSED) or either 2 (FAILED).
     */
    public static int run (String argv[], PrintStream out) {
        out_stream = out;

        int v_test_result = new methbyname_s004().runThis(argv,out_stream);
        if ( v_test_result == 2/*STATUS_FAILED*/ ) {
            out_stream.println("\n==> nsk/jdi/ReferenceType/methodsByName_s/methbyname_s004 test FAILED");
        }
        else {
            out_stream.println("\n==> nsk/jdi/ReferenceType/methodsByName_s/methbyname_s004 test PASSED");
        }
        return v_test_result;
    }

    private void print_log_on_verbose(String message) {
        display(message);
    }

    /**
     * Non-static variant of the method <code>run(args,out)</code>
     */
    private int runThis (String argv[], PrintStream out) {
        ArgumentHandler argHandler = new ArgumentHandler(argv);
        verbose_mode = argHandler.verbose();

        if ( out_stream == null ) {
            out_stream = out;
        }

        out_stream.println("==> nsk/jdi/ReferenceType/methodsByName_s/methbyname_s004 test LOG:");
        out_stream.println("==> test checks methodsByName(String name) method of ReferenceType interface ");
        out_stream.println("    of the com.sun.jdi package for overloaded methods\n");

        String debugee_launch_command = debugeeName;
        if (verbose_mode) {
            logTo(out_stream);
        }

        Binder binder = new Binder(argHandler,this);
        Debugee debugee = binder.bindToDebugee(debugee_launch_command);
        IOPipe pipe = new IOPipe(debugee);

        debugee.redirectStderr(out);
        print_log_on_verbose("--> methbyname_s004: methbyname_s004a debugee launched");
        debugee.resume();

        String line = pipe.readln();
        if (line == null) {
            out_stream.println
                ("##> methbyname_s004: UNEXPECTED debugee's signal (not \"ready\") - " + line);
            return 2/*STATUS_FAILED*/;
        }
        if (!line.equals("ready")) {
            out_stream.println
                ("##> methbyname_s004: UNEXPECTED debugee's signal (not \"ready\") - " + line);
            return 2/*STATUS_FAILED*/;
        }
        else {
            print_log_on_verbose("--> methbyname_s004: debugee's \"ready\" signal recieved!");
        }

        out_stream.println
            ("--> methbyname_s004: check ReferenceType.methodsByName(String name) method for debugee's "
            + class_for_check + " class...");
        boolean class_not_found_error = false;
        int methods_for_check_number = methods_for_check.length;
        int methodsByName_exceptions = 0;
        int not_found_methods_number = 0;
        int not_matched_methods_number = 0;
        int all_method_errors_number = 0;
        int passed_methods_number = 0;


        while ( true ) {
            ReferenceType refType = debugee.classByName(class_for_check);
            if (refType == null) {
                out_stream.println("##> methbyname_s004: Could NOT FIND class: " + class_for_check);
                class_not_found_error = true;
                break;
            }
            for (int i=0; i<methods_for_check_number; i++) {
                int expected_methods_number = 0;
                try {
                    expected_methods_number = Integer.parseInt(methods_for_check[i][1]);
                }
                catch (NumberFormatException e) {
                }

                List<Method> methods_byname_list = null;
                try {
                    methods_byname_list = refType.methodsByName(methods_for_check[i][0]);
                }
                catch (Throwable thrown) {
                    out_stream.println
                        ("##> methbyname_s004: FAILED: methodsByName(...) throws unexpected "
                        + thrown);
                    out_stream.println
                        ("##>                  requested method: " + methods_for_check[i][0]);
                    methodsByName_exceptions++;
                    all_method_errors_number++;
                    continue;
                }
                int methods_byname_number = methods_byname_list.size();
                if ( methods_byname_number == 0 ) {
                    out_stream.println
                        ("##> methbyname_s004: FAILED: methodsByName(...) returned empty List of methods!");
                    out_stream.println
                        ("##>                  requested method: " + methods_for_check[i][0]);
                    out_stream.println
                        ("##>                  expected number of returned methods = " + expected_methods_number);
                    not_found_methods_number++;
                    all_method_errors_number++;
                    continue;
                }
                Method methods_byname_array[] = new Method[methods_byname_number];
                methods_byname_list.toArray(methods_byname_array);
                if ( methods_byname_number != expected_methods_number ) {
                    out_stream.println
                        ("##> methbyname_s004: FAILED: methodsByName(...) returned unexpected methods number = "
                        + methods_byname_number);
                    out_stream.println
                        ("##>                  requested method: " + methods_for_check[i][0]);
                    out_stream.println
                        ("##>                  expected number of returned methods = " + expected_methods_number);
                    out_stream.println
                        ("##>                  expected methods:");
                    int counter = 0;
                    for (int k=0; k<expected_methods_full_list.length; k++) {
                        if ( ! expected_methods_full_list[k][0].equals(methods_for_check[i][0]) ) {
                            continue;
                        }
                        String expected_method_signature = expected_methods_full_list[k][2];
                        String expected_declaring_class = expected_methods_full_list[k][1];

                        String expected_method_info =  methods_for_check[i][0] + "  (\""
                            + expected_method_signature + "\", " + expected_declaring_class + ")";
                        out_stream.println
                            ("##>                  returned method[" + counter +"] - " + expected_method_info);
                        counter++;
                    }
                    out_stream.println
                        ("##>                  returned methods:");
                    for (int k=0; k<methods_byname_number; k++) {
                        Method found_method = methods_byname_array[k];
                        String found_method_name = found_method.name();
                        String found_method_signature = found_method.signature();
                        String declaring_class_name = "declaring class NOT defined";
                        try {
                            declaring_class_name = found_method.declaringType().name();
                        }
                        catch (Throwable thrown) {
                        }
                        String found_method_info =  found_method_name + "  (\""
                            + found_method_signature + "\", " + declaring_class_name + ")";
                        out_stream.println
                            ("##>                  expected method[" + k +"] - " + found_method_info);
                    }
                    not_matched_methods_number++;
                    all_method_errors_number++;
                    continue;
                }
                int matched_methods_number = 0;
                for (int k=0; k<methods_byname_number; k++) {
                    Method found_method = methods_byname_array[k];
                    String found_method_name = found_method.name();
                    String found_method_signature = found_method.signature();
                    String declaring_class_name = "declaring class NOT defined";
                    try {
                        declaring_class_name = found_method.declaringType().name();
                    }
                    catch (Throwable thrown) {
                    }

// Below Strings 'found_method_info' and 'expected_method_info' are changed
// to fix the test failure.

//                    String found_method_info =  found_method_name + "  ("
//                        + found_method_signature + ", " + declaring_class_name + ")";
                    String found_method_info =  found_method_name + "  ("
                        + found_method_signature + ")";

                    for (int j=0; j<expected_methods_full_list.length; j++) {
                        if ( ! expected_methods_full_list[j][0].equals(found_method_name) ) {
                            continue;
                        }
                        String expected_method_signature = expected_methods_full_list[j][2];
                        String expected_declaring_class = expected_methods_full_list[j][1];

//                        String expected_method_info =  methods_for_check[i][0] + "  ("
//                            + expected_method_signature + ", " + expected_declaring_class + ")";
                        String expected_method_info =  methods_for_check[i][0] + "  ("
                            + expected_method_signature + ")";

                        if ( expected_method_info.equals(found_method_info) ) {
                            matched_methods_number++;
                            break;
                        }
                    }

                }
                if ( matched_methods_number != expected_methods_number ) {
                    out_stream.println
                        ("##> methbyname_s004: FAILED: methodsByName(...) returned unexpected List of methods!");
                    out_stream.println
                        ("##>                  requested method: " + methods_for_check[i][0]);
                    out_stream.println
                        ("##>                  expected number of returned methods = " + expected_methods_number);
                    out_stream.println
                        ("##>                  expected methods:");
                    int counter = 0;
                    for (int k=0; k<expected_methods_full_list.length; k++) {
                        if ( ! expected_methods_full_list[k][0].equals(methods_for_check[i][0]) ) {
                            continue;
                        }
                        String expected_method_signature = expected_methods_full_list[k][2];
                        String expected_declaring_class = expected_methods_full_list[k][1];

                        String expected_method_info =  methods_for_check[i][0] + "  (\""
                            + expected_method_signature + "\", " + expected_declaring_class + ")";
                        out_stream.println
                            ("##>                  expected[" + counter +"] - " + expected_method_info);
                        counter++;
                    }
                    out_stream.println
                        ("##>                  in fact number of returned methods = " + expected_methods_number);
                    out_stream.println
                        ("##>                  returned methods:");
                    for (int k=0; k<methods_byname_number; k++) {
                        Method found_method = methods_byname_array[k];
                        String found_method_name = found_method.name();
                        String found_method_signature = found_method.signature();
                        String declaring_class_name = "declaring class NOT defined";
                        try {
                            declaring_class_name = found_method.declaringType().name();
                        }
                        catch (Throwable thrown) {
                        }
                        String found_method_info =  found_method_name + "  (\""
                            + found_method_signature + "\", " + declaring_class_name + ")";
                        out_stream.println
                            ("##>                  returned method[" + k +"] - " + found_method_info);
                    }
                    not_matched_methods_number++;
                    all_method_errors_number++;
                }
                else {
                    print_log_on_verbose
                        ("--> methbyname_s004: PASSED for method: " + methods_for_check[i][0]);
                    passed_methods_number++;
                }
            }
            break;
        }

        out_stream.println("--> methbyname_s004: check completed!");
        int v_test_result = 0/*STATUS_PASSED*/;
        if ( class_not_found_error ) {
            v_test_result = 2/*STATUS_FAILED*/;
        }
        else {
            out_stream.println
                ("--> methbyname_s004: number of checked methods = " + methods_for_check_number);
            if ( methodsByName_exceptions > 0 ) {
                out_stream.println
                    ("--> methbyname_s004: number of unexpected exceptions thrown by methodsByName(...) = "
                    + methodsByName_exceptions);
            }
            if ( not_found_methods_number > 0 ) {
                out_stream.println
                    ("--> methbyname_s004: number of methods not found by methodsByName(...) (empty List returned) = "
                    + not_found_methods_number);
            }
            if ( not_matched_methods_number > 0 ) {
                out_stream.println
                    ("--> methbyname_s004: number of returned by methodsByName(...) methods not matched to requested method = "
                    + not_matched_methods_number);
            }
            out_stream.println
                ("--> methbyname_s004: number of methods for which methodsByName(...) returned expected result = "
                + passed_methods_number);
        }
        if ( all_method_errors_number > 0 ) {
            v_test_result = 2/*STATUS_FAILED*/;
        }

        print_log_on_verbose("--> methbyname_s004: waiting for debugee finish...");
        pipe.println("quit");
        debugee.waitFor();

        int status = debugee.getStatus();
        if (status != 0/*STATUS_PASSED*/ + 95/*STATUS_TEMP*/) {
            out_stream.println
                ("##> methbyname_s004: UNEXPECTED Debugee's exit status (not 95) - " + status);
            v_test_result = 2/*STATUS_FAILED*/;
        }
        else {
            print_log_on_verbose
                ("--> methbyname_s004: expected Debugee's exit status - " + status);
        }

        return v_test_result;
    }
}
