/*
* Copyright 2000-2015 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jetbrains.idea.maven.actions;
import com.intellij.openapi.module.EffectiveLanguageLevelUtil;
import com.intellij.openapi.module.Module;
import com.intellij.openapi.roots.*;
import com.intellij.openapi.roots.libraries.Library;
import com.intellij.openapi.roots.libraries.LibraryTablesRegistrar;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.pom.java.LanguageLevel;
import com.intellij.psi.PsiManager;
import com.intellij.psi.xml.XmlTag;
import com.intellij.util.containers.ContainerUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.concurrency.Promise;
import org.jetbrains.idea.maven.dom.MavenDomWithIndicesTestCase;
import org.jetbrains.idea.maven.importing.MavenProjectModelModifier;
import java.io.IOException;
import java.util.Collections;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* @author nik
*/
public class MavenProjectModelModifierTest extends MavenDomWithIndicesTestCase {
public void testAddExternalLibraryDependency() throws IOException {
importProject("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>");
Promise<Void> result =
getExtension().addExternalLibraryDependency(Collections.singletonList(getModule("project")), new JunitLibraryDescriptor(),
DependencyScope.COMPILE);
assertNotNull(result);
String version = assertHasDependency(myProjectPom, "junit", "junit");
waitUntilImported(result);
assertModuleLibDep("project", "Maven: junit:junit:" + version);
}
public void testAddExternalLibraryDependencyWithEqualMinAndMaxVersions() throws IOException {
importProject("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>");
Promise<Void> result =
getExtension().addExternalLibraryDependency(Collections.singletonList(getModule("project")), new CommonsIoLibraryDescriptor_2_4(),
DependencyScope.COMPILE);
assertNotNull(result);
assertHasDependency(myProjectPom, "commons-io", "commons-io");
waitUntilImported(result);
assertModuleLibDep("project", "Maven: commons-io:commons-io:2.4");
}
public void testAddManagedLibraryDependency() throws IOException {
importProject("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>" +
"<dependencyManagement>\n" +
" <dependencies>\n" +
" <dependency>\n" +
" <groupId>commons-io</groupId>\n" +
" <artifactId>commons-io</artifactId>\n" +
" <version>2.4</version>\n" +
" </dependency>\n" +
" </dependencies>\n" +
"</dependencyManagement>");
Promise<Void> result =
getExtension().addExternalLibraryDependency(Collections.singletonList(getModule("project")), new CommonsIoLibraryDescriptor_2_4(),
DependencyScope.COMPILE);
assertNotNull(result);
assertHasManagedDependency(myProjectPom, "commons-io", "commons-io");
waitUntilImported(result);
assertModuleLibDep("project", "Maven: commons-io:commons-io:2.4");
}
public void testAddManagedLibraryDependencyWithDifferentScope() throws IOException {
importProject("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>" +
"<dependencyManagement>\n" +
" <dependencies>\n" +
" <dependency>\n" +
" <groupId>commons-io</groupId>\n" +
" <artifactId>commons-io</artifactId>\n" +
" <version>2.4</version>\n" +
" <scope>test</scope>\n" +
" </dependency>\n" +
" </dependencies>\n" +
"</dependencyManagement>");
Promise<Void> result =
getExtension().addExternalLibraryDependency(Collections.singletonList(getModule("project")), new CommonsIoLibraryDescriptor_2_4(),
DependencyScope.COMPILE);
assertNotNull(result);
waitUntilImported(result);
assertModuleLibDepScope("project", "Maven: commons-io:commons-io:2.4", DependencyScope.COMPILE);
}
public void testAddLibraryDependencyReleaseVersion() throws IOException {
importProject("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>");
Promise<Void> result = getExtension().addExternalLibraryDependency(
Collections.singletonList(getModule("project")), new CommonsIoLibraryDescriptorUnknownVersion(), DependencyScope.COMPILE);
assertNotNull(result);
final String version = assertHasDependency(myProjectPom, "commons-io", "commons-io");
assertEquals("RELEASE", version);
waitUntilImported(result);
LibraryOrderEntry dep = null;
for (OrderEntry e : getRootManager("project").getOrderEntries()) {
// can be commons-io:commons-io:2.4 or commons-io:commons-io:RELEASE
if (LibraryOrderEntry.class.isInstance(e) && e.getPresentableName().startsWith("Maven: commons-io:commons-io:")) {
dep = (LibraryOrderEntry)e;
}
}
assertNotNull(dep);
}
public void testAddModuleDependency() throws IOException {
createTwoModulesPom("m1", "m2");
VirtualFile m1 = createModulePom("m1", "<groupId>test</groupId>" +
"<artifactId>m1</artifactId>" +
"<version>1</version>");
createModulePom("m2", "<groupId>test</groupId>" +
"<artifactId>m2</artifactId>" +
"<version>1</version>");
importProject();
Promise<Void> result = getExtension().addModuleDependency(getModule("m1"), getModule("m2"), DependencyScope.COMPILE);
assertNotNull(result);
assertHasDependency(m1, "test", "m2");
waitUntilImported(result);
assertModuleModuleDeps("m1", "m2");
}
public void testAddLibraryDependency() throws IOException {
createTwoModulesPom("m1", "m2");
VirtualFile m1 = createModulePom("m1", "<groupId>test</groupId>" +
"<artifactId>m1</artifactId>" +
"<version>1</version>");
createModulePom("m2", "<groupId>test</groupId>" +
"<artifactId>m2</artifactId>" +
"<version>1</version>" +
"<dependencies>" +
" <dependency>" +
" <groupId>junit</groupId>" +
" <artifactId>junit</artifactId>" +
" <version>4.0</version>" +
" <scope>test</scope>" +
" </dependency>" +
"</dependencies>");
importProject();
String libName = "Maven: junit:junit:4.0";
assertModuleLibDep("m2", libName);
Library library = LibraryTablesRegistrar.getInstance().getLibraryTable(myProject).getLibraryByName(libName);
assertNotNull(library);
Promise<Void> result = getExtension().addLibraryDependency(getModule("m1"), library, DependencyScope.COMPILE);
assertNotNull(result);
assertHasDependency(m1, "junit", "junit");
waitUntilImported(result);
assertModuleLibDep("m1", libName);
}
public void testChangeLanguageLevel() throws IOException {
importProject("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>");
Module module = getModule("project");
assertEquals(LanguageLevel.JDK_1_5, EffectiveLanguageLevelUtil.getEffectiveLanguageLevel(module));
Promise<Void> result = getExtension().changeLanguageLevel(module, LanguageLevel.JDK_1_8);
assertNotNull(result);
XmlTag tag = findTag("project.build.plugins.plugin");
assertNotNull(tag);
assertEquals("maven-compiler-plugin", tag.getSubTagText("artifactId"));
XmlTag configuration = tag.findFirstSubTag("configuration");
assertNotNull(configuration);
assertEquals("1.8", configuration.getSubTagText("source"));
assertEquals("1.8", configuration.getSubTagText("target"));
waitUntilImported(result);
assertEquals(LanguageLevel.JDK_1_8, EffectiveLanguageLevelUtil.getEffectiveLanguageLevel(module));
}
private void createTwoModulesPom(final String m1, final String m2) throws IOException {
createProjectPom("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<packaging>pom</packaging>" +
"<version>1</version>" +
"<modules>" +
" <module>" + m1 + "</module>" +
" <module>" + m2 + "</module>" +
"</modules>");
}
private String assertHasDependency(VirtualFile pom, final String groupId, final String artifactId) {
String pomText = PsiManager.getInstance(myProject).findFile(pom).getText();
Pattern
pattern = Pattern.compile("(?s).*<dependency>\\s*<groupId>" + groupId + "</groupId>\\s*<artifactId>" +
artifactId + "</artifactId>\\s*<version>(.*)</version>\\s*</dependency>.*");
Matcher matcher = pattern.matcher(pomText);
assertTrue(matcher.matches());
return matcher.group(1);
}
private void assertHasManagedDependency(VirtualFile pom, final String groupId, final String artifactId) {
String pomText = PsiManager.getInstance(myProject).findFile(pom).getText();
Pattern
pattern = Pattern.compile("(?s).*<dependency>\\s*<groupId>" + groupId + "</groupId>\\s*<artifactId>" +
artifactId + "</artifactId>\\s*</dependency>.*");
Matcher matcher = pattern.matcher(pomText);
assertTrue(matcher.matches());
}
private void waitUntilImported(Promise<Void> result) {
waitForReadingCompletion();
myProjectsManager.waitForResolvingCompletion();
myProjectsManager.waitForArtifactsDownloadingCompletion();
performPostImportTasks();
myProjectsManager.performScheduledImportInTests();
assertSame(Promise.State.FULFILLED, result.getState());
}
private MavenProjectModelModifier getExtension() {
return ContainerUtil.findInstance(JavaProjectModelModifier.EP_NAME.getExtensions(myProject), MavenProjectModelModifier.class);
}
private static class CommonsIoLibraryDescriptor_2_4 extends ExternalLibraryDescriptor {
public CommonsIoLibraryDescriptor_2_4() {
super("commons-io", "commons-io", "2.4", "2.4");
}
@NotNull
@Override
public List<String> getLibraryClassesRoots() {
return Collections.emptyList();
}
}
private static class CommonsIoLibraryDescriptorUnknownVersion extends ExternalLibraryDescriptor {
public CommonsIoLibraryDescriptorUnknownVersion() {
super("commons-io", "commons-io", "999.999", "999.999");
}
@NotNull
@Override
public List<String> getLibraryClassesRoots() {
return Collections.emptyList();
}
}
private static class JunitLibraryDescriptor extends ExternalLibraryDescriptor {
public JunitLibraryDescriptor() {
super("junit", "junit");
}
@NotNull
@Override
public List<String> getLibraryClassesRoots() {
return Collections.emptyList();
}
}
}