Bug 196847 [Patch] Eclipse patcher does not require deletions or context lines to be contiguous

5 files changed, 215 insertions, 13 deletions

diff --git a/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/PatchTest.java b/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/PatchTest.java
index 0f58df187..2b89590b8 100644
--- a/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/PatchTest.java
+++ b/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/PatchTest.java
@@ -10,20 +10,41 @@
  *******************************************************************************/
 package org.eclipse.compare.tests;
 
-import java.io.*;
+import java.io.BufferedInputStream;
+import java.io.BufferedReader;
+import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.FileFilter;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.net.URL;
 import java.util.ArrayList;
 import java.util.List;
 
 import junit.framework.Assert;
+import junit.framework.AssertionFailedError;
 import junit.framework.TestCase;
 
 import org.eclipse.compare.internal.Utilities;
-import org.eclipse.compare.internal.patch.*;
-import org.eclipse.compare.patch.*;
+import org.eclipse.compare.internal.patch.FileDiff;
+import org.eclipse.compare.internal.patch.FileDiffResult;
+import org.eclipse.compare.internal.patch.LineReader;
+import org.eclipse.compare.internal.patch.Patcher;
+import org.eclipse.compare.internal.patch.WorkspacePatcher;
+import org.eclipse.compare.patch.ApplyPatchOperation;
+import org.eclipse.compare.patch.IFilePatch;
+import org.eclipse.compare.patch.IFilePatchResult;
+import org.eclipse.compare.patch.PatchConfiguration;
 import org.eclipse.core.resources.IStorage;
 import org.eclipse.core.resources.ResourcesPlugin;
 import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.FileLocator;
 import org.eclipse.core.runtime.IPath;
