1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
/*******************************************************************************
* Copyright (c) 2013 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.ui.tests.packageHover;
import java.io.File;
import java.net.URL;
import junit.framework.Assert;
import junit.framework.Test;
import junit.framework.TestSuite;
import org.eclipse.jdt.testplugin.JavaProjectHelper;
import org.eclipse.jdt.testplugin.JavaTestPlugin;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.jface.text.Region;
import org.eclipse.jdt.core.IClasspathAttribute;
import org.eclipse.jdt.core.IClasspathEntry;
import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.IPackageFragment;
import org.eclipse.jdt.core.IPackageFragmentRoot;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.internal.core.JavaElement;
import org.eclipse.jdt.internal.corext.CorextMessages;
import org.eclipse.jdt.ui.tests.core.CoreTests;
import org.eclipse.jdt.ui.tests.core.ProjectTestSetup;
import org.eclipse.jdt.internal.ui.text.java.hover.JavadocBrowserInformationControlInput;
import org.eclipse.jdt.internal.ui.text.java.hover.JavadocHover;
/**
* Tests for fetching package Javadoc.
*
* @since 3.9
*/
public class PackageJavadocTests extends CoreTests {
public PackageJavadocTests(String name) {
super(name);
}
public static Test suite() {
return setUpTest(new TestSuite(PackageJavadocTests.class));
}
private IJavaProject fJProject1;
public void testGetDocFromPackageHtml_src() throws Exception {
File junitSrcArchive= JavaTestPlugin.getDefault().getFileInPlugin(new Path("testresources/PackageJavadocTests/JavadocHover_src.zip"));
assertTrue("junit src not found", junitSrcArchive != null && junitSrcArchive.exists());
JavaProjectHelper.addSourceContainerWithImport(fJProject1, "src", junitSrcArchive, JavaProjectHelper.JUNIT_SRC_ENCODING);
ICompilationUnit cu= (ICompilationUnit)fJProject1.findElement(new Path("junit/javadochoverhtml/JavaDocHoverTest.java"));
assertNotNull("JavaDocHoverTest.java", cu);
IPackageFragment pack= (IPackageFragment)cu.getParent();
IJavaElement[] elements= new JavaElement[1];
elements[0]= pack;
JavadocBrowserInformationControlInput hoverInfo= JavadocHover.getHoverInfo(elements, cu, new Region(21, 16), null);
String actualHtmlContent= hoverInfo.getHtml();
//checking for some part of the expected Javadoc which could be retrieved.
Assert.assertTrue(actualHtmlContent.contains("Test package documentation in package.html"));
}
public void testGetDocFromPackageInfoJava_src() throws Exception {
File junitSrcArchive= JavaTestPlugin.getDefault().getFileInPlugin(new Path("testresources/PackageJavadocTests/JavadocHover_src.zip"));
assertTrue("junit src not found", junitSrcArchive != null && junitSrcArchive.exists());
JavaProjectHelper.addSourceContainerWithImport(fJProject1, "src", junitSrcArchive, JavaProjectHelper.JUNIT_SRC_ENCODING);
ICompilationUnit cu= (ICompilationUnit)fJProject1.findElement(new Path("junit/javadochover/Activator.java"));
assertNotNull("Activator.java", cu);
IPackageFragment pack= (IPackageFragment)cu.getParent();
IJavaElement[] elements= new JavaElement[1];
elements[0]= pack;
JavadocBrowserInformationControlInput hoverInfo= JavadocHover.getHoverInfo(elements, cu, new Region(21, 12), null);
String actualHtmlContent= hoverInfo.getHtml();
Assert.assertTrue(actualHtmlContent.contains("This is the test content"));
}
public void testGetDocFromPackageHtml_archive() throws Exception {
File junitSrcArchive= JavaTestPlugin.getDefault().getFileInPlugin(new Path("testresources/PackageJavadocTests/JavadocHover_src.zip"));
assertTrue("junit src not found", junitSrcArchive != null && junitSrcArchive.exists());
JavaProjectHelper.addSourceContainerWithImport(fJProject1, "src", junitSrcArchive, JavaProjectHelper.JUNIT_SRC_ENCODING);
ICompilationUnit cu= (ICompilationUnit)fJProject1.findElement(new Path("junit/javadochoverhtml/JavaDocHoverTest.java"));
assertNotNull("JavaDocHoverTest.java", cu);
IPackageFragment pack= (IPackageFragment)cu.getParent();
IJavaElement[] elements= new JavaElement[1];
elements[0]= pack;
JavadocBrowserInformationControlInput hoverInfo= JavadocHover.getHoverInfo(elements, cu, new Region(67, 10), null);
String actualHtmlContent= hoverInfo.getHtml();
Assert.assertTrue(actualHtmlContent.contains("Test package documentation in package.html"));
}
public void testGetDocFromPackageInfoJava_archive() throws Exception {
File junitSrcArchive= JavaTestPlugin.getDefault().getFileInPlugin(new Path("testresources/PackageJavadocTests/JavadocHover_src.zip"));
assertTrue("junit src not found", junitSrcArchive != null && junitSrcArchive.exists());
JavaProjectHelper.addSourceContainerWithImport(fJProject1, "src", junitSrcArchive, JavaProjectHelper.JUNIT_SRC_ENCODING);
ICompilationUnit cu= (ICompilationUnit)fJProject1.findElement(new Path("junit/javadochoverhtml/JavaDocHoverTest.java"));
assertNotNull("JavaDocHoverTest.java", cu);
File clsJarPath= JavaTestPlugin.getDefault().getFileInPlugin(new Path("/testresources/PackageJavadocTests/testData.zip"));
File srcJarPath= JavaTestPlugin.getDefault().getFileInPlugin(new Path("/testresources/PackageJavadocTests/testData_src.zip"));
JavaProjectHelper.addLibraryWithImport(fJProject1, new Path(clsJarPath.getAbsolutePath()), new Path(srcJarPath.getAbsolutePath()), null);
fJProject1.open(null);
IPackageFragmentRoot jarRoot= this.fJProject1.getPackageFragmentRoot(ResourcesPlugin.getWorkspace().getRoot().getFile(new Path("/TestSetupProject/testData.zip")));
IPackageFragment packageFragment= jarRoot.getPackageFragment("org.eclipse.jdt.ui.tests");
assertNotNull(packageFragment);
IPath sourceAttachmentPath= jarRoot.getSourceAttachmentPath();
Assert.assertNotNull(sourceAttachmentPath);
int offset= cu.getSource().indexOf("org.eclipse.jdt.ui.tests");
int length= "org.eclipse.jdt.ui.tests".length();
IJavaElement[] codeSelect= cu.codeSelect(offset, length);
Assert.assertNotNull(codeSelect);
Assert.assertTrue("No package found !", codeSelect.length > 0);
packageFragment= (IPackageFragment)codeSelect[0];
JavadocBrowserInformationControlInput hoverInfo= JavadocHover.getHoverInfo(new IJavaElement[] { packageFragment }, cu, new Region(offset, length), null);
String actualHtmlContent= hoverInfo.getHtml();
Assert.assertTrue(actualHtmlContent.contains("This is the package documentation for org.eclipse.jdt.ui.tests"));
}
public void testGetDocFromSourceAttachmentRootPath() throws Exception {
File junitSrcArchive= JavaTestPlugin.getDefault().getFileInPlugin(new Path("testresources/PackageJavadocTests/JavadocHover_src.zip"));
assertTrue("junit src not found", junitSrcArchive != null && junitSrcArchive.exists());
JavaProjectHelper.addSourceContainerWithImport(fJProject1, "src", junitSrcArchive, JavaProjectHelper.JUNIT_SRC_ENCODING);
ICompilationUnit cu= (ICompilationUnit)fJProject1.findElement(new Path("junit/javadochoverhtml/JavaDocHoverTest.java"));
assertNotNull("JavaDocHoverTest.java", cu);
File clsJarPath= JavaTestPlugin.getDefault().getFileInPlugin(new Path("/testresources/PackageJavadocTests/testData.zip"));
File srcJarPath= JavaTestPlugin.getDefault().getFileInPlugin(new Path("/testresources/PackageJavadocTests/testData_src.zip"));
JavaProjectHelper.addLibraryWithImport(fJProject1, new Path(clsJarPath.getAbsolutePath()), new Path(srcJarPath.getAbsolutePath()), new Path("src"));
fJProject1.open(null);
IPackageFragmentRoot jarRoot= this.fJProject1.getPackageFragmentRoot(ResourcesPlugin.getWorkspace().getRoot().getFile(new Path("/TestSetupProject/testData.zip")));
Assert.assertTrue(jarRoot != null && jarRoot.exists());
IPackageFragment packageFragment= jarRoot.getPackageFragment("org.eclipse.jdt.ui.tests.html");
Assert.assertTrue(packageFragment != null && packageFragment.exists());
IPath sourceAttachmentPath= jarRoot.getSourceAttachmentPath();
Assert.assertNotNull(sourceAttachmentPath);
int offset= cu.getSource().indexOf("org.eclipse.jdt.ui.tests.html");
int length= "org.eclipse.jdt.ui.tests.html".length();
IJavaElement[] codeSelect= cu.codeSelect(offset, length);
Assert.assertNotNull(codeSelect);
Assert.assertTrue("No package found !", codeSelect.length > 0);
packageFragment= (IPackageFragment)codeSelect[0];
JavadocBrowserInformationControlInput hoverInfo= JavadocHover.getHoverInfo(new IJavaElement[] { packageFragment }, cu, new Region(offset, length), null);
String actualHtmlContent= hoverInfo.getHtml();
Assert.assertTrue(actualHtmlContent.contains("This is the package documentation for org.eclipse.jdt.ui.tests.html."));
}
public void testGetPackageAttacheddoc() throws Exception {
// http://download.oracle.com/javase/6/docs/api/
File junitSrcArchive= JavaTestPlugin.getDefault().getFileInPlugin(new Path("testresources/PackageJavadocTests/JavadocHover_src.zip"));
assertTrue("junit src not found", junitSrcArchive != null && junitSrcArchive.exists());
JavaProjectHelper.addSourceContainerWithImport(fJProject1, "src", junitSrcArchive, JavaProjectHelper.JUNIT_SRC_ENCODING);
ICompilationUnit cu= (ICompilationUnit)fJProject1.findElement(new Path("junit/javadochoverhtml/JavaDocHoverTest.java"));
assertNotNull("JavaDocHoverTest.java", cu);
IClasspathAttribute attribute=
JavaCore.newClasspathAttribute(
IClasspathAttribute.JAVADOC_LOCATION_ATTRIBUTE_NAME,
"url:http://download.oracle.com/javase/6/docs/api/");
IClasspathEntry[] rawClasspath= fJProject1.getRawClasspath();
IClasspathEntry newEntry= JavaCore.newLibraryEntry(new Path(JavaTestPlugin.getDefault().getFileInPlugin(new Path("/testresources/rtstubs15.jar")).getAbsolutePath()), null, null, null,
new IClasspathAttribute[] { attribute }, false);
rawClasspath[0]= newEntry;
IClasspathEntry[] newPathEntry= new IClasspathEntry[] { rawClasspath[0], rawClasspath[1] };
this.fJProject1.setRawClasspath(newPathEntry, null);
this.fJProject1.getResolvedClasspath(false);
int offset= cu.getSource().indexOf("java.math");
int length= "java.math".length();
IJavaElement[] codeSelect= cu.codeSelect(offset, length);
Assert.assertNotNull(codeSelect);
Assert.assertTrue("No package found !", codeSelect.length > 0);
JavadocBrowserInformationControlInput hoverInfo= JavadocHover.getHoverInfo(codeSelect, cu, new Region(offset, length), null);
String actualHtmlContent= hoverInfo.getHtml();
Assert.assertNotNull(actualHtmlContent);
try {
//trying to connect to the internet. Exception will be thrown if there is no net connection.
new URL("url:http://download.oracle.com/").openConnection().connect();
Assert.assertTrue(actualHtmlContent.contains("Provides classes for performing arbitrary-precision integer arithmetic"));
} catch (Exception e) {
//there is no internet connection, so the Javadoc cannot be retrieved.
Assert.assertTrue(actualHtmlContent.contains(CorextMessages.JavaDocLocations_noAttachedSource) || actualHtmlContent.contains(CorextMessages.JavaDocLocations_error_gettingJavadoc)
|| actualHtmlContent.contains(CorextMessages.JavaDocLocations_error_gettingAttachedJavadoc));
}
}
/**
* Package Javadoc hover throws NullPointerException if package-info.java contains references.
* This test case is to test the fix.
*
* @throws Exception when the test case fails
*/
public void testPackageInfoWithReferenceLinks() throws Exception {
File junitSrcArchive= JavaTestPlugin.getDefault().getFileInPlugin(new Path("testresources/PackageJavadocTests/JavadocHover_src.zip"));
assertTrue("junit src not found", junitSrcArchive != null && junitSrcArchive.exists());
JavaProjectHelper.addSourceContainerWithImport(fJProject1, "src", junitSrcArchive, JavaProjectHelper.JUNIT_SRC_ENCODING);
ICompilationUnit cu= (ICompilationUnit)fJProject1.findElement(new Path("junit/checkPackageInfo/TestNPEHover.java"));
assertNotNull("TestNPEHover.java", cu);
IPackageFragment pack= (IPackageFragment)cu.getParent();
IJavaElement[] elements= new JavaElement[1];
elements[0]= pack;
JavadocBrowserInformationControlInput hoverInfo= JavadocHover.getHoverInfo(elements, cu, new Region(21, 12), null);
String actualHtmlContent= hoverInfo.getHtml();
Assert.assertTrue(actualHtmlContent.contains("The pack is a test package. This doc contains references"));
}
public void testPackageWithNoJavadoc() throws Exception {
File junitSrcArchive= JavaTestPlugin.getDefault().getFileInPlugin(new Path("testresources/PackageJavadocTests/JavadocHover_src.zip"));
assertTrue("junit src not found", junitSrcArchive != null && junitSrcArchive.exists());
JavaProjectHelper.addSourceContainerWithImport(fJProject1, "src", junitSrcArchive, JavaProjectHelper.JUNIT_SRC_ENCODING);
ICompilationUnit cu= (ICompilationUnit)fJProject1.findElement(new Path("junit/javadochoverhtml/JavaDocHoverTest.java"));
assertNotNull("JavaDocHoverTest.java", cu);
File clsJarPath= JavaTestPlugin.getDefault().getFileInPlugin(new Path("/testresources/PackageJavadocTests/testData.zip"));
File srcJarPath= JavaTestPlugin.getDefault().getFileInPlugin(new Path("/testresources/PackageJavadocTests/testData_src.zip"));
JavaProjectHelper.addLibraryWithImport(fJProject1, new Path(clsJarPath.getAbsolutePath()), new Path(srcJarPath.getAbsolutePath()), new Path("src"));
fJProject1.open(null);
IPackageFragmentRoot jarRoot= this.fJProject1.getPackageFragmentRoot(ResourcesPlugin.getWorkspace().getRoot().getFile(new Path("/TestSetupProject/testData.zip")));
Assert.assertTrue(jarRoot != null && jarRoot.exists());
IPackageFragment packageFragment= jarRoot.getPackageFragment("org.eclipse.jdt.ui.tests.noJavadoc");
Assert.assertTrue(packageFragment != null && packageFragment.exists());
IPath sourceAttachmentPath= jarRoot.getSourceAttachmentPath();
Assert.assertNotNull(sourceAttachmentPath);
int offset= cu.getSource().indexOf("org.eclipse.jdt.ui.tests.noJavadoc");
int length= "org.eclipse.jdt.ui.tests.noJavadoc".length();
IJavaElement[] codeSelect= cu.codeSelect(offset, length);
Assert.assertNotNull(codeSelect);
Assert.assertTrue("No package found !", codeSelect.length > 0);
packageFragment= (IPackageFragment)codeSelect[0];
JavadocBrowserInformationControlInput hoverInfo= JavadocHover.getHoverInfo(new IJavaElement[] { packageFragment }, cu, new Region(offset, length), null);
String actualHtmlContent= hoverInfo.getHtml();
Assert.assertTrue(actualHtmlContent.contains(CorextMessages.JavaDocLocations_noAttachedJavadoc));
}
public void testErrotGettingAttachedJavadoc() throws Exception {
File junitSrcArchive= JavaTestPlugin.getDefault().getFileInPlugin(new Path("testresources/PackageJavadocTests/JavadocHover_src.zip"));
assertTrue("junit src not found", junitSrcArchive != null && junitSrcArchive.exists());
JavaProjectHelper.addSourceContainerWithImport(fJProject1, "src", junitSrcArchive, JavaProjectHelper.JUNIT_SRC_ENCODING);
ICompilationUnit cu= (ICompilationUnit)fJProject1.findElement(new Path("junit/javadochoverhtml/JavaDocHoverTest.java"));
assertNotNull("JavaDocHoverTest.java", cu);
//set a wrong Javadoc location URL
IClasspathAttribute attribute=
JavaCore.newClasspathAttribute(
IClasspathAttribute.JAVADOC_LOCATION_ATTRIBUTE_NAME,
"url:http://download.oracle.com/javase/6/docs/apii/");
IClasspathEntry[] rawClasspath= fJProject1.getRawClasspath();
IClasspathEntry newEntry= JavaCore.newLibraryEntry(new Path(JavaTestPlugin.getDefault().getFileInPlugin(new Path("/testresources/rtstubs15.jar")).getAbsolutePath()), null, null, null,
new IClasspathAttribute[] { attribute }, false);
rawClasspath[0]= newEntry;
IClasspathEntry[] newPathEntry= new IClasspathEntry[] { rawClasspath[0], rawClasspath[1] };
this.fJProject1.setRawClasspath(newPathEntry, null);
this.fJProject1.getResolvedClasspath(false);
int offset= cu.getSource().indexOf("java.math");
int length= "java.math".length();
IJavaElement[] codeSelect= cu.codeSelect(offset, length);
Assert.assertNotNull(codeSelect);
Assert.assertTrue("No package found !", codeSelect.length > 0);
JavadocBrowserInformationControlInput hoverInfo= JavadocHover.getHoverInfo(codeSelect, cu, new Region(offset, length), null);
String actualHtmlContent= hoverInfo.getHtml();
Assert.assertNotNull(actualHtmlContent);
Assert.assertTrue(actualHtmlContent.contains(CorextMessages.JavaDocLocations_error_gettingAttachedJavadoc));
}
public static Test setUpTest(Test test) {
return new ProjectTestSetup(test);
}
@Override
protected void setUp() throws Exception {
fJProject1= ProjectTestSetup.getProject();
}
@Override
protected void tearDown() throws Exception {
JavaProjectHelper.clear(fJProject1, ProjectTestSetup.getDefaultClasspath());
}
}
|
