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
|
/*******************************************************************************
* Copyright (c) 2009, 2016 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ua.tests.help.other;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import org.eclipse.help.IIndexSee;
import org.eclipse.help.IIndexSubpath;
import org.eclipse.help.internal.base.BaseHelpSystem;
import org.eclipse.help.internal.index.IndexEntry;
import org.eclipse.help.internal.index.IndexSee;
import org.eclipse.ua.tests.help.util.DocumentCreator;
import org.junit.Before;
import org.junit.Test;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
public class IndexSeeTest {
private static final String AGUILA = "\u00E1guila"; // 00E1 is an accented letter 'a'
private static final String ECLIPSE = "eclipse";
private static final String SDK = "sdk";
private static final String VIEWS = "views";
private static final String SEE_END = "</see>";
private static final String SEE_HEAD_ECLIPSE = "<see keyword=\"eclipse\">";
private static final String SEE_ECLIPSE = "<see keyword=\"eclipse\"/>";
private static final String SEE_SDK = "<see keyword=\"sdk\"/>";
private static final String SUBPATH_SDK = "<subpath keyword=\"sdk\">";
private static final String SUBPATH_VIEWS = "<subpath keyword=\"views\">";
private static final String SUBPATH_END = "</subpath>";
private static final String SEE_ECLIPSE_SDK = SEE_HEAD_ECLIPSE +
SUBPATH_SDK + SUBPATH_END + SEE_END;
private static final String SEE_ECLIPSE_VIEWS = SEE_HEAD_ECLIPSE +
SUBPATH_SDK + SUBPATH_END + SUBPATH_VIEWS + SUBPATH_END + SEE_END;
private static final String SEE_ECLIPSE_SDK_VIEWS = SEE_HEAD_ECLIPSE +
SUBPATH_SDK + SUBPATH_END + SUBPATH_VIEWS + SUBPATH_END + SEE_END;
@Before
public void setUp() throws Exception {
BaseHelpSystem.setMode(BaseHelpSystem.MODE_WORKBENCH);
}
private IndexSee createSee(final String elementSource) {
IndexSee element;
Document doc;
try {
doc = DocumentCreator.createDocument(elementSource);
} catch (Exception e) {
fail("Caught Exception");
doc = null;
}
element = new IndexSee((Element) doc.getFirstChild());
return element;
}
private IndexSee createSimpleSee(final String keyword) {
IndexSee element;
Document doc;
String elementSource = "<see keyword=\"" + keyword + "\" />";
try {
doc = DocumentCreator.createDocument(elementSource);
} catch (Exception e) {
fail("Caught Exception");
doc = null;
}
element = new IndexSee((Element) doc.getFirstChild());
return element;
}
@Test
public void testSimpleIndexSee() {
IndexSee see;
see = createSee(SEE_ECLIPSE);
assertEquals(ECLIPSE, see.getKeyword());
}
@Test
public void testCopySimpleIndexSee() {
IndexSee see1;
see1 = createSee(SEE_ECLIPSE);
IndexSee see2 = new IndexSee(see1);
assertEquals(ECLIPSE, see1.getKeyword());
assertEquals(0, see1.getSubpathElements().length);
assertEquals(ECLIPSE, see1.getKeyword());
assertEquals(ECLIPSE, see2.getKeyword());
assertEquals(0, see2.getSubpathElements().length);
assertEquals(ECLIPSE, see2.getKeyword());
}
@Test
public void testCopyIndexSeeWithSubpath() {
IndexSee see1;
see1 = createSee(SEE_ECLIPSE_SDK);
IndexSee see2 = new IndexSee(see1);
assertEquals(1, see1.getSubpathElements().length);
assertEquals(ECLIPSE, see1.getKeyword());
assertEquals(SDK, see1.getSubpathElements()[0].getKeyword());
assertEquals(1, see2.getSubpathElements().length);
assertEquals(ECLIPSE, see2.getKeyword());
assertEquals(SDK, see2.getSubpathElements()[0].getKeyword());
}
@Test
public void testCopyIndexSeeWithLongerSubpath() {
IndexSee see1;
see1 = createSee(SEE_ECLIPSE_SDK_VIEWS);
IndexSee see2 = new IndexSee(see1);
assertEquals(2, see1.getSubpathElements().length);
assertEquals(ECLIPSE, see1.getKeyword());
assertEquals(SDK, see1.getSubpathElements()[0].getKeyword());
assertEquals(VIEWS, see1.getSubpathElements()[1].getKeyword());
assertEquals(2, see2.getSubpathElements().length);
assertEquals(ECLIPSE, see2.getKeyword());
assertEquals(SDK, see2.getSubpathElements()[0].getKeyword());
assertEquals(VIEWS, see2.getSubpathElements()[1].getKeyword());
}
@Test
public void testCompareSimpleSame() {
IndexSee see1 = createSee(SEE_ECLIPSE);
IndexSee see2 = createSee(SEE_ECLIPSE);
assertTrue (see1.equals(see2));
assertEquals(0, see1.compareTo(see2));
assertEquals(0, see2.compareTo(see1));
assertEquals(see1.hashCode(), see2.hashCode());
}
@Test
public void testCompareSimpleDifferent() {
IndexSee see1 = createSee(SEE_ECLIPSE);
IndexSee see2 = createSee(SEE_SDK);
assertFalse (see1.equals(see2));
assertTrue(see1.compareTo(see2) < 0);
assertTrue(see2.compareTo(see1) > 0);
}
@Test
public void testCompareCompoundSame() {
IndexSee see1 = createSee(SEE_ECLIPSE_SDK);
IndexSee see2 = createSee(SEE_ECLIPSE_SDK);
assertTrue (see1.equals(see2));
assertEquals(0, see1.compareTo(see2));
assertEquals(0, see2.compareTo(see1));
assertEquals(see1.hashCode(), see2.hashCode());
}
@Test
public void testCompareCompoundDifferent() {
IndexSee see1 = createSee(SEE_ECLIPSE_SDK);
IndexSee see2 = createSee(SEE_ECLIPSE_VIEWS);
assertFalse (see1.equals(see2));
assertTrue(see1.compareTo(see2) < 0);
assertTrue(see2.compareTo(see1) > 0);
}
@Test
public void testCompareCompoundDifferentLengths() {
IndexSee see1 = createSee(SEE_ECLIPSE_SDK);
IndexSee see2 = createSee(SEE_ECLIPSE_SDK_VIEWS);
assertFalse (see1.equals(see2));
assertTrue(see1.compareTo(see2) < 0);
assertTrue(see2.compareTo(see1) > 0);
}
@Test
public void testCompare_AAA_abacus() {
IndexSee see1 = createSimpleSee("AAA");
IndexSee see2 = createSimpleSee("abacus");
assertFalse (see1.equals(see2));
assertTrue(see1.compareTo(see2) < 0);
assertTrue(see2.compareTo(see1) > 0);
}
@Test
public void testCompare_abacus_ABC() {
IndexSee see1 = createSimpleSee("abacus");
IndexSee see2 = createSimpleSee(AGUILA);
assertFalse (see1.equals(see2));
assertTrue(see1.compareTo(see2) < 0);
assertTrue(see2.compareTo(see1) > 0);
}
@Test
public void testCompare_ABC_aguila() {
IndexSee see1 = createSimpleSee("ABC");
IndexSee see2 = createSimpleSee(AGUILA);
assertFalse (see1.equals(see2));
assertTrue(see1.compareTo(see2) < 0);
assertTrue(see2.compareTo(see1) > 0);
}
@Test
public void testCompare_aguila_axe() {
IndexSee see1 = createSimpleSee(AGUILA);
IndexSee see2 = createSimpleSee("axe");
assertFalse (see1.equals(see2));
assertTrue(see1.compareTo(see2) < 0);
assertTrue(see2.compareTo(see1) > 0);
}
@Test
public void testCompare_to_underscore() {
IndexSee see1 = createSimpleSee("abc");
IndexSee see2 = createSimpleSee("_xyz");
assertFalse (see1.equals(see2));
assertTrue(see1.compareTo(see2) > 0);
assertTrue(see2.compareTo(see1) < 0);
}
@Test
public void testUserSee() {
UserIndexSee u1;
u1 = createUserSee();
IndexSee see = new IndexSee(u1);
checkCreatedSee(see);
}
@Test
public void testCopyUserSee() {
UserIndexSee u1;
u1 = createUserSee();
IndexSee see = new IndexSee(u1);
IndexSee see2 = new IndexSee(see);
checkCreatedSee(see);
checkCreatedSee(see2);
}
@Test
public void testCreateTwiceUserSee() {
UserIndexSee u1;
u1 = createUserSee();
IndexSee see = new IndexSee(u1);
IndexSee see2 = new IndexSee(u1);
checkCreatedSee(see);
checkCreatedSee(see2);
}
@Test
public void testSeeAlsoWithSiblingTopic() {
UserIndexEntry entry = new UserIndexEntry("test", true);
UserTopic topic = new UserTopic("label", "href.html", true);
entry.addTopic(topic);
UserIndexSee see = new UserIndexSee("check", true);
entry.addSee(see);
IndexEntry indexEntry = new IndexEntry(entry);
IIndexSee[] sees = indexEntry.getSees();
assertTrue(((IndexSee)sees[0]).isSeeAlso());
}
@Test
public void testSeeAlsoWithSiblingEntry() {
UserIndexEntry entry = new UserIndexEntry("test", true);
UserIndexEntry subEntry = new UserIndexEntry("case", true);
UserTopic topic = new UserTopic("label", "href.html", true);
entry.addEntry(subEntry);
subEntry.addTopic(topic);
UserIndexSee see = new UserIndexSee("check", true);
entry.addSee(see);
IndexEntry indexEntry = new IndexEntry(entry);
IIndexSee[] sees = indexEntry.getSees();
assertTrue(((IndexSee)sees[0]).isSeeAlso());
}
@Test
public void testSiblingSeesNotSeeAlso() {
UserIndexEntry entry = new UserIndexEntry("test", true);
UserIndexSee see1 = new UserIndexSee("check", true);
entry.addSee(see1);
UserIndexSee see2 = new UserIndexSee("verify", true);
entry.addSee(see2);
IndexEntry indexEntry = new IndexEntry(entry);
IIndexSee[] sees = indexEntry.getSees();
assertFalse(((IndexSee)sees[0]).isSeeAlso());
assertFalse(((IndexSee)sees[1]).isSeeAlso());
}
private UserIndexSee createUserSee() {
UserIndexSee u1;
u1 = new UserIndexSee("eclipse", false);
UserIndexSubpath u2 = new UserIndexSubpath("platform");
UserIndexSubpath u3 = new UserIndexSubpath("ui");
u1.addSubpath(u2);
u1.addSubpath(u3);
return u1;
}
private void checkCreatedSee(IndexSee see) {
assertEquals("eclipse", see.getKeyword());
IIndexSubpath[] subpath = see.getSubpathElements();
assertEquals(2, subpath.length);
assertEquals("platform", subpath[0].getKeyword());
assertEquals("ui", subpath[1].getKeyword());
}
}
|
