org.sonar.plugins.visualstudio.VisualStudioAssemblyLocator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-visual-studio-plugin Show documentation
Bootstraps the analysis from Visual Studio solution and project files.
The newest version!
/*
 * Analysis Bootstrapper for Visual Studio Projects
 * Copyright (C) 2014 SonarSource
 * [email protected]
 *
 * 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.plugins.visualstudio;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Splitter;
import com.google.common.collect.Lists;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.config.Settings;

import javax.annotation.Nullable;

import java.io.File;
import java.io.Serializable;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;

public class VisualStudioAssemblyLocator {

  private static final Logger LOG = LoggerFactory.getLogger(VisualStudioProjectBuilder.class);
  private static final Comparator FILE_LAST_MODIFIED_COMPARATOR = new FileLastModifiedComparator();

  private final Settings settings;

  public VisualStudioAssemblyLocator(Settings settings) {
    this.settings = settings;
  }

  public File locateAssembly(String projectName, File projectFile, VisualStudioProject project) {
    LOG.debug("Locating the assembly for the project " + projectName + "... " + projectFile.getAbsolutePath());
    if (project.outputType() == null || project.assemblyName() == null) {
      LOG.warn("Unable to locate the assembly as either the output type or the assembly name is missing.");
      return null;
    }

    String extension = extension(projectFile, project.outputType());
    if (extension == null) {
      LOG.warn("Unable to locate the assembly of the unsupported output type \"" + project.outputType() + "\" of project: " + projectFile.getAbsolutePath());
      return null;
    }

    String assemblyFileName = project.assemblyName() + "." + extension;
    List candidates = candidates(assemblyFileName, projectFile, project);

    if (candidates.isEmpty()) {
      LOG.warn("Unable to locate the assembly of project " + projectName);
      return null;
    }

    Collections.sort(candidates, FILE_LAST_MODIFIED_COMPARATOR);

    if (candidates.size() == 1) {
      String title = candidates.size() == 1 ? "Using the the following assembly for project " : "Using the most recently generated assembly for project ";
      LOG.info(title + projectName + ": " + candidates.get(0).getAbsolutePath());
    }

    return candidates.get(0);
  }

  @VisibleForTesting
  @Nullable
  String extension(File projectFile, String outputType) {
    String result;

    String lowerOutputType = outputType.toLowerCase();

    if ("library".equals(lowerOutputType)) {
      result = "dll";
    } else if ("exe".equals(lowerOutputType)) {
      result = "exe";
    } else if ("winexe".equals(lowerOutputType)) {
      result = "exe";
    } else {
      result = null;
    }

    return result;
  }

  private List candidates(String assemblyFileName, File projectFile, VisualStudioProject project) {
    List candidates = Lists.newArrayList();

    String explicitOutputPaths = settings.getString(VisualStudioPlugin.VISUAL_STUDIO_OUTPUT_PATHS_PROPERTY_KEY);
    if (explicitOutputPaths != null) {
      LOG.info("Using the assembly output paths specified using the property \"" + VisualStudioPlugin.VISUAL_STUDIO_OUTPUT_PATHS_PROPERTY_KEY
        + "\" set to: " + explicitOutputPaths);

      for (String explicitOutputPath : Splitter.on(',').omitEmptyStrings().split(explicitOutputPaths)) {
        File candidate = new File(new File(explicitOutputPath.replace('\\', '/')), assemblyFileName);
        candidates.add(candidate);
      }
    } else {
      for (int i = 0; i < project.outputPaths().size(); i++) {
        String outputPath = project.outputPaths().get(i);
        File candidate = new File(projectFile.getParentFile(), outputPath.replace('\\', '/') + '/' + assemblyFileName);

        if (!candidate.isFile()) {
          LOG.debug("The following candidate assembly was not built: " + candidate.getAbsolutePath());
        } else if (matchesBuildConfigurationAndPlatform(project.propertyGroupConditions().get(i))) {
          LOG.debug("The following candidate assembly was found: " + candidate.getAbsolutePath());
          candidates.add(candidate);
        } else {
          LOG.info("The following candidate assembly was found, but rejected because it does not match the request build configuration and platform: "
            + candidate.getAbsolutePath());
        }
      }
    }

    return candidates;
  }

  private boolean matchesBuildConfigurationAndPlatform(String condition) {
    String buildConfiguration = settings.getString(VisualStudioPlugin.VISUAL_STUDIO_OLD_BUILD_CONFIGURATION_PROPERTY_KEY);
    String buildPlatform = settings.getString(VisualStudioPlugin.VISUAL_STUDIO_OLD_BUILD_PLATFORM_PROPERTY_KEY);

    if (buildConfiguration != null && buildPlatform != null) {
      LOG.warn("The properties \"" + VisualStudioPlugin.VISUAL_STUDIO_OLD_BUILD_CONFIGURATION_PROPERTY_KEY + "\" and \""
        + VisualStudioPlugin.VISUAL_STUDIO_OLD_BUILD_PLATFORM_PROPERTY_KEY + "\" are deprecated");
      return condition.contains(buildConfiguration) && condition.contains(buildPlatform);
    }

    return true;
  }

  public static class FileLastModifiedComparator implements Comparator, Serializable {

    private static final long serialVersionUID = 1L;

    @Override
    public int compare(File o1, File o2) {
      if (o1.lastModified() == o2.lastModified()) {
        return 0;
      }

      return o1.lastModified() > o2.lastModified() ? -1 : 1;
    }

  }

}