+import org.eclipse.core.runtime.NullProgressMonitor;
+import org.eclipse.core.runtime.Path;
 
 public class PatchTest extends TestCase {
 
@@ -48,7 +69,33 @@ public class PatchTest extends TestCase {
 		public InputStream getContents() throws CoreException {
 			return new BufferedInputStream(asInputStream(fileName));
 		}
+	}
 	
+	class FileStorage implements IStorage {
+		File file;
+		public FileStorage(File file) {
+			this.file = file;
+		}
+		public InputStream getContents() throws CoreException {
+			try {
+				return new FileInputStream(file);
+			} catch (FileNotFoundException e) {
+				// ignore, should never happen
+			}
+			return null;
+		}
+		public IPath getFullPath() {
+			return new Path(file.getAbsolutePath());
+		}
+		public String getName() {
+			return file.getName();
+		}
+		public boolean isReadOnly() {
+			return true;
+		}
+		public Object getAdapter(Class adapter) {
+			return null;
+		}
 	}
 	
 	public PatchTest(String name) {
@@ -99,41 +146,101 @@ public class PatchTest extends TestCase {
 	//Test creation of new workspace patch 
 	public void testWorkspacePatch_Create(){
 		//Note the order that exists in the array of expected results is based purely on the order of the files in the patch 
-		patchWorkspace(new String[]{"addition.txt", "addition.txt"}, "patch_workspacePatchAddition.txt", new String[] { "exp_workspacePatchAddition2.txt","exp_workspacePatchAddition.txt"}, false);   //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$
+		patchWorkspace(new String[]{"addition.txt", "addition.txt"}, "patch_workspacePatchAddition.txt", new String[] { "exp_workspacePatchAddition2.txt","exp_workspacePatchAddition.txt"}, false, false);   //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$
 	}
 	
 	//Test applying the reverse of workspace creation patch 
 	public void testWorkspacePatch_Create_Reverse(){
 		//Note the order that exists in the array of expected results is based purely on the order of the files in the patch 
-		patchWorkspace(new String[]{"exp_workspacePatchAddition2.txt","exp_workspacePatchAddition.txt"}, "patch_workspacePatchAddition.txt", new String[] {"addition.txt", "addition.txt"}, true);   //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$
+		patchWorkspace(new String[]{"exp_workspacePatchAddition2.txt","exp_workspacePatchAddition.txt"}, "patch_workspacePatchAddition.txt", new String[] {"addition.txt", "addition.txt"}, true, false);   //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$
 	}
 	
 	//Test the patching of an already existing file, the creation of a new one and the deletion of elements in a file
 	public void testWorkspacePatch_Modify(){
 		//Note the order that exists in the array of expected results is based purely on the order of the files in the patch 
-		patchWorkspace(new String[]{"exp_workspacePatchAddition2.txt","exp_workspacePatchAddition.txt", "addition.txt"}, "patch_workspacePatchMod.txt", new String[] { "exp_workspacePatchMod1.txt","exp_workspacePatchMod2.txt", "exp_workspacePatchMod3.txt"}, false );   //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$
+		patchWorkspace(new String[]{"exp_workspacePatchAddition2.txt","exp_workspacePatchAddition.txt", "addition.txt"}, "patch_workspacePatchMod.txt", new String[] { "exp_workspacePatchMod1.txt","exp_workspacePatchMod2.txt", "exp_workspacePatchMod3.txt"}, false, false );   //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$
 	}
 	
 	//Test applying the reverse of a workspace modify patch
 	public void testWorkspacePatch_Modify_Reverse(){
 		//Note the order that exists in the array of expected results is based purely on the order of the files in the patch 
-		patchWorkspace(new String[]{ "exp_workspacePatchMod1.txt","exp_workspacePatchMod2.txt", "exp_workspacePatchMod3.txt"}, "patch_workspacePatchMod.txt", new String[] {"exp_workspacePatchAddition2.txt","exp_workspacePatchAddition.txt", "addition.txt"}, true );   //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$
+		patchWorkspace(new String[]{ "exp_workspacePatchMod1.txt","exp_workspacePatchMod2.txt", "exp_workspacePatchMod3.txt"}, "patch_workspacePatchMod.txt", new String[] {"exp_workspacePatchAddition2.txt","exp_workspacePatchAddition.txt", "addition.txt"}, true, false );   //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$
 	}
 	
 	//Tests the deletion of an already existing file, and the modification of another file
 	public void testWorkspacePatch_Delete(){
 		//Note the order that exists in the array of expected results is based purely on the order of the files in the patch 
-		patchWorkspace(new String[]{"exp_workspacePatchMod2.txt","addition.txt", "exp_workspacePatchMod1.txt","addition.txt"}, "patch_workspacePatchDelete.txt", new String[] { "addition.txt","exp_workspacePatchDelete2.txt", "addition.txt", "exp_workspacePatchDelete1.txt"}, false );   //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$ //$NON-NLS-8$ //$NON-NLS-9$
+		patchWorkspace(new String[]{"exp_workspacePatchMod2.txt","addition.txt", "exp_workspacePatchMod1.txt","addition.txt"}, "patch_workspacePatchDelete.txt", new String[] { "addition.txt","exp_workspacePatchDelete2.txt", "addition.txt", "exp_workspacePatchDelete1.txt"}, false, false );   //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$ //$NON-NLS-8$ //$NON-NLS-9$
 	}
 	
 	//Test applying the reverse of a workspace deletion patch
 	public void testWorkspacePatch_Delete_Reverse(){
 		//Note the order that exists in the array of expected results is based purely on the order of the files in the patch 
-		patchWorkspace(new String[]{"addition.txt","exp_workspacePatchDelete2.txt", "addition.txt", "exp_workspacePatchDelete1.txt" }, "patch_workspacePatchDelete.txt", new String[] {"exp_workspacePatchMod2.txt","addition.txt", "exp_workspacePatchMod1.txt","addition.txt"}, true );   //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$ //$NON-NLS-8$ //$NON-NLS-9$
+		patchWorkspace(new String[]{"addition.txt","exp_workspacePatchDelete2.txt", "addition.txt", "exp_workspacePatchDelete1.txt" }, "patch_workspacePatchDelete.txt", new String[] {"exp_workspacePatchMod2.txt","addition.txt", "exp_workspacePatchMod1.txt","addition.txt"}, true, false );   //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$ //$NON-NLS-8$ //$NON-NLS-9$
 	}
 	
+	public void testPatchdataSubfolders() throws IOException, CoreException {
+		URL patchdataFolderUrl = getClass().getResource("patchdata");
+		patchdataFolderUrl = FileLocator.resolve(patchdataFolderUrl);
+		Assert.assertTrue(patchdataFolderUrl.getProtocol().equals("file"));
+		IPath patchdataFolderPath  = new Path(patchdataFolderUrl.getPath());
+		File patchdataFolderFile = patchdataFolderPath.toFile();
+		assertTrue(patchdataFolderFile.isDirectory());
+		File[] listOfSubfolders = patchdataFolderFile.listFiles(new FileFilter() {
+			public boolean accept(File pathname) {
+				return pathname.isDirectory();
+			}
+		});
+		for (int i = 0; i < listOfSubfolders.length; i++) {
+			File subfolder = listOfSubfolders[i];
+			File[] files = subfolder.listFiles();
+			File patchFile = null;
+			File fileToPatch = null;
+			File fileWithExpectedResult = null;
+			File fileWithActualResult = null; // optional
+			for (int j = 0; j < files.length; j++) {
+				File file = files[j];
+				String filename = file.getName();
+				if (filename.indexOf("patch") > -1) {
+					assertTrue(ApplyPatchOperation.isPatch(new FileStorage(file)));
+					patchFile = file;
+				} else if (filename.indexOf("exp") > -1) {
+					fileWithExpectedResult = file;
+				} else if (filename.indexOf("act") > -1) {
+					fileWithActualResult = file;
+				} else if (filename.indexOf("context") > -1) {
+					fileToPatch = file;
+				} else {
+					fileToPatch = file;
+				}
+			}
+			
+			// make the paths relative
+			String fileToPatchString = fileToPatch.getPath().substring(patchdataFolderFile.getPath().length() + 1);
+			String patchFileString = patchFile.getPath().substring(patchdataFolderFile.getPath().length() + 1);
+			String fileWithExpectedResultString = fileWithExpectedResult.getPath().substring(patchdataFolderFile.getPath().length() + 1);
+			
+			// create a message to distinguish tests from different subfolders 
+			String msg = "Test for subfolder [patchdata/" + subfolder.getName() + "] failed;";
+			
+			// test with expected result
+			patchWorkspace(msg, new String[] { fileToPatchString }, patchFileString, new String[] { fileWithExpectedResultString }, false, true);
+			
+			// test with actual result, should fail
+			if (fileWithActualResult != null) {
+				String fileWithActualResultString = fileWithActualResult.getPath().substring(patchdataFolderFile.getPath().length() + 1);
+				try {
+					patchWorkspace(msg, new String[] { fileToPatchString }, patchFileString, new String[] { fileWithActualResultString }, false, true);
+				} catch (AssertionFailedError e) {
+					// a failure is expected
+					continue; // continue with the next subfolder
+				}
+				fail("patchWorkspace should fail for file ["+fileWithActualResultString+"] in folder [patchdata/"+subfolder.getName()+"]");
+			}
+		}
+	}
 	
-	//Test changing 
+	// Test changing
 	private BufferedReader getReader(String name) {
 		InputStream resourceAsStream = asInputStream(name);
 		InputStreamReader reader2= new InputStreamReader(resourceAsStream);
@@ -200,14 +307,23 @@ public class PatchTest extends TestCase {
 			Assert.assertEquals(expected[i], result[i]);
 	}
 	
+	private void patchWorkspace(String[] originalFiles, String patch,
+			String[] expectedOutcomeFiles, boolean reverse,
+			boolean guessFuzzFactor) {
+		patchWorkspace(null, originalFiles, patch, expectedOutcomeFiles,
+				reverse, guessFuzzFactor);
+	}
+	
 	/**
 	 * Parses a workspace patch and applies the diffs to the appropriate files
+	 * @param msg
 	 * @param originalFiles
 	 * @param patch
 	 * @param expectedOutcomeFiles
 	 * @param reverse
+	 * @param guessFuzzFactor TODO
 	 */
-	private void patchWorkspace(String[] originalFiles, String patch, String[] expectedOutcomeFiles, boolean reverse) {
+	private void patchWorkspace(String msg, String[] originalFiles, String patch, String[] expectedOutcomeFiles, boolean reverse, boolean guessFuzzFactor) {
 		
 		//ensure that we have the same number of input files as we have expected files
 		Assert.assertEquals(originalFiles.length, expectedOutcomeFiles.length);
@@ -215,6 +331,8 @@ public class PatchTest extends TestCase {
 		//Parse the passed in patch and extract all the Diffs
 		WorkspacePatcher patcher= new WorkspacePatcher();
 		try {
+			if (guessFuzzFactor)
+				patcher.getConfiguration().setFuzz(patcher.guessFuzzFactor(new NullProgressMonitor()));
 			patcher.parse(getReader(patch));
 			patcher.setReversed(reverse);
 		} catch (IOException e) {
@@ -240,10 +358,10 @@ public class PatchTest extends TestCase {
 			Object[] expected= expectedLines.toArray();
 			Object[] result= inLines.toArray();
 			
-			Assert.assertEquals(expected.length, result.length);
+			Assert.assertEquals(msg, expected.length, result.length);
 			
 			for (int j= 0; j < expected.length; j++)
-				Assert.assertEquals(expected[j], result[j]);
+				Assert.assertEquals(msg, expected[j], result[j]);
 		}
 	}
 }
diff --git a/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/patchdata/196847/stuff.txt b/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/patchdata/196847/stuff.txt
new file mode 100644
index 000000000..e0718bdff
--- /dev/null
+++ b/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/patchdata/196847/stuff.txt
@@ -0,0 +1,22 @@
+so
+this
+is
+a
+test
+this
+is
+only
+a
+test
+if
+this
+was
+other
+than
+a
+test
+it
+wouldn't
+be
+a
+test
diff --git a/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/patchdata/196847/stuff_actual_result.txt b/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/patchdata/196847/stuff_actual_result.txt
new file mode 100644
index 000000000..9e3d970f7
--- /dev/null
+++ b/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/patchdata/196847/stuff_actual_result.txt
@@ -0,0 +1,23 @@
+so
+a
+test
+this
+is
+this
+might
+be
+a
+monkey
+test
+if
+this
+was
+other
+than
+a
+test
+it
+wouldn't
+be
+a
+test
diff --git a/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/patchdata/196847/stuff_expected_result.txt b/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/patchdata/196847/stuff_expected_result.txt
new file mode 100644
index 000000000..4d6b43dde
--- /dev/null
+++ b/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/patchdata/196847/stuff_expected_result.txt
@@ -0,0 +1,23 @@
+so
+this
+is
+a
+test
+this
+might
+be
+a
+monkey
+test
+if
+this
+was
+other
+than
+a
+test
+it
+wouldn't
+be
+a
+test
diff --git a/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/patchdata/196847/stuff_patch.txt b/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/patchdata/196847/stuff_patch.txt
new file mode 100644
index 000000000..261fa881e
--- /dev/null
+++ b/tests/org.eclipse.compare.tests/src/org/eclipse/compare/tests/patchdata/196847/stuff_patch.txt
@@ -0,0 +1,16 @@
+#
+diff -u -N stuff.txt stuff.txt
+--- stuff.txt	2007-06-27 08:50:46.000000603 -0400
++++ stuff.txt	2007-07-11 17:24:45.000000000 -0400
+@@ -4,5 +4,6 @@
+-this
+-is
+-only
+-a
+-test
++this
++might
++be
++a
++monkey
++test