au.com.integradev.delphi.nunit.DelphiNUnitParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of delphi-frontend Show documentation
The newest version!
/*
 * Sonar Delphi Plugin
 * Copyright (C) 2019 Integrated Application Development
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package au.com.integradev.delphi.nunit;

import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.Collections;
import javax.xml.XMLConstants;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.filefilter.FileFilterUtils;
import org.apache.commons.io.filefilter.TrueFileFilter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.xml.sax.SAXException;

/** Parses NUnit test reports from XML files. */
public final class DelphiNUnitParser {
  private static final Logger LOG = LoggerFactory.getLogger(DelphiNUnitParser.class);

  private DelphiNUnitParser() {
    // Utility class
  }

  public static ResultsAggregator collect(File reportsDir) {
    LOG.info("Processing reports in {}", reportsDir);
    return parseFiles(getReports(reportsDir));
  }

  private static Collection getReports(File path) {
    if (!path.isDirectory()) {
      LOG.warn("Reports directory not found: {}", path.getAbsolutePath());
      return Collections.emptyList();
    } else {
      Collection files = findXmlFiles(path);
      LOG.info("Found {} XML files in {}", files.size(), path);
      return files;
    }
  }

  private static Collection findXmlFiles(File dir) {
    return FileUtils.listFiles(
        dir, FileFilterUtils.suffixFileFilter(".xml"), TrueFileFilter.INSTANCE);
  }

  private static NUnitFileParser getParserForFile(Document doc) {
    String rootElementName = doc.getDocumentElement().getNodeName();

    if (rootElementName.equals("test-run")) {
      return new NUnit3FileParser();
    } else if (rootElementName.equals("test-results")) {
      return new NUnit2FileParser();
    } else {
      return null;
    }
  }

  private static void parse(File reportFile, ResultsAggregator results) {
    try {
      LOG.debug("Parsing NUnit report {}", reportFile);
      DocumentBuilderFactory docBuilderFactory = DocumentBuilderFactory.newInstance();
      docBuilderFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true);
      docBuilderFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_DTD, "");
      docBuilderFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_SCHEMA, "");
      DocumentBuilder docBuilder = docBuilderFactory.newDocumentBuilder();
      Document doc = docBuilder.parse(reportFile);

      doc.getDocumentElement().normalize();

      NUnitFileParser parser = getParserForFile(doc);
      if (parser != null) {
        parser.parse(doc, results);
      } else {
        LOG.error("Report '{}' is not a recognised NUnit format, skipping.", reportFile);
      }
    } catch (SAXException | ParserConfigurationException | IOException e) {
      LOG.error("Error while parsing report '{}':", reportFile, e);
    }
  }

  private static ResultsAggregator parseFiles(Collection reports) {
    ResultsAggregator results = new ResultsAggregator();
    reports.forEach(report -> parse(report, results));
    return results;
  }
}