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
|
/*******************************************************************************
* Copyright (c) 2006, 2015 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.ua.tests.help.preferences;
import java.util.HashSet;
import java.util.List;
import java.util.Properties;
import java.util.Set;
import java.util.StringTokenizer;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
import org.eclipse.help.internal.util.ProductPreferences;
import org.eclipse.ua.tests.plugin.UserAssistanceTestPlugin;
import org.junit.Assert;
/*
* Tests the products preferences utility
*/
public class ProductPreferencesTest extends TestCase {
// [items], [expectedOrder], [primaryOrdering], [secondaryOrdering1], [secondaryOrdering2], ...
private static final String[][] GET_ORDERED_LIST_DATA = {
// one item, no specified ordering
{ "a", "a", "", },
// just one item to order, not found
{ "a", "a", "b,c,d", "e,f,g" },
// just one item to order
{ "a", "a", "a", "a" },
// several items
{ "a,b,c", "a,b,c", "a", "b,c" },
// extra element not ordered
{ "a,b,c", "b,c,a", "b,c", "d,e,f", "g,h,i" },
// longer test
{ "1,2,3,4,5", "1,2,3,4,5", "2,3", "1,2", "4,5", "3,4" },
// same, but items shuffled
{ "four,two,five,one,three", "one,two,three,four,five", "two,three", "one,two", "four,five", "three,four" },
// would fail if only used one secondary ordering
{ "seven,six,five,four,three,two,one", "one,two,three,four,five,six,seven", "one,two", "two,three,four", "one,two,six", "three,four,five", "five,six", "four,five", "six,seven" },
// slightly overlapping
{ "5,4,6,3,7,2,8,1,9", "9,8,7,6,5,4,3,2,1", "3,2,1", "9,8,7", "7,6,5", "5,4,3" },
// primary is subset
{ "5,4,6,3,7,2,8,1,9", "9,8,7,6,5,4,3,2,1", "9,7,5,3,1", "9,8,7,6,5,4,3,2,1" },
// complex test
{ "4,7,2,8,1,5,9,3,6", "1,2,3,4,5,6,7,8,9", "2,4,6,8", "1,3,5,7,9", "1,2", "3,4", "5,6", "7,8" },
// conflicts; primary wins
{ "1,2,3", "2,3,1", "2,3,1", "1,2,3", "1,3,2", "2,1,3", "2,3,1", "3,1,2", "3,2,1" },
// one conflict; primary wins
{ "3,2,1", "1,3,2", "1,3", "1,2" },
// variation of previous
{ "3,2,1", "1,2,3", "1,3", "1,2,3" },
// primary wants one way but everyone else wants other way; primary wins
{ "2,1,3", "3,1,2", "3,1,2", "3,2,1", "3,2,1" },
};
// [inputFile in data/help/preferences/], [key1=value1], [key2=value2], ...
private static final String[][] GET_PROPERTIES_FILE_DATA = {
// file with a single property
{ "propertiesSingle.txt", "myKey=myValue" },
// file with many properties
{ "propertiesMultiple.txt", "key1=value1", "key2=value2", "this.is.another/key=this.is.another.value" }
};
// [key to find], [possible resulting values], [primaryProperties], [secondaryProperties1], [secondaryProperties2], ...
private static final String[][] GET_VALUE_DATA = {
// key doesn't exist
{ "keyDoesNotExist", "", "values1.txt", "values1.txt" },
// only exists in primary properties
{ "key1", "value1", "values1.txt", "values1.txt" },
// exists only in two secondary properties
{ "key2", "value2,value3", "values1.txt", "values1.txt", "values2.txt", "values3.txt" },
// exists both primary and secondary; primary should take precedence
{ "key3", "value3", "values1.txt", "values1.txt", "values2.txt", "values3.txt" }
};
// [input], [token1], [token2], ...
private static final String[][] TOKENIZE_DATA = {
// tolerate null; return no tokens
{ null },
// no delimiters
{ "Test", "Test" },
// simple test
{ "one, two, three", "one", "two", "three" },
// same one repeated
{ "repeat, repeat, repeat", "repeat", "repeat", "repeat" },
// just commas, no whitespace
{ "a,b,c", "a", "b", "c" },
// semicolons
{ "semi;colon;separator", "semi", "colon", "separator" },
// various whitespace
{ "all\nkinds\rof\t whitespace", "all", "kinds", "of", "whitespace" },
// mixed commas and semicolons
{ "many;,;,;,separators,;,;,;,test", "many", "separators", "test" },
// all mixed
{ "mixed; space, and separators", "mixed", "space", "and", "separators" }
};
/*
* Returns an instance of this Test.
*/
public static Test suite() {
return new TestSuite(ProductPreferencesTest.class);
}
public void testGetOrderedList() {
for (String[] data : GET_ORDERED_LIST_DATA) {
List<String> items = ProductPreferences.tokenize(data[0]);
List<String> expectedOrder = ProductPreferences.tokenize(data[1]);
List<String> primaryOrdering = ProductPreferences.tokenize(data[2]);
@SuppressWarnings("unchecked")
List<String>[] secondaryOrderings = (List<String>[]) new List<?>[data.length - 3];
for (int j=0;j<secondaryOrderings.length;++j) {
secondaryOrderings[j] = ProductPreferences.tokenize(data[j + 3]);
}
List<String> actualOrder = ProductPreferences.getOrderedList(items, primaryOrdering, secondaryOrderings, null);
Assert.assertEquals("Items in list were not ordered as expected", expectedOrder, actualOrder);
}
}
public void testGetPropertiesFile() {
for (String[] data : GET_PROPERTIES_FILE_DATA) {
String path = "data/help/preferences/" + data[0];
Properties properties = ProductPreferences.loadPropertiesFile(UserAssistanceTestPlugin.getDefault().getBundle().getSymbolicName(), path);
Assert.assertNotNull("The result of loading a properties file was unexpectedly null", properties);
Assert.assertEquals(data.length - 1, properties.size());
for (int j=1;j<data.length;++j) {
StringTokenizer tok = new StringTokenizer(data[j], "=");
String key = tok.nextToken();
String expectedValue = tok.nextToken();
String actualValue = properties.getProperty(key);
Assert.assertEquals("One of the properties files' keys did not match the expected value: file=" + path + ", key=" + key, expectedValue, actualValue);
}
}
}
public void testGetValue() {
for (String[] data : GET_VALUE_DATA) {
String key = data[0];
Set<String> allowableValues = new HashSet<String>(ProductPreferences.tokenize(data[1]));
Properties primary = ProductPreferences.loadPropertiesFile(UserAssistanceTestPlugin.getDefault().getBundle().getSymbolicName(), "data/help/preferences/" + data[2]);
Properties[] secondary = new Properties[data.length - 3];
for (int j=0;j<secondary.length;++j) {
secondary[j] = ProductPreferences.loadPropertiesFile(UserAssistanceTestPlugin.getDefault().getBundle().getSymbolicName(), "data/help/preferences/" + data[j + 3]);
}
String value = ProductPreferences.getValue(key, primary, secondary);
if (allowableValues.isEmpty()) {
Assert.assertNull("Value should have been null, but was not: " + key, value);
}
else {
Assert.assertTrue("Value returned was not one of the allowable values", allowableValues.contains(value));
}
}
}
public void testTokenize() {
for (String[] data : TOKENIZE_DATA) {
String input = data[0];
List<String> output = ProductPreferences.tokenize(input);
Assert.assertNotNull("The tokenized output was unexpectedly null for: " + input, output);
Assert.assertEquals("The number of tokens did not match the expected result for: " + input, data.length - 1, output.size());
for (int j=0;j<output.size();++j) {
Assert.assertEquals("One of the tokens did not match the expected result", data[j + 1], output.get(j));
}
}
}
}
|
