Check target of linked resources in action handler isEnabled

The fix provides stronger checks on selected linked resources before
enabling menu items. In particular, linked resources that point to a
file that is part of a project shared with egit are allowed to be
operated on. Otherwise team actions are disabled if the selection
contains a linked resource pointing to a file outside any project and
repository. A default isEnabled() implementation is provided for this
behavior. After adding a test case a couple more handlers have been
amended and made compliant.

Bug: 406922
Change-Id: Id9fd5ea0c31a78b84796638570d214d14cc3c4fd
Signed-off-by: François Rey <eclipse.org@francois.rey.name>
Signed-off-by: Robin Stocker <robin@nibor.org>

2 files changed, 140 insertions, 0 deletions

diff --git a/org.eclipse.egit.ui.test/src/org/eclipse/egit/ui/internal/actions/LinkedResourcesTest.java b/org.eclipse.egit.ui.test/src/org/eclipse/egit/ui/internal/actions/LinkedResourcesTest.java
new file mode 100644
index 0000000000..7ce5e77939
--- /dev/null
+++ b/org.eclipse.egit.ui.test/src/org/eclipse/egit/ui/internal/actions/LinkedResourcesTest.java
@@ -0,0 +1,138 @@
+/*******************************************************************************
+ * Copyright (C) 2013, François Rey <eclipse.org_@_francois_._rey_._name>
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    François Rey - First implementation as part of handling linked resources
+ ******************************************************************************/
+package org.eclipse.egit.ui.internal.actions;
+
+import static org.eclipse.jgit.junit.JGitTestUtil.write;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.eclipse.core.resources.IFile;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.resources.IResource;
+import org.eclipse.core.resources.ResourcesPlugin;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IConfigurationElement;
+import org.eclipse.core.runtime.IExtensionPoint;
+import org.eclipse.core.runtime.IExtensionRegistry;
+import org.eclipse.core.runtime.Platform;
+import org.eclipse.egit.ui.common.LocalRepositoryTestCase;
+import org.eclipse.jface.viewers.StructuredSelection;
+import org.eclipse.jgit.util.FS;
+import org.eclipse.jgit.util.FileUtils;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+public class LinkedResourcesTest extends LocalRepositoryTestCase {
+
+	// the standalone temporary directory
+	private static File standaloneDirectory;
+
+	private static final String LINKED_FILE = "LinkedFile";
+
+	private static final String STANDALONE_FOLDER = "StandaloneFolder";
+
+	private File gitDir;
+
+	private IProject project;
+
+	@Before
+	public void setUp() throws Exception {
+		gitDir = createProjectAndCommitToRepository();
+		project = ResourcesPlugin.getWorkspace().getRoot().getProject(PROJ1);
+		// create our standalone temporary directory in the user space
+		File userHome = FS.DETECTED.userHome();
+		standaloneDirectory = new File(userHome, STANDALONE_FOLDER);
+		if (standaloneDirectory.exists())
+			FileUtils.delete(standaloneDirectory, FileUtils.RECURSIVE
+					| FileUtils.RETRY);
+		if (!standaloneDirectory.exists())
+			FileUtils.mkdir(standaloneDirectory, true);
+	}
+
+	@After
+	public void tearDown() throws Exception {
+		deleteAllProjects();
+		shutDownRepositories();
+		FileUtils.delete(gitDir.getParentFile(), FileUtils.RECURSIVE
+				| FileUtils.RETRY);
+		FileUtils.delete(standaloneDirectory, FileUtils.RECURSIVE
+				| FileUtils.RETRY);
+	}
+
+	private List<RepositoryActionHandler> getRepositoryActionHandlerList()
+			throws CoreException {
+		IExtensionRegistry registry = Platform.getExtensionRegistry();
+		IExtensionPoint point = registry.getExtensionPoint("org.eclipse.ui.commands");
+		IConfigurationElement[] elements = point.getConfigurationElements();
+		ArrayList<RepositoryActionHandler> result = new ArrayList<RepositoryActionHandler>();
+		for (IConfigurationElement e: elements) {
+			String categoryId = e.getAttribute("categoryId");
+			if ("org.eclipse.egit.ui.commandCategory".equals(categoryId)) {
+				if (e.getAttribute("defaultHandler") != null) {
+					Object o = e.createExecutableExtension("defaultHandler");
+					if (o instanceof RepositoryActionHandler)
+						result.add((RepositoryActionHandler) o);
+				}
+			}
+		}
+		return result;
+	}
+
+	@Test
+	public void testSomeActionsWithoutLinkedResources() throws Exception {
+		List<RepositoryActionHandler> handlers = getRepositoryActionHandlerList();
+		int count = 0;
+		IFile selection = project.getFile(FILE1);
+		for (RepositoryActionHandler handler: handlers) {
+			handler.setSelection(new StructuredSelection(selection));
+			if (handler.isEnabled())
+				count++;
+		}
+		// This sorts of test this test case: if no action is enabled,
+		// there's something wrong in our testing approach.
+		assertTrue(
+				"Some EGit action should be enabled, please review this test.",
+				count > 0);
+	}
+
+	@Test
+	public void testNoActionOnLinkedResources() throws Exception {
+		List<RepositoryActionHandler> handlers = getRepositoryActionHandlerList();
+		// Create a file outside any project or repository
+		File standaloneFile = new File(standaloneDirectory, LINKED_FILE);
+		write(standaloneFile, "Something");
+		// Create linked file in project that points the file above
+		IFile linkedFile = project.getFile(LINKED_FILE);
+		linkedFile.createLink(standaloneFile.toURI(),
+				IResource.ALLOW_MISSING_LOCAL, null);
+		// Prepare a mixed selection
+		Object[] mixedSelection = { linkedFile,
+				project.getFile(FILE1), project.getFile(FILE2) };
+		for (RepositoryActionHandler handler : handlers) {
+			handler.setSelection(new StructuredSelection(linkedFile));
+			assertFalse(
+					handler.getClass().getSimpleName()
+							+ " is enabled on a linked resource pointing outside any project and repository.",
+					handler.isEnabled());
+			handler.setSelection(new StructuredSelection(mixedSelection));
+			assertFalse(
+					handler.getClass().getSimpleName()
+							+ " is enabled when selection contains a linked resource pointing outside any project and repository.",
+					handler.isEnabled());
+		}
+	}
+}
diff --git a/org.eclipse.egit.ui.test/src/org/eclipse/egit/ui/test/nonswt/AllNonSWTTests.java b/org.eclipse.egit.ui.test/src/org/eclipse/egit/ui/test/nonswt/AllNonSWTTests.java
index 296475d331..a8458685b1 100644
--- a/org.eclipse.egit.ui.test/src/org/eclipse/egit/ui/test/nonswt/AllNonSWTTests.java
+++ b/org.eclipse.egit.ui.test/src/org/eclipse/egit/ui/test/nonswt/AllNonSWTTests.java
@@ -8,6 +8,7 @@
  *******************************************************************************/
 package org.eclipse.egit.ui.test.nonswt;
 
+import org.eclipse.egit.ui.internal.actions.LinkedResourcesTest;
 import org.eclipse.egit.ui.internal.decorators.DecoratableResourceAdapterTest;
 import org.eclipse.egit.ui.internal.synchronize.model.AllGitModelTests;
 import org.junit.runner.RunWith;
@@ -16,6 +17,7 @@ import org.junit.runners.Suite.SuiteClasses;
 
 @RunWith(Suite.class)
 @SuiteClasses({ DecoratableResourceAdapterTest.class,
+		LinkedResourcesTest.class,
 		AllGitModelTests.class })
 public class AllNonSWTTests {
 	// Empty class