All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.sonar.api.batch.bootstrap.ProjectDefinition Maven / Gradle / Ivy

Go to download

There is a newer version: 5.1
Show newest version
/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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  02110-1301, USA.
 */
package org.sonar.api.batch.bootstrap;

import com.google.common.collect.Lists;
import org.apache.commons.lang.StringUtils;
import org.sonar.api.CoreProperties;

import javax.annotation.CheckForNull;
import javax.annotation.Nullable;

import java.io.File;
import java.util.List;
import java.util.Properties;

/**
 * Defines project metadata (key, name, source directories, ...). It's generally used by the
 * {@link org.sonar.api.batch.bootstrap.ProjectBuilder extension point} and must not be used
 * by other standard extensions.
 *
 * @since 2.9
 */
public class ProjectDefinition {

  public static final String SOURCES_PROPERTY = "sonar.sources";
  /**
   * @deprecated since 4.5 use {@link #SOURCES_PROPERTY}
   */
  @Deprecated
  public static final String SOURCE_DIRS_PROPERTY = SOURCES_PROPERTY;
  /**
   * @deprecated since 4.5 use {@link #SOURCES_PROPERTY}
   */
  @Deprecated
  public static final String SOURCE_FILES_PROPERTY = "sonar.sourceFiles";

  public static final String TESTS_PROPERTY = "sonar.tests";
  /**
   * @deprecated since 4.5 use {@link #TESTS_PROPERTY}
   */
  @Deprecated
  public static final String TEST_DIRS_PROPERTY = TESTS_PROPERTY;
  /**
   * @deprecated since 4.5 use {@link #TESTS_PROPERTY}
   */
  @Deprecated
  public static final String TEST_FILES_PROPERTY = "sonar.testFiles";
  /**
   * @deprecated since 4.5.1 use SonarQube Java specific API
   */
  @Deprecated
  public static final String BINARIES_PROPERTY = "sonar.binaries";
  /**
   * @deprecated since 4.5.1 use SonarQube Java specific API
   */
  @Deprecated
  public static final String LIBRARIES_PROPERTY = "sonar.libraries";
  public static final String BUILD_DIR_PROPERTY = "sonar.buildDir";

  private static final char SEPARATOR = ',';

  private File baseDir, workDir, buildDir;
  private Properties properties = new Properties();
  private ProjectDefinition parent = null;
  private List subProjects = Lists.newArrayList();
  private List containerExtensions = Lists.newArrayList();

  private ProjectDefinition(Properties p) {
    this.properties = p;
  }

  /**
   * @deprecated in 2.12, because it uses external object to represent internal state.
   *             To ensure backward-compatibility with Ant task this method cannot clone properties,
   *             so other callers must explicitly make clone of properties before passing into this method.
   *             Thus better to use {@link #create()} with combination of other methods like {@link #setProperties(Properties)} and {@link #setProperty(String, String)}.
   */
  @Deprecated
  public static ProjectDefinition create(Properties properties) {
    return new ProjectDefinition(properties);
  }

  public static ProjectDefinition create() {
    return new ProjectDefinition(new Properties());
  }

  public ProjectDefinition setBaseDir(File baseDir) {
    this.baseDir = baseDir;
    return this;
  }

  public File getBaseDir() {
    return baseDir;
  }

  public ProjectDefinition setWorkDir(@Nullable File workDir) {
    this.workDir = workDir;
    return this;
  }

  @CheckForNull
  public File getWorkDir() {
    return workDir;
  }

  public ProjectDefinition setBuildDir(@Nullable File d) {
    this.buildDir = d;
    return this;
  }

  @CheckForNull
  public File getBuildDir() {
    return buildDir;
  }

  public Properties getProperties() {
    return properties;
  }

  /**
   * Copies specified properties into this object.
   *
   * @since 2.12
   */
  public ProjectDefinition setProperties(Properties properties) {
    this.properties.putAll(properties);
    return this;
  }

