| /******************************************************************************* |
| * Copyright (c) 2000, 2016 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.releng.generators; |
| |
| import java.io.BufferedInputStream; |
| import java.io.BufferedOutputStream; |
| import java.io.BufferedReader; |
| import java.io.File; |
| import java.io.FileInputStream; |
| import java.io.FileNotFoundException; |
| import java.io.FileOutputStream; |
| import java.io.FileReader; |
| import java.io.FileWriter; |
| import java.io.FilenameFilter; |
| import java.io.IOException; |
| import java.io.InputStream; |
| import java.io.OutputStream; |
| import java.io.Writer; |
| import java.util.ArrayList; |
| import java.util.Arrays; |
| import java.util.Enumeration; |
| import java.util.Iterator; |
| import java.util.List; |
| import java.util.StringTokenizer; |
| import java.util.Vector; |
| |
| import javax.xml.parsers.DocumentBuilder; |
| import javax.xml.parsers.DocumentBuilderFactory; |
| import javax.xml.parsers.ParserConfigurationException; |
| |
| import org.apache.tools.ant.BuildException; |
| import org.apache.tools.ant.Task; |
| import org.w3c.dom.Document; |
| import org.w3c.dom.Element; |
| import org.w3c.dom.NamedNodeMap; |
| import org.w3c.dom.Node; |
| import org.w3c.dom.NodeList; |
| import org.xml.sax.InputSource; |
| import org.xml.sax.SAXException; |
| |
| /** |
| * @version 1.0 |
| * @author Dean Roberts |
| */ |
| public class TestResultsGenerator extends Task { |
| |
| private static final String HTML_EXTENSION = ".html"; |
| private static final String XML_EXTENSION = ".xml"; |
| private static final String WARNING_SEVERITY = "WARNING"; |
| private static final String ERROR_SEVERITY = "ERROR"; |
| private static final String ForbiddenReferenceID = "ForbiddenReference"; |
| private static final String DiscouragedReferenceID = "DiscouragedReference"; |
| |
| private static final int DEFAULT_READING_SIZE = 8192; |
| |
| private static final String elementName = "testsuite"; |
| private static final String testResultsToken = "%testresults%"; |
| private static final String compileLogsToken = "%compilelogs%"; |
| private static final String accessesLogsToken = "%accesseslogs%"; |
| private ArrayList<String> foundConfigs = new ArrayList(); |
| private ArrayList<String> expectedConfigs = null; |
| private static final String EOL = System.getProperty("line.separator"); |
| private static boolean DEBUG = false; |
| private static String FOUND_TEST_CONFIGS_FILENAME = "testConfigsFound.php"; |
| private static String found_config_type = "found"; |
| private static String EXPECTED_TEST_CONFIGS_FILENAME = "testConfigs.php"; |
| private static String expected_config_type = "expected"; |
| |
| class ExpectedConfigFiler implements FilenameFilter { |
| |
| String config; |
| |
| public ExpectedConfigFiler(String expectedConfig) { |
| config = expectedConfig; |
| } |
| |
| public boolean accept(File dir, String name) { |
| return (name.endsWith("_" + config + XML_EXTENSION)); |
| } |
| |
| } |
| |
| private String extractXmlRelativeFileName(final String rootCanonicalPath, final File xmlFile) { |
| if (rootCanonicalPath != null) { |
| String xmlFileCanonicalPath = null; |
| try { |
| xmlFileCanonicalPath = xmlFile.getCanonicalPath(); |
| } |
| catch (final IOException e) { |
| logException(e); |
| } |
| if (xmlFileCanonicalPath != null) { |
| // + 1 to remove the '\' |
| return xmlFileCanonicalPath.substring(rootCanonicalPath.length() + 1).replace('\\', '/'); |
| } |
| } |
| return ""; |
| } |
| |
| private void logException(final Throwable e) { |
| log(e.getMessage()); |
| StackTraceElement[] stackTrace = e.getStackTrace(); |
| for (StackTraceElement stackTraceElement : stackTrace) { |
| log(stackTraceElement.toString()); |
| } |
| } |
| |
| private static byte[] getFileByteContent(final String fileName) throws IOException { |
| InputStream stream = null; |
| try { |
| final File file = new File(fileName); |
| stream = new BufferedInputStream(new FileInputStream(file)); |
| return getInputStreamAsByteArray(stream, (int) file.length()); |
| } |
| finally { |
| if (stream != null) { |
| try { |
| stream.close(); |
| } |
| catch (final IOException e) { |
| // ignore |
| } |
| } |
| } |
| } |
| |
| /** |
| * Returns the given input stream's contents as a byte array. If a length is |
| * specified (ie. if length != -1), only length bytes are returned. |
| * Otherwise all bytes in the stream are returned. Note this doesn't close |
| * the stream. |
| * |
| * @throws IOException |
| * if a problem occurred reading the stream. |
| */ |
| private static byte[] getInputStreamAsByteArray(final InputStream stream, final int length) throws IOException { |
| byte[] contents; |
| if (length == -1) { |
| contents = new byte[0]; |
| int contentsLength = 0; |
| int amountRead = -1; |
| do { |
| final int amountRequested = Math.max(stream.available(), DEFAULT_READING_SIZE); // read |
| // at |
| // least |
| // 8K |
| |
| // resize contents if needed |
| if ((contentsLength + amountRequested) > contents.length) { |
| System.arraycopy(contents, 0, contents = new byte[contentsLength + amountRequested], 0, contentsLength); |
| } |
| |
| // read as many bytes as possible |
| amountRead = stream.read(contents, contentsLength, amountRequested); |
| |
| if (amountRead > 0) { |
| // remember length of contents |
| contentsLength += amountRead; |
| } |
| } |
| while (amountRead != -1); |
| |
| // resize contents if necessary |
| if (contentsLength < contents.length) { |
| System.arraycopy(contents, 0, contents = new byte[contentsLength], 0, contentsLength); |
| } |
| } else { |
| contents = new byte[length]; |
| int len = 0; |
| int readSize = 0; |
| while ((readSize != -1) && (len != length)) { |
| // See PR 1FMS89U |
| // We record first the read size. In this case len is the actual |
| // read size. |
| len += readSize; |
| readSize = stream.read(contents, len, length - len); |
| } |
| } |
| |
| return contents; |
| } |
| |
| public static void main(final String[] args) { |
| final TestResultsGenerator test = new TestResultsGenerator(); |
| if (Boolean.FALSE) { |
| test.setTestsConfigExpected( |
| "ep46N-unit-lin64_linux.gtk.x86_64_8.0.xml ,ep46N-unit-mac64_macosx.cocoa.x86_64_8.0.xml ,ep46N-unit-win32_win32.win32.x86_8.0.xml, ep46N-unit-cen64_linux.gtk.x86_64_8.0.xml"); |
| DEBUG = true; |
| try { |
| test.getTestsConfig(); |
| } |
| catch (IOException e) { |
| e.printStackTrace(); |
| } |
| |
| } else { |
| test.setTestsConfigExpected( |
| "ep46N-unit-lin64_linux.gtk.x86_64_8.0.xml ,ep46N-unit-mac64_macosx.cocoa.x86_64_8.0.xml ,ep46N-unit-win32_win32.win32.x86_8.0.xml, ep46N-unit-cen64_linux.gtk.x86_64_8.0.xml"); |
| |
| // "%equinox%,%framework%,%extrabundles%,%other%,%incubator%,%provisioning%,%launchers%,%osgistarterkits%"); |
| test.setDropTokenList( |
| "%sdk%,%tests%,%example%,%rcpruntime%,%rcpsdk%,%deltapack%,%runtime%,%jdt%,%jdtsdk%,%jdtc%,%pde%,%pdesdk%,%cvs%,%cvssdk%,%swt%,%relengtools%"); |
| test.getDropTokensFromList(test.dropTokenList); |
| test.setIsBuildTested(false); |
| test.setXmlDirectoryName( |
| "/home/shared/eclipse/builds/4N/siteDir/eclipse/downloads/drops4/N20160324-2000/testresults/xml"); |
| test.setHtmlDirectoryName("/home/shared/eclipse/builds/4N/siteDir/eclipse/downloads/drops4/N20160324-2000/testresults"); |
| test.setDropDirectoryName("/home/shared/eclipse/builds/4N/siteDir/eclipse/downloads/drops4/N20160324-2000"); |
| test.setTestResultsTemplateFileName( |
| "/home/davidw/gitLuna/eclipse.platform.releng.aggregator/eclipse.platform.releng.tychoeclipsebuilder/eclipse/publishingFiles/templateFiles/testResults.php.template"); |
| |
| test.setDropTemplateFileName( |
| "/home/davidw/gitLuna/eclipse.platform.releng.aggregator/eclipse.platform.releng.tychoeclipsebuilder/eclipse/publishingFiles/templateFiles/index.php.template"); |
| test.setTestResultsHtmlFileName("testResults.php"); |
| test.setDropHtmlFileName("index.php"); |
| |
| test.setHrefTestResultsTargetPath("testresults"); |
| test.setCompileLogsDirectoryName( |
| "/home/shared/eclipse/builds/4N/siteDir/eclipse/downloads/drops4/N20160324-2000/compilelogs/plugins"); |
| test.setHrefCompileLogsTargetPath("compilelogs"); |
| test.setTestManifestFileName( |
| "/home/davidw/gitLuna/eclipse.platform.releng.aggregator/eclipse.platform.releng.tychoeclipsebuilder/eclipse/publishingFiles/testManifest.xml"); |
| test.execute(); |
| } |
| } |
| |
| private Vector dropTokens; |
| |
| private String testResultsWithProblems = "EOL"; |
| private String testResultsXmlUrls = "EOL"; |
| |
| private DocumentBuilder parser = null; |
| private ErrorTracker anErrorTracker; |
| private String testResultsTemplateString = ""; |
| |
| private String dropTemplateString = ""; |
| |
| // assume tests ran. If no html files are found, this is set to false |
| private boolean testsRan = true; |
| |
| // Parameters |
| // build runs JUnit automated tests |
| private boolean isBuildTested; |
| |
| // testedBuildType, I, N |
| private String testedBuildType; |
| |
| // Comma separated list of drop tokens |
| private String dropTokenList; |
| |
| // Location of the xml files |
| private String xmlDirectoryName; |
| |
| // Location of the html files |
| private String htmlDirectoryName; |
| |
| // Location of the resulting index.php file. |
| private String dropDirectoryName; |
| |
| // Location and name of the template index.php file. |
| private String testResultsTemplateFileName; |
| |
| // Location and name of the template drop index.php file. |
| private String dropTemplateFileName; |
| |
| // Name of the generated index php file. |
| private String testResultsHtmlFileName; |
| |
| // Name of the generated drop index php file; |
| private String dropHtmlFileName; |
| |
| // Arbitrary path used in the index.php page to href the |
| // generated .html files. |
| private String hrefTestResultsTargetPath; |
| // Arbitrary path used in the index.php page to reference the compileLogs |
| private String hrefCompileLogsTargetPath; |
| // Location of compile logs base directory |
| private String compileLogsDirectoryName; |
| // Location and name of test manifest file |
| private String testManifestFileName; |
| |
| // temporary way to force "missing" list not to be printed (until complete |
| // solution found) |
| private boolean doMissingList = true; |
| |
| // Initialize the prefix to a default string |
| private String prefix = "default"; |
| |
| private String testShortName = ""; |
| |
| private int counter = 0; |
| |
| // Configuration of test machines. |
| // Add or change new configurations here |
| // and update titles in testResults.template.php. |
| // These are the suffixes used for JUnit's XML output files. |
| // On each invocation, all files in results directory are |
| // scanned, to see if they end with suffixes, and if so, |
| // are processed for summary row. The column order is determined by |
| // the order listed here. |
| // This suffix is determined, at test time, when the files junit files are |
| // generated, by the setting of a variable named "platform" in test.xml |
| // and associated property files. |
| |
| // defaults removed since adds to confusion or errors |
| // private String[] testsConfigDefaults = { "ep4" + getTestedBuildType() + |
| // "-unit-lin64_linux.gtk.x86_64_8.0.xml", |
| // "ep4" + getTestedBuildType() + "-unit-mac64_macosx.cocoa.x86_64_8.0.xml", |
| // "ep4" + getTestedBuildType() + "-unit-win32_win32.win32.x86_8.0.xml", |
| // "ep4" + getTestedBuildType() + "-unit-cen64_linux.gtk.x86_64_8.0.xml" }; |
| private String testsConfigExpected; |
| |
| private int missingCount = 0; |
| |
| private int countCompileErrors(final String aString) { |
| return extractNumber(aString, "error"); |
| } |
| |
| private int countCompileWarnings(final String aString) { |
| return extractNumber(aString, "warning"); |
| } |
| |
| private int countDiscouragedWarnings(final String aString) { |
| return extractNumber(aString, "Discouraged access:"); |
| } |
| |
| private int countErrors(final String fileName) { |
| int errorCount = 0; |
| |
| if (new File(fileName).length() == 0) { |
| return -1; |
| } |
| |
| try { |
| final DocumentBuilderFactory docBuilderFactory = DocumentBuilderFactory.newInstance(); |
| parser = docBuilderFactory.newDocumentBuilder(); |
| |
| final Document document = parser.parse(fileName); |
| final NodeList elements = document.getElementsByTagName(elementName); |
| |
| final int elementCount = elements.getLength(); |
| if (elementCount == 0) { |
| return -1; |
| } |
| for (int i = 0; i < elementCount; i++) { |
| final Element element = (Element) elements.item(i); |
| final NamedNodeMap attributes = element.getAttributes(); |
| Node aNode = attributes.getNamedItem("errors"); |
| errorCount = errorCount + Integer.parseInt(aNode.getNodeValue()); |
| aNode = attributes.getNamedItem("failures"); |
| errorCount = errorCount + Integer.parseInt(aNode.getNodeValue()); |
| |
| } |
| |
| } |
| catch (final IOException e) { |
| log("IOException: " + fileName); |
| logException(e); |
| return 0; |
| } |
| catch (final SAXException e) { |
| log("SAXException: " + fileName); |
| logException(e); |
| return 0; |
| } |
| catch (final ParserConfigurationException e) { |
| logException(e); |
| } |
| return errorCount; |
| } |
| |
| private int countForbiddenWarnings(final String aString) { |
| return extractNumber(aString, "Access restriction:"); |
| } |
| |
| @Override |
| public void execute() { |
| |
| anErrorTracker = new ErrorTracker(); |
| anErrorTracker.loadFile(testManifestFileName); |
| getDropTokensFromList(dropTokenList); |
| testResultsTemplateString = readFile(testResultsTemplateFileName); |
| dropTemplateString = readFile(dropTemplateFileName); |
| |
| if (isBuildTested()) { |
| log("Begin: Generating test results index page"); |
| log("Parsing XML files"); |
| try { |
| parseXml(); |
| } |
| catch (IOException e) { |
| throw new BuildException(e); |
| } |
| log("End: Generating test results index page"); |
| } else { |
| log("isBuildTested value was not true, so did no processing for test file"); |
| } |
| log("Parsing compile logs"); |
| parseCompileLogs(); |
| log("End: Generating compile logs summary page"); |
| writeTestResultsFile(); |
| writeDropIndexFile(); |
| } |
| |
| private int extractNumber(final String aString, final String endToken) { |
| final int endIndex = aString.lastIndexOf(endToken); |
| if (endIndex == -1) { |
| return 0; |
| } |
| |
| int startIndex = endIndex; |
| while ((startIndex >= 0) && (aString.charAt(startIndex) != '(') && (aString.charAt(startIndex) != ',')) { |
| startIndex--; |
| } |
| |
| final String count = aString.substring(startIndex + 1, endIndex).trim(); |
| try { |
| return Integer.parseInt(count); |
| } |
| catch (final NumberFormatException e) { |
| return 0; |
| } |
| |
| } |
| |
| private void formatAccessesErrorRow(final String fileName, final int forbiddenAccessesWarningsCount, |
| final int discouragedAccessesWarningsCount, final StringBuffer buffer) { |
| |
| if ((forbiddenAccessesWarningsCount == 0) && (discouragedAccessesWarningsCount == 0)) { |
| return; |
| } |
| |
| final String hrefCompileLogsTargetPath2 = getHrefCompileLogsTargetPath(); |
| final int i = fileName.indexOf(hrefCompileLogsTargetPath2); |
| |
| final String shortName = fileName.substring(i + hrefCompileLogsTargetPath2.length()); |
| |
| buffer.append("<tr>\n<td>\n").append("<a href=").append("\"").append(hrefCompileLogsTargetPath2).append(shortName) |
| .append("\">").append(shortName).append("</a>").append("</td>\n").append("<td align=\"center\">").append("<a href=") |
| .append("\"").append(hrefCompileLogsTargetPath2).append(shortName).append("#FORBIDDEN_WARNINGS").append("\">") |
| .append(forbiddenAccessesWarningsCount).append("</a>").append("</td>\n").append("<td align=\"center\">") |
| .append("<a href=").append("\"").append(hrefCompileLogsTargetPath2).append(shortName) |
| .append("#DISCOURAGED_WARNINGS").append("\">").append(discouragedAccessesWarningsCount).append("</a>") |
| .append("</td>\n").append("</tr>\n"); |
| } |
| |
| private void formatCompileErrorRow(final String fileName, final int errorCount, final int warningCount, |
| final StringBuffer buffer) { |
| |
| if ((errorCount == 0) && (warningCount == 0)) { |
| return; |
| } |
| |
| final String hrefCompileLogsTargetPath2 = getHrefCompileLogsTargetPath(); |
| final int i = fileName.indexOf(hrefCompileLogsTargetPath2); |
| |
| final String shortName = fileName.substring(i + hrefCompileLogsTargetPath2.length()); |
| |
| buffer.append("<tr>\n<td>\n").append("<a href=").append("\"").append(hrefCompileLogsTargetPath2).append(shortName) |
| .append("\">").append(shortName).append("</a>").append("</td>\n").append("<td align=\"center\">").append("<a href=") |
| .append("\"").append(hrefCompileLogsTargetPath2).append(shortName).append("#ERRORS").append("\">") |
| .append(errorCount).append("</a>").append("</td>\n").append("<td align=\"center\">").append("<a href=").append("\"") |
| .append(hrefCompileLogsTargetPath2).append(shortName).append("#OTHER_WARNINGS").append("\">").append(warningCount) |
| .append("</a>").append("</td>\n").append("</tr>\n"); |
| } |
| |
| // Specific to the RelEng test results page |
| private String formatRowReleng(final String fileName, final int errorCount, final boolean link, String config) { |
| String testsConstant = ".tests"; |
| int testsConstantLength = testsConstant.length(); |
| String aString = ""; |
| if (!link) { |
| return "<tr><td>" + fileName + "</td><td align=\"center\">" + "DNF </td></tr>"; |
| } |
| |
| final int begin = fileName.lastIndexOf(File.separatorChar); |
| |
| // Get org.eclipse. out of the component name |
| int orgEclipseLength = "org.eclipse".length(); |
| // this is 11, 13 was hard coded? |
| // indexOf('_') assumes never part of file name? |
| final String shortName = fileName.substring(begin + orgEclipseLength, fileName.indexOf('_')); |
| String displayName = shortName; |
| |
| // If the short name does not start with this prefix |
| if (!shortName.startsWith(prefix)) { |
| // If the prefix is not yet set |
| if (prefix == "default") { |
| // Set the testShortName variable to the current short name |
| testShortName = shortName; |
| counter = 0; |
| // Set new prefix |
| |
| prefix = shortName.substring(0, shortName.indexOf(testsConstant) + testsConstantLength); |
| aString = aString + "\n<tbody>\r<tr><td><b>" + prefix + ".*" + "</b><td><td><td><td>"; |
| aString = aString + "<tr><td><p>" + shortName; |
| |
| } else { |
| // Set new prefix |
| prefix = shortName.substring(0, shortName.indexOf(testsConstant) + testsConstantLength); |
| |
| // Loop until the matching string postfix(test config.) is |
| // found |
| while (!fileName.endsWith(config)) { |
| aString = aString + "<td align=\"center\">-</td>"; |
| counter++; |
| } |
| |
| // In this case, the new prefix should be set with the short |
| // name under it, |
| // since this would mean that the team has more than one |
| // component test |
| // CAUTION: origionally said only "tests", not ".tests" |
| if (!shortName.endsWith(testsConstant)) { |
| aString = aString + "\n<tbody>\n<tr><td><b>" + prefix + ".*" + "</b><td><td><td><td>"; |
| aString = aString + "<tr><td><p>" + shortName; |
| } |
| // The team has only one component test |
| else { |
| aString = aString + "\n<tbody><tr><td><b>" + shortName; |
| } |
| testShortName = shortName; |
| |
| counter = 0; |
| } |
| } |
| // If the file's short name starts with the current prefix |
| if (shortName.startsWith(prefix)) { |
| // If the new file has a different short name than the current |
| // one |
| if (!shortName.equals(testShortName)) { |
| // Fill the remaining cells with '-'. These files will later |
| // be listed as |
| // missing |
| while (counter < getTestsConfigExpected().length()) { |
| aString = aString + "<td align=\"center\">-</td>"; |
| counter++; |
| } |
| counter = 0; |
| // Print the component name |
| aString = aString + "<tr><td><p>" + shortName; |
| // Loop until the matching string postfix(test config.) is |
| // found |
| while ((counter < getTestsConfigExpected().length()) && !fileName.endsWith(config)) { |
| aString = aString + "<td align=\"center\">-</td>"; |
| counter++; |
| } |
| } else { |
| // Loop until the matching string postfix(test config.) is |
| // found |
| while ((counter < getTestsConfigExpected().length()) && !fileName.endsWith(config)) { |
| aString = aString + "<td align=\"center\">-</td>"; |
| counter++; |
| } |
| // If the previous component has no more test files left |
| if (counter == getTestsConfigExpected().length()) { |
| counter = 0; |
| // Print the new component name |
| aString = aString + "<tr><td><p>" + shortName; |
| // Loop until the matching string postfix(test config.) |
| // is found |
| while ((counter < getTestsConfigExpected().length()) && !fileName.endsWith(config)) { |
| aString = aString + "<td align=\"center\">-</td>"; |
| counter++; |
| } |
| } |
| } |
| |
| testShortName = shortName; |
| |
| if (errorCount != 0) { |
| aString = aString + "<td align=\"center\"><b>"; |
| } else { |
| aString = aString + "<td align=\"center\">"; |
| } |
| |
| // Print number of errors |
| if (errorCount != 0) { |
| displayName = "<font color=\"#ff0000\">" + "(" + String.valueOf(errorCount) + ")" + "</font>"; |
| } else { |
| displayName = "(0)"; |
| } |
| |
| // Reference |
| if (errorCount == -1) { |
| aString = aString.concat(displayName); |
| } else { |
| // rawfilename is file name with no extension. |
| String rawfilename = fileName.substring(begin + 1, fileName.length() - XML_EXTENSION.length()); |
| aString = aString + "<a href=" + "\"" + hrefTestResultsTargetPath + "/html/" + rawfilename + HTML_EXTENSION + "\">" |
| + displayName + "</a>"; |
| aString = aString |
| + " <a style=\"color:#AAAAAA\" title=\"XML Test Result (e.g. for importing into the Eclipse JUnit view)\" href=\"" |
| + hrefTestResultsTargetPath + "/xml/" + rawfilename + XML_EXTENSION + "\">(XML)</a>"; |
| } |
| |
| if (errorCount == -1) { |
| aString = aString + "<font color=\"#ff0000\">DNF"; |
| } |
| |
| if (errorCount != 0) { |
| aString = aString + "</font></b></td>"; |
| } else { |
| aString = aString + "</td>"; |
| } |
| counter++; |
| } |
| |
| return aString; |
| } |
| |
| public String getTestedBuildType() { |
| return testedBuildType; |
| } |
| |
| /** |
| * Gets the compileLogsDirectoryName. |
| * |
| * @return Returns a String |
| */ |
| public String getCompileLogsDirectoryName() { |
| return compileLogsDirectoryName; |
| } |
| |
| public String getDropDirectoryName() { |
| return dropDirectoryName; |
| } |
| |
| /** |
| * Gets the dropHtmlFileName. |
| * |
| * @return Returns a String |
| */ |
| public String getDropHtmlFileName() { |
| return dropHtmlFileName; |
| } |
| |
| /** |
| * Gets the dropTemplateFileName. |
| * |
| * @return Returns a String |
| */ |
| public String getDropTemplateFileName() { |
| return dropTemplateFileName; |
| } |
| |
| public String getDropTokenList() { |
| return dropTokenList; |
| } |
| |
| /** |
| * @return |
| */ |
| public Vector getDropTokens() { |
| return dropTokens; |
| } |
| |
| private void getDropTokensFromList(final String list) { |
| final StringTokenizer tokenizer = new StringTokenizer(list, ","); |
| dropTokens = new Vector(); |
| |
| while (tokenizer.hasMoreTokens()) { |
| dropTokens.add(tokenizer.nextToken()); |
| } |
| } |
| |
| /** |
| * Gets the hrefCompileLogsTargetPath. |
| * |
| * @return Returns a String |
| */ |
| public String getHrefCompileLogsTargetPath() { |
| return hrefCompileLogsTargetPath; |
| } |
| |
| /** |
| * Gets the hrefTestResultsTargetPath. |
| * |
| * @return Returns a String |
| */ |
| public String getHrefTestResultsTargetPath() { |
| return hrefTestResultsTargetPath; |
| } |
| |
| public String getHtmlDirectoryName() { |
| return htmlDirectoryName; |
| } |
| |
| /** |
| * Gets the testManifestFileName. |
| * |
| * @return Returns a String |
| */ |
| public String getTestManifestFileName() { |
| return testManifestFileName; |
| } |
| |
| public String getTestResultsHtmlFileName() { |
| return testResultsHtmlFileName; |
| } |
| |
| public String getTestResultsTemplateFileName() { |
| return testResultsTemplateFileName; |
| } |
| |
| /** |
| * @return |
| */ |
| public String getTestResultsWithProblems() { |
| return testResultsWithProblems; |
| } |
| |
| /** |
| * @return |
| */ |
| public String getTestResultsXmlUrls() { |
| return testResultsXmlUrls; |
| } |
| |
| public String getXmlDirectoryName() { |
| return xmlDirectoryName; |
| } |
| |
| public boolean isBuildTested() { |
| return isBuildTested; |
| } |
| |
| private void parseCompileLog(final String log, final StringBuffer compilerLog, final StringBuffer accessesLog) { |
| int errorCount = 0; |
| int warningCount = 0; |
| int forbiddenWarningCount = 0; |
| int discouragedWarningCount = 0; |
| |
| final File file = new File(log); |
| Document aDocument = null; |
| BufferedReader reader = null; |
| try { |
| reader = new BufferedReader(new FileReader(file)); |
| final InputSource inputSource = new InputSource(reader); |
| final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); |
| final DocumentBuilder builder = factory.newDocumentBuilder(); |
| aDocument = builder.parse(inputSource); |
| } |
| catch (final SAXException e) { |
| logException(e); |
| } |
| catch (final IOException e) { |
| logException(e); |
| } |
| catch (final ParserConfigurationException e) { |
| logException(e); |
| } |
| finally { |
| if (reader != null) { |
| try { |
| reader.close(); |
| } |
| catch (final IOException e) { |
| // ignore |
| } |
| } |
| } |
| |
| if (aDocument == null) { |
| return; |
| } |
| // Get summary of problems |
| final NodeList nodeList = aDocument.getElementsByTagName("problem"); |
| if ((nodeList == null) || (nodeList.getLength() == 0)) { |
| return; |
| } |
| |
| final int length = nodeList.getLength(); |
| for (int i = 0; i < length; i++) { |
| final Node problemNode = nodeList.item(i); |
| final NamedNodeMap aNamedNodeMap = problemNode.getAttributes(); |
| final Node severityNode = aNamedNodeMap.getNamedItem("severity"); |
| final Node idNode = aNamedNodeMap.getNamedItem("id"); |
| if (severityNode != null) { |
| final String severityNodeValue = severityNode.getNodeValue(); |
| if (WARNING_SEVERITY.equals(severityNodeValue)) { |
| // this is a warning |
| // need to check the id |
| final String nodeValue = idNode.getNodeValue(); |
| if (ForbiddenReferenceID.equals(nodeValue)) { |
| forbiddenWarningCount++; |
| } else if (DiscouragedReferenceID.equals(nodeValue)) { |
| discouragedWarningCount++; |
| } else { |
| warningCount++; |
| } |
| } else if (ERROR_SEVERITY.equals(severityNodeValue)) { |
| // this is an error |
| errorCount++; |
| } |
| } |
| } |
| if (errorCount != 0) { |
| // use wildcard in place of version number on directory names |
| // log(log + "/n"); |
| String logName = log.substring(getCompileLogsDirectoryName().length() + 1); |
| final StringBuffer buffer = new StringBuffer(logName); |
| buffer.replace(logName.indexOf("_") + 1, logName.indexOf(File.separator, logName.indexOf("_") + 1), "*"); |
| logName = new String(buffer); |
| |
| anErrorTracker.registerError(logName); |
| } |
| // make sure '.xml' extension is "last thing" in string. (bug 490320) |
| final String logName = log.replaceAll(XML_EXTENSION + "$", HTML_EXTENSION); |
| formatCompileErrorRow(logName, errorCount, warningCount, compilerLog); |
| formatAccessesErrorRow(logName, forbiddenWarningCount, discouragedWarningCount, accessesLog); |
| } |
| |
| private void parseCompileLogs() { |
| |
| final StringBuffer compilerString = new StringBuffer(); |
| final StringBuffer accessesString = new StringBuffer(); |
| processCompileLogsDirectory(compileLogsDirectoryName, compilerString, accessesString); |
| if (compilerString.length() == 0) { |
| compilerString.append("None"); |
| } |
| if (accessesString.length() == 0) { |
| accessesString.append("None"); |
| } |
| testResultsTemplateString = replace(testResultsTemplateString, compileLogsToken, String.valueOf(compilerString)); |
| |
| testResultsTemplateString = replace(testResultsTemplateString, accessesLogsToken, String.valueOf(accessesString)); |
| } |
| |
| private void parseXml() throws IOException { |
| |
| final File sourceDirectory = new File(xmlDirectoryName); |
| |
| if (sourceDirectory.exists()) { |
| // reinitialize each time. |
| // We currently "re do" all of them, but can improve in the future |
| // where the |
| // 'found configs" are remembered, but then have to keep track of |
| // original order |
| // (not "found order"). |
| foundConfigs.clear(); |
| String replaceString = ""; |
| for (String expectedConfig : getTestsConfig()) { |
| |
| FilenameFilter configfilter = new ExpectedConfigFiler(expectedConfig); |
| final File[] xmlFileNames = sourceDirectory.listFiles(configfilter); |
| |
| if (xmlFileNames.length > 0) { |
| foundConfigs.add(expectedConfig); |
| } |
| // sort by name, for each 'config' found. |
| Arrays.sort(xmlFileNames); |
| |
| String sourceDirectoryCanonicalPath = computeMainOutputDirectory(sourceDirectory); |
| |
| for (int i = 0; i < xmlFileNames.length; i++) { |
| final String fullName = xmlFileNames[i].getPath(); |
| final int errorCount = countErrors(fullName); |
| if (errorCount != 0) { |
| final String testName = xmlFileNames[i].getName().substring(0, |
| xmlFileNames[i].getName().length() - XML_EXTENSION.length()); |
| testResultsWithProblems = testResultsWithProblems.concat("\n" + testName); |
| testResultsXmlUrls = testResultsXmlUrls |
| .concat("\n" + extractXmlRelativeFileName(sourceDirectoryCanonicalPath, xmlFileNames[i])); |
| anErrorTracker.registerError(fullName.substring(getXmlDirectoryName().length() + 1)); |
| } |
| String tmp = formatRowReleng(xmlFileNames[i].getPath(), errorCount, true, expectedConfig); |
| replaceString = replaceString + tmp; |
| } |
| // check for missing test logs |
| replaceString = replaceString + verifyAllTestsRan(xmlDirectoryName, expectedConfig); |
| |
| testResultsTemplateString = replace(testResultsTemplateString, testResultsToken, replaceString); |
| testsRan = true; |
| } |
| if (foundConfigs.size() > 0) { |
| // write each to output directory in file testConfigs.php |
| writePhpConfigFile(sourceDirectory, found_config_type, foundConfigs, FOUND_TEST_CONFIGS_FILENAME); |
| } else { |
| testsRan = false; |
| log("Test results not found in " + sourceDirectory.getAbsolutePath()); |
| } |
| } |
| } |
| |
| private void writePhpConfigFile(final File sourceDirectory, String config_type, ArrayList<String> configs, String phpfilename) |
| throws IOException { |
| File mainDir = new File(computeMainOutputDirectory(sourceDirectory)); |
| File testConfigsFile = new File(mainDir, phpfilename); |
| Writer testconfigsPHP = new FileWriter(testConfigsFile); |
| testconfigsPHP.write("<?php" + EOL); |
| testconfigsPHP.write("//This file created by 'generateIndex' ant task, while parsing test results" + EOL); |
| testconfigsPHP.write("// It is based on " + config_type + " testConfigs" + EOL); |
| String phpArrayVariableName = "$" + config_type + "TestConfigs"; |
| testconfigsPHP.write(phpArrayVariableName + " = array();" + EOL); |
| for (String fConfig : configs) { |
| testconfigsPHP.write(phpArrayVariableName + "[]=\"" + fConfig + "\";" + EOL); |
| } |
| testconfigsPHP.close(); |
| } |
| |
| private String computeMainOutputDirectory(final File sourceDirectory) { |
| File sourceDirectoryParent = sourceDirectory.getParentFile(); |
| if (sourceDirectoryParent != null) { |
| sourceDirectoryParent = sourceDirectoryParent.getParentFile(); |
| } |
| String sourceDirectoryCanonicalPath = null; |
| try { |
| sourceDirectoryCanonicalPath = sourceDirectoryParent.getCanonicalPath(); |
| } |
| catch (final IOException e) { |
| logException(e); |
| } |
| return sourceDirectoryCanonicalPath; |
| } |
| |
| private void processCompileLogsDirectory(final String directoryName, final StringBuffer compilerLog, |
| final StringBuffer accessesLog) { |
| final File sourceDirectory = new File(directoryName); |
| if (sourceDirectory.isFile()) { |
| if (sourceDirectory.getName().endsWith(".log")) { |
| readCompileLog(sourceDirectory.getAbsolutePath(), compilerLog, accessesLog); |
| } |
| if (sourceDirectory.getName().endsWith(XML_EXTENSION)) { |
| parseCompileLog(sourceDirectory.getAbsolutePath(), compilerLog, accessesLog); |
| } |
| } |
| if (sourceDirectory.isDirectory()) { |
| final File[] logFiles = sourceDirectory.listFiles(); |
| Arrays.sort(logFiles); |
| for (int j = 0; j < logFiles.length; j++) { |
| processCompileLogsDirectory(logFiles[j].getAbsolutePath(), compilerLog, accessesLog); |
| } |
| } |
| } |
| |
| private String processDropRow(final PlatformStatus aPlatform) { |
| if ("equinox".equalsIgnoreCase(aPlatform.getFormat())) { |
| return processEquinoxDropRow(aPlatform); |
| } |
| |
| String result = "<tr>"; |
| // result = result + "<td><div align=left>" + getStatusColumn(aPlatform, |
| // "", true) + "</div></td>\n"; |
| result = result + "<td>" + aPlatform.getName() + "</td>"; |
| result = result + "<td>" + aPlatform.getFileName() + "</td>\n"; |
| result = result + "</tr>\n"; |
| return result; |
| } |
| |
| private String processDropRows(final PlatformStatus[] platforms) { |
| String result = ""; |
| for (int i = 0; i < platforms.length; i++) { |
| result = result + processDropRow(platforms[i]); |
| } |
| return result; |
| } |
| |
| /* |
| * Generate and return the HTML mark-up for a single row for an Equinox JAR |
| * on the downloads page. |
| */ |
| private String processEquinoxDropRow(final PlatformStatus aPlatform) { |
| String result = "<tr>"; |
| // result = result + "<td align=\"center\">" + |
| // getStatusColumn(aPlatform, "/equinox/images/", true) + "</td>\n"; |
| result = result + "<td>"; |
| final String filename = aPlatform.getFileName(); |
| // if there are images, put them in the same table column as the name of |
| // the file |
| final List images = aPlatform.getImages(); |
| if ((images != null) && !images.isEmpty()) { |
| for (final Iterator iter = images.iterator(); iter.hasNext();) { |
| result = result + "<img src=\"" + iter.next() + "\"/> "; |
| } |
| } |
| result = result + "<a href=\"download.php?dropFile=" + filename + "\">" + filename + "</a></td>\n"; |
| result = result + "{$generateDropSize(\"" + filename + "\")}\n"; |
| result = result + "{$generateChecksumLinks(\"" + filename + "\", $buildlabel)}\n"; |
| result = result + "</tr>\n"; |
| return result; |
| } |
| |
| private void readCompileLog(final String log, final StringBuffer compilerLog, final StringBuffer accessesLog) { |
| final String fileContents = readFile(log); |
| |
| final int errorCount = countCompileErrors(fileContents); |
| final int warningCount = countCompileWarnings(fileContents); |
| final int forbiddenWarningCount = countForbiddenWarnings(fileContents); |
| final int discouragedWarningCount = countDiscouragedWarnings(fileContents); |
| if (errorCount != 0) { |
| // use wildcard in place of version number on directory names |
| String logName = log.substring(getCompileLogsDirectoryName().length() + 1); |
| final StringBuffer stringBuffer = new StringBuffer(logName); |
| stringBuffer.replace(logName.indexOf("_") + 1, logName.indexOf(File.separator, logName.indexOf("_") + 1), "*"); |
| logName = new String(stringBuffer); |
| |
| anErrorTracker.registerError(logName); |
| } |
| formatCompileErrorRow(log, errorCount, warningCount, compilerLog); |
| formatAccessesErrorRow(log, forbiddenWarningCount, discouragedWarningCount, accessesLog); |
| } |
| |
| private String readFile(final String fileName) { |
| byte[] aByteArray = null; |
| try { |
| aByteArray = getFileByteContent(fileName); |
| } |
| catch (final IOException e) { |
| logException(e); |
| } |
| if (aByteArray == null) { |
| return ""; |
| } |
| return new String(aByteArray); |
| } |
| |
| private String replace(final String source, final String original, final String replacement) { |
| |
| final int replaceIndex = source.indexOf(original); |
| if (replaceIndex > -1) { |
| String resultString = source.substring(0, replaceIndex); |
| resultString = resultString + replacement; |
| resultString = resultString + source.substring(replaceIndex + original.length()); |
| return resultString; |
| } else { |
| log("Could not find token: " + original); |
| return source; |
| } |
| |
| } |
| |
| public void setTestedBuildType(final String buildType) { |
| this.testedBuildType = buildType; |
| } |
| |
| /** |
| * Sets the compileLogsDirectoryName. |
| * |
| * @param compileLogsDirectoryName |
| * The compileLogsDirectoryName to set |
| */ |
| public void setCompileLogsDirectoryName(final String compileLogsDirectoryName) { |
| this.compileLogsDirectoryName = compileLogsDirectoryName; |
| } |
| |
| public void setDropDirectoryName(final String aString) { |
| dropDirectoryName = aString; |
| } |
| |
| /** |
| * Sets the dropHtmlFileName. |
| * |
| * @param dropHtmlFileName |
| * The dropHtmlFileName to set |
| */ |
| public void setDropHtmlFileName(final String dropHtmlFileName) { |
| this.dropHtmlFileName = dropHtmlFileName; |
| } |
| |
| /** |
| * Sets the dropTemplateFileName. |
| * |
| * @param dropTemplateFileName |
| * The dropTemplateFileName to set |
| */ |
| public void setDropTemplateFileName(final String dropTemplateFileName) { |
| this.dropTemplateFileName = dropTemplateFileName; |
| } |
| |
| public void setDropTokenList(final String dropTokenList) { |
| this.dropTokenList = dropTokenList; |
| } |
| |
| /** |
| * Sets the hrefCompileLogsTargetPath. |
| * |
| * @param hrefCompileLogsTargetPath |
| * The hrefCompileLogsTargetPath to set |
| */ |
| public void setHrefCompileLogsTargetPath(final String hrefCompileLogsTargetPath) { |
| this.hrefCompileLogsTargetPath = hrefCompileLogsTargetPath; |
| } |
| |
| /** |
| * Sets the hrefTestResultsTargetPath. |
| * |
| * @param hrefTestResultsTargetPath |
| * The hrefTestResultsTargetPath to set |
| */ |
| public void setHrefTestResultsTargetPath(final String htmlTargetPath) { |
| hrefTestResultsTargetPath = htmlTargetPath; |
| } |
| |
| public void setHtmlDirectoryName(final String aString) { |
| htmlDirectoryName = aString; |
| } |
| |
| public void setIsBuildTested(final boolean isBuildTested) { |
| this.isBuildTested = isBuildTested; |
| } |
| |
| /** |
| * Sets the testManifestFileName. |
| * |
| * @param testManifestFileName |
| * The testManifestFileName to set |
| */ |
| public void setTestManifestFileName(final String testManifestFileName) { |
| this.testManifestFileName = testManifestFileName; |
| } |
| |
| public void setTestResultsHtmlFileName(final String aString) { |
| testResultsHtmlFileName = aString; |
| } |
| |
| public void setTestResultsTemplateFileName(final String aString) { |
| testResultsTemplateFileName = aString; |
| } |
| |
| /** |
| * @param b |
| */ |
| public void setTestsRan(final boolean b) { |
| testsRan = b; |
| } |
| |
| public void setXmlDirectoryName(final String aString) { |
| xmlDirectoryName = aString; |
| } |
| |
| /** |
| * @return |
| */ |
| public boolean testsRan() { |
| return testsRan; |
| } |
| |
| private String verifyAllTestsRan(final String directory, String foundConfig) { |
| String replaceString = ""; |
| if (getDoMissingList()) { |
| final Enumeration enumeration = (anErrorTracker.getTestLogs()).elements(); |
| |
| while (enumeration.hasMoreElements()) { |
| final String testLogName = enumeration.nextElement().toString(); |
| |
| if (new File(directory + File.separator + testLogName).exists()) { |
| continue; |
| } |
| |
| anErrorTracker.registerError(testLogName); |
| // final String tmp = ((platformSpecificTemplateList.equals("")) |
| // ? formatRow(testLogName, -1, false) : formatRowReleng( |
| // testLogName, -1, false)); |
| String tmp = formatRowReleng(testLogName, -1, false, foundConfig); |
| if (missingCount == 0) { |
| replaceString = replaceString + "</table></br>" + "\n" |
| + "<table width=\"65%\" border=\"1\" bgcolor=\"#EEEEEE\" rules=\"groups\" align=\"center\">" |
| + "<tr bgcolor=\"#9999CC\"> <th width=\"80%\" align=\"center\"> Missing Files </th><th align=\"center\"> Status </th></tr>"; |
| } |
| replaceString = replaceString + tmp; |
| testResultsWithProblems = testResultsWithProblems |
| .concat("\n" + testLogName.substring(0, testLogName.length() - XML_EXTENSION.length()) + " (file missing)"); |
| missingCount++; |
| } |
| } else { |
| // Note: we intentionally |
| replaceString = replaceString + "<tbody>\n" + "<tr><td colspan=\"0\"><p><span class=\"footnote\">NOTE: </span>\n" |
| + "Remember that for performance unit test tables, there are never any \"missing files\" listed, if there are any. \n" |
| + "This is expected to be a temporary solution, until an exact fix can be implemented. For more details, see \n" |
| + "<a href=\"https://bugs.eclipse.org/bugs/show_bug.cgi?id=451890\">bug 451890</a>.</p>\n" + "</td></tr>\n" |
| + "</tbody>\n"; |
| } |
| return replaceString; |
| } |
| |
| private void writeDropIndexFile() { |
| |
| final String[] types = anErrorTracker.getTypes(); |
| for (int i = 0; i < types.length; i++) { |
| final PlatformStatus[] platforms = anErrorTracker.getPlatforms(types[i]); |
| final String replaceString = processDropRows(platforms); |
| dropTemplateString = replace(dropTemplateString, dropTokens.get(i).toString(), replaceString); |
| } |
| final String outputFileName = dropDirectoryName + File.separator + dropHtmlFileName; |
| writeFile(outputFileName, dropTemplateString); |
| } |
| |
| private void writeFile(final String outputFileName, final String contents) { |
| OutputStream outputStream = null; |
| try { |
| outputStream = new BufferedOutputStream(new FileOutputStream(outputFileName)); |
| outputStream.write(contents.getBytes()); |
| } |
| catch (final FileNotFoundException e) { |
| log("File not found exception writing: " + outputFileName); |
| } |
| catch (final IOException e) { |
| log("IOException writing: " + outputFileName); |
| } |
| finally { |
| if (outputStream != null) { |
| try { |
| outputStream.close(); |
| } |
| catch (final IOException e) { |
| // ignore |
| } |
| } |
| } |
| } |
| |
| private void writeTestResultsFile() { |
| final String outputFileName = dropDirectoryName + File.separator + testResultsHtmlFileName; |
| writeFile(outputFileName, testResultsTemplateString); |
| } |
| |
| public String getTestsConfigExpected() { |
| |
| return testsConfigExpected; |
| } |
| |
| public void setTestsConfigExpected(String testsConfigExpected) { |
| this.testsConfigExpected = testsConfigExpected; |
| System.out.println("DEBUG: testsConfigExpected: " + testsConfigExpected); |
| } |
| |
| private ArrayList<String> getTestsConfig() throws IOException { |
| if (expectedConfigs == null) { |
| expectedConfigs = new ArrayList<String>(); |
| String expectedConfigParam = getTestsConfigExpected(); |
| if (expectedConfigParam != null) { |
| StringTokenizer tokenizer = new StringTokenizer(expectedConfigParam, " ,\t"); |
| while (tokenizer.hasMoreTokens()) { |
| expectedConfigs.add(tokenizer.nextToken()); |
| } |
| } else { |
| throw new BuildException("test configurations were not found. One or more must be set."); |
| } |
| if (DEBUG) { |
| log("DEBUG: testsConfig array "); |
| for (String expected : expectedConfigs) { |
| log("\tDEBUG: expectedTestConfig: " + expected); |
| } |
| } |
| // write expected test config file here. This file is later used by |
| // the PHP file. |
| final File sourceDirectory = new File(xmlDirectoryName); |
| writePhpConfigFile(sourceDirectory, expected_config_type, expectedConfigs, EXPECTED_TEST_CONFIGS_FILENAME); |
| } |
| return expectedConfigs; |
| } |
| |
| private boolean getDoMissingList() { |
| return doMissingList; |
| } |
| |
| } |
