</issueManagement>
<properties>
- <sonar.buildVersion>3.5</sonar.buildVersion>
+ <sonar.buildVersion>3.7-SNAPSHOT</sonar.buildVersion>
<maven.test.redirectTestOutputToFile>true</maven.test.redirectTestOutputToFile>
</properties>
<dependency>
<groupId>org.codehaus.sonar</groupId>
<artifactId>sonar-home</artifactId>
- <version>3.5</version>
+ <version>${sonar.buildVersion}</version>
</dependency>
</dependencies>
</dependencyManagement>
<name>Sonar Runner - Batch</name>
<properties>
- <sonarBatchVersion>3.5</sonarBatchVersion>
+ <sonarBatchVersion>3.7-SNAPSHOT</sonarBatchVersion>
</properties>
<dependencies>
import com.google.common.annotations.VisibleForTesting;
import org.apache.commons.io.IOUtils;
import org.slf4j.LoggerFactory;
-import org.sonar.api.batch.bootstrap.ProjectReactor;
import org.sonar.api.utils.SonarException;
import org.sonar.batch.bootstrapper.Batch;
import org.sonar.batch.bootstrapper.EnvironmentInformation;
}
Batch createBatch(Properties properties, List<Object> extensions) {
- ProjectReactor projectReactor = null;
initLogging(properties);
EnvironmentInformation env = new EnvironmentInformation(properties.getProperty("sonarRunner.app"), properties.getProperty("sonarRunner.appVersion"));
Batch.Builder builder = Batch.builder()
.setEnvironment(env)
.addComponents(extensions);
- String task = properties.getProperty("sonar.task", "scan");
- if ("scan".equals(task)) {
- Properties propsClone = new Properties();
- propsClone.putAll(properties);
- projectReactor = new ProjectReactorBuilder(propsClone).build();
- } else {
- // only on sonar 3.5+... in theory
- builder.setGlobalProperties((Map) properties);
- }
-
- if (projectReactor != null) {
- builder.setProjectReactor(projectReactor);
- }
+ builder.setBootstrapProperties((Map) properties);
return builder.build();
}
+++ /dev/null
-/*
- * Sonar Runner - Batch
- * Copyright (C) 2011 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.runner.batch;
-
-import com.google.common.annotations.VisibleForTesting;
-import com.google.common.collect.Lists;
-import org.apache.commons.io.IOUtils;
-import org.apache.commons.io.filefilter.AndFileFilter;
-import org.apache.commons.io.filefilter.FileFileFilter;
-import org.apache.commons.io.filefilter.IOFileFilter;
-import org.apache.commons.io.filefilter.WildcardFileFilter;
-import org.apache.commons.lang.StringUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.sonar.api.batch.bootstrap.ProjectDefinition;
-import org.sonar.api.batch.bootstrap.ProjectReactor;
-
-import java.io.File;
-import java.io.FileFilter;
-import java.io.FileInputStream;
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Map.Entry;
-import java.util.Properties;
-
-/**
- * Class that creates a Sonar project definition based on a set of properties.
- *
- * @since 1.5
- */
-class ProjectReactorBuilder {
-
- private static final Logger LOG = LoggerFactory.getLogger(ProjectReactorBuilder.class);
-
- private static final String PROPERTY_PROJECT_BASEDIR = "sonar.projectBaseDir";
- private static final String PROPERTY_PROJECT_CONFIG_FILE = "sonar.projectConfigFile";
- private static final String PROPERTY_PROJECT_KEY = "sonar.projectKey";
- private static final String PROPERTY_PROJECT_NAME = "sonar.projectName";
- private static final String PROPERTY_PROJECT_DESCRIPTION = "sonar.projectDescription";
- private static final String PROPERTY_PROJECT_VERSION = "sonar.projectVersion";
- private static final String PROPERTY_MODULES = "sonar.modules";
-
- /**
- * New properties, to be consistent with Sonar naming conventions
- *
- * @since 1.5
- */
- private static final String PROPERTY_SOURCES = "sonar.sources";
- private static final String PROPERTY_TESTS = "sonar.tests";
- private static final String PROPERTY_BINARIES = "sonar.binaries";
- private static final String PROPERTY_LIBRARIES = "sonar.libraries";
-
- /**
- * Old deprecated properties, replaced by the same ones preceded by "sonar."
- */
- private static final String PROPERTY_OLD_SOURCES = "sources";
- private static final String PROPERTY_OLD_TESTS = "tests";
- private static final String PROPERTY_OLD_BINARIES = "binaries";
- private static final String PROPERTY_OLD_LIBRARIES = "libraries";
- private static final Map<String, String> DEPRECATED_PROPS_TO_NEW_PROPS = new HashMap<String, String>() {
- {
- put(PROPERTY_OLD_SOURCES, PROPERTY_SOURCES);
- put(PROPERTY_OLD_TESTS, PROPERTY_TESTS);
- put(PROPERTY_OLD_BINARIES, PROPERTY_BINARIES);
- put(PROPERTY_OLD_LIBRARIES, PROPERTY_LIBRARIES);
- }
- };
-
- /**
- * @since 1.4
- */
- private static final String PROPERTY_WORK_DIRECTORY = "sonar.working.directory";
- private static final String DEF_VALUE_WORK_DIRECTORY = ".sonar";
-
- /**
- * Array of all mandatory properties required for a project without child.
- */
- private static final String[] MANDATORY_PROPERTIES_FOR_SIMPLE_PROJECT = {
- PROPERTY_PROJECT_BASEDIR, PROPERTY_PROJECT_KEY, PROPERTY_PROJECT_NAME, PROPERTY_PROJECT_VERSION
- };
-
- /**
- * Array of all mandatory properties required for a project with children.
- */
- private static final String[] MANDATORY_PROPERTIES_FOR_MULTIMODULE_PROJECT = {PROPERTY_PROJECT_BASEDIR, PROPERTY_PROJECT_KEY, PROPERTY_PROJECT_NAME, PROPERTY_PROJECT_VERSION};
-
- /**
- * Array of all mandatory properties required for a child project before its properties get merged with its parent ones.
- */
- private static final String[] MANDATORY_PROPERTIES_FOR_CHILD = {PROPERTY_PROJECT_KEY, PROPERTY_PROJECT_NAME};
-
- /**
- * Properties that must not be passed from the parent project to its children.
- */
- private static final List<String> NON_HERITED_PROPERTIES_FOR_CHILD = Lists.newArrayList(PROPERTY_PROJECT_BASEDIR, PROPERTY_MODULES, PROPERTY_PROJECT_DESCRIPTION);
-
- private Properties properties;
- private File rootProjectWorkDir;
-
- ProjectReactorBuilder(Properties properties) {
- this.properties = properties;
- }
-
- ProjectReactor build() {
- ProjectDefinition rootProject = defineProject(properties, null);
- rootProjectWorkDir = rootProject.getWorkDir();
- defineChildren(rootProject);
- cleanAndCheckProjectDefinitions(rootProject);
- return new ProjectReactor(rootProject);
- }
-
- private ProjectDefinition defineProject(Properties properties, ProjectDefinition parent) {
- File baseDir = new File(properties.getProperty(PROPERTY_PROJECT_BASEDIR));
- if (properties.containsKey(PROPERTY_MODULES)) {
- checkMandatoryProperties(properties, MANDATORY_PROPERTIES_FOR_MULTIMODULE_PROJECT);
- } else {
- checkMandatoryProperties(properties, MANDATORY_PROPERTIES_FOR_SIMPLE_PROJECT);
- }
- File workDir;
- if (parent == null) {
- validateDirectories(properties, baseDir, properties.getProperty(PROPERTY_PROJECT_KEY));
- workDir = initRootProjectWorkDir(baseDir);
- } else {
- workDir = initModuleWorkDir(properties);
- }
-
- ProjectDefinition definition = ProjectDefinition.create().setProperties(properties)
- .setBaseDir(baseDir)
- .setWorkDir(workDir);
- return definition;
- }
-
- @VisibleForTesting
- protected File initRootProjectWorkDir(File baseDir) {
- String workDir = properties.getProperty(PROPERTY_WORK_DIRECTORY);
- if (StringUtils.isBlank(workDir)) {
- return new File(baseDir, DEF_VALUE_WORK_DIRECTORY);
- }
-
- File customWorkDir = new File(workDir);
- if (customWorkDir.isAbsolute()) {
- return customWorkDir;
- }
- return new File(baseDir, customWorkDir.getPath());
- }
-
- @VisibleForTesting
- protected File initModuleWorkDir(Properties properties) {
- String cleanKey = StringUtils.deleteWhitespace(properties.getProperty(PROPERTY_PROJECT_KEY));
- cleanKey = StringUtils.replace(cleanKey, ":", "_");
- return new File(rootProjectWorkDir, cleanKey);
- }
-
- private void defineChildren(ProjectDefinition parentProject) {
- Properties parentProps = parentProject.getProperties();
- if (parentProps.containsKey(PROPERTY_MODULES)) {
- for (String module : Utils.getListFromProperty(parentProps, PROPERTY_MODULES)) {
- Properties moduleProps = extractModuleProperties(module, parentProps);
- ProjectDefinition childProject = loadChildProject(parentProject, moduleProps, module);
- // check the uniqueness of the child key
- checkUniquenessOfChildKey(childProject, parentProject);
- // the child project may have children as well
- defineChildren(childProject);
- // and finally add this child project to its parent
- parentProject.addSubProject(childProject);
- }
- }
- }
-
- private ProjectDefinition loadChildProject(ProjectDefinition parentProject, Properties moduleProps, String moduleId) {
- setProjectKeyAndNameIfNotDefined(moduleProps, moduleId);
-
- final File baseDir;
- if (moduleProps.containsKey(PROPERTY_PROJECT_BASEDIR)) {
- baseDir = getFileFromPath(moduleProps.getProperty(PROPERTY_PROJECT_BASEDIR), parentProject.getBaseDir());
- setProjectBaseDir(baseDir, moduleProps, moduleId);
- try {
- if (!parentProject.getBaseDir().getCanonicalFile().equals(baseDir.getCanonicalFile())) {
- tryToFindAndLoadPropsFile(baseDir, moduleProps, moduleId);
- }
- } catch (IOException e) {
- throw new IllegalStateException("Error when resolving baseDir", e);
- }
- } else if (moduleProps.containsKey(PROPERTY_PROJECT_CONFIG_FILE)) {
- baseDir = loadPropsFile(parentProject, moduleProps, moduleId);
- } else {
- baseDir = new File(parentProject.getBaseDir(), moduleId);
- setProjectBaseDir(baseDir, moduleProps, moduleId);
- tryToFindAndLoadPropsFile(baseDir, moduleProps, moduleId);
- }
-
- // and finish
- checkMandatoryProperties(moduleProps, MANDATORY_PROPERTIES_FOR_CHILD);
- validateDirectories(moduleProps, baseDir, moduleId);
-
- mergeParentProperties(moduleProps, parentProject.getProperties());
-
- prefixProjectKeyWithParentKey(moduleProps, parentProject.getKey());
-
- return defineProject(moduleProps, parentProject);
- }
-
- /**
- * @return baseDir
- */
- protected File loadPropsFile(ProjectDefinition parentProject, Properties moduleProps, String moduleId) {
- File propertyFile = getFileFromPath(moduleProps.getProperty(PROPERTY_PROJECT_CONFIG_FILE), parentProject.getBaseDir());
- if (propertyFile.isFile()) {
- Properties propsFromFile = toProperties(propertyFile);
- for (Entry<Object, Object> entry : propsFromFile.entrySet()) {
- moduleProps.put(entry.getKey(), entry.getValue());
- }
- File baseDir = null;
- if (moduleProps.containsKey(PROPERTY_PROJECT_BASEDIR)) {
- baseDir = getFileFromPath(moduleProps.getProperty(PROPERTY_PROJECT_BASEDIR), propertyFile.getParentFile());
- } else {
- baseDir = propertyFile.getParentFile();
- }
- setProjectBaseDir(baseDir, moduleProps, moduleId);
- return baseDir;
- } else {
- throw new IllegalStateException("The properties file of the module '" + moduleId + "' does not exist: " + propertyFile.getAbsolutePath());
- }
- }
-
- private void tryToFindAndLoadPropsFile(File baseDir, Properties moduleProps, String moduleId) {
- File propertyFile = new File(baseDir, "sonar-project.properties");
- if (propertyFile.isFile()) {
- Properties propsFromFile = toProperties(propertyFile);
- for (Entry<Object, Object> entry : propsFromFile.entrySet()) {
- moduleProps.put(entry.getKey(), entry.getValue());
- }
- if (moduleProps.containsKey(PROPERTY_PROJECT_BASEDIR)) {
- File overwrittenBaseDir = getFileFromPath(moduleProps.getProperty(PROPERTY_PROJECT_BASEDIR), propertyFile.getParentFile());
- setProjectBaseDir(overwrittenBaseDir, moduleProps, moduleId);
- }
- }
- }
-
- @VisibleForTesting
- protected static Properties toProperties(File propertyFile) {
- Properties propsFromFile = new Properties();
- FileInputStream fileInputStream = null;
- try {
- fileInputStream = new FileInputStream(propertyFile);
- propsFromFile.load(fileInputStream);
- } catch (IOException e) {
- throw new IllegalStateException("Impossible to read the property file: " + propertyFile.getAbsolutePath(), e);
- } finally {
- IOUtils.closeQuietly(fileInputStream);
- }
- return propsFromFile;
- }
-
- @VisibleForTesting
- protected static void setProjectKeyAndNameIfNotDefined(Properties childProps, String moduleId) {
- if (!childProps.containsKey(PROPERTY_PROJECT_KEY)) {
- childProps.put(PROPERTY_PROJECT_KEY, moduleId);
- }
- if (!childProps.containsKey(PROPERTY_PROJECT_NAME)) {
- childProps.put(PROPERTY_PROJECT_NAME, moduleId);
- }
- }
-
- @VisibleForTesting
- protected static void checkUniquenessOfChildKey(ProjectDefinition childProject, ProjectDefinition parentProject) {
- for (ProjectDefinition definition : parentProject.getSubProjects()) {
- if (definition.getKey().equals(childProject.getKey())) {
- throw new IllegalStateException("Project '" + parentProject.getKey() + "' can't have 2 modules with the following key: " + childProject.getKey());
- }
- }
- }
-
- @VisibleForTesting
- protected static void prefixProjectKeyWithParentKey(Properties childProps, String parentKey) {
- String childKey = childProps.getProperty(PROPERTY_PROJECT_KEY);
- childProps.put(PROPERTY_PROJECT_KEY, parentKey + ":" + childKey);
- }
-
- private static void setProjectBaseDir(File baseDir, Properties childProps, String moduleId) {
- if (!baseDir.isDirectory()) {
- throw new IllegalStateException("The base directory of the module '" + moduleId + "' does not exist: " + baseDir.getAbsolutePath());
- }
- childProps.put(PROPERTY_PROJECT_BASEDIR, baseDir.getAbsolutePath());
- }
-
- @VisibleForTesting
- protected static void checkMandatoryProperties(Properties props, String[] mandatoryProps) {
- replaceDeprecatedProperties(props);
- StringBuilder missing = new StringBuilder();
- for (String mandatoryProperty : mandatoryProps) {
- if (!props.containsKey(mandatoryProperty)) {
- if (missing.length() > 0) {
- missing.append(", ");
- }
- missing.append(mandatoryProperty);
- }
- }
- String projectKey = props.getProperty(PROPERTY_PROJECT_KEY);
- if (missing.length() != 0) {
- throw new IllegalStateException("You must define the following mandatory properties for '" + (projectKey == null ? "Unknown" : projectKey) + "': " + missing);
- }
- }
-
- private static void validateDirectories(Properties props, File baseDir, String projectId) {
- if (!props.containsKey(PROPERTY_MODULES)) {
- // SONARPLUGINS-2285 Not an aggregator project so we can validate that paths are correct if defined
-
- // We need to resolve patterns that may have been used in "sonar.libraries"
- for (String pattern : Utils.getListFromProperty(props, PROPERTY_LIBRARIES)) {
- File[] files = getLibraries(baseDir, pattern);
- if (files == null || files.length == 0) {
- LOG.error("Invalid value of " + PROPERTY_LIBRARIES + " for " + projectId);
- throw new IllegalStateException("No files nor directories matching '" + pattern + "' in directory " + baseDir);
- }
- }
-
- // Check sonar.tests
- String[] testDirs = Utils.getListFromProperty(props, PROPERTY_TESTS);
- checkExistenceOfDirectories(projectId, baseDir, testDirs, PROPERTY_TESTS);
-
- // Check sonar.binaries
- String[] binDirs = Utils.getListFromProperty(props, PROPERTY_BINARIES);
- checkExistenceOfDirectories(projectId, baseDir, binDirs, PROPERTY_BINARIES);
- }
- }
-
- @VisibleForTesting
- protected static void cleanAndCheckProjectDefinitions(ProjectDefinition project) {
- if (project.getSubProjects().isEmpty()) {
- cleanAndCheckModuleProperties(project);
- } else {
- cleanAndCheckAggregatorProjectProperties(project);
-
- // clean modules properties as well
- for (ProjectDefinition module : project.getSubProjects()) {
- cleanAndCheckProjectDefinitions(module);
- }
- }
- }
-
- @VisibleForTesting
- protected static void cleanAndCheckModuleProperties(ProjectDefinition project) {
- Properties properties = project.getProperties();
-
- // We need to check the existence of source directories
- String[] sourceDirs = Utils.getListFromProperty(properties, PROPERTY_SOURCES);
- checkExistenceOfDirectories(project.getKey(), project.getBaseDir(), sourceDirs, PROPERTY_SOURCES);
-
- // And we need to resolve patterns that may have been used in "sonar.libraries"
- List<String> libPaths = Lists.newArrayList();
- for (String pattern : Utils.getListFromProperty(properties, PROPERTY_LIBRARIES)) {
- for (File file : getLibraries(project.getBaseDir(), pattern)) {
- libPaths.add(file.getAbsolutePath());
- }
- }
- properties.remove(PROPERTY_LIBRARIES);
- properties.put(PROPERTY_LIBRARIES, StringUtils.join(libPaths, ","));
- }
-
- @VisibleForTesting
- protected static void cleanAndCheckAggregatorProjectProperties(ProjectDefinition project) {
- Properties properties = project.getProperties();
-
- // SONARPLUGINS-2295
- String[] sourceDirs = Utils.getListFromProperty(properties, PROPERTY_SOURCES);
- for (String path : sourceDirs) {
- File sourceFolder = getFileFromPath(path, project.getBaseDir());
- if (sourceFolder.isDirectory()) {
- LOG.warn("/!\\ A multi-module project can't have source folders, so '{}' won't be used for the analysis. " +
- "If you want to analyse files of this folder, you should create another sub-module and move them inside it.",
- sourceFolder.toString());
- }
- }
-
- // "aggregator" project must not have the following properties:
- properties.remove(PROPERTY_SOURCES);
- properties.remove(PROPERTY_TESTS);
- properties.remove(PROPERTY_BINARIES);
- properties.remove(PROPERTY_LIBRARIES);
-
- // and they don't need properties related to their modules either
- Properties clone = (Properties) properties.clone();
- List<String> moduleIds = Lists.newArrayList(Utils.getListFromProperty(properties, PROPERTY_MODULES));
- for (Entry<Object, Object> entry : clone.entrySet()) {
- String key = (String) entry.getKey();
- if (isKeyPrefixedByModuleId(key, moduleIds)) {
- properties.remove(key);
- }
- }
- }
-
- /**
- * Replaces the deprecated properties by the new ones, and logs a message to warn the users.
- */
- @VisibleForTesting
- protected static void replaceDeprecatedProperties(Properties props) {
- for (Entry<String, String> entry : DEPRECATED_PROPS_TO_NEW_PROPS.entrySet()) {
- String key = entry.getKey();
- if (props.containsKey(key)) {
- String newKey = entry.getValue();
- LOG.warn("/!\\ The '{}' property is deprecated and is replaced by '{}'. Don't forget to update your files.", key, newKey);
- String value = props.getProperty(key);
- props.remove(key);
- props.put(newKey, value);
- }
- }
-
- }
-
- @VisibleForTesting
- protected static void mergeParentProperties(Properties childProps, Properties parentProps) {
- List<String> moduleIds = Lists.newArrayList(Utils.getListFromProperty(parentProps, PROPERTY_MODULES));
- for (Map.Entry<Object, Object> entry : parentProps.entrySet()) {
- String key = (String) entry.getKey();
- if (!childProps.containsKey(key)
- && !NON_HERITED_PROPERTIES_FOR_CHILD.contains(key)
- && !isKeyPrefixedByModuleId(key, moduleIds)) {
- childProps.put(entry.getKey(), entry.getValue());
- }
- }
- }
-
- private static boolean isKeyPrefixedByModuleId(String key, List<String> moduleIds) {
- for (String moduleId : moduleIds) {
- if (key.startsWith(moduleId + ".")) {
- return true;
- }
- }
- return false;
- }
-
- @VisibleForTesting
- protected static Properties extractModuleProperties(String module, Properties properties) {
- Properties moduleProps = new Properties();
- String propertyPrefix = module + ".";
- int prefixLength = propertyPrefix.length();
- for (Map.Entry<Object, Object> entry : properties.entrySet()) {
- String key = (String) entry.getKey();
- if (key.startsWith(propertyPrefix)) {
- moduleProps.put(key.substring(prefixLength), entry.getValue());
- }
- }
- return moduleProps;
- }
-
- @VisibleForTesting
- protected static void checkExistenceOfDirectories(String moduleRef, File baseDir, String[] sourceDirs, String propName) {
- for (String path : sourceDirs) {
- File sourceFolder = getFileFromPath(path, baseDir);
- if (!sourceFolder.isDirectory()) {
- LOG.error("Invalid value of " + propName + " for " + moduleRef);
- throw new IllegalStateException("The folder '" + path + "' does not exist for '" + moduleRef +
- "' (base directory = " + baseDir.getAbsolutePath() + ")");
- }
- }
-
- }
-
- /**
- * Returns files matching specified pattern.
- */
- @VisibleForTesting
- protected static File[] getLibraries(File baseDir, String pattern) {
- final int i = Math.max(pattern.lastIndexOf('/'), pattern.lastIndexOf('\\'));
- final String dirPath, filePattern;
- if (i == -1) {
- dirPath = ".";
- filePattern = pattern;
- } else {
- dirPath = pattern.substring(0, i);
- filePattern = pattern.substring(i + 1);
- }
- List<IOFileFilter> filters = new ArrayList<IOFileFilter>();
- if (pattern.indexOf('*') >= 0) {
- filters.add(FileFileFilter.FILE);
- }
- filters.add(new WildcardFileFilter(filePattern));
- File dir = resolvePath(baseDir, dirPath);
- File[] files = dir.listFiles((FileFilter) new AndFileFilter(filters));
- if (files == null) {
- files = new File[0];
- }
- return files;
- }
-
- private static File resolvePath(File baseDir, String path) {
- File file = new File(path);
- if (!file.isAbsolute()) {
- try {
- file = new File(baseDir, path).getCanonicalFile();
- } catch (IOException e) {
- throw new IllegalStateException("Unable to resolve path \"" + path + "\"", e);
- }
- }
- return file;
- }
-
- /**
- * Returns the file denoted by the given path, may this path be relative to "baseDir" or absolute.
- */
- @VisibleForTesting
- protected static File getFileFromPath(String path, File baseDir) {
- File propertyFile = new File(path.trim());
- if (!propertyFile.isAbsolute()) {
- propertyFile = new File(baseDir, propertyFile.getPath());
- }
- return propertyFile;
- }
-
-}
+++ /dev/null
-/*
- * Sonar Runner - Batch
- * Copyright (C) 2011 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.runner.batch;
-
-import org.apache.commons.lang.StringUtils;
-
-import java.util.Properties;
-
-/**
- * Public utility that can be used by consumers of the Sonar Runner.
- */
-class Utils {
-
- private Utils() {
- // only static methods
- }
-
- /**
- * Transforms a comma-separated list String property in to a array of trimmed strings.
- *
- * This works even if they are separated by whitespace characters (space char, EOL, ...)
- *
- */
- static String[] getListFromProperty(Properties properties, String key) {
- return StringUtils.stripAll(StringUtils.split(properties.getProperty(key, ""), ','));
- }
-
-}
+++ /dev/null
-/*
- * Sonar Runner - Batch
- * Copyright (C) 2011 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.runner.batch;
-
-import org.junit.Rule;
-import org.junit.Test;
-import org.junit.rules.ExpectedException;
-import org.sonar.api.batch.bootstrap.ProjectDefinition;
-import org.sonar.api.batch.bootstrap.ProjectReactor;
-import org.sonar.test.TestUtils;
-
-import java.io.File;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-import java.util.List;
-import java.util.Properties;
-
-import static org.fest.assertions.Assertions.assertThat;
-
-public class ProjectReactorBuilderTest {
-
- @Rule
- public ExpectedException thrown = ExpectedException.none();
-
- @Test
- public void shouldDefineSimpleProject() throws IOException {
- ProjectDefinition projectDefinition = loadProjectDefinition("simple-project");
-
- assertThat(projectDefinition.getKey()).isEqualTo("com.foo.project");
- assertThat(projectDefinition.getName()).isEqualTo("Foo Project");
- assertThat(projectDefinition.getVersion()).isEqualTo("1.0-SNAPSHOT");
- assertThat(projectDefinition.getDescription()).isEqualTo("Description of Foo Project");
- assertThat(projectDefinition.getSourceDirs()).contains("sources");
- assertThat(projectDefinition.getLibraries()).contains(TestUtils.getResource(this.getClass(), "simple-project/libs/lib2.txt").getAbsolutePath(),
- TestUtils.getResource(this.getClass(), "simple-project/libs/lib2.txt").getAbsolutePath());
- }
-
- @Test
- public void shouldDefineSimpleProjectWithDeprecatedProperties() throws IOException {
- ProjectDefinition projectDefinition = loadProjectDefinition("simple-project-with-deprecated-props");
-
- assertThat(projectDefinition.getSourceDirs()).contains("sources");
- assertThat(projectDefinition.getLibraries()).contains(
- TestUtils.getResource(this.getClass(), "simple-project-with-deprecated-props/libs/lib2.txt").getAbsolutePath(),
- TestUtils.getResource(this.getClass(), "simple-project-with-deprecated-props/libs/lib2.txt").getAbsolutePath());
- }
-
- @Test
- public void shouldFailIfUnexistingSourceDirectory() throws IOException {
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("The folder 'unexisting-source-dir' does not exist for 'com.foo.project' (base directory = "
- + TestUtils.getResource(this.getClass(), "simple-project-with-unexisting-source-dir") + ")");
-
- loadProjectDefinition("simple-project-with-unexisting-source-dir");
- }
-
- @Test
- public void shouldDefineMultiModuleProjectWithDefinitionsAllInRootProject() throws IOException {
- ProjectDefinition rootProject = loadProjectDefinition("multi-module-definitions-all-in-root");
-
- // CHECK ROOT
- assertThat(rootProject.getKey()).isEqualTo("com.foo.project");
- assertThat(rootProject.getName()).isEqualTo("Foo Project");
- assertThat(rootProject.getVersion()).isEqualTo("1.0-SNAPSHOT");
- assertThat(rootProject.getDescription()).isEqualTo("Description of Foo Project");
- // root project must not contain some properties - even if they are defined in the root properties file
- assertThat(rootProject.getSourceDirs().contains("sources")).isFalse();
- assertThat(rootProject.getTestDirs().contains("tests")).isFalse();
- assertThat(rootProject.getBinaries().contains("target/classes")).isFalse();
- // and module properties must have been cleaned
- assertThat(rootProject.getProperties().getProperty("module1.sonar.projectKey")).isNull();
- assertThat(rootProject.getProperties().getProperty("module2.sonar.projectKey")).isNull();
- // Check baseDir and workDir
- assertThat(rootProject.getBaseDir().getCanonicalFile())
- .isEqualTo(TestUtils.getResource(this.getClass(), "multi-module-definitions-all-in-root"));
- assertThat(rootProject.getWorkDir().getCanonicalFile())
- .isEqualTo(new File(TestUtils.getResource(this.getClass(), "multi-module-definitions-all-in-root"), ".sonar"));
-
- // CHECK MODULES
- List<ProjectDefinition> modules = rootProject.getSubProjects();
- assertThat(modules.size()).isEqualTo(2);
-
- // Module 1
- ProjectDefinition module1 = modules.get(0);
- assertThat(module1.getBaseDir().getCanonicalFile()).isEqualTo(TestUtils.getResource(this.getClass(), "multi-module-definitions-all-in-root/module1"));
- assertThat(module1.getKey()).isEqualTo("com.foo.project:module1");
- assertThat(module1.getName()).isEqualTo("module1");
- assertThat(module1.getVersion()).isEqualTo("1.0-SNAPSHOT");
- // Description should not be inherited from parent if not set
- assertThat(module1.getDescription()).isNull();
- assertThat(module1.getSourceDirs()).contains("sources");
- assertThat(module1.getTestDirs()).contains("tests");
- assertThat(module1.getBinaries()).contains("target/classes");
- // and module properties must have been cleaned
- assertThat(module1.getProperties().getProperty("module1.sonar.projectKey")).isNull();
- assertThat(module1.getProperties().getProperty("module2.sonar.projectKey")).isNull();
- // Check baseDir and workDir
- assertThat(module1.getBaseDir().getCanonicalFile())
- .isEqualTo(TestUtils.getResource(this.getClass(), "multi-module-definitions-all-in-root/module1"));
- assertThat(module1.getWorkDir().getCanonicalFile())
- .isEqualTo(new File(TestUtils.getResource(this.getClass(), "multi-module-definitions-all-in-root"), ".sonar/com.foo.project_module1"));
-
- // Module 2
- ProjectDefinition module2 = modules.get(1);
- assertThat(module2.getBaseDir().getCanonicalFile()).isEqualTo(TestUtils.getResource(this.getClass(), "multi-module-definitions-all-in-root/module2"));
- assertThat(module2.getKey()).isEqualTo("com.foo.project:com.foo.project.module2");
- assertThat(module2.getName()).isEqualTo("Foo Module 2");
- assertThat(module2.getVersion()).isEqualTo("1.0-SNAPSHOT");
- assertThat(module2.getDescription()).isEqualTo("Description of Module 2");
- assertThat(module2.getSourceDirs()).contains("src");
- assertThat(module2.getTestDirs()).contains("tests");
- assertThat(module2.getBinaries()).contains("target/classes");
- // and module properties must have been cleaned
- assertThat(module2.getProperties().getProperty("module1.sonar.projectKey")).isNull();
- assertThat(module2.getProperties().getProperty("module2.sonar.projectKey")).isNull();
- // Check baseDir and workDir
- assertThat(module2.getBaseDir().getCanonicalFile())
- .isEqualTo(TestUtils.getResource(this.getClass(), "multi-module-definitions-all-in-root/module2"));
- assertThat(module2.getWorkDir().getCanonicalFile())
- .isEqualTo(new File(TestUtils.getResource(this.getClass(), "multi-module-definitions-all-in-root"), ".sonar/com.foo.project_com.foo.project.module2"));
- }
-
- @Test
- public void shouldDefineMultiModuleProjectWithDefinitionsAllInEachModule() throws IOException {
- ProjectDefinition rootProject = loadProjectDefinition("multi-module-definitions-in-each-module");
-
- // CHECK ROOT
- assertThat(rootProject.getKey()).isEqualTo("com.foo.project");
- assertThat(rootProject.getName()).isEqualTo("Foo Project");
- assertThat(rootProject.getVersion()).isEqualTo("1.0-SNAPSHOT");
- assertThat(rootProject.getDescription()).isEqualTo("Description of Foo Project");
- // root project must not contain some properties - even if they are defined in the root properties file
- assertThat(rootProject.getSourceDirs().contains("sources")).isFalse();
- assertThat(rootProject.getTestDirs().contains("tests")).isFalse();
- assertThat(rootProject.getBinaries().contains("target/classes")).isFalse();
- // and module properties must have been cleaned
- assertThat(rootProject.getProperties().getProperty("module1.sonar.projectKey")).isNull();
- assertThat(rootProject.getProperties().getProperty("module2.sonar.projectKey")).isNull();
-
- // CHECK MODULES
- List<ProjectDefinition> modules = rootProject.getSubProjects();
- assertThat(modules.size()).isEqualTo(2);
-
- // Module 1
- ProjectDefinition module1 = modules.get(0);
- assertThat(module1.getBaseDir().getCanonicalFile()).isEqualTo(TestUtils.getResource(this.getClass(), "multi-module-definitions-in-each-module/module1"));
- assertThat(module1.getKey()).isEqualTo("com.foo.project:com.foo.project.module1");
- assertThat(module1.getName()).isEqualTo("Foo Module 1");
- assertThat(module1.getVersion()).isEqualTo("1.0-SNAPSHOT");
- // Description should not be inherited from parent if not set
- assertThat(module1.getDescription()).isEqualTo("Description of Module 1");
- assertThat(module1.getSourceDirs()).contains("sources");
- assertThat(module1.getTestDirs()).contains("tests");
- assertThat(module1.getBinaries()).contains("target/classes");
- // and module properties must have been cleaned
- assertThat(module1.getProperties().getProperty("module1.sonar.projectKey")).isNull();
- assertThat(module1.getProperties().getProperty("module2.sonar.projectKey")).isNull();
-
- // Module 2
- ProjectDefinition module2 = modules.get(1);
- assertThat(module2.getBaseDir().getCanonicalFile()).isEqualTo(TestUtils.getResource(this.getClass(), "multi-module-definitions-in-each-module/module2/newBaseDir"));
- assertThat(module2.getKey()).isEqualTo("com.foo.project:com.foo.project.module2");
- assertThat(module2.getName()).isEqualTo("Foo Module 2");
- assertThat(module2.getVersion()).isEqualTo("1.0-SNAPSHOT");
- assertThat(module2.getDescription()).isEqualTo("Description of Module 2");
- assertThat(module2.getSourceDirs()).contains("src");
- assertThat(module2.getTestDirs()).contains("tests");
- assertThat(module2.getBinaries()).contains("target/classes");
- // and module properties must have been cleaned
- assertThat(module2.getProperties().getProperty("module1.sonar.projectKey")).isNull();
- assertThat(module2.getProperties().getProperty("module2.sonar.projectKey")).isNull();
- }
-
- @Test
- public void shouldDefineMultiModuleProjectWithDefinitionsModule1Inherited() throws IOException {
- ProjectDefinition rootProject = loadProjectDefinition("multi-module-definitions-in-each-module-inherited");
-
- // CHECK ROOT
- assertThat(rootProject.getKey()).isEqualTo("com.foo.project");
- assertThat(rootProject.getName()).isEqualTo("Foo Project");
- assertThat(rootProject.getVersion()).isEqualTo("1.0-SNAPSHOT");
- assertThat(rootProject.getDescription()).isEqualTo("Description of Foo Project");
- // root project must not contain some properties - even if they are defined in the root properties file
- assertThat(rootProject.getSourceDirs().contains("sources")).isFalse();
- assertThat(rootProject.getTestDirs().contains("tests")).isFalse();
- assertThat(rootProject.getBinaries().contains("target/classes")).isFalse();
- // and module properties must have been cleaned
- assertThat(rootProject.getProperties().getProperty("module1.sonar.projectKey")).isNull();
- assertThat(rootProject.getProperties().getProperty("module2.sonar.projectKey")).isNull();
-
- // CHECK MODULES
- List<ProjectDefinition> modules = rootProject.getSubProjects();
- assertThat(modules.size()).isEqualTo(2);
-
- // Module 1
- ProjectDefinition module1 = modules.get(0);
- assertThat(module1.getBaseDir().getCanonicalFile()).isEqualTo(TestUtils.getResource(this.getClass(), "multi-module-definitions-in-each-module-inherited/module1"));
- assertThat(module1.getKey()).isEqualTo("com.foo.project:module1");
- assertThat(module1.getName()).isEqualTo("module1");
- assertThat(module1.getVersion()).isEqualTo("1.0-SNAPSHOT");
- // Description should not be inherited from parent if not set
- assertThat(module1.getDescription()).isNull();
- assertThat(module1.getSourceDirs()).contains("sources");
- assertThat(module1.getTestDirs()).contains("tests");
- assertThat(module1.getBinaries()).contains("target/classes");
- // and module properties must have been cleaned
- assertThat(module1.getProperties().getProperty("module1.sonar.projectKey")).isNull();
- assertThat(module1.getProperties().getProperty("module2.sonar.projectKey")).isNull();
-
- // Module 2
- ProjectDefinition module2 = modules.get(1);
- assertThat(module2.getBaseDir().getCanonicalFile()).isEqualTo(TestUtils.getResource(this.getClass(), "multi-module-definitions-in-each-module-inherited/module2/newBaseDir"));
- assertThat(module2.getKey()).isEqualTo("com.foo.project:com.foo.project.module2");
- assertThat(module2.getName()).isEqualTo("Foo Module 2");
- assertThat(module2.getVersion()).isEqualTo("1.0-SNAPSHOT");
- assertThat(module2.getDescription()).isEqualTo("Description of Module 2");
- assertThat(module2.getSourceDirs()).contains("src");
- assertThat(module2.getTestDirs()).contains("tests");
- assertThat(module2.getBinaries()).contains("target/classes");
- // and module properties must have been cleaned
- assertThat(module2.getProperties().getProperty("module1.sonar.projectKey")).isNull();
- assertThat(module2.getProperties().getProperty("module2.sonar.projectKey")).isNull();
- }
-
- // SONARPLUGINS-2421
- @Test
- public void shouldDefineMultiLanguageProjectWithDefinitionsAllInRootProject() throws IOException {
- ProjectDefinition rootProject = loadProjectDefinition("multi-language-definitions-all-in-root");
-
- // CHECK ROOT
- assertThat(rootProject.getKey()).isEqualTo("example");
- assertThat(rootProject.getName()).isEqualTo("Example");
- assertThat(rootProject.getVersion()).isEqualTo("1.0");
-
- // CHECK MODULES
- List<ProjectDefinition> modules = rootProject.getSubProjects();
- assertThat(modules.size()).isEqualTo(2);
-
- // Module 1
- ProjectDefinition module1 = modules.get(0);
- assertThat(module1.getBaseDir().getCanonicalFile()).isEqualTo(TestUtils.getResource(this.getClass(), "multi-language-definitions-all-in-root"));
- assertThat(module1.getSourceDirs()).contains("src/main/java");
- // and module properties must have been cleaned
- assertThat(module1.getWorkDir().getCanonicalFile())
- .isEqualTo(new File(TestUtils.getResource(this.getClass(), "multi-language-definitions-all-in-root"), ".sonar/example_java-module"));
-
- // Module 2
- ProjectDefinition module2 = modules.get(1);
- assertThat(module2.getBaseDir().getCanonicalFile()).isEqualTo(TestUtils.getResource(this.getClass(), "multi-language-definitions-all-in-root"));
- assertThat(module2.getSourceDirs()).contains("src/main/groovy");
- // and module properties must have been cleaned
- assertThat(module2.getWorkDir().getCanonicalFile())
- .isEqualTo(new File(TestUtils.getResource(this.getClass(), "multi-language-definitions-all-in-root"), ".sonar/example_groovy-module"));
- }
-
- @Test
- public void shouldDefineMultiModuleProjectWithBaseDir() throws IOException {
- ProjectDefinition rootProject = loadProjectDefinition("multi-module-with-basedir");
- List<ProjectDefinition> modules = rootProject.getSubProjects();
- assertThat(modules.size()).isEqualTo(1);
- assertThat(modules.get(0).getKey()).isEqualTo("com.foo.project:com.foo.project.module1");
- }
-
- @Test
- public void shouldDefineMultiModuleProjectWithConfigFile() throws IOException {
- ProjectDefinition rootProject = loadProjectDefinition("multi-module-with-configfile");
- List<ProjectDefinition> modules = rootProject.getSubProjects();
- assertThat(modules.size()).isEqualTo(1);
- ProjectDefinition module = modules.get(0);
- assertThat(module.getKey()).isEqualTo("com.foo.project:com.foo.project.module1");
- // verify the base directory that has been changed in this config file
- assertThat(module.getBaseDir().getCanonicalFile()).isEqualTo(TestUtils.getResource(this.getClass(), "multi-module-with-configfile/any-folder"));
- }
-
- @Test
- public void shouldDefineMultiModuleProjectWithConfigFileAndOverwrittenBasedir() throws IOException {
- ProjectDefinition rootProject = loadProjectDefinition("multi-module-with-configfile-and-overwritten-basedir");
- List<ProjectDefinition> modules = rootProject.getSubProjects();
- assertThat(modules.size()).isEqualTo(1);
- ProjectDefinition module = modules.get(0);
- assertThat(module.getKey()).isEqualTo("com.foo.project:com.foo.project.module1");
- // verify the base directory that has been changed in this config file
- assertThat(module.getBaseDir().getCanonicalFile()).isEqualTo(TestUtils.getResource(this.getClass(), "multi-module-with-configfile-and-overwritten-basedir/any-folder"));
- }
-
- @Test
- public void shouldFailIfUnexistingModuleBaseDir() throws IOException {
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("The base directory of the module 'module1' does not exist: "
- + TestUtils.getResource(this.getClass(), "multi-module-with-unexisting-basedir").getAbsolutePath() + File.separator + "module1");
-
- loadProjectDefinition("multi-module-with-unexisting-basedir");
- }
-
- @Test
- public void shouldFailIfUnexistingModuleFile() throws IOException {
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("The properties file of the module 'module1' does not exist: "
- + TestUtils.getResource(this.getClass(), "multi-module-with-unexisting-file").getAbsolutePath() + File.separator + "any-folder"
- + File.separator + "any-file.properties");
-
- loadProjectDefinition("multi-module-with-unexisting-file");
- }
-
- @Test
- public void shouldFailIfUnexistingSourceFolderInheritedInMultimodule() throws IOException {
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("The folder 'unexisting-source-dir' does not exist for 'com.foo.project:module1' (base directory = "
- + TestUtils.getResource(this.getClass(), "multi-module-with-unexisting-source-dir").getAbsolutePath() + File.separator + "module1)");
-
- loadProjectDefinition("multi-module-with-unexisting-source-dir");
- }
-
- @Test
- public void shouldNotFailIfUnexistingTestBinLibFolderInheritedInMultimodule() throws IOException {
- loadProjectDefinition("multi-module-with-unexisting-test-bin-lib-dir");
- }
-
- @Test
- public void shouldFailIfExplicitUnexistingTestFolder() throws IOException {
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("The folder 'tests' does not exist for 'com.foo.project' (base directory = "
- + TestUtils.getResource(this.getClass(), "simple-project-with-unexisting-test-dir").getAbsolutePath());
-
- loadProjectDefinition("simple-project-with-unexisting-test-dir");
- }
-
- @Test
- public void shouldFailIfExplicitUnexistingBinaryFolder() throws IOException {
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("The folder 'bin' does not exist for 'com.foo.project' (base directory = "
- + TestUtils.getResource(this.getClass(), "simple-project-with-unexisting-binary").getAbsolutePath());
-
- loadProjectDefinition("simple-project-with-unexisting-binary");
- }
-
- @Test
- public void shouldFailIfExplicitUnmatchingLibFolder() throws IOException {
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("No files nor directories matching 'libs/*.txt' in directory "
- + TestUtils.getResource(this.getClass(), "simple-project-with-unexisting-lib").getAbsolutePath());
-
- loadProjectDefinition("simple-project-with-unexisting-lib");
- }
-
- @Test
- public void shouldGetLibDirectory() throws IOException {
- ProjectDefinition def = loadProjectDefinition("simple-project-with-lib-dir");
- assertThat(def.getLibraries()).hasSize(1);
- File libDir = new File(def.getLibraries().get(0));
- assertThat(libDir).isDirectory().exists();
- assertThat(libDir.getName()).isEqualTo("lib");
- }
-
- @Test
- public void shouldFailIfExplicitUnexistingTestFolderOnModule() throws IOException {
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("The folder 'tests' does not exist for 'module1' (base directory = "
- + TestUtils.getResource(this.getClass(), "multi-module-with-explicit-unexisting-test-dir").getAbsolutePath() + File.separator + "module1)");
-
- loadProjectDefinition("multi-module-with-explicit-unexisting-test-dir");
- }
-
- @Test
- public void shouldFailIfExplicitUnexistingBinaryFolderOnModule() throws IOException {
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("The folder 'bin' does not exist for 'module1' (base directory = "
- + TestUtils.getResource(this.getClass(), "multi-module-with-explicit-unexisting-binary-dir").getAbsolutePath() + File.separator + "module1)");
-
- loadProjectDefinition("multi-module-with-explicit-unexisting-binary-dir");
- }
-
- @Test
- public void shouldFailIfExplicitUnmatchingLibFolderOnModule() throws IOException {
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("No files nor directories matching 'lib/*.jar' in directory "
- + TestUtils.getResource(this.getClass(), "multi-module-with-explicit-unexisting-lib").getAbsolutePath() + File.separator + "module1");
-
- loadProjectDefinition("multi-module-with-explicit-unexisting-lib");
- }
-
- @Test
- public void shouldExtractModuleProperties() {
- Properties props = new Properties();
- props.setProperty("sources", "src/main/java");
- props.setProperty("tests", "src/test/java");
- props.setProperty("foo.sources", "src/main/java");
- props.setProperty("foobar.tests", "src/test/java");
- props.setProperty("foobar.binaries", "target/classes");
-
- Properties moduleProps = ProjectReactorBuilder.extractModuleProperties("bar", props);
- assertThat(moduleProps.size()).isEqualTo(0);
-
- moduleProps = ProjectReactorBuilder.extractModuleProperties("foo", props);
- assertThat(moduleProps.size()).isEqualTo(1);
- assertThat(moduleProps.get("sources")).isEqualTo("src/main/java");
-
- moduleProps = ProjectReactorBuilder.extractModuleProperties("foobar", props);
- assertThat(moduleProps.size()).isEqualTo(2);
- assertThat(moduleProps.get("tests")).isEqualTo("src/test/java");
- assertThat(moduleProps.get("binaries")).isEqualTo("target/classes");
- }
-
- @Test
- public void shouldFailIfMandatoryPropertiesAreNotPresent() {
- Properties props = new Properties();
- props.setProperty("foo1", "bla");
- props.setProperty("foo4", "bla");
-
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("You must define the following mandatory properties for 'Unknown': foo2, foo3");
-
- ProjectReactorBuilder.checkMandatoryProperties(props, new String[]{"foo1", "foo2", "foo3"});
- }
-
- @Test
- public void shouldFailIfMandatoryPropertiesAreNotPresentButWithProjectKey() {
- Properties props = new Properties();
- props.setProperty("foo1", "bla");
- props.setProperty("sonar.projectKey", "my-project");
-
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("You must define the following mandatory properties for 'my-project': foo2, foo3");
-
- ProjectReactorBuilder.checkMandatoryProperties(props, new String[]{"foo1", "foo2", "foo3"});
- }
-
- @Test
- public void shouldNotFailIfMandatoryPropertiesArePresent() {
- Properties props = new Properties();
- props.setProperty("foo1", "bla");
- props.setProperty("foo4", "bla");
-
- ProjectReactorBuilder.checkMandatoryProperties(props, new String[]{"foo1"});
-
- // No exception should be thrown
- }
-
- @Test
- public void shouldFilterFiles() throws Exception {
- File baseDir = TestUtils.getResource(this.getClass(), "shouldFilterFiles");
- assertThat(ProjectReactorBuilder.getLibraries(baseDir, "in*.txt")).hasSize(1);
- assertThat(ProjectReactorBuilder.getLibraries(baseDir, "*.txt")).hasSize(2);
- assertThat(ProjectReactorBuilder.getLibraries(baseDir.getParentFile(), "shouldFilterFiles/in*.txt")).hasSize(1);
- assertThat(ProjectReactorBuilder.getLibraries(baseDir.getParentFile(), "shouldFilterFiles/*.txt")).hasSize(2);
- }
-
- @Test
- public void shouldWorkWithAbsolutePath() throws Exception {
- File baseDir = new File("not-exists");
- String absolutePattern = TestUtils.getResource(this.getClass(), "shouldFilterFiles").getAbsolutePath() + "/in*.txt";
- assertThat(ProjectReactorBuilder.getLibraries(baseDir.getParentFile(), absolutePattern)).hasSize(1);
- }
-
- @Test
- public void shouldGetRelativeFile() {
- assertThat(ProjectReactorBuilder.getFileFromPath("shouldGetFile/foo.properties", TestUtils.getResource(this.getClass(), "/")))
- .isEqualTo(TestUtils.getResource(this.getClass(), "shouldGetFile/foo.properties"));
- }
-
- @Test
- public void shouldGetAbsoluteFile() {
- File file = TestUtils.getResource(this.getClass(), "shouldGetFile/foo.properties");
-
- assertThat(ProjectReactorBuilder.getFileFromPath(file.getAbsolutePath(), TestUtils.getResource(this.getClass(), "/")))
- .isEqualTo(file);
- }
-
- @Test
- public void shouldMergeParentProperties() {
- Properties parentProps = new Properties();
- parentProps.setProperty("toBeMergeProps", "fooParent");
- parentProps.setProperty("existingChildProp", "barParent");
- parentProps.setProperty("sonar.modules", "mod1,mod2");
- parentProps.setProperty("sonar.projectDescription", "Desc from Parent");
- parentProps.setProperty("mod1.sonar.projectDescription", "Desc for Mod1");
- parentProps.setProperty("mod2.sonar.projectkey", "Key for Mod2");
-
- Properties childProps = new Properties();
- childProps.setProperty("existingChildProp", "barChild");
- childProps.setProperty("otherProp", "tutuChild");
-
- ProjectReactorBuilder.mergeParentProperties(childProps, parentProps);
-
- assertThat(childProps.size()).isEqualTo(3);
- assertThat(childProps.getProperty("toBeMergeProps")).isEqualTo("fooParent");
- assertThat(childProps.getProperty("existingChildProp")).isEqualTo("barChild");
- assertThat(childProps.getProperty("otherProp")).isEqualTo("tutuChild");
- assertThat(childProps.getProperty("sonar.modules")).isNull();
- assertThat(childProps.getProperty("sonar.projectDescription")).isNull();
- assertThat(childProps.getProperty("mod1.sonar.projectDescription")).isNull();
- assertThat(childProps.getProperty("mod2.sonar.projectkey")).isNull();
- }
-
- @Test
- public void shouldInitRootWorkDir() {
- ProjectReactorBuilder builder = new ProjectReactorBuilder(new Properties());
- File baseDir = new File("target/tmp/baseDir");
-
- File workDir = builder.initRootProjectWorkDir(baseDir);
-
- assertThat(workDir).isEqualTo(new File(baseDir, ".sonar"));
- }
-
- @Test
- public void shouldInitWorkDirWithCustomRelativeFolder() {
- Properties properties = new Properties();
- properties.put("sonar.working.directory", ".foo");
- ProjectReactorBuilder builder = new ProjectReactorBuilder(properties);
- File baseDir = new File("target/tmp/baseDir");
-
- File workDir = builder.initRootProjectWorkDir(baseDir);
-
- assertThat(workDir).isEqualTo(new File(baseDir, ".foo"));
- }
-
- @Test
- public void shouldInitRootWorkDirWithCustomAbsoluteFolder() {
- Properties properties = new Properties();
- properties.put("sonar.working.directory", new File("src").getAbsolutePath());
- ProjectReactorBuilder builder = new ProjectReactorBuilder(properties);
- File baseDir = new File("target/tmp/baseDir");
-
- File workDir = builder.initRootProjectWorkDir(baseDir);
-
- assertThat(workDir).isEqualTo(new File("src").getAbsoluteFile());
- }
-
- @Test
- public void shouldReturnPrefixedKey() {
- Properties props = new Properties();
- props.put("sonar.projectKey", "my-module-key");
-
- ProjectReactorBuilder.prefixProjectKeyWithParentKey(props, "my-parent-key");
- assertThat(props.getProperty("sonar.projectKey")).isEqualTo("my-parent-key:my-module-key");
- }
-
- @Test
- public void shouldFailIf2ModulesWithSameKey() {
- Properties props = new Properties();
- props.put("sonar.projectKey", "root");
- ProjectDefinition root = ProjectDefinition.create().setProperties(props);
-
- Properties props1 = new Properties();
- props1.put("sonar.projectKey", "mod1");
- root.addSubProject(ProjectDefinition.create().setProperties(props1));
-
- // Check uniqueness of a new module: OK
- Properties props2 = new Properties();
- props2.put("sonar.projectKey", "mod2");
- ProjectDefinition mod2 = ProjectDefinition.create().setProperties(props2);
- ProjectReactorBuilder.checkUniquenessOfChildKey(mod2, root);
-
- // Now, add it and check again
- root.addSubProject(mod2);
-
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("Project 'root' can't have 2 modules with the following key: mod2");
-
- ProjectReactorBuilder.checkUniquenessOfChildKey(mod2, root);
- }
-
- @Test
- public void shouldSetProjectKeyIfNotPresent() {
- Properties props = new Properties();
- props.put("sonar.projectVersion", "1.0");
-
- // should be set
- ProjectReactorBuilder.setProjectKeyAndNameIfNotDefined(props, "foo");
- assertThat(props.getProperty("sonar.projectKey")).isEqualTo("foo");
- assertThat(props.getProperty("sonar.projectName")).isEqualTo("foo");
-
- // but not this 2nd time
- ProjectReactorBuilder.setProjectKeyAndNameIfNotDefined(props, "bar");
- assertThat(props.getProperty("sonar.projectKey")).isEqualTo("foo");
- assertThat(props.getProperty("sonar.projectName")).isEqualTo("foo");
- }
-
- @Test
- public void shouldFailToLoadPropertiesFile() throws Exception {
- thrown.expect(IllegalStateException.class);
- thrown.expectMessage("Impossible to read the property file");
-
- ProjectReactorBuilder.toProperties(new File("foo.properties"));
- }
-
- private ProjectDefinition loadProjectDefinition(String projectFolder) throws IOException {
- Properties props = ProjectReactorBuilder.toProperties(TestUtils.getResource(this.getClass(), projectFolder + "/sonar-project.properties"));
- props.put("sonar.projectBaseDir", TestUtils.getResource(this.getClass(), projectFolder).getAbsolutePath());
- ProjectReactor projectReactor = new ProjectReactorBuilder(props).build();
- return projectReactor.getRoot();
- }
-
-}
+++ /dev/null
-/*
- * Sonar Runner - Batch
- * Copyright (C) 2011 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.runner.batch;
-
-import org.apache.commons.io.IOUtils;
-import org.junit.Test;
-import org.sonar.test.TestUtils;
-
-import java.io.FileInputStream;
-import java.io.IOException;
-import java.util.Properties;
-
-import static org.fest.assertions.Assertions.assertThat;
-
-public class UtilsTest {
-
- @Test
- public void shouldGetList() {
- Properties props = new Properties();
-
- props.put("prop", " foo , bar , \n\ntoto,tutu");
- assertThat(Utils.getListFromProperty(props, "prop")).containsOnly("foo", "bar", "toto", "tutu");
- }
-//
-// @Test
-// public void test_props() {
-// Properties p1 = new Properties();
-// p1.setProperty("foo", "bar");
-// Properties p2 = new Properties();
-// p2.putAll(p1);
-// assertThat(p2.getProperty("foo")).isEqualTo("bar");
-// }
-
- @Test
- public void shouldGetListFromFile() throws IOException {
- String filePath = "shouldGetList/foo.properties";
- Properties props = loadPropsFromFile(filePath);
-
- assertThat(Utils.getListFromProperty(props, "prop")).containsOnly("foo", "bar", "toto", "tutu");
- }
-
- private Properties loadPropsFromFile(String filePath) throws IOException {
- Properties props = new Properties();
- FileInputStream fileInputStream = null;
- try {
- fileInputStream = new FileInputStream(TestUtils.getResource(this.getClass(), filePath));
- props.load(fileInputStream);
- } finally {
- IOUtils.closeQuietly(fileInputStream);
- }
- return props;
- }
-
-}
+++ /dev/null
-sonar.projectKey=example
-sonar.projectName=Example
-sonar.projectVersion=1.0
-
-sonar.modules=java-module,groovy-module
-
-java-module.sonar.language=java
-java-module.sonar.projectBaseDir=.
-java-module.sonar.sources=src/main/java
-
-groovy-module.sonar.language=groovy
-groovy-module.sonar.projectBaseDir=.
-groovy-module.sonar.sources=src/main/groovy
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=sources
-sonar.tests=tests
-sonar.binaries=target/classes
-
-sonar.modules=module1,\
- module2
-
-# Mandatory properties for module1 are all inferred from the module ID
-
-module2.sonar.projectKey=com.foo.project.module2
-module2.sonar.projectName=Foo Module 2
-# redefine some properties
-module2.sonar.projectDescription=Description of Module 2
-module2.sonar.sources=src
+++ /dev/null
-# Mandatory properties for module1 are all inferred from the module ID
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-sonar.projectKey=com.foo.project.module2
-sonar.projectName=Foo Module 2
-# redefine some properties
-sonar.projectBaseDir=newBaseDir
-sonar.projectDescription=Description of Module 2
-sonar.sources=src
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=sources
-sonar.tests=tests
-sonar.binaries=target/classes
-
-sonar.modules=module1,\
- module2
+++ /dev/null
-sonar.projectKey=com.foo.project.module1
-sonar.projectName=Foo Module 1
-sonar.projectDescription=Description of Module 1
-sonar.sources=sources
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-sonar.projectKey=com.foo.project.module2
-sonar.projectName=Foo Module 2
-# redefine some properties
-sonar.projectBaseDir=newBaseDir
-sonar.projectDescription=Description of Module 2
-sonar.sources=src
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.tests=tests
-sonar.binaries=target/classes
-
-sonar.modules=module1,\
- module2
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=sources
-sonar.tests=tests
-sonar.binaries=target/classes
-
-sonar.modules=module1
-
-module1.sonar.projectBaseDir=modules/module1
-module1.sonar.projectKey=com.foo.project.module1
-module1.sonar.projectName=Foo Module 1
+++ /dev/null
-sonar.projectKey=com.foo.project.module1
-sonar.projectName=Foo Module 1
-
-# and specify a different baseDir
-sonar.projectBaseDir=..
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=sources
-sonar.tests=tests
-sonar.binaries=target/classes
-
-sonar.modules=module1
-
-module1.sonar.projectConfigFile=any-folder/generated/any-file.properties
+++ /dev/null
-sonar.projectKey=com.foo.project.module1
-sonar.projectName=Foo Module 1
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=sources
-sonar.tests=tests
-sonar.binaries=target/classes
-
-sonar.modules=module1
-
-module1.sonar.projectConfigFile=any-folder/any-file.properties
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=src
-
-sonar.modules=module1
-module1.sonar.binaries=bin
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=src
-
-sonar.modules=module1
-module1.sonar.libraries=lib/*.jar
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=src
-
-sonar.modules=module1
-module1.sonar.tests=tests
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=sources
-sonar.tests=tests
-sonar.binaries=target/classes
-
-sonar.modules=module1
-
-module1.sonar.projectKey=com.foo.project.module1
-module1.sonar.projectName=Foo Module 1
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=sources
-sonar.tests=tests
-sonar.binaries=target/classes
-
-sonar.modules=module1
-
-module1.sonar.projectConfigFile=any-folder/any-file.properties
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=unexisting-source-dir
-
-sonar.modules=module1
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=src
-sonar.tests=tests
-sonar.binaries=bin
-sonar.libraries=lib/*.jar
-
-sonar.modules=module1
+++ /dev/null
-prop= foo, bar, \
-toto,\
-\
-tutu,
\ No newline at end of file
+++ /dev/null
-lib1
\ No newline at end of file
+++ /dev/null
-lib2
\ No newline at end of file
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-# Those are the deprecated properties
-sources=sources
-libraries=libs/*.txt
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-package org.sonar.runner.batch.ProjectReactorBuilderTest.simple
-
-Fake
\ No newline at end of file
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=sources
-sonar.libraries=lib
+++ /dev/null
-package org.sonar.runner.batch.ProjectReactorBuilderTest.simple
-
-Fake
\ No newline at end of file
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=sources
-sonar.binaries=bin
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=sources
-sonar.libraries=libs/*.txt
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=unexisting-source-dir
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=sources
-sonar.tests=tests
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-lib1
\ No newline at end of file
+++ /dev/null
-lib2
\ No newline at end of file
+++ /dev/null
-sonar.projectKey=com.foo.project
-sonar.projectName=Foo Project
-sonar.projectVersion=1.0-SNAPSHOT
-sonar.projectDescription=Description of Foo Project
-
-sonar.sources=sources
-sonar.libraries=libs/*.txt
+++ /dev/null
-Fake
\ No newline at end of file
+++ /dev/null
-prop= foo, bar, \
-toto,\
-\
-tutu,
\ No newline at end of file
class RunnerFactory {
- Runner create(Properties props) {
- Runner runner;
+ Runner<?> create(Properties props) {
+ Runner<?> runner;
if ("fork".equals(props.getProperty("sonarRunner.mode"))) {
runner = ForkedRunner.create();
String jvmArgs = props.getProperty("sonarRunner.fork.jvmArgs", "");
if (!"".equals(jvmArgs)) {
- ((ForkedRunner)runner).addJvmArguments(jvmArgs.split(" "));
+ ((ForkedRunner) runner).addJvmArguments(jvmArgs.split(" "));
}
} else {
projects / sonar-scanner-cli.git / commitdiff