test/hotspot/jtreg/vmTestbase/nsk/jdwp/ArrayReference/SetValues/setvalues001.java
changeset 50317 cf71bff5f533
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/hotspot/jtreg/vmTestbase/nsk/jdwp/ArrayReference/SetValues/setvalues001.java	Wed May 30 20:54:45 2018 -0700
@@ -0,0 +1,346 @@
+/*
+ * Copyright (c) 2001, 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.jdwp.ArrayReference.SetValues;
+
+import java.io.*;
+
+import nsk.share.*;
+import nsk.share.jpda.*;
+import nsk.share.jdwp.*;
+
+/**
+ * Test for JDWP command: ArrayReference.SetValues.
+ *
+ * See setvalues001.README for description of test execution.
+ *
+ * Test is executed by invoking method runIt().
+ * JDWP command is tested in method testCommand().
+ *
+ * @see #runIt()
+ * @see #testCommand()
+ */
+public class setvalues001 {
+
+    // exit status constants
+    static final int JCK_STATUS_BASE = 95;
+    static final int PASSED = 0;
+    static final int FAILED = 2;
+
+    // communication signals constants
+    static final String READY = "ready";
+    static final String RUN = "run";
+    static final String DONE = "done";
+    static final String ERROR = "error";
+    static final String QUIT = "quit";
+
+    // package and classes names constants
+    static final String PACKAGE_NAME = "nsk.jdwp.ArrayReference.SetValues";
+    static final String TEST_CLASS_NAME = PACKAGE_NAME + "." + "setvalues001";
+    static final String DEBUGEE_CLASS_NAME = TEST_CLASS_NAME + "a";
+
+    // tested JDWP command constants
+    static final String JDWP_COMMAND_NAME = "ArrayReference.SetValues";
+    static final int JDWP_COMMAND_ID = JDWP.Command.ArrayReference.SetValues;
+
+    // tested class name and signature constants
+    static final String TESTED_CLASS_NAME = DEBUGEE_CLASS_NAME + "$" + "TestedClass";
+    static final String TESTED_CLASS_SIGNATURE = "L" + TESTED_CLASS_NAME.replace('.', '/') + ";";
+
+    // name of the static field in the tested class with the tested object value
+    static final String ARRAY_FIELD_NAME = setvalues001a.ARRAY_FIELD_NAME;
+
+    // length, first index and number of array components to get
+    static final int ARRAY_LENGTH = setvalues001a.ARRAY_LENGTH;
+    static final int ARRAY_FIRST_INDEX = setvalues001a.ARRAY_FIRST_INDEX;
+    static final int ARRAY_ITEMS_COUNT = setvalues001a.ARRAY_ITEMS_COUNT;
+
+    // usual scaffold objects
+    ArgumentHandler argumentHandler = null;
+    Log log = null;
+    Binder binder = null;
+    Debugee debugee = null;
+    Transport transport = null;
+    IOPipe pipe = null;
+
+    // test passed or not
+    boolean success = true;
+
+    // -------------------------------------------------------------------
+
+    /**
+     * Start test from command line.
+     */
+    public static void main (String argv[]) {
+        System.exit(run(argv,System.out) + JCK_STATUS_BASE);
+    }
+
+    /**
+     * Start JCK-compilant test.
+     */
+    public static int run(String argv[], PrintStream out) {
+        return new setvalues001().runIt(argv, out);
+    }
+
+    // -------------------------------------------------------------------
+
+    /**
+     * Perform test execution.
+     */
+    public int runIt(String argv[], PrintStream out) {
+
+        // make log for debugger messages
+        argumentHandler = new ArgumentHandler(argv);
+        log = new Log(out, argumentHandler);
+
+        // execute test and display results
+        try {
+            log.display("\n>>> Preparing debugee for testing \n");
+
+            // launch debugee
+            binder = new Binder(argumentHandler, log);
+            log.display("Launching debugee");
+            debugee = binder.bindToDebugee(DEBUGEE_CLASS_NAME);
+            transport = debugee.getTransport();
+            pipe = debugee.createIOPipe();
+
+            // make debuggee ready for testing
+            prepareDebugee();
+
+            // work with prepared debugee
+            try {
+                log.display("\n>>> Obtaining requred data from debugee \n");
+
+                // query debugee for TypeID of tested class
+                log.display("Getting ReferenceTypeID by signature:\n"
+                            + "  " + TESTED_CLASS_SIGNATURE);
+                long classID = debugee.getReferenceTypeID(TESTED_CLASS_SIGNATURE);
+                log.display("  got classID: " + classID);
+
+                // query debuggee for arrayID value from static field
+                log.display("Getting arrayID value from static field: "
+                            + ARRAY_FIELD_NAME);
+                long arrayID = queryObjectID(classID,
+                            ARRAY_FIELD_NAME, JDWP.Tag.ARRAY);
+                log.display("  got arrayID: " + arrayID);
+
+                // perform testing JDWP command
+                log.display("\n>>> Testing JDWP command \n");
+                testCommand(arrayID);
+
+                // check confirmation from debuggee that values have been set correctly
+                log.display("\n>>> Checking that the values have been set correctly \n");
+                checkValuesChanged();
+
+            } finally {
+                // quit debugee
+                log.display("\n>>> Finishing test \n");
+                quitDebugee();
+            }
+
+        } catch (Failure e) {
+            log.complain("TEST FAILED: " + e.getMessage());
+            e.printStackTrace(out);
+            success = false;
+        } catch (Exception e) {
+            log.complain("Caught unexpected exception:\n" + e);
+            e.printStackTrace(out);
+            success = false;
+        }
+
+        if (!success) {
+            log.complain("TEST FAILED");
+            return FAILED;
+        }
+
+        out.println("TEST PASSED");
+        return PASSED;
+
+    }
+
+    /**
+     * Prepare debugee for testing and waiting for ready signal.
+     */
+    void prepareDebugee() {
+        // wait for VM_INIT event from debugee
+        log.display("Waiting for VM_INIT event");
+        debugee.waitForVMInit();
+
+        // query debugee for VM-dependent ID sizes
+        log.display("Querying for IDSizes");
+        debugee.queryForIDSizes();
+
+        // resume initially suspended debugee
+        log.display("Resuming debugee VM");
+        debugee.resume();
+
+        // wait for READY signal from debugee
+        log.display("Waiting for signal from debugee: " + READY);
+        String signal = pipe.readln();
+        log.display("Received signal from debugee: " + signal);
+        if (! signal.equals(READY)) {
+            throw new TestBug("Unexpected signal received form debugee: " + signal
+                            + " (expected: " + READY + ")");
+        }
+    }
+
+    /**
+     * Sending debugee signal to quit and waiting for it exits.
+     */
+    void quitDebugee() {
+        // send debugee signal to quit
+        log.display("Sending signal to debugee: " + QUIT);
+        pipe.println(QUIT);
+
+        // wait for debugee exits
+        log.display("Waiting for debugee exits");
+        int code = debugee.waitFor();
+
+        // analize debugee exit status code
+        if (code == JCK_STATUS_BASE + PASSED) {
+            log.display("Debugee PASSED with exit code: " + code);
+        } else {
+            log.complain("Debugee FAILED with exit code: " + code);
+            success = false;
+        }
+    }
+
+    /**
+     * Query debuggee for objectID value of static class field.
+     */
+    long queryObjectID(long classID, String fieldName, byte tag) {
+        // get fieledID for static field (declared in the class)
+        long fieldID = debugee.getClassFieldID(classID, fieldName, true);
+        // get value of the field
+        JDWP.Value value = debugee.getStaticFieldValue(classID, fieldID);
+
+        // check that value has THREAD tag
+        if (value.getTag() != tag) {
+            throw new Failure("Wrong objectID tag received from field \"" + fieldName
+                            + "\": " + value.getTag() + " (expected: " + tag + ")");
+        }
+
+        // extract threadID from the value
+        long objectID = ((Long)value.getValue()).longValue();
+        return objectID;
+    }
+
+    /**
+     * Perform testing JDWP command for specified objectID.
+     */
+    void testCommand(long arrayID) {
+        // create command packet
+        log.display("Create command packet:");
+        log.display("Command: " + JDWP_COMMAND_NAME);
+        CommandPacket command = new CommandPacket(JDWP_COMMAND_ID);
+
+        // add out data to the command packet
+        log.display("  arrayID: " + arrayID);
+        command.addObjectID(arrayID);
+        log.display("  firstIndex: " + ARRAY_FIRST_INDEX);
+        command.addInt(ARRAY_FIRST_INDEX);
+        log.display("  values: " + ARRAY_ITEMS_COUNT);
+        command.addInt(ARRAY_ITEMS_COUNT);
+        // add new int values for array components
+        for (int i = ARRAY_FIRST_INDEX; i < ARRAY_FIRST_INDEX + ARRAY_ITEMS_COUNT; i++) {
+            int intValue = i * 100 + 1;
+            JDWP.UntaggedValue value = new JDWP.UntaggedValue(new Integer(intValue));
+            log.display("  untagged_value: " + value);
+            command.addUntaggedValue(value, JDWP.Tag.INT);
+        }
+        command.setLength();
+
+        // send command packet to debugee
+        try {
+            log.display("Sending command packet:\n" + command);
+            transport.write(command);
+        } catch (IOException e) {
+            log.complain("Unable to send command packet:\n" + e);
+            success = false;
+            return;
+        }
+
+        ReplyPacket reply = new ReplyPacket();
+
+        // receive reply packet from debugee
+        try {
+            log.display("Waiting for reply packet");
+            transport.read(reply);
+            log.display("Reply packet received:\n" + reply);
+        } catch (IOException e) {
+            log.complain("Unable to read reply packet:\n" + e);
+            success = false;
+            return;
+        }
+
+        // check reply packet header
+        try{
+            log.display("Checking reply packet header");
+            reply.checkHeader(command.getPacketID());
+        } catch (BoundException e) {
+            log.complain("Bad header of reply packet: " + e.getMessage());
+            success = false;
+        }
+
+        // start parsing reply packet data
+        log.display("Parsing reply packet:");
+        reply.resetPosition();
+
+        // no reply data to extract
+
+        // check for extra data in reply packet
+        if (! reply.isParsed()) {
+            log.complain("Extra trailing bytes found in reply packet at: "
+                        + "0x" + reply.toHexString(reply.currentDataPosition(), 4));
+            success = false;
+        }
+    }
+
+    /**
+     * Check confirmation from debuggee that values are changed correctly.
+     */
+    void checkValuesChanged() {
+        // send debugee signal RUN
+        log.display("Sending signal to debugee: " + RUN);
+        pipe.println(RUN);
+
+        // wait for DONE signal from debugee
+        log.display("Waiting for signal from debugee: " + DONE);
+        String signal = pipe.readln();
+        log.display("Received signal from debugee: " + signal);
+
+        // check received signal
+        if (signal == null) {
+            throw new TestBug("<null> signal received from debugee: " + signal
+                            + " (expected: " + DONE + ")");
+        } else if (signal.equals(DONE)) {
+            log.display("All array values have been correctly set into debuggee VM");
+        } else if (signal.equals(ERROR)) {
+            log.complain("Not all array values have been correctly set into debuggee VM");
+            success = false;
+        } else {
+            throw new TestBug("Unexpected signal received from debugee: " + signal
+                            + " (expected: " + DONE + ")");
+        }
+    }
+}