test/hotspot/jtreg/vmTestbase/nsk/jdi/ReferenceType/getValues/getvalues003.java

/*
 * Copyright (c) 2002, 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.getValues;

import com.sun.jdi.*;
import com.sun.jdi.event.*;
import com.sun.jdi.request.*;

import java.util.*;
import java.io.*;

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

/**
 * The test checks that the JDI method
 * <code>com.sun.jdi.ReferenceType.getValues()</code>
 * properly throws <i>IllegalArgumentException</i> - if any field is
 * not valid for this object's class.<p>
 *
 * Debuggee part of the test consists of the following classes:
 * <i>getvalues003t</i> inside a main package, and <i>getvalues003ta</i>
 * outside the package.<br>
 * The exception is provoked to be thrown by getting a Map of values
 * which correspond to a list containing wrong fields such as:<br>
 * <li>private fields obtained from the getvalues003ta but applied to
 * reference type of the getvalues003t
 * <li>default-access fields from the getvalues003ta but applied to
 * reference type of the getvalues003t
 * <li>protected fields from the getvalues003ta but applied to reference
 * type of the getvalues003t.
 */
public class getvalues003 {
    static final String DEBUGGEE_CLASSES[] = {
        "nsk.jdi.ReferenceType.getValues.getvalues003t",
        "nsk.jdi.ReferenceType.dummyPackage.getvalues003a"
    };

    // debuggee source line where it should be stopped
    static final int DEBUGGEE_STOPATLINE = 56;

    static final int LST_NUM = 3; // number of lists
    static final int FLD_NUM = 8; // number of fields in particular list
    // tested fields used to provoke the exception and
    // type reference numbers for applying/obtaining a Field
    static final String DEBUGGEE_FLDS[][][] = {
       {{"boolFld", "0", "1", "default-access"},
        {"byteFld", "0", "1", "default-access"},
        {"charFld", "0", "1", "default-access"},
        {"doubleFld", "0", "1", "default-access"},
        {"floatFld", "0", "1", "default-access"},
        {"intFld", "0", "1", "default-access"},
        {"longFld", "0", "1", "default-access"},
        {"shortFld", "0", "1", "default-access"}},

       {{"boolPrFld", "0", "1", "private"},
        {"bytePrFld", "0", "1", "private"},
        {"charPrFld", "0", "1", "private"},
        {"doublePrFld", "0", "1", "private"},
        {"floatPrFld", "0", "1", "private"},
        {"intPrFld", "0", "1", "private"},
        {"longPrFld", "0", "1", "private"},
        {"shortPrFld", "0", "1", "private"}},

       {{"boolProtFld", "0", "1", "protected"},
        {"byteProtFld", "0", "1", "protected"},
        {"charProtFld", "0", "1", "protected"},
        {"doubleProtFld", "0", "1", "protected"},
        {"floatProtFld", "0", "1", "protected"},
        {"intProtFld", "0", "1", "protected"},
        {"longProtFld", "0", "1", "protected"},
        {"shortProtFld", "0", "1", "protected"}}
    };

    static final String COMMAND_READY = "ready";
    static final String COMMAND_GO = "go";
    static final String COMMAND_QUIT = "quit";

    static final int DELAY = 500; // in milliseconds

    private ArgumentHandler argHandler;
    private Log log;
    private IOPipe pipe;
    private Debugee debuggee;
    private VirtualMachine vm;
    private volatile int tot_res = Consts.TEST_PASSED;
    private BreakpointRequest BPreq;
    private volatile boolean gotEvent = false;

    public static void main (String argv[]) {
        System.exit(run(argv, System.out) + Consts.JCK_STATUS_BASE);
    }

    public static int run(String argv[], PrintStream out) {
        return new getvalues003().runIt(argv, out);
    }

    private int runIt(String args[], PrintStream out) {
        argHandler = new ArgumentHandler(args);
        log = new Log(out, argHandler);
        Binder binder = new Binder(argHandler, log);

        debuggee = binder.bindToDebugee(DEBUGGEE_CLASSES[0]);
        pipe = debuggee.createIOPipe();
        vm = debuggee.VM();
        debuggee.redirectStderr(log, "getvalues003t.err> ");
        debuggee.resume();
        String cmd = pipe.readln();
        if (!cmd.equals(COMMAND_READY)) {
            log.complain("TEST BUG: unknown debuggee command: " + cmd);
            tot_res = Consts.TEST_FAILED;
            return quitDebuggee();
        }

        try {
            ReferenceType[] rType = new ReferenceType[2];
            // debuggee main & dummy classes
            rType[0] = debuggee.classByName(DEBUGGEE_CLASSES[0]);
            rType[1] = debuggee.classByName(DEBUGGEE_CLASSES[1]);

            // suspend debuggee VM at breakpoint
            suspendAtBP(rType[0], DEBUGGEE_STOPATLINE);

            for (int l=0; l<LST_NUM; l++) {
                log.display("\n" + (l+1)
                    + ") Constructing a list of debuggee fields ...");
                ArrayList<Field> flds = new ArrayList<Field>();
                int appIx = 0;
                int obtIx = 0;


                for (int i=0; i<FLD_NUM; i++) {
                    // get reference type ##
                    appIx = Integer.parseInt(DEBUGGEE_FLDS[l][i][1]);
                    obtIx = Integer.parseInt(DEBUGGEE_FLDS[l][i][2]);

                    Field fld = rType[obtIx].fieldByName(DEBUGGEE_FLDS[l][i][0]);
                    log.display("\tAdding " + DEBUGGEE_FLDS[l][i][3]
                        + " field #" + (i+1) + ": \""
                        + fld.name() + " " + fld.signature()
                        + "\"\n\t\tobtained from reference type \""
                        + rType[obtIx]
                        + "\"\n\t\tand applied to reference type \""
                        + rType[appIx] + "\" ...");
                    flds.add(fld);
                }

                // Check the tested assersion
                try {
                    log.display("\tTrying to get a Map containing Value of each field in the list"
                        + "\n\t\tusing reference type \""
                        + rType[appIx] + "\" ...");

                    Map<Field, Value> valMap = rType[appIx].getValues(flds);

                    log.complain("TEST FAILED: expected IllegalArgumentException was not thrown"
                        + "\n\twhen attempted to get a Map containing Value of each field in the list"
                        + "\n\t\tusing reference type \""
                        + rType[appIx] + "\",\n\t\tand the fields are not valid");
                    tot_res = Consts.TEST_FAILED;
                } catch (IllegalArgumentException ee) {
                    log.display("CHECK PASSED: caught expected " + ee);
                } catch (Exception ue) {
                    ue.printStackTrace();
                    log.complain("TEST FAILED: caught unexpected "
                        + ue + "\n\tinstead of expected IllegalArgumentException"
                        + "\n\twhen attempted to get a Map containing Value of each field in the list"
                        + "\"\n\t\tusing reference type \""
                        + rType[appIx] + "\",\n\t\tand the fields are not valid");
                    tot_res = Consts.TEST_FAILED;
                }

            }
        } catch (Exception e) {
            e.printStackTrace();
            log.complain("TEST FAILURE: caught unexpected exception: " + e);
            tot_res = Consts.TEST_FAILED;
        }

// Finish the test
        return quitDebuggee();
    }

    private BreakpointRequest setBP(ReferenceType refType, int bpLine) {
        EventRequestManager evReqMan =
            debuggee.getEventRequestManager();
        Location loc;

        try {
            List locations = refType.allLineLocations();
            Iterator iter = locations.iterator();
            while (iter.hasNext()) {
                loc = (Location) iter.next();
                if (loc.lineNumber() == bpLine) {
                    BreakpointRequest BPreq =
                        evReqMan.createBreakpointRequest(loc);
                    BPreq.setSuspendPolicy(EventRequest.SUSPEND_EVENT_THREAD);
                    log.display("created " + BPreq + "\n\tfor " + refType
                        + " ; line=" + bpLine);
                    return BPreq;
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
            throw new Failure("setBP: caught unexpected exception: " + e);
        }
        throw new Failure("setBP: location corresponding debuggee source line "
            + bpLine + " not found");
    }

    private void suspendAtBP(ReferenceType rType, int bpLine) {

// Class containing a critical section which may lead to time out of the test
        class CriticalSection extends Thread {
            public volatile boolean waitFor = true;

            public void run() {
                try {
                    do {
                        EventSet eventSet = vm.eventQueue().remove(DELAY);
                        if (eventSet != null) { // it is not a timeout
                            EventIterator it = eventSet.eventIterator();
                            while (it.hasNext()) {
                                Event event = it.nextEvent();
                                if (event instanceof VMDisconnectEvent) {
                                    log.complain("TEST FAILED: unexpected VMDisconnectEvent");
                                    break;
                                } else if (event instanceof VMDeathEvent) {
                                    log.complain("TEST FAILED: unexpected VMDeathEvent");
                                    break;
                                } else if (event instanceof BreakpointEvent) {
                                    if (event.request().equals(BPreq)) {
                                        log.display("expected Breakpoint event occured: "
                                            + event.toString());
                                        gotEvent = true;
                                        return;
                                    }
                                } else
                                    log.display("following JDI event occured: "
                                        + event.toString());
                            }
                        }
                    } while(waitFor);
                    log.complain("TEST FAILED: no expected Breakpoint event");
                    tot_res = Consts.TEST_FAILED;
                } catch (Exception e) {
                    e.printStackTrace();
                    tot_res = Consts.TEST_FAILED;
                    log.complain("TEST FAILED: caught unexpected exception: " + e);
                }
            }
        }
/////////////////////////////////////////////////////////////////////////////

        BPreq = setBP(rType, bpLine);
        BPreq.enable();
        CriticalSection critSect = new CriticalSection();
        log.display("\nStarting potential timed out section:\n\twaiting "
            + (argHandler.getWaitTime())
            + " minute(s) for JDI Breakpoint event ...\n");
        critSect.start();
        pipe.println(COMMAND_GO);
        try {
            critSect.join((argHandler.getWaitTime())*60000);
            if (critSect.isAlive()) {
                critSect.waitFor = false;
                throw new Failure("timeout occured while waiting for Breakpoint event");
            }
        } catch (InterruptedException e) {
            critSect.waitFor = false;
            throw new Failure("TEST INCOMPLETE: InterruptedException occured while waiting for Breakpoint event");
        } finally {
            BPreq.disable();
        }
        log.display("\nPotential timed out section successfully passed\n");
        if (gotEvent == false)
            throw new Failure("unable to suspend debuggee thread at breakpoint");
    }

    private int quitDebuggee() {
        log.display("\nFinal resumption of the debuggee VM");
        vm.resume();
        pipe.println(COMMAND_QUIT);
        debuggee.waitFor();
        int debStat = debuggee.getStatus();
        if (debStat != (Consts.JCK_STATUS_BASE + Consts.TEST_PASSED)) {
            log.complain("TEST FAILED: debuggee process finished with status: "
                + debStat);
            tot_res = Consts.TEST_FAILED;
        } else
            log.display("\nDebuggee process finished with the status: "
                + debStat);

        return tot_res;
    }
}