aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/sonar-maven-batch-plugin
diff options
context:
space:
mode:
authorJulien HENRY <julien.henry@sonarsource.com>2013-06-20 16:11:14 +0200
committerJulien HENRY <julien.henry@sonarsource.com>2013-06-20 17:23:56 +0200
commit9035a835c690eb50abc5891ee0659212117d0391 (patch)
tree85b465b6e91d553e4b8eee7ffeb8e8bec0a3c73f /plugins/sonar-maven-batch-plugin
parent19e30a139b746ff2cbf0b2f07b3aab5b345d0f48 (diff)
downloadsonarqube-9035a835c690eb50abc5891ee0659212117d0391.tar.gz
sonarqube-9035a835c690eb50abc5891ee0659212117d0391.zip
Improve testability and coverage by UTs
Diffstat (limited to 'plugins/sonar-maven-batch-plugin')
-rw-r--r--plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/MavenBatchPlugin.java2
-rw-r--r--plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/MavenProjectConverter.java13
-rw-r--r--plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/SonarMavenProjectBuilder.java7
-rw-r--r--plugins/sonar-maven-batch-plugin/src/test/java/org/sonar/plugins/maven/MavenBatchPluginTest.java34
-rw-r--r--plugins/sonar-maven-batch-plugin/src/test/java/org/sonar/plugins/maven/MavenProjectConverterTest.java20
-rw-r--r--plugins/sonar-maven-batch-plugin/src/test/java/org/sonar/plugins/maven/SonarMavenProjectBuilderTest.java89
6 files changed, 146 insertions, 19 deletions
diff --git a/plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/MavenBatchPlugin.java b/plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/MavenBatchPlugin.java
index 257d9dcb1d3..aac1e709fbf 100644
--- a/plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/MavenBatchPlugin.java
+++ b/plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/MavenBatchPlugin.java
@@ -27,6 +27,6 @@ import java.util.List;
public final class MavenBatchPlugin extends SonarPlugin {
public List getExtensions() {
- return ImmutableList.of(SonarMavenProjectBuilder.class, RealMavenPluginExecutor.class);
+ return ImmutableList.of(SonarMavenProjectBuilder.class, RealMavenPluginExecutor.class, MavenProjectConverter.class);
}
}
diff --git a/plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/MavenProjectConverter.java b/plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/MavenProjectConverter.java
index 5a884f3e628..3e5a900e2a5 100644
--- a/plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/MavenProjectConverter.java
+++ b/plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/MavenProjectConverter.java
@@ -29,7 +29,9 @@ import org.apache.maven.model.CiManagement;
import org.apache.maven.model.IssueManagement;
import org.apache.maven.model.Scm;
import org.apache.maven.project.MavenProject;
+import org.sonar.api.BatchExtension;
import org.sonar.api.CoreProperties;
+import org.sonar.api.batch.InstantiationStrategy;
import org.sonar.api.batch.bootstrap.ProjectDefinition;
import org.sonar.api.batch.maven.MavenUtils;
import org.sonar.api.utils.SonarException;
@@ -42,22 +44,19 @@ import java.util.Arrays;
import java.util.List;
import java.util.Map;
-public class MavenProjectConverter {
+@InstantiationStrategy(InstantiationStrategy.PER_BATCH)
+public class MavenProjectConverter implements BatchExtension {
private static final String UNABLE_TO_DETERMINE_PROJECT_STRUCTURE_EXCEPTION_MESSAGE = "Unable to determine structure of project." +
" Probably you use Maven Advanced Reactor Options, which is not supported by Sonar and should not be used.";
- private MavenProjectConverter() {
- // only static methods
- }
-
- public static ProjectDefinition convert(List<MavenProject> poms, MavenProject root) {
+ public ProjectDefinition convert(List<MavenProject> poms, MavenProject root) {
ProjectDefinition def = ProjectDefinition.create();
configure(def, poms, root);
return def;
}
- public static void configure(ProjectDefinition rootProjectDefinition, List<MavenProject> poms, MavenProject root) {
+ public void configure(ProjectDefinition rootProjectDefinition, List<MavenProject> poms, MavenProject root) {
// projects by canonical path to pom.xml
Map<String, MavenProject> paths = Maps.newHashMap();
Map<MavenProject, ProjectDefinition> defs = Maps.newHashMap();
diff --git a/plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/SonarMavenProjectBuilder.java b/plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/SonarMavenProjectBuilder.java
index 0c576dc32cb..d2a648f71c3 100644
--- a/plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/SonarMavenProjectBuilder.java
+++ b/plugins/sonar-maven-batch-plugin/src/main/java/org/sonar/plugins/maven/SonarMavenProjectBuilder.java
@@ -31,13 +31,16 @@ import java.util.List;
public class SonarMavenProjectBuilder extends ProjectBuilder {
private MavenSession session;
+ private MavenProjectConverter mavenProjectConverter;
- public SonarMavenProjectBuilder(MavenSession session) {
+ public SonarMavenProjectBuilder(MavenSession session, MavenProjectConverter mavenProjectConverter) {
this.session = session;
+ this.mavenProjectConverter = mavenProjectConverter;
}
@Override
public void build(ProjectBuilderContext context) {
+ // Don't use session.getTopLevelProject or session.getProjects to keep compatibility with Maven 2
List<MavenProject> sortedProjects = session.getSortedProjects();
MavenProject topLevelProject = null;
for (MavenProject project : sortedProjects) {
@@ -46,7 +49,7 @@ public class SonarMavenProjectBuilder extends ProjectBuilder {
break;
}
}
- MavenProjectConverter.configure(context.getProjectReactor().getRoot(), sortedProjects, topLevelProject);
+ mavenProjectConverter.configure(context.getProjectReactor().getRoot(), sortedProjects, topLevelProject);
}
}
diff --git a/plugins/sonar-maven-batch-plugin/src/test/java/org/sonar/plugins/maven/MavenBatchPluginTest.java b/plugins/sonar-maven-batch-plugin/src/test/java/org/sonar/plugins/maven/MavenBatchPluginTest.java
new file mode 100644
index 00000000000..23b6726170a
--- /dev/null
+++ b/plugins/sonar-maven-batch-plugin/src/test/java/org/sonar/plugins/maven/MavenBatchPluginTest.java
@@ -0,0 +1,34 @@
+/*
+ * SonarQube, open source software quality management tool.
+ * Copyright (C) 2008-2013 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.plugins.maven;
+
+import org.junit.Test;
+
+import static org.fest.assertions.Assertions.assertThat;
+
+public class MavenBatchPluginTest {
+
+ @Test
+ public void testGetExtensions() {
+ MavenBatchPlugin plugin = new MavenBatchPlugin();
+ assertThat(plugin.getExtensions()).hasSize(3);
+ }
+
+}
diff --git a/plugins/sonar-maven-batch-plugin/src/test/java/org/sonar/plugins/maven/MavenProjectConverterTest.java b/plugins/sonar-maven-batch-plugin/src/test/java/org/sonar/plugins/maven/MavenProjectConverterTest.java
index d1ae22d872e..604a9bf82c1 100644
--- a/plugins/sonar-maven-batch-plugin/src/test/java/org/sonar/plugins/maven/MavenProjectConverterTest.java
+++ b/plugins/sonar-maven-batch-plugin/src/test/java/org/sonar/plugins/maven/MavenProjectConverterTest.java
@@ -51,6 +51,8 @@ public class MavenProjectConverterTest {
@Rule
public TemporaryFolder temp = new TemporaryFolder();
+ private MavenProjectConverter mavenProjectConverter = new MavenProjectConverter();
+
/**
* See SONAR-2681
*/
@@ -62,7 +64,7 @@ public class MavenProjectConverterTest {
root.getModules().add("module/pom.xml");
try {
- MavenProjectConverter.convert(Arrays.asList(root), root);
+ mavenProjectConverter.convert(Arrays.asList(root), root);
fail();
} catch (IllegalStateException e) {
assertThat(e.getMessage(), containsString("Advanced Reactor Options"));
@@ -82,7 +84,7 @@ public class MavenProjectConverterTest {
module.setFile(new File(basedir, "module/pom.xml"));
module.getBuild().setDirectory("target");
module.getBuild().setOutputDirectory("target/classes");
- ProjectDefinition project = MavenProjectConverter.convert(Arrays.asList(root, module), root);
+ ProjectDefinition project = mavenProjectConverter.convert(Arrays.asList(root, module), root);
assertThat(project.getSubProjects().size(), is(1));
}
@@ -122,7 +124,7 @@ public class MavenProjectConverterTest {
MavenProject module1 = loadPom("/org/sonar/plugins/maven/MavenProjectConverterTest/moduleNameShouldEqualArtifactId/module1/pom.xml", false);
MavenProject module2 = loadPom("/org/sonar/plugins/maven/MavenProjectConverterTest/moduleNameShouldEqualArtifactId/module2/pom.xml", false);
- ProjectDefinition rootDef = MavenProjectConverter.convert(Arrays.asList(parent, module1, module2), parent);
+ ProjectDefinition rootDef = mavenProjectConverter.convert(Arrays.asList(parent, module1, module2), parent);
assertThat(rootDef.getSubProjects().size(), Is.is(2));
assertThat(rootDef.getKey(), Is.is("org.test:parent"));
@@ -143,7 +145,7 @@ public class MavenProjectConverterTest {
MavenProject module1 = loadPom("/org/sonar/plugins/maven/MavenProjectConverterTest/moduleNameDifferentThanArtifactId/path1/pom.xml", false);
MavenProject module2 = loadPom("/org/sonar/plugins/maven/MavenProjectConverterTest/moduleNameDifferentThanArtifactId/path2/pom.xml", false);
- ProjectDefinition rootDef = MavenProjectConverter.convert(Arrays.asList(parent, module1, module2), parent);
+ ProjectDefinition rootDef = mavenProjectConverter.convert(Arrays.asList(parent, module1, module2), parent);
assertThat(rootDef.getSubProjects().size(), is(2));
assertThat(rootDef.getKey(), is("org.test:parent"));
@@ -163,7 +165,7 @@ public class MavenProjectConverterTest {
MavenProject parent = loadPom("/org/sonar/plugins/maven/MavenProjectConverterTest/mavenProjectFileNameNotEqualsToPomXml/pom.xml", true);
MavenProject module = loadPom("/org/sonar/plugins/maven/MavenProjectConverterTest/mavenProjectFileNameNotEqualsToPomXml/module/pom_having_different_name.xml", false);
- ProjectDefinition rootDef = MavenProjectConverter.convert(Arrays.asList(parent, module), parent);
+ ProjectDefinition rootDef = mavenProjectConverter.convert(Arrays.asList(parent, module), parent);
assertThat(rootDef.getSubProjects().size(), Is.is(1));
assertThat(rootDef.getKey(), Is.is("org.test:parent"));
@@ -182,7 +184,7 @@ public class MavenProjectConverterTest {
File rootDir = TestUtils.getResource("/org/sonar/plugins/maven/MavenProjectConverterTest/singleProjectWithoutModules/");
MavenProject pom = loadPom("/org/sonar/plugins/maven/MavenProjectConverterTest/singleProjectWithoutModules/pom.xml", true);
- ProjectDefinition rootDef = MavenProjectConverter.convert(Arrays.asList(pom), pom);
+ ProjectDefinition rootDef = mavenProjectConverter.convert(Arrays.asList(pom), pom);
assertThat(rootDef.getKey(), is("org.test:parent"));
assertThat(rootDef.getSubProjects().size(), is(0));
@@ -194,7 +196,7 @@ public class MavenProjectConverterTest {
public void shouldConvertLinksToProperties() throws Exception {
MavenProject pom = loadPom("/org/sonar/plugins/maven/MavenProjectConverterTest/projectWithLinks/pom.xml", true);
- ProjectDefinition rootDef = MavenProjectConverter.convert(Arrays.asList(pom), pom);
+ ProjectDefinition rootDef = mavenProjectConverter.convert(Arrays.asList(pom), pom);
Properties props = rootDef.getProperties();
assertThat(props.getProperty(CoreProperties.LINKS_HOME_PAGE)).isEqualTo("http://home.com");
@@ -208,7 +210,7 @@ public class MavenProjectConverterTest {
public void shouldNotConvertLinksToPropertiesIfPropertyAlreadyDefined() throws Exception {
MavenProject pom = loadPom("/org/sonar/plugins/maven/MavenProjectConverterTest/projectWithLinksAndProperties/pom.xml", true);
- ProjectDefinition rootDef = MavenProjectConverter.convert(Arrays.asList(pom), pom);
+ ProjectDefinition rootDef = mavenProjectConverter.convert(Arrays.asList(pom), pom);
Properties props = rootDef.getProperties();
@@ -226,7 +228,7 @@ public class MavenProjectConverterTest {
public void shouldLoadSourceEncoding() throws Exception {
MavenProject pom = loadPom("/org/sonar/plugins/maven/MavenProjectConverterTest/sourceEncoding/pom.xml", true);
- ProjectDefinition rootDef = MavenProjectConverter.convert(Arrays.asList(pom), pom);
+ ProjectDefinition rootDef = mavenProjectConverter.convert(Arrays.asList(pom), pom);
assertThat(rootDef.getProperties().getProperty(CoreProperties.ENCODING_PROPERTY)).isEqualTo("Shift_JIS");
}
diff --git a/plugins/sonar-maven-batch-plugin/src/test/java/org/sonar/plugins/maven/SonarMavenProjectBuilderTest.java b/plugins/sonar-maven-batch-plugin/src/test/java/org/sonar/plugins/maven/SonarMavenProjectBuilderTest.java
new file mode 100644
index 00000000000..d631b60e617
--- /dev/null
+++ b/plugins/sonar-maven-batch-plugin/src/test/java/org/sonar/plugins/maven/SonarMavenProjectBuilderTest.java
@@ -0,0 +1,89 @@
+/*
+ * SonarQube, open source software quality management tool.
+ * Copyright (C) 2008-2013 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.plugins.maven;
+
+import org.apache.maven.execution.MavenSession;
+import org.apache.maven.project.MavenProject;
+import org.junit.Test;
+import org.mockito.ArgumentCaptor;
+import org.sonar.api.batch.bootstrap.ProjectBuilderContext;
+import org.sonar.api.batch.bootstrap.ProjectDefinition;
+import org.sonar.api.batch.bootstrap.ProjectReactor;
+
+import java.util.Arrays;
+import java.util.List;
+
+import static org.fest.assertions.Assertions.assertThat;
+import static org.mockito.Matchers.eq;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+public class SonarMavenProjectBuilderTest {
+
+ @Test
+ public void testSimpleProject() {
+ MavenSession session = mock(MavenSession.class);
+ MavenProject rootProject = mock(MavenProject.class);
+ when(rootProject.isExecutionRoot()).thenReturn(true);
+ when(session.getSortedProjects()).thenReturn(Arrays.asList(rootProject));
+
+ MavenProjectConverter mavenProjectConverter = mock(MavenProjectConverter.class);
+ SonarMavenProjectBuilder builder = new SonarMavenProjectBuilder(session, mavenProjectConverter);
+
+ ProjectBuilderContext context = mock(ProjectBuilderContext.class);
+ ProjectDefinition root = ProjectDefinition.create();
+ ProjectReactor reactor = new ProjectReactor(root);
+ when(context.getProjectReactor()).thenReturn(reactor);
+
+ builder.build(context);
+
+ ArgumentCaptor<List> argument = ArgumentCaptor.forClass(List.class);
+ verify(mavenProjectConverter).configure(eq(root), argument.capture(), eq(rootProject));
+ assertThat(argument.getValue()).contains(rootProject);
+ }
+
+ @Test
+ public void testMultimoduleProject() {
+ MavenSession session = mock(MavenSession.class);
+ MavenProject rootProject = mock(MavenProject.class);
+ MavenProject module1 = mock(MavenProject.class);
+ MavenProject module2 = mock(MavenProject.class);
+ when(rootProject.isExecutionRoot()).thenReturn(true);
+ when(module1.isExecutionRoot()).thenReturn(false);
+ when(module2.isExecutionRoot()).thenReturn(false);
+ when(session.getSortedProjects()).thenReturn(Arrays.asList(module1, module2, rootProject));
+
+ MavenProjectConverter mavenProjectConverter = mock(MavenProjectConverter.class);
+ SonarMavenProjectBuilder builder = new SonarMavenProjectBuilder(session, mavenProjectConverter);
+
+ ProjectBuilderContext context = mock(ProjectBuilderContext.class);
+ ProjectDefinition root = ProjectDefinition.create();
+ ProjectReactor reactor = new ProjectReactor(root);
+ when(context.getProjectReactor()).thenReturn(reactor);
+
+ builder.build(context);
+
+ ArgumentCaptor<List> argument = ArgumentCaptor.forClass(List.class);
+ verify(mavenProjectConverter).configure(eq(root), argument.capture(), eq(rootProject));
+ assertThat(argument.getValue()).contains(module1, module2, rootProject);
+ }
+
+}