-
Notifications
You must be signed in to change notification settings - Fork 71
/
BuildTests.java
479 lines (412 loc) · 15.9 KB
/
BuildTests.java
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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
/*******************************************************************************
* Copyright (c) 2000, 2023 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.releng.tests;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assume.assumeFalse;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FilenameFilter;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.URLConnection;
import java.nio.file.Files;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Enumeration;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import org.eclipse.core.runtime.Platform;
import org.junit.Test;
import org.osgi.framework.Version;
public class BuildTests {
private static final String PLATFORM_FEATURE = "org.eclipse.platform_";
public class FileSuffixFilter implements FilenameFilter {
private String suffix;
public FileSuffixFilter(String suffix) {
this.suffix = suffix;
}
@Override
public boolean accept(File dir, String name) {
int lastDot = name.lastIndexOf('.');
if (lastDot == -1) {
return false;
}
return name.substring(lastDot).equals(suffix);
}
}
public static final List<String> REQUIRED_FEATURE_FILES_EPL2 = List.of("epl-2.0.html", "feature.properties",
"feature.xml", "license.html");
public static final String REQUIRED_FEATURE_SUFFIX = "";
public static final List<String> REQUIRED_PLUGIN_FILES = List.of("about.html", "plugin.properties", "plugin.xml");
public static final String REQUIRED_PLUGIN_SUFFIX = ".jar";
public static final List<String> REQUIRED_FEATURE_PLUGIN_FILES = List.of("about.html", "about.ini",
"about.mappings", "about.properties", "plugin.properties", "plugin.xml");
public static final String REQUIRED_FEATURE_PLUGIN_SUFFIX = ".gif";
public static final List<String> REQUIRED_FRAGMENT_FILES = List.of("fragment.xml");
public static final String REQUIRED_FRAGMENT_SUFFIX = "";
public static final List<String> REQUIRED_SWT_FRAGMENT_FILES = List.of("fragment.properties");
public static final String REQUIRED_SWT_FRAGMENT_SUFFIX = "";
public static final List<String> REQUIRED_SOURCE_FILES = List.of("about.html");
public static final String REQUIRED_SOURCE_SUFFIX = ".zip";
public static final List<String> REQUIRED_BUNDLE_FILES = List.of("about.html");
public static final String REQUIRED_BUNDLE_MANIFEST = "MANIFEST.MF";
public static final String REQUIRED_BUNDLE_SUFFIX = ".jar";
public static final List<String> SUFFIX_EXEMPT_LIST = List.of("org.eclipse.swt", "org.apache.ant");
public static final int PLUGIN_COUNT = 84; // - 20; // Note this number
// must include non-shipping
// test plugins
public static final int FEATURE_COUNT = 9; // - 1; // Note this number must
// include non-shipping test
// feature
@Test
public void testFeatureFiles() {
assumeFalse(isMavenRun());
List<String> result = new ArrayList<>();
String installDir = Platform.getInstallLocation().getURL().getPath();
File featureDir = new File(installDir, "features");
for (File aFeature : featureDir.listFiles()) {
List<String> testFiles = REQUIRED_FEATURE_FILES_EPL2;
if (!testDirectory(aFeature, testFiles, REQUIRED_FEATURE_SUFFIX)) {
result.add(aFeature.getPath());
}
}
String aString = "";
if (!result.isEmpty()) {
for (String element: result) {
aString = aString + element + "; ";
}
}
assertTrue("Feature directory missing required files: " + aString, result.isEmpty());
}
@Test
public void testProductFileVersion() throws Exception {
assumeFalse(isMavenRun());
String installDir = Platform.getInstallLocation().getURL().getPath();
File productFile = new File(installDir, ".eclipseproduct");
Properties props = new Properties();
try (InputStream stream = Files.newInputStream(productFile.toPath())) {
props.load(stream);
}
String versionProp = props.getProperty("version");
assertNotNull("'version' property not found in " + productFile, versionProp);
File featureDir = new File(installDir, "features");
String versionStr = null;
for (File feature : featureDir.listFiles()) {
String featureName = feature.getName();
if (!featureName.startsWith(PLATFORM_FEATURE)) {
continue;
}
// something like org.eclipse.platform_4.28.0.v20230328-1800
versionStr = featureName.substring(PLATFORM_FEATURE.length(), featureName.length());
break;
}
assertNotNull("Failed to find platform feature at " + featureDir, versionStr);
assertTrue("Failed to find product file at " + productFile, productFile.isFile());
Version featureVersion = new Version(versionStr);
featureVersion = new Version(featureVersion.getMajor(), featureVersion.getMinor(), featureVersion.getMicro());
Version productVersion = new Version(versionProp);
assertEquals("Product version doesn't match version of the platform", featureVersion, productVersion);
}
/**
* Verifies all bundles starting with org.eclipse (with listed exceptions) to
* contain e.g. about.html and other recommended files.
*/
@Test
public void testPluginFiles() {
assumeFalse(isMavenRun());
List<String> result = new ArrayList<>();
String installDir = Platform.getInstallLocation().getURL().getPath();
File pluginDir = new File(installDir, "plugins");
for (File aPlugin : pluginDir.listFiles()) {
String name = aPlugin.getName();
if (!name.contains("test") && name.startsWith("org.eclipse") && !name.contains("org.eclipse.jetty")
&& !name.contains("org.eclipse.ecf") && !name.startsWith("org.eclipse.orbit")) {
if (!testPluginFile(aPlugin)) {
result.add(aPlugin.getPath());
}
}
}
String aString = "";
if (!result.isEmpty()) {
for (String element : result) {
aString = aString + element + "; ";
}
}
assertTrue("Plugin directory missing required files: " + aString, result.isEmpty());
}
private boolean isMavenRun() {
return System.getenv("MAVEN_CMD_LINE_ARGS") != null;
}
private boolean testPluginFile(File aPlugin) {
// Are we a doc plugin?
if (testDirectory(aPlugin, REQUIRED_PLUGIN_FILES, ".zip")) {
return true;
}
// Are we a feature plugin?
if (testDirectory(aPlugin, REQUIRED_FEATURE_PLUGIN_FILES, REQUIRED_FEATURE_PLUGIN_SUFFIX)) {
return true;
}
// Are we a regular plugin
if (testDirectory(aPlugin, REQUIRED_PLUGIN_FILES, REQUIRED_PLUGIN_SUFFIX)) {
return true;
}
// Are we a source plugin
if (testSourcePlugin(aPlugin)) {
return true;
}
// Are we a fragment
if ((testDirectory(aPlugin, REQUIRED_FRAGMENT_FILES, REQUIRED_FRAGMENT_SUFFIX))
|| (testBundleDirectory(aPlugin, REQUIRED_BUNDLE_FILES, REQUIRED_BUNDLE_MANIFEST, REQUIRED_FRAGMENT_SUFFIX))) {
return true;
}
// Are we an swt fragment
if (testDirectory(aPlugin, REQUIRED_SWT_FRAGMENT_FILES, REQUIRED_SWT_FRAGMENT_SUFFIX)) {
return true;
}
// Are we a bundle?
if (testBundleDirectory(aPlugin, REQUIRED_BUNDLE_FILES, REQUIRED_BUNDLE_MANIFEST, REQUIRED_BUNDLE_SUFFIX)) {
return true;
}
// No then we are bad
return false;
}
private boolean testPluginJar(File aDirectory, List<String> requiredFiles) {
ArrayList<String> list = new ArrayList<>();
try (ZipFile jarredPlugin = new ZipFile(aDirectory)) {
Enumeration<? extends ZipEntry> _enum = jarredPlugin.entries();
while (_enum.hasMoreElements()) {
list.add(_enum.nextElement().toString());
}
} catch (IOException e) {
e.printStackTrace();
}
if (!list.containsAll(requiredFiles)) {
return false;
}
return true;
}
private boolean testDirectory(File aDirectory, List<String> requiredFiles, String requiredSuffix) {
if (aDirectory.getName().endsWith(".jar")) {
return testPluginJar(aDirectory, requiredFiles);
} else {
if (!Arrays.asList(aDirectory.list()).containsAll(requiredFiles)) {
return false;
}
int index = aDirectory.getName().indexOf('_');
if (index == -1) {
index = aDirectory.getName().length();
}
String plainName = aDirectory.getName().substring(0, index);
if (requiredSuffix.isEmpty() || SUFFIX_EXEMPT_LIST.contains(plainName)) {
return true;
} else if (aDirectory.listFiles(new FileSuffixFilter(requiredSuffix)).length == 0) {
return false;
}
}
return true;
}
private boolean testBundleDirectory(File aDirectory, List<String> requiredFiles, String manifestFile, String requiredSuffix) {
if (aDirectory.getName().endsWith(".jar")) {
return testPluginJar(aDirectory, requiredFiles);
} else {
if (!Arrays.asList(aDirectory.list()).containsAll(requiredFiles)) {
return false;
}
int index = aDirectory.getName().indexOf('_');
if (index == -1) {
index = aDirectory.getName().length();
}
String plainName = aDirectory.getName().substring(0, index);
File metaDir = new File(aDirectory, "META-INF");
String[] metaFiles = metaDir.list();
if (metaFiles == null) {
return (false);
} else {
for (String filename : metaFiles) {
if (filename == manifestFile) {
return true;
}
}
}
if (!metaDir.exists()) {
return false;
}
if (requiredSuffix.isEmpty() || SUFFIX_EXEMPT_LIST.contains(plainName)) {
return true;
} else if (aDirectory.listFiles(new FileSuffixFilter(requiredSuffix)).length == 0) {
return false;
}
}
return true;
}
/**
* Return true if the receiver is a source plugin, false otherwise A separate method because this is a little tricky.
*
* @return boolean
*/
private boolean testSourcePlugin(File aPlugin) {
if (!testDirectory(aPlugin, REQUIRED_PLUGIN_FILES, "")) {
return false;
}
File sourceDir = new File(aPlugin, "src");
File[] sourceDirs = sourceDir.listFiles();
if (sourceDirs == null) {
return false;
}
for ( File aSourceDir : sourceDirs) {
if (!testDirectory(aSourceDir, REQUIRED_SOURCE_FILES, REQUIRED_SOURCE_SUFFIX)) {
return false;
}
}
return true;
}
@Test
public void testJavadocLogs() throws Exception {
assumeFalse(isMavenRun());
String javadocUrls = System.getProperty("RELENGTEST.JAVADOC.URLS");
// Skip this test if there are no logs to check
if (javadocUrls == null) {
System.err.println("WARNING: no javadoc logs to test, since RELENGTEST.JAVADOC.URLS property was not set");
return;
} else {
System.err.println("RELENGTEST.JAVADOC.URLS: " + javadocUrls);
}
String[] urls = javadocUrls.split(",");
URL[] javadocLogs = new URL[urls.length];
for (int i = 0; i < urls.length; i++) {
javadocLogs[i] = new URL(urls[i]);
System.err.println("javadocLogs[" + i + "]: " + javadocLogs[i]);
}
JavadocLog javadocLog = new JavadocLog(javadocLogs);
String message = "javadoc errors and/or warnings in: \n";
boolean problemLogsExist = !javadocLog.logs.isEmpty();
if (problemLogsExist) {
for (int i = 0; i < javadocLog.logs.size(); i++)
message = message.concat(javadocLog.logs.get(i) + "\n");
}
message = message.concat("See the javadoc logs linked from the test results page for details");
assertTrue(message, !problemLogsExist);
}
@Test
public void testJarSign() throws Exception {
assumeFalse(isMavenRun());
String buildId = System.getProperty("buildId");
assertNotNull("buildId property must be specified for testJarSign test", buildId);
String downloadHost = "download.eclipse.org";
String urlOfFile = "https://" + downloadHost + "/eclipse/downloads/drops4/" + buildId
+ "/buildlogs/reporeports/reports/unsigned8.txt";
URL logURL = new URL(urlOfFile);
URLConnection urlConnection = logURL.openConnection();
long nBytes = urlConnection.getContentLength();
// nBytes will be -1 if the file doesn't exist
// it will be more than 3 if there are unsigned jars. (atlear jar extention will be listed
assertTrue("Some bundles are unsigned please refer " + urlOfFile, (2 > nBytes));
}
private String getDownloadHost() {
String downloadHost = System.getProperty("downloadHost");
if (downloadHost == null) {
downloadHost = "download.eclipse.org";
}
return downloadHost;
}
private void printHeaders(URLConnection urlConnection) {
System.out.println("Debug: Headers for urlConnection to " + urlConnection.getURL());
Map<String, List<String>> allFields = urlConnection.getHeaderFields();
for (Entry<String, List<String>> entry : allFields.entrySet()) {
for (String value : entry.getValue()) {
System.out.printf("Debug: %-20s %-30s %n", "key: " + entry.getKey(), "value: " + value);
}
}
}
@Test
public void testComparatorLogSize() throws Exception {
assumeFalse(isMavenRun());
final boolean DEBUG_TEST = true;
// MAX_ALLOWED_BYTES will never be 'zero', even if no unexpected comparator warnings, because the
// report always contains some information, such as identifying which build it was for.
// The goal, here, is to
// "hard code" nominal values, to make sure
// there is no regressions, which would be implied by a report larger
// than that nominal value.
long MAX_ALLOWED_BYTES = 319;
String buildId = System.getProperty("buildId");
assertNotNull("buildId property must be specified for testComparatorLogSize test", buildId);
// Comparator logs are not generated for N builds
String downloadHost = getDownloadHost();
String urlOfFile = "https://" + downloadHost + "/eclipse/downloads/drops4/" + buildId
+ "/buildlogs/comparatorlogs/buildtimeComparatorUnanticipated.log.txt";
URL logURL = new URL(urlOfFile);
URLConnection urlConnection = logURL.openConnection();
// urlConnection.connect();
long nBytes = urlConnection.getContentLength();
if (DEBUG_TEST) {
System.out.println("Debug info for testComparatorLogSize");
System.out.println("Debug: nBytes: " + nBytes);
printHeaders(urlConnection);
}
// if find "response does not contain length, on a regular basis, for
// some servers, will have to read contents.
assertTrue("Either file (url) does not exist, or HTTP response does not contain content length. urlOfFile: "
+ urlOfFile, (-1 != nBytes));
assertTrue("Unanticipated comparator log file has increased in size, indicating a regression. See " + urlOfFile,
nBytes <= MAX_ALLOWED_BYTES);
if (MAX_ALLOWED_BYTES > (nBytes + 20)) {
System.out.println(
"WARNING: MAX_ALLOWED_BYTES was larger than bytes found, by " + (MAX_ALLOWED_BYTES - nBytes)
+ ", which may indicate MAX_ALLOWED_BYTES needs to be lowered, to catch regressions.");
}
}
private class JavadocLog {
private ArrayList<String> logs = new ArrayList<>();
private JavadocLog(URL[] logs) {
findProblems(logs);
}
private void findProblems(URL[] javadocLogs) {
String JAVADOC_WARNING = ": warning";
String JAVADOC_ERROR = ": error";
String JAVADOC_JAVA = ".java:";
for (URL javadocLog : javadocLogs) {
try (BufferedReader in = new BufferedReader(new InputStreamReader(javadocLog.openStream()))){
String tmp;
while ((tmp = in.readLine()) != null) {
tmp = tmp.toLowerCase();
if (tmp.contains(JAVADOC_ERROR) || tmp.contains(JAVADOC_WARNING)
|| tmp.contains(JAVADOC_JAVA)) {
String fileName = new File(javadocLog.getFile()).getName();
if (!logs.contains(fileName))
logs.add(fileName);
}
}
}
catch (FileNotFoundException e) {
logs.add("Unable to find " + new File(javadocLog.getFile()).getName() + " to read.");
e.printStackTrace();
}
catch (IOException e) {
logs.add("Unable to read " + new File(javadocLog.getFile()).getName());
e.printStackTrace();
}
}
}
}
}