/*
* 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.jdi.Method.locationOfCodeIndex;
import nsk.share.*;
import nsk.share.jpda.*;
import nsk.share.jdi.*;
import com.sun.jdi.*;
import java.util.*;
import java.io.*;
/**
* The test for the implementation of an object of the type
* Method.
*
* The test checks up that results of the method
* com.sun.jdi.Method.locationOfCodeIndex()
* complies with its spec for non-abstract, non-native method.
* The test works as follows.
* In a debuggee, a TestClass contains a "testedmethod".
* After getting a mirror of the testedmethod, a debugger gets
* a List allLineLocations containing executable lines of
* the method, and performs a loop on the List, in which it
* each element in the List is equal to a Location object
* getting with call to the method locationOfCodeIndex().
* Since the method allLineLocations returnes a list of executable
* lines the check that the method locationOfCodeIndex()
* doesn't return null is also perfomed.
*/
public class locationofcodeindex001 {
//----------------------------------------------------- templete section
static final int PASSED = 0;
static final int FAILED = 2;
static final int PASS_BASE = 95;
//----------------------------------------------------- templete parameters
static final String
sHeader1 = "\n==> nsk/jdi/Method/locationOfCodeIndex/locationofcodeindex001 ",
sHeader2 = "--> debugger: ",
sHeader3 = "##> debugger: ";
//----------------------------------------------------- main method
public static void main (String argv[]) {
int result = run(argv, System.out);
System.exit(result + PASS_BASE);
}
public static int run (String argv[], PrintStream out) {
return new locationofcodeindex001().runThis(argv, out);
}
//-------------------------------------------------- log procedures
private static Log logHandler;
private static void log1(String message) {
logHandler.display(sHeader1 + message);
}
private static void log2(String message) {
logHandler.display(sHeader2 + message);
}
private static void log3(String message) {
logHandler.complain(sHeader3 + message);
}
// ************************************************ test parameters
private String debuggeeName =
"nsk.jdi.Method.locationOfCodeIndex.locationofcodeindex001a";
private String testedClassName =
"nsk.jdi.Method.locationOfCodeIndex.TestClass";
//String mName = "nsk.jdi.Method.locationOfCodeIndex";
//====================================================== test program
//------------------------------------------------------ common section
static ArgumentHandler argsHandler;
static int waitTime;
static VirtualMachine vm = null;
ReferenceType testedclass = null;
static int testExitCode = PASSED;
static final int returnCode0 = 0;
static final int returnCode1 = 1;
static final int returnCode2 = 2;
static final int returnCode3 = 3;
static final int returnCode4 = 4;
//------------------------------------------------------ methods
private int runThis (String argv[], PrintStream out) {
Debugee debuggee;
argsHandler = new ArgumentHandler(argv);
logHandler = new Log(out, argsHandler);
Binder binder = new Binder(argsHandler, logHandler);
if (argsHandler.verbose()) {
debuggee = binder.bindToDebugee(debuggeeName + " -vbs");
} else {
debuggee = binder.bindToDebugee(debuggeeName);
}
waitTime = argsHandler.getWaitTime();
IOPipe pipe = new IOPipe(debuggee);
debuggee.redirectStderr(out);
log2("issuspended002a debuggee launched");
debuggee.resume();
String line = pipe.readln();
if ((line == null) || !line.equals("ready")) {
log3("signal received is not 'ready' but: " + line);
return FAILED;
} else {
log2("'ready' recieved");
}
vm = debuggee.VM();
//------------------------------------------------------ testing section
log1(" TESTING BEGINS");
for (int i = 0; ; i++) {
pipe.println("newcheck");
line = pipe.readln();
if (line.equals("checkend")) {
log2(" : returned string is 'checkend'");
break ;
} else if (!line.equals("checkready")) {
log3("ERROR: returned string is not 'checkready'");
testExitCode = FAILED;
break ;
}
log1("new checkready: #" + i);
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ variable part
String testedMethod = "testedmethod";
List methods = null;
Method m = null;
List locations = null;
log2(" getting: List classes = vm.classesByName(testedClassName);");
List classes = vm.classesByName(testedClassName);
if (classes.size() != 1) {
testExitCode = FAILED;
log3("ERROR: classes.size() != 1");
break ;
}
log2(" getting a tested method object 'm'");
methods = ((ReferenceType) classes.get(0)).methodsByName(testedMethod);
m = (Method) methods.get(0);
log2("......locations = m.allLineLocations(); no AbsentInformationException is expected");
try {
locations = m.allLineLocations();
} catch ( AbsentInformationException e ) {
testExitCode = FAILED;
log3("ERROR: AbsentInformationException");
log3(" ATTENTION: see the README file to this test");
break ;
}
log2("......checking up on a value of locations.size(); 0 is not expected");
if (locations.size() == 0) {
testExitCode = FAILED;
log3("ERROR: locations.size() == 0");
break ;
}
log2(" getting: ListIterator li = locations.listIterator();");
ListIterator li = locations.listIterator();
Location loc1 = null;
Location loc2 = null;
long codeIndex;
log2("......loop of testing elements in allLineLocations");
for (int ifor = 1; li.hasNext(); ifor++) {
loc1 = (Location) li.next();
codeIndex = loc1.codeIndex();
loc2 = m.locationOfCodeIndex(codeIndex);
if (loc2 == null) {
log3("ERROR: a location in allLineLocations == null; element in List: " + ifor);
testExitCode = FAILED;
} else {
if (!loc2.equals(loc1)) {
log3("ERROR: !loc2.equals(loc1); element in List: " + ifor);
testExitCode = FAILED;
}
}
}
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
}
log1(" TESTING ENDS");
//-------------------------------------------------- test summary section
//------------------------------------------------- standard end section
pipe.println("quit");
log2("waiting for the debuggee to finish ...");
debuggee.waitFor();
int status = debuggee.getStatus();
if (status != PASSED + PASS_BASE) {
log3("debuggee returned UNEXPECTED exit status: " +
status + " != PASS_BASE");
testExitCode = FAILED;
} else {
log2("debuggee returned expected exit status: " +
status + " == PASS_BASE");
}
if (testExitCode != PASSED) {
logHandler.complain("TEST FAILED");
}
return testExitCode;
}
}