  public ProjectDefinition setProperty(String key, String value) {
    properties.setProperty(key, value);
    return this;
  }

  public ProjectDefinition setKey(String key) {
    properties.setProperty(CoreProperties.PROJECT_KEY_PROPERTY, key);
    return this;
  }

  public ProjectDefinition setVersion(String s) {
    properties.setProperty(CoreProperties.PROJECT_VERSION_PROPERTY, StringUtils.defaultString(s));
    return this;
  }

  public ProjectDefinition setName(String s) {
    properties.setProperty(CoreProperties.PROJECT_NAME_PROPERTY, StringUtils.defaultString(s));
    return this;
  }

  public ProjectDefinition setDescription(String s) {
    properties.setProperty(CoreProperties.PROJECT_DESCRIPTION_PROPERTY, StringUtils.defaultString(s));
    return this;
  }

  public String getKey() {
    return properties.getProperty(CoreProperties.PROJECT_KEY_PROPERTY);
  }

  /**
   * @since 4.5
   */
  public String getKeyWithBranch() {
    String branch = properties.getProperty(CoreProperties.PROJECT_BRANCH_PROPERTY);
    String projectKey = getKey();
    if (StringUtils.isNotBlank(branch)) {
      projectKey = String.format("%s:%s", projectKey, branch);
    }
    return projectKey;
  }

  public String getVersion() {
    return properties.getProperty(CoreProperties.PROJECT_VERSION_PROPERTY);
  }

  public String getName() {
    String name = properties.getProperty(CoreProperties.PROJECT_NAME_PROPERTY);
    if (StringUtils.isBlank(name)) {
      name = "Unnamed - " + getKey();
    }
    return name;
  }

  public String getDescription() {
    return properties.getProperty(CoreProperties.PROJECT_DESCRIPTION_PROPERTY);
  }

  private void appendProperty(String key, String value) {
    String current = properties.getProperty(key, "");
    if (StringUtils.isBlank(current)) {
      properties.put(key, value);
    } else {
      properties.put(key, current + SEPARATOR + value);
    }
  }

  /**
   * @return Source files and folders.
   */
  public List sources() {
    String sources = properties.getProperty(SOURCES_PROPERTY, "");
    return trim(StringUtils.split(sources, SEPARATOR));
  }

  /**
   * @deprecated since 4.5 use {@link #sources()}
   */
  @Deprecated
  public List getSourceDirs() {
    return sources();
  }

  /**
   * @param paths paths to file or directory with main sources.
   *              They can be absolute or relative to project base directory.
   */
  public ProjectDefinition addSources(String... paths) {
    for (String path : paths) {
      appendProperty(SOURCES_PROPERTY, path);
    }
    return this;
  }

  /**
   * @deprecated since 4.5 use {@link #addSources(String...)}
   */
  @Deprecated
  public ProjectDefinition addSourceDirs(String... paths) {
    return addSources(paths);
  }

  public ProjectDefinition addSources(File... fileOrDirs) {
    for (File fileOrDir : fileOrDirs) {
      addSources(fileOrDir.getAbsolutePath());
    }
    return this;
  }

  /**
   * @deprecated since 4.5 use {@link #addSources(File...)}
   */
  @Deprecated
  public ProjectDefinition addSourceDirs(File... dirs) {
    return addSources(dirs);
  }

  public ProjectDefinition resetSources() {
    properties.remove(SOURCES_PROPERTY);
    return this;
  }

  /**
   * @deprecated since 4.5 use {@link #resetSources()}
   */
  @Deprecated
  public ProjectDefinition resetSourceDirs() {
    return resetSources();
  }

  public ProjectDefinition setSources(String... paths) {
    resetSources();
    return addSources(paths);
  }

  /**
   * @deprecated since 4.5 use {@link #setSources(String...)}
   */
  @Deprecated
  public ProjectDefinition setSourceDirs(String... paths) {
    return setSources(paths);
  }

  public ProjectDefinition setSources(File... filesOrDirs) {
    resetSources();
    for (File fileOrDir : filesOrDirs) {
      addSources(fileOrDir.getAbsolutePath());
    }
    return this;
  }

  /**
   * @deprecated since 4.5 use {@link #setSources(File...)}
   */
  @Deprecated
  public ProjectDefinition setSourceDirs(File... dirs) {
    resetSourceDirs();
    for (File dir : dirs) {
      addSourceDirs(dir.getAbsolutePath());
    }
    return this;
  }

  /**
   * @deprecated since 4.5 use {@link #addSources(File...)}
   */
  @Deprecated
  public ProjectDefinition addSourceFiles(String... paths) {
    // Hack for visual studio project builder that used to add baseDir first as source dir
    List sourceDirs = getSourceDirs();
    if (sourceDirs.size() == 1 && isDirectory(sourceDirs.get(0))) {
      resetSources();
    }
    return addSources(paths);
  }

  /**
   * @deprecated since 4.5 use {@link #addSources(File...)}
   */
  @Deprecated
  public ProjectDefinition addSourceFiles(File... files) {
    // Hack for visual studio project builder that used to add baseDir first as source dir
    List sourceDirs = getSourceDirs();
    if (sourceDirs.size() == 1 && isDirectory(sourceDirs.get(0))) {
      resetSources();
    }
    return addSources(files);
  }

  /**
   * @deprecated since 4.5 use {@link #sources()}
   */
  @Deprecated
  public List getSourceFiles() {
    return sources();
  }

  public List tests() {
    String sources = properties.getProperty(TESTS_PROPERTY, "");
    return trim(StringUtils.split(sources, SEPARATOR));
  }

  /**
   * @deprecated since 4.5 use {@link #tests()}
   */
  @Deprecated
  public List getTestDirs() {
    return tests();
  }

  /**
   * @param paths path to files or directories with test sources.
   *              It can be absolute or relative to project directory.
   */
  public ProjectDefinition addTests(String... paths) {
    for (String path : paths) {
      appendProperty(TESTS_PROPERTY, path);
    }
    return this;
  }

  /**
   * @deprecated since 4.5 use {@link #addTests(String...)}
   */
  @Deprecated
  public ProjectDefinition addTestDirs(String... paths) {
    return addTests(paths);
  }

  public ProjectDefinition addTests(File... fileOrDirs) {
    for (File fileOrDir : fileOrDirs) {
      addTests(fileOrDir.getAbsolutePath());
    }
    return this;
  }

  /**
   * @deprecated since 4.5 use {@link #addTests(File...)}
   */
  @Deprecated
  public ProjectDefinition addTestDirs(File... dirs) {
    return addTests(dirs);
  }

  public ProjectDefinition setTests(String... paths) {
    resetTests();
    return addTests(paths);
  }

  /**
   * @deprecated since 4.5 use {@link #setTests(String...)}
   */
  @Deprecated
  public ProjectDefinition setTestDirs(String... paths) {
    return setTests(paths);
  }

  public ProjectDefinition setTests(File... fileOrDirs) {
    resetTests();
    for (File dir : fileOrDirs) {
      addTests(dir.getAbsolutePath());
    }
    return this;
  }

  /**
   * @deprecated since 4.5 use {@link #setTests(File...)}
   */
  @Deprecated
  public ProjectDefinition setTestDirs(File... dirs) {
    return setTests(dirs);
  }

  public ProjectDefinition resetTests() {
    properties.remove(TESTS_PROPERTY);
    return this;
  }

  /**
   * @deprecated since 4.5 use {@link #resetTests()}
   */
  @Deprecated
  public ProjectDefinition resetTestDirs() {
    return resetTests();
  }

  /**
   * @deprecated since 4.5 use {@link #addTests(String...)}
   */
  @Deprecated
  public ProjectDefinition addTestFiles(String... paths) {
    // Hack for visual studio project builder that used to add baseDir first as test dir
    List testDirs = getTestDirs();
    if (testDirs.size() == 1 && isDirectory(testDirs.get(0))) {
      resetTests();
    }
    return addTests(paths);
  }

  private boolean isDirectory(String relativeOrAbsoluteDir) {
    File file = new File(relativeOrAbsoluteDir);
    if (!file.isAbsolute()) {
      file = new File(baseDir, relativeOrAbsoluteDir);
    }
    return file.isDirectory();
  }

  /**
   * @deprecated since 4.5 use {@link #addTests(File...)}
   */
  @Deprecated
  public ProjectDefinition addTestFiles(File... files) {
    // Hack for visual studio project builder that used to add baseDir first as test dir
    List testDirs = getTestDirs();
    if (testDirs.size() == 1 && isDirectory(testDirs.get(0))) {
      resetTests();
    }
    return addTests(files);
  }

  /**
   * @deprecated since 4.5 use {@link #tests()}
   */
  @Deprecated
  public List getTestFiles() {
    return tests();
  }

  /**
   * @deprecated since 4.5.1 use SonarQube Java specific API
   */
  @Deprecated
  public List getBinaries() {
    String sources = properties.getProperty(BINARIES_PROPERTY, "");
    return trim(StringUtils.split(sources, SEPARATOR));
  }

  /**
   * @param path path to directory with compiled source. In case of Java this is directory with class files.
   *             It can be absolute or relative to project directory.
   * @deprecated since 4.5.1 use SonarQube Java specific API
   */
  @Deprecated
  public ProjectDefinition addBinaryDir(String path) {
    appendProperty(BINARIES_PROPERTY, path);
    return this;
  }

  /**
   * @deprecated since 4.5.1 use SonarQube Java specific API
   */
  @Deprecated
  public ProjectDefinition addBinaryDir(File f) {
    return addBinaryDir(f.getAbsolutePath());
  }

  /**
   * @deprecated since 4.5.1 use SonarQube Java specific API
   */
  @Deprecated
  public List getLibraries() {
    String sources = properties.getProperty(LIBRARIES_PROPERTY, "");
    return trim(StringUtils.split(sources, SEPARATOR));
  }

  /**
   * @param path path to file with third-party library. In case of Java this is path to jar file.
   *             It can be absolute or relative to project directory.
   * @deprecated since 4.5.1 use SonarQube Java specific API
   */
  @Deprecated
  public void addLibrary(String path) {
    appendProperty(LIBRARIES_PROPERTY, path);
  }

  /**
   * Adds an extension, which would be available in PicoContainer during analysis of this project.
   *
   * @since 2.8
   */
  public ProjectDefinition addContainerExtension(Object extension) {
    containerExtensions.add(extension);
    return this;
  }

  /**
   * @since 2.8
   */
  public List getContainerExtensions() {
    return containerExtensions;
  }

  /**
   * @since 2.8
   */
  public ProjectDefinition addSubProject(ProjectDefinition child) {
    subProjects.add(child);
    child.setParent(this);
    return this;
  }

  public ProjectDefinition getParent() {
    return parent;
  }

  public void remove() {
    if (parent != null) {
      parent.subProjects.remove(this);
      parent = null;
      subProjects.clear();
    }
  }

  private void setParent(ProjectDefinition parent) {
    this.parent = parent;
  }

  /**
   * @since 2.8
   */
  public List getSubProjects() {
    return subProjects;
  }

  private static List trim(String[] strings) {
    List result = Lists.newArrayList();
    for (String s : strings) {
      result.add(StringUtils.trim(s));
    }
    return result;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    ProjectDefinition that = (ProjectDefinition) o;
    String key = getKey();
    if (key != null ? !key.equals(that.getKey()) : that.getKey() != null) {
      return false;
    }

    return true;
  }

  @Override
  public int hashCode() {
    String key = getKey();
    return key != null ? key.hashCode() : 0;
  }
}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy