/*
* Copyright 2000-2017 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.importing;
import com.intellij.openapi.actionSystem.ActionManager;
import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.KeyboardShortcut;
import com.intellij.openapi.command.WriteCommandAction;
import com.intellij.openapi.keymap.Keymap;
import com.intellij.openapi.keymap.KeymapManager;
import com.intellij.openapi.vfs.VirtualFile;
import org.jetbrains.idea.maven.MavenImportingTestCase;
import org.jetbrains.idea.maven.project.MavenProject;
import org.jetbrains.idea.maven.tasks.MavenKeymapExtension;
import org.jetbrains.idea.maven.tasks.MavenShortcutsManager;
import java.util.Arrays;
import java.util.List;
public class MavenShortcutsManagerTest extends MavenImportingTestCase {
private MavenShortcutsManager myShortcutsManager;
@Override
protected void setUp() throws Exception {
super.setUp();
myShortcutsManager = MavenShortcutsManager.getInstance(myProject);
myShortcutsManager.doInit();
initProjectsManager(true);
}
@Override
public void tearDown() throws Exception {
try {
MavenKeymapExtension.clearActions(myProject);
}
finally {
myShortcutsManager = null;
super.tearDown();
}
}
public void testRefreshingActionsOnImport() throws Exception {
assertTrue(getProjectActions().isEmpty());
VirtualFile p1 = createModulePom("p1", "<groupId>test</groupId>" +
"<artifactId>p1</artifactId>" +
"<version>1</version>");
VirtualFile p2 = createModulePom("p2", "<groupId>test</groupId>" +
"<artifactId>p2</artifactId>" +
"<version>1</version>");
importProjects(p1, p2);
assertEmptyKeymap();
}
public void testRefreshingOnProjectRead() throws Exception {
importProject("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>");
assertEmptyKeymap();
String goal = "clean";
assignShortcut(myProjectPom, goal, "alt shift X");
importProject("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>" +
"<build>" +
" <plugins>" +
" <plugin>" +
" <groupId>org.apache.maven.plugins</groupId>" +
" <artifactId>maven-surefire-plugin</artifactId>" +
" </plugin>" +
" </plugins>" +
"</build>");
assertKeymapContains(myProjectPom, goal);
}
public void testRefreshingOnPluginResolve() throws Exception {
importProject("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>");
assertEmptyKeymap();
String goal = "org.apache.maven.plugins:maven-surefire-plugin:2.4.3:test";
assignShortcut(myProjectPom, goal, "alt shift X");
importProject("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>" +
"<build>" +
" <plugins>" +
" <plugin>" +
" <groupId>org.apache.maven.plugins</groupId>" +
" <artifactId>maven-surefire-plugin</artifactId>" +
" <version>2.4.3</version>" +
" </plugin>" +
" </plugins>" +
"</build>");
resolvePlugins();
assertKeymapContains(myProjectPom, goal);
}
public void testActionWhenSeveralSimilarPlugins() throws Exception {
importProject("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>");
importProject("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>" +
"<build>" +
" <plugins>" +
" <plugin>" +
" <groupId>org.apache.maven.plugins</groupId>" +
" <artifactId>maven-surefire-plugin</artifactId>" +
" <version>2.4.3</version>" +
" </plugin>" +
" <plugin>" +
" <groupId>org.apache.maven.plugins</groupId>" +
" <artifactId>maven-surefire-plugin</artifactId>" +
" <version>2.4.3</version>" +
" </plugin>" +
" </plugins>" +
"</build>");
String goal = "org.apache.maven.plugins:maven-surefire-plugin:2.4.3:test";
assignShortcut(myProjectPom, goal, "alt shift X");
resolvePlugins();
assertKeymapContains(myProjectPom, goal);
}
public void testRefreshingOnProjectAddition() throws Exception {
importProject("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>");
VirtualFile m = createModulePom("module", "<groupId>test</groupId>" +
"<artifactId>module</artifactId>" +
"<version>1</version>");
String goal = "clean";
assertKeymapDoesNotContain(m, goal);
createProjectPom("<groupId>test</groupId>" +
"<artifactId>project</artifactId>" +
"<version>1</version>" +
"<modules>" +
" <module>module</module>" +
"</modules>");
waitForReadingCompletion();
assertEmptyKeymap();
assignShortcut(m, goal, "alt shift X");
assertKeymapContains(m, goal);
}
public void testDeletingActionOnProjectRemoval() throws Exception {
final VirtualFile p1 = createModulePom("p1", "<groupId>test</groupId>" +
"<artifactId>p1</artifactId>" +
"<version>1</version>");
VirtualFile p2 = createModulePom("p2", "<groupId>test</groupId>" +
"<artifactId>p2</artifactId>" +
"<version>1</version>");
importProjects(p1, p2);
assertEmptyKeymap();
String goal = "clean";
assignShortcut(p1, goal, "alt shift X");
assignShortcut(p2, goal, "alt shift Y");
assertKeymapContains(p1, goal);
assertKeymapContains(p2, goal);
new WriteCommandAction.Simple(myProject) {
@Override
protected void run() throws Throwable {
p1.delete(this);
}
}.execute().throwException();
waitForReadingCompletion();
assertKeymapDoesNotContain(p1, goal);
assertKeymapContains(p2, goal);
}
public void testRefreshingActionsOnChangingIgnoreFlag() throws Exception {
VirtualFile p1 = createModulePom("p1", "<groupId>test</groupId>" +
"<artifactId>p1</artifactId>" +
"<version>1</version>");
VirtualFile p2 = createModulePom("p2", "<groupId>test</groupId>" +
"<artifactId>p2</artifactId>" +
"<version>1</version>");
importProjects(p1, p2);
assertEmptyKeymap();
String goal = "clean";
assignShortcut(p1, goal, "alt shift X");
assignShortcut(p2, goal, "alt shift Y");
assertKeymapContains(p1, goal);
assertKeymapContains(p2, goal);
myProjectsManager.setIgnoredState(Arrays.asList(myProjectsManager.findProject(p1)), true);
assertKeymapDoesNotContain(p1, goal);
assertKeymapContains(p2, goal);
myProjectsManager.setIgnoredState(Arrays.asList(myProjectsManager.findProject(p1)), false);
assertKeymapContains(p1, goal);
assertKeymapContains(p2, goal);
}
private void assertKeymapContains(VirtualFile pomFile, String goal) {
String id = myShortcutsManager.getActionId(pomFile.getPath(), goal);
assertContain(getProjectActions(), id);
}
private void assertEmptyKeymap() {
assertEmpty(getProjectActions());
}
private void assertKeymapDoesNotContain(VirtualFile pomFile, String goal) {
String id = myShortcutsManager.getActionId(pomFile.getPath(), goal);
assertDoNotContain(getProjectActions(), id);
}
private void assignShortcut(VirtualFile pomFile, String goal, String shortcut) {
MavenProject mavenProject = myProjectsManager.findProject(pomFile);
assert mavenProject != null;
String actionId = myShortcutsManager.getActionId(mavenProject.getPath(), goal);
assert actionId != null;
AnAction action = ActionManager.getInstance().getAction(actionId);
if (action == null) {
MavenKeymapExtension.getOrRegisterAction(mavenProject, actionId, goal);
}
Keymap activeKeymap = KeymapManager.getInstance().getActiveKeymap();
activeKeymap.addShortcut(actionId, KeyboardShortcut.fromString(shortcut));
}
private List<String> getProjectActions() {
String prefix = MavenKeymapExtension.getActionPrefix(myProject, null);
return Arrays.asList(ActionManager.getInstance().getActionIds(prefix));
}
}