diff options
author | Julien HENRY <henryju@yahoo.fr> | 2016-06-14 13:19:08 +0200 |
---|---|---|
committer | Julien HENRY <henryju@yahoo.fr> | 2016-07-05 14:00:16 +0200 |
commit | 0ba54087a18539d0fbe4d8e985e18b01bfe67757 (patch) | |
tree | e76db84602f4c1a98748f933062ddefcca6936fe /sonar-plugin-api | |
parent | 1dba982961537fd82e35e016402d962afde7d76b (diff) | |
download | sonarqube-0ba54087a18539d0fbe4d8e985e18b01bfe67757.tar.gz sonarqube-0ba54087a18539d0fbe4d8e985e18b01bfe67757.zip |
SONAR-7727 Remove deprecated stuff on ProjectDefinition
Diffstat (limited to 'sonar-plugin-api')
3 files changed, 29 insertions, 397 deletions
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectDefinition.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectDefinition.java index 7fae7a84d02..2e5b8ec608c 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectDefinition.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectDefinition.java @@ -41,38 +41,9 @@ import org.sonar.api.CoreProperties; 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 = ','; @@ -90,17 +61,6 @@ public class ProjectDefinition { } } - /** - * @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()); } @@ -253,14 +213,6 @@ public class ProjectDefinition { } /** - * @deprecated since 4.5 use {@link #sources()} - */ - @Deprecated - public List<String> getSourceDirs() { - return sources(); - } - - /** * @param paths paths to file or directory with main sources. * They can be absolute or relative to project base directory. */ @@ -271,14 +223,6 @@ public class ProjectDefinition { 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()); @@ -286,40 +230,16 @@ public class ProjectDefinition { 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) { @@ -328,66 +248,12 @@ public class ProjectDefinition { 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<String> 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<String> sourceDirs = getSourceDirs(); - if (sourceDirs.size() == 1 && isDirectory(sourceDirs.get(0))) { - resetSources(); - } - return addSources(files); - } - - /** - * @deprecated since 4.5 use {@link #sources()} - */ - @Deprecated - public List<String> getSourceFiles() { - return sources(); - } - public List<String> tests() { String sources = (String) ObjectUtils.defaultIfNull(properties.get(TESTS_PROPERTY), ""); return trim(StringUtils.split(sources, SEPARATOR)); } /** - * @deprecated since 4.5 use {@link #tests()} - */ - @Deprecated - public List<String> getTestDirs() { - return tests(); - } - - /** * @param paths path to files or directories with test sources. * It can be absolute or relative to project directory. */ @@ -398,14 +264,6 @@ public class ProjectDefinition { 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()); @@ -413,27 +271,11 @@ public class ProjectDefinition { 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) { @@ -442,117 +284,12 @@ public class ProjectDefinition { 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<String> 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<String> testDirs = getTestDirs(); - if (testDirs.size() == 1 && isDirectory(testDirs.get(0))) { - resetTests(); - } - return addTests(files); - } - - /** - * @deprecated since 4.5 use {@link #tests()} - */ - @Deprecated - public List<String> getTestFiles() { - return tests(); - } - - /** - * @deprecated since 4.5.1 use SonarQube Java specific API - */ - @Deprecated - public List<String> getBinaries() { - String sources = (String) ObjectUtils.defaultIfNull(properties.get(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<String> getLibraries() { - String sources = (String) ObjectUtils.defaultIfNull(properties.get(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); - } - - /** * @since 2.8 */ public ProjectDefinition addSubProject(ProjectDefinition child) { diff --git a/sonar-plugin-api/src/test/java/org/sonar/api/batch/bootstrap/ProjectBuilderTest.java b/sonar-plugin-api/src/test/java/org/sonar/api/batch/bootstrap/ProjectBuilderTest.java index 296cbaa8a78..c3f2efde151 100644 --- a/sonar-plugin-api/src/test/java/org/sonar/api/batch/bootstrap/ProjectBuilderTest.java +++ b/sonar-plugin-api/src/test/java/org/sonar/api/batch/bootstrap/ProjectBuilderTest.java @@ -23,6 +23,8 @@ import org.junit.Test; import org.sonar.api.batch.bootstrap.internal.ProjectBuilderContext; import org.sonar.api.config.Settings; +import static org.assertj.core.api.Assertions.assertThat; + import java.io.File; import static org.hamcrest.core.Is.is; @@ -43,7 +45,7 @@ public class ProjectBuilderTest { ProjectDefinition root = projectReactor.getRoot(); assertThat(root.getName(), is("Name changed by plugin")); assertThat(root.getSubProjects().size(), is(1)); - assertThat(root.getSubProjects().get(0).getSourceDirs(), hasItem("src")); + assertThat(root.getSubProjects().get(0).sources()).contains("src"); } final static class ProjectBuilderSample extends ProjectBuilder { @@ -68,7 +70,7 @@ public class ProjectBuilderTest { subProject.setKey("groupId:parentProjectId"); subProject.setVersion(root.getVersion()); subProject.setName("Sub Project"); - subProject.setSourceDirs("src"); + subProject.setSources("src"); root.addSubProject(subProject); } } diff --git a/sonar-plugin-api/src/test/java/org/sonar/api/batch/bootstrap/ProjectDefinitionTest.java b/sonar-plugin-api/src/test/java/org/sonar/api/batch/bootstrap/ProjectDefinitionTest.java index 5deb5611a66..a02f7e226dd 100644 --- a/sonar-plugin-api/src/test/java/org/sonar/api/batch/bootstrap/ProjectDefinitionTest.java +++ b/sonar-plugin-api/src/test/java/org/sonar/api/batch/bootstrap/ProjectDefinitionTest.java @@ -30,9 +30,6 @@ import java.util.List; import java.util.Properties; import static org.assertj.core.api.Assertions.assertThat; -import static org.hamcrest.Matchers.is; -import static org.hamcrest.Matchers.nullValue; -import static org.junit.Assert.assertThat; public class ProjectDefinitionTest { @@ -43,14 +40,14 @@ public class ProjectDefinitionTest { public void shouldSetKey() { ProjectDefinition def = ProjectDefinition.create(); def.setKey("mykey"); - assertThat(def.getKey(), is("mykey")); + assertThat(def.getKey()).isEqualTo("mykey"); } @Test public void shouldSetVersion() { ProjectDefinition def = ProjectDefinition.create(); def.setVersion("2.0-SNAPSHOT"); - assertThat(def.getVersion(), is("2.0-SNAPSHOT")); + assertThat(def.getVersion()).isEqualTo("2.0-SNAPSHOT"); } @Test @@ -58,15 +55,15 @@ public class ProjectDefinitionTest { ProjectDefinition def = ProjectDefinition.create(); def.setName("myname"); def.setDescription("desc"); - assertThat(def.getName(), is("myname")); - assertThat(def.getDescription(), is("desc")); + assertThat(def.getName()).isEqualTo("myname"); + assertThat(def.getDescription()).isEqualTo("desc"); } @Test public void shouldSupportDefaultName() { ProjectDefinition def = ProjectDefinition.create(); def.setKey("myKey"); - assertThat(def.getName(), is("Unnamed - myKey")); + assertThat(def.getName()).isEqualTo("Unnamed - myKey"); } @Test @@ -75,16 +72,14 @@ public class ProjectDefinitionTest { props.setProperty(CoreProperties.PROJECT_KEY_PROPERTY, "foo"); ProjectDefinition def = ProjectDefinition.create(); def.setProperties(props); - assertThat(def.getKey(), is("foo")); + assertThat(def.getKey()).isEqualTo("foo"); } @Test public void testDefaultValues() { ProjectDefinition def = ProjectDefinition.create(); - assertThat(def.getSourceDirs().size(), is(0)); - assertThat(def.getTestDirs().size(), is(0)); - assertThat(def.getBinaries().size(), is(0)); - assertThat(def.getLibraries().size(), is(0)); + assertThat(def.sources()).isEmpty(); + assertThat(def.tests()).isEmpty(); } /** @@ -93,54 +88,11 @@ public class ProjectDefinitionTest { @Test public void shouldTrimPaths() { ProjectDefinition def = ProjectDefinition.create(); - def.setProperty(ProjectDefinition.SOURCE_DIRS_PROPERTY, "src1, src2 , with whitespace"); - def.setProperty(ProjectDefinition.TEST_DIRS_PROPERTY, "test1, test2 , with whitespace"); - def.setProperty(ProjectDefinition.BINARIES_PROPERTY, "bin1, bin2 , with whitespace"); - def.setProperty(ProjectDefinition.LIBRARIES_PROPERTY, "lib1, lib2 , with whitespace"); - - assertFiles(def.getSourceDirs(), "src1", "src2", "with whitespace"); - assertFiles(def.getTestDirs(), "test1", "test2", "with whitespace"); - assertFiles(def.getBinaries(), "bin1", "bin2", "with whitespace"); - assertFiles(def.getLibraries(), "lib1", "lib2", "with whitespace"); - } - - @Test - public void shouldAddDirectoriesAsPath() { - ProjectDefinition def = ProjectDefinition.create(); - def.addSourceDirs("src/main/java", "src/main/java2"); - def.addTestDirs("src/test/java"); - def.addTestDirs("src/test/java2"); - def.addBinaryDir("target/classes"); - def.addBinaryDir("target/classes2"); - def.addLibrary("junit.jar"); - def.addLibrary("mockito.jar"); - - assertFiles(def.getSourceDirs(), "src/main/java", "src/main/java2"); - assertFiles(def.getTestDirs(), "src/test/java", "src/test/java2"); - assertFiles(def.getBinaries(), "target/classes", "target/classes2"); - assertFiles(def.getLibraries(), "junit.jar", "mockito.jar"); - } - - @Test - public void shouldAddDirectories() { - ProjectDefinition def = ProjectDefinition.create(); - def.addSourceDirs(new File("src/main/java"), new File("src/main/java2")); - def.addTestDirs(new File("src/test/java"), new File("src/test/java2")); - def.addBinaryDir(new File("target/classes")); - - assertThat(def.getSourceDirs().size(), is(2)); - assertThat(def.getTestDirs().size(), is(2)); - assertThat(def.getBinaries().size(), is(1)); - } - - @Test - public void shouldAddFiles() { - ProjectDefinition def = ProjectDefinition.create(); - def.addSourceFiles("src/main/java/foo/Bar.java", "src/main/java/hello/World.java"); - def.addTestFiles("src/test/java/foo/BarTest.java", "src/test/java/hello/WorldTest.java"); + def.setSources("src1", " src2 ", " with whitespace"); + def.setTests("test1"," test2 "," with whitespace"); - assertFiles(def.getSourceFiles(), "src/main/java/foo/Bar.java", "src/main/java/hello/World.java"); - assertFiles(def.getTestFiles(), "src/test/java/foo/BarTest.java", "src/test/java/hello/WorldTest.java"); + assertThat(def.sources()).containsOnly("src1", "src2", "with whitespace"); + assertThat(def.tests()).containsOnly("test1", "test2", "with whitespace"); } @Test @@ -149,91 +101,32 @@ public class ProjectDefinitionTest { ProjectDefinition child = ProjectDefinition.create(); root.addSubProject(child); - assertThat(root.getSubProjects().size(), is(1)); - assertThat(child.getSubProjects().size(), is(0)); + assertThat(root.getSubProjects()).hasSize(1); + assertThat(child.getSubProjects()).isEmpty(); - assertThat(root.getParent(), nullValue()); - assertThat(child.getParent(), is(root)); + assertThat(root.getParent()).isNull(); + assertThat(child.getParent()).isEqualTo(root); } @Test public void shouldResetSourceDirs() { ProjectDefinition root = ProjectDefinition.create(); - root.addSourceDirs("src", "src2/main"); - assertThat(root.getSourceDirs().size(), is(2)); + root.addSources("src", "src2/main"); + assertThat(root.sources()).hasSize(2); - root.resetSourceDirs(); - assertThat(root.getSourceDirs().size(), is(0)); + root.resetSources(); + assertThat(root.sources()).isEmpty(); } @Test public void shouldResetTestDirs() { ProjectDefinition root = ProjectDefinition.create(); - root.addTestDirs("src", "src2/test"); - assertThat(root.getTestDirs().size(), is(2)); + root.addTests("src", "src2/test"); + assertThat(root.tests()).hasSize(2); - root.resetTestDirs(); - assertThat(root.getTestDirs().size(), is(0)); + root.resetTests(); + assertThat(root.tests()).isEmpty(); } - @Test - public void shouldResetSourceDirsWhenUsindDeprecatedMethod() throws IOException { - File baseDir = temp.newFolder(); - ProjectDefinition root = ProjectDefinition.create().setBaseDir(baseDir); - File src = new File(baseDir, "src"); - src.mkdir(); - root.addSourceDirs("src"); - assertThat(root.getSourceDirs()).containsOnly("src"); - - root.addSourceFiles("foo.java"); - assertThat(root.getSourceDirs()).containsOnly("foo.java"); - } - - @Test - public void shouldResetTestDirsWhenUsindDeprecatedMethod() throws IOException { - File baseDir = temp.newFolder(); - ProjectDefinition root = ProjectDefinition.create().setBaseDir(baseDir); - File test = new File(baseDir, "test"); - test.mkdir(); - root.addTestDirs("test"); - assertThat(root.getTestDirs()).containsOnly("test"); - - root.addTestFiles("fooTest.java"); - assertThat(root.getTestDirs()).containsOnly("fooTest.java"); - } - - @Test - public void shouldResetSourceDirsWhenUsindDeprecatedFileMethod() throws IOException { - File baseDir = temp.newFolder(); - ProjectDefinition root = ProjectDefinition.create().setBaseDir(baseDir); - File src = new File(baseDir, "src"); - src.mkdir(); - root.addSourceDirs("src"); - assertThat(root.getSourceDirs()).containsOnly("src"); - - File file = new File(src, "foo.java"); - root.addSourceFiles(file); - assertThat(root.getSourceDirs()).containsOnly(file.getAbsolutePath()); - } - - @Test - public void shouldResetTestDirsWhenUsindDeprecatedFileMethod() throws IOException { - File baseDir = temp.newFolder(); - ProjectDefinition root = ProjectDefinition.create().setBaseDir(baseDir); - File test = new File(baseDir, "test"); - test.mkdir(); - root.addTestDirs("test"); - assertThat(root.getTestDirs()).containsOnly("test"); - - File file = new File(test, "fooTest.java"); - root.addTestFiles(file); - assertThat(root.getTestDirs()).containsOnly(file.getAbsolutePath()); - } - private static void assertFiles(List<String> paths, String... values) { - assertThat(paths.size(), is(values.length)); - for (int i = 0; i < values.length; i++) { - assertThat(paths.get(i), is(values[i])); - } - } } |