/*******************************************************************************
* Copyright (c) 2000, 2014 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.debug.tests.breakpoints;
import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.dom.AST;
import org.eclipse.jdt.core.dom.ASTParser;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.debug.tests.AbstractDebugTest;
import org.eclipse.jdt.internal.debug.core.breakpoints.ValidBreakpointLocationLocator;
import org.eclipse.jface.text.Document;
/**
* Tests breakpoint location locator.
*/
public class BreakpointLocationVerificationTests extends AbstractDebugTest {
/**
* Constructor
* @param name
*/
public BreakpointLocationVerificationTests(String name) {
super(name);
}
/**
* Parses the specified <code>ICompilationUnit</code> into its respective
* <code>CompilationUnit</code>
* @param unit
* @return the parsed <code>CompilationUnit</code>
*/
private CompilationUnit parseCompilationUnit(ICompilationUnit unit) {
ASTParser parser = ASTParser.newParser(AST.JLS4);
parser.setSource(unit);
parser.setUnitName(unit.getElementName());
parser.setResolveBindings(true);
return (CompilationUnit) parser.createAST(null);
}
/**
* Tests that the predefined location is locatable in the specified type
* @param lineToTry
* @param expectedLineNumber
* @param expectedTypeName
* @throws JavaModelException
*/
private void testLocation(int lineToTry, int expectedLineNumber, String expectedTypeName) throws JavaModelException {
testLocation(lineToTry, expectedLineNumber, expectedTypeName, expectedTypeName, false);
}
/**
* Tests that the predefined location is locatable in the specified type
* @param lineToTry
* @param expectedLineNumber
* @param baseTypeName
* @param expectedTypeName
* @param bestmatch
* @throws JavaModelException
*/
private void testLocation(int lineToTry, int expectedLineNumber, String baseTypeName, String expectedTypeName, boolean bestmatch) throws JavaModelException {
IType type= get14Project().findType(baseTypeName);
assertNotNull("Cannot find type", type);
CompilationUnit compilationUnit= parseCompilationUnit(type.getCompilationUnit());
ValidBreakpointLocationLocator locator= new ValidBreakpointLocationLocator(compilationUnit, lineToTry, true, bestmatch);
compilationUnit.accept(locator);
int lineNumber= locator.getLineLocation();
assertEquals("Wrong line number", expectedLineNumber, lineNumber);
String typeName= locator.getFullyQualifiedTypeName();
if (typeName != null) {
typeName = typeName.replaceAll("\\$", ".");
}
if (lineNumber == -1) {
assertEquals("Wrong type name", null, typeName);
} else {
assertEquals("Wrong type name", expectedTypeName, typeName);
}
}
/**
* Tests setting a line breakpoint on a final field that is initialized
*
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
*
* @throws Exception
*/
public void testFinalFieldWithTypeDecl() throws Exception {
testLocation(14, 14, "FinalBreakpointLocations");
}
/**
* Tests setting a line breakpoint on a final field that is initialized looking for best match
*
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
*
* @throws Exception
*/
public void testFinalFieldWithTypeDecla() throws Exception {
testLocation(14, 14, "FinalBreakpointLocations", "FinalBreakpointLocations", true);
}
/**
* Tests setting a line breakpoint on an inner type member for the initializer of
* a final local field variable
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
*
* @throws Exception
*/
public void testFinalFieldWithTypeDecl3() throws Exception {
testLocation(17, 17, "FinalBreakpointLocations");
}
/**
* Tests setting a line breakpoint on an inner type member for the initializer of looking
* for best match
* a final local field variable
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
*
* @throws Exception
*/
public void testFinalFieldWithTypeDecl3a() throws Exception {
testLocation(17, 17, "FinalBreakpointLocations", "FinalBreakpointLocations", true);
}
/**
* Tests setting a line breakpoint on an inner-inner type member for the initializer of
* a final local field variable
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
*
* @throws Exception
*/
public void testFinalFieldWithTypeDecl4() throws Exception {
testLocation(20, 20, "FinalBreakpointLocations");
}
/**
* Tests setting a line breakpoint on an inner-inner type member for the initializer of
* a final local field variable looking for best match
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
*
* @throws Exception
*/
public void testFinalFieldWithTypeDecl4a() throws Exception {
testLocation(20, 20, "FinalBreakpointLocations", "FinalBreakpointLocations", true);
}
/**
* Tests setting a line breakpoint on a final field that has not been initialized
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
*
* @throws Exception
*/
public void testFinalFieldWithTypeDecl5() throws Exception {
testLocation(27, 30, "FinalBreakpointLocations");
}
/**
* Tests setting a line breakpoint on a final field that has not been initialized looking
* for best match
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
*
* @throws Exception
*/
public void testFinalFieldWithTypeDecl5a() throws Exception {
testLocation(27, 30, "FinalBreakpointLocations", "FinalBreakpointLocations", true);
}
/**
* Test line before type declaration
*
* @throws Exception
*/
public void testLineBeforeTypeDeclaration() throws Exception {
testLocation(9, 18, "BreakpointsLocation");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testLineMethodSignature() throws Exception {
testLocation(32, 33, "BreakpointsLocation");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testLineInInnerType() throws Exception {
testLocation(25, 25, "BreakpointsLocation.InnerClass");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testLineInAnnonymousType() throws Exception {
testLocation(39, 39, "BreakpointsLocation");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testLineAfterAllCode() throws Exception {
// ********* this test need to be updated every time BreakpointsLocation.java is modified *************
testLocation(82, -1, "BreakpointsLocation");
// ******************************
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testLineVariableDeclarationWithAssigment() throws Exception {
testLocation(43, 46, "BreakpointsLocation");
}
/**
* Tests that a breakpoint is not set on a final field
* @throws Exception
*/
public void testFieldLocationOnFinalField() throws Exception {
testLocation(13, 13, "org.eclipse.debug.tests.targets.BreakpointsLocationBug344984");
}
/**
* Tests that a breakpoint is not set on a final field looking
* for best match
* @throws Exception
*/
public void testFieldLocationOnFinalFielda() throws Exception {
testLocation(13, 13, "org.eclipse.debug.tests.targets.BreakpointsLocationBug344984", "org.eclipse.debug.tests.targets.BreakpointsLocationBug344984", true);
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testEmptyLabel() throws Exception {
testLocation(15, 16, "LabelTest");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testNestedEmptyLabels() throws Exception {
testLocation(19, 21, "LabelTest");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testLabelWithCode() throws Exception {
testLocation(21, 21, "LabelTest");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testLineFieldDeclarationWithAssigment() throws Exception {
testLocation(51, 55, "BreakpointsLocation");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testLineExpressionReplacedByConstant1() throws Exception {
testLocation(62, 62, "BreakpointsLocation");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testLineExpressionReplacedByConstant2() throws Exception {
testLocation(64, 62, "BreakpointsLocation");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testLineExpressionNotReplacedByConstant1() throws Exception {
testLocation(70, 70, "BreakpointsLocation");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testLineExpressionNotReplacedByConstant2() throws Exception {
testLocation(72, 72, "BreakpointsLocation");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testLineLitteral1() throws Exception {
testLocation(46, 46, "BreakpointsLocation");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testLineLitteral2() throws Exception {
testLocation(55, 55, "BreakpointsLocation");
}
/**
* Tests a specific breakpoint location
* @throws Exception
*/
public void testInnerStaticClass() throws Exception {
String version = get14Project().getOption(JavaCore.COMPILER_COMPLIANCE, false);
if(JavaCore.VERSION_1_5.equals(version) || JavaCore.VERSION_1_6.equals(version)) {
testLocation(79, 79, "BreakpointsLocation", "BreakpointsLocation.1StaticInnerClass", false);
}
else {
testLocation(79, 79, "BreakpointsLocation", "BreakpointsLocation.1.StaticInnerClass", false);
}
}
/**
* Tests that an specific field is locatable in a specific type at a given offset and line
* @param line
* @param offsetInLine
* @param expectedFieldName
* @param expectedTypeName
* @throws Exception
*/
public void testField(int line, int offsetInLine, String expectedFieldName, String expectedTypeName) throws Exception {
IType type= get14Project().findType("BreakpointsLocation");
assertNotNull("Cannot find type", type);
ICompilationUnit unit= type.getCompilationUnit();
CompilationUnit compilationUnit= parseCompilationUnit(unit);
int offset= new Document(unit.getSource()).getLineOffset(line - 1) + offsetInLine;
BreakpointFieldLocator locator= new BreakpointFieldLocator(offset);
compilationUnit.accept(locator);
String fieldName= locator.getFieldName();
assertEquals("Wrong File Name", expectedFieldName, fieldName);
String typeName= locator.getTypeName();
assertEquals("Wrong Type Name", expectedTypeName, typeName);
}
/**
* Tests that a specific filed is at the correct location
* @throws Exception
*/
public void testFieldLocationOnField() throws Exception {
testField(30, 20, "fList", "BreakpointsLocation");
}
/**
* Tests that a specific filed is at the correct location
* @throws Exception
*/
public void testFieldLocationNotOnField() throws Exception {
testField(33, 18, null, null);
}
/**
* Tests that a specific method is locatable in the specified type at the given offset and line
* @param line
* @param offsetInLine
* @param expectedMethodName
* @param expectedTypeName
* @param expectedMethodSignature
* @throws Exception
*/
public void testMethod(int line, int offsetInLine, String expectedMethodName, String expectedTypeName, String expectedMethodSignature) throws Exception {
IType type= get14Project().findType("BreakpointsLocation");
assertNotNull("Cannot find type", type);
ICompilationUnit unit= type.getCompilationUnit();
CompilationUnit compilationUnit= parseCompilationUnit(unit);
int offset= new Document(unit.getSource()).getLineOffset(line - 1) + offsetInLine;
BreakpointMethodLocator locator= new BreakpointMethodLocator(offset);
compilationUnit.accept(locator);
String methodName= locator.getMethodName();
assertEquals("Wrong method name", expectedMethodName, methodName);
String typeName= locator.getTypeName();
assertEquals("Wrong type name", expectedTypeName, typeName);
String methodSignature= locator.getMethodSignature();
assertEquals("Wrong method signature", expectedMethodSignature, methodSignature);
}
/**
* Tests that a specific method is locatable in a specific location
* @throws Exception
*/
public void testMethodOnSignature() throws Exception {
testMethod(17, 20, "test1", "BreakpointsLocation", "()V");
}
/**
* Tests that a specific method is locatable in a specific location
* @throws Exception
*/
public void testMethodOnCode() throws Exception {
testMethod(19, 17, "test1", "BreakpointsLocation", "()V");
}
/**
* Tests that a specific method is locatable in a specific location
* @throws Exception
*/
public void testMethodNotOnMethod() throws Exception {
testMethod(30, 1, null, null, null);
}
/**
* Tests that a specific method is locatable in a specific location
* @throws Exception
*/
public void testMethodOnMethodSignatureNotAvailable() throws Exception {
testMethod(32, 1, "test2", "BreakpointsLocation", null);
}
}