SessionExporter.java

/*******************************************************************************
 * Copyright (c) 2006, 2016 Mountainminds GmbH & Co. KG and Contributors
 * 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:
 *    Marc R. Hoffmann - initial API and implementation
 *    
 ******************************************************************************/
package com.mountainminds.eclemma.internal.core;

import static com.mountainminds.eclemma.core.ISessionExporter.ExportFormat.EXEC;
import static com.mountainminds.eclemma.core.ISessionExporter.ExportFormat.HTML;

import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.Reader;
import java.io.StringReader;
import java.util.Map;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.SubProgressMonitor;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.IPackageFragment;
import org.eclipse.jdt.core.IPackageFragmentRoot;
import org.eclipse.jdt.core.ISourceReference;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.formatter.IndentManipulation;
import org.eclipse.osgi.util.NLS;
import org.jacoco.core.analysis.IBundleCoverage;
import org.jacoco.core.data.ExecutionDataWriter;
import org.jacoco.report.FileMultiReportOutput;
import org.jacoco.report.IReportGroupVisitor;
import org.jacoco.report.IReportVisitor;
import org.jacoco.report.ISourceFileLocator;
import org.jacoco.report.ZipMultiReportOutput;
import org.jacoco.report.csv.CSVFormatter;
import org.jacoco.report.html.HTMLFormatter;
import org.jacoco.report.xml.XMLFormatter;

import com.mountainminds.eclemma.core.EclEmmaStatus;
import com.mountainminds.eclemma.core.ICoverageSession;
import com.mountainminds.eclemma.core.ISessionExporter;
import com.mountainminds.eclemma.core.analysis.IJavaModelCoverage;
import com.mountainminds.eclemma.internal.core.analysis.SessionAnalyzer;

/**
 * Implementation of ISessionExporter.
 */
public class SessionExporter implements ISessionExporter {

  private final ICoverageSession session;
  private ExportFormat format;
  private String destination;

  public SessionExporter(ICoverageSession session) {
    this.session = session;
  }

  public void setFormat(ExportFormat format) {
    this.format = format;
  }

  public void setDestination(String filename) {
    this.destination = filename;
  }

  public void export(IProgressMonitor monitor) throws CoreException {
    try {
      if (EXEC.equals(format)) {
        createExecFile(monitor);
      } else {
        createReport(monitor);
      }
    } catch (IOException e) {
      throw new CoreException(EclEmmaStatus.EXPORT_ERROR.getStatus(e));
    }
  }

  private void createExecFile(IProgressMonitor monitor) throws IOException,
      CoreException {
    monitor.beginTask(
        NLS.bind(CoreMessages.ExportingSession_task, session.getDescription()),
        1);
    final OutputStream out = new BufferedOutputStream(new FileOutputStream(
        destination));
    final ExecutionDataWriter writer = new ExecutionDataWriter(out);
    session.accept(writer, writer);
    out.close();
    monitor.done();
  }

  private void createReport(IProgressMonitor monitor) throws CoreException,
      IOException {
    final int work = session.getScope().size();
    monitor.beginTask(
        NLS.bind(CoreMessages.ExportingSession_task, session.getDescription()),
        work * 2);
    final SessionAnalyzer analyzer = new SessionAnalyzer();
    final IJavaModelCoverage modelCoverage = analyzer.processSession(session,
        new SubProgressMonitor(monitor, work));
    final IReportVisitor formatter = createFormatter();
    formatter
        .visitInfo(analyzer.getSessionInfos(), analyzer.getExecutionData());
    final IReportGroupVisitor modelgroup = formatter.visitGroup(session
        .getDescription());
    for (IJavaProject project : modelCoverage.getProjects()) {
      final IReportGroupVisitor projectgroup = modelgroup.visitGroup(project
          .getElementName());
      for (IPackageFragmentRoot root : project.getPackageFragmentRoots()) {
        final IBundleCoverage coverage = (IBundleCoverage) modelCoverage
            .getCoverageFor(root);
        if (coverage != null) {
          projectgroup.visitBundle(coverage, createSourceFileLocator(root));
          monitor.worked(1);
        }
      }
    }
    formatter.visitEnd();
    monitor.done();
  }

  private IReportVisitor createFormatter() throws IOException {
    final File file = new File(destination);
    if (HTML.equals(format)) {
      HTMLFormatter htmlFormatter = new HTMLFormatter();
      htmlFormatter.setFooterText(session.getDescription());
      return htmlFormatter.createVisitor(new FileMultiReportOutput(file));
    }
    final OutputStream out = new BufferedOutputStream(
        new FileOutputStream(file));
    switch (format) {
    case HTMLZIP:
      final HTMLFormatter htmlFormatter = new HTMLFormatter();
      htmlFormatter.setFooterText(session.getDescription());
      return htmlFormatter.createVisitor(new ZipMultiReportOutput(out));
    case XML:
      final XMLFormatter xmlFormatter = new XMLFormatter();
      return xmlFormatter.createVisitor(out);
    case CSV:
      final CSVFormatter csvFormatter = new CSVFormatter();
      return csvFormatter.createVisitor(out);
    default:
      out.close();
      throw new AssertionError("Unexpected format " + format); //$NON-NLS-1$
    }
  }

  private ISourceFileLocator createSourceFileLocator(IPackageFragmentRoot root)
      throws JavaModelException {
    if (root.getKind() == IPackageFragmentRoot.K_SOURCE) {
      return new SourceFolderSourceFileLocator(root);
    } else {
      return new LibrarySourceFileLocator(root);
    }
  }

  private static abstract class AbstractSourceFileLocator implements
      ISourceFileLocator {

    protected final IPackageFragmentRoot root;
    private final int tabWidth;

    public AbstractSourceFileLocator(IPackageFragmentRoot root) {
      this.root = root;
      final Map<?, ?> options = root.getJavaProject().getOptions(true);
      this.tabWidth = IndentManipulation.getTabWidth(options);
    }

    public final int getTabWidth() {
      return tabWidth;
    }

    public final Reader getSourceFile(String packagename, String sourcename)
        throws IOException {
      try {
        packagename = packagename.replace('/', '.');
        final IPackageFragment pkg = root.getPackageFragment(packagename);
        final String source = getSourceReference(pkg, sourcename).getSource();
        if (source != null) {
          return new StringReader(source);
        } else {
          return null;
        }
      } catch (CoreException e) {
        final IOException ioException = new IOException(e.getMessage());
        throw (IOException) ioException.initCause(e);
      }
    }

    protected abstract ISourceReference getSourceReference(
        IPackageFragment pkg, String sourcename) throws CoreException;

  }

  private static class SourceFolderSourceFileLocator extends
      AbstractSourceFileLocator {

    public SourceFolderSourceFileLocator(IPackageFragmentRoot root) {
      super(root);
    }

    @Override
    protected ISourceReference getSourceReference(IPackageFragment pkg,
        String sourcename) throws CoreException {
      return pkg.getCompilationUnit(sourcename);
    }

  }

  private static class LibrarySourceFileLocator extends
      AbstractSourceFileLocator {

    public LibrarySourceFileLocator(IPackageFragmentRoot root) {
      super(root);
    }

    @Override
    protected ISourceReference getSourceReference(IPackageFragment pkg,
        String sourcename) throws CoreException {
      int idx = sourcename.lastIndexOf('.');
      if (idx != -1) {
        sourcename = sourcename.substring(0, idx);
      }
      return pkg.getClassFile(sourcename + ".class"); //$NON-NLS-1$
    }
  }

}