FxCopRunner.java

/*
 * .NET tools :: FxCop Runner
 * Copyright (C) 2010 Jose Chillan, Alexandre Victoor and SonarSource
 * dev@sonar.codehaus.org
 *
 * 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 org.sonar.dotnet.tools.fxcop;

import java.io.File;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.utils.command.CommandExecutor;
import org.sonar.dotnet.tools.commons.visualstudio.VisualStudioProject;
import org.sonar.dotnet.tools.commons.visualstudio.VisualStudioSolution;

/**
 * Class that runs the FxCop program.
 */
public class FxCopRunner { // NOSONAR : can't mock it otherwise

  private static final Logger LOG = LoggerFactory.getLogger(FxCopRunner.class);

  private static final String FXCOP_EXECUTABLE = "FxCopCmd.exe";

  private static final long MINUTES_TO_MILLISECONDS = 60000;

  private File fxCopExecutable;

  private FxCopRunner() {
  }

  /**
   * Creates a new {@link FxCopRunner} object for the given executable file.
   * 
   * @param fxCopPath
   *          the full path of the fxcop install directory. For instance: "C:/Program Files/Microsoft FxCop 10.0".
   */
  public static FxCopRunner create(String fxCopPath) throws FxCopException {
    FxCopRunner runner = new FxCopRunner();
    runner.fxCopExecutable = new File(fxCopPath, FXCOP_EXECUTABLE);
    return runner;
  }

  
  /**
   * Creates a pre-configured {@link FxCopCommandBuilder} that needs to be completed before running the
   * {@link #execute(FxCopCommandBuilder, int)} method.
   * @param solution  the current VS solution
   * @param project   the VS project to analyse
   * 
   * @return the command to complete.
   */
  public FxCopCommandBuilder createCommandBuilder(VisualStudioSolution solution, VisualStudioProject project) {
    FxCopCommandBuilder builder = FxCopCommandBuilder.createBuilder(solution, project);
    builder.setExecutable(fxCopExecutable);
    return builder;
  }

  /**
   * Executes the given FxCop command.
   * 
   * @param fxCopCommandBuilder
   *          the fxCopCommandBuilder
   * @param timeoutMinutes
   *          the timeout for the command
   * @throws FxCopException
   *           if FxCop fails to execute
   */
  public void execute(FxCopCommandBuilder fxCopCommandBuilder, int timeoutMinutes) throws FxCopException {
    LOG.debug("Executing FxCop program...");
    int exitCode = CommandExecutor.create().execute(fxCopCommandBuilder.toCommand(), timeoutMinutes * MINUTES_TO_MILLISECONDS);
    if (exitCode != 0 && exitCode != 512) {
      throw new FxCopException("FxCop execution failed with return code '" + exitCode
          + "'. Check FxCop documentation for more information.");
    }
  }

}