GenerateUnifiedDiffTest.java

package com.github.difflib;

import static java.util.stream.Collectors.joining;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;

import com.github.difflib.patch.Chunk;
import com.github.difflib.patch.Patch;
import com.github.difflib.patch.PatchFailedException;
import java.io.BufferedReader;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import org.junit.jupiter.api.Test;

public class GenerateUnifiedDiffTest {

		public static List<String> fileToLines(String filename) throws FileNotFoundException, IOException {
				List<String> lines = new ArrayList<>();
				String line = "";
				try (BufferedReader in = new BufferedReader(new FileReader(filename))) {
						while ((line = in.readLine()) != null) {
								lines.add(line);
						}
				}
				return lines;
		}

		@Test
		public void testGenerateUnified() throws IOException {
				List<String> origLines = fileToLines(TestConstants.MOCK_FOLDER + "original.txt");
				List<String> revLines = fileToLines(TestConstants.MOCK_FOLDER + "revised.txt");

				verify(origLines, revLines, "original.txt", "revised.txt");
		}

		@Test
		public void testGenerateUnifiedWithOneDelta() throws IOException {
				List<String> origLines = fileToLines(TestConstants.MOCK_FOLDER + "one_delta_test_original.txt");
				List<String> revLines = fileToLines(TestConstants.MOCK_FOLDER + "one_delta_test_revised.txt");

				verify(origLines, revLines, "one_delta_test_original.txt", "one_delta_test_revised.txt");
		}

		@Test
		public void testGenerateUnifiedDiffWithoutAnyDeltas() {
				List<String> test = Arrays.asList("abc");
				List<String> testRevised = Arrays.asList("abc2");
				Patch<String> patch = DiffUtils.diff(test, testRevised);
				String unifiedDiffTxt = String.join("\n", UnifiedDiffUtils.generateUnifiedDiff("abc1", "abc2", test, patch, 0));
				System.out.println(unifiedDiffTxt);

				assertThat(unifiedDiffTxt)
								.as("original filename should be abc1")
								.contains("--- abc1")
								.as("revised filename should be abc2")
								.contains("+++ abc2");
		}

		@Test
		public void testDiff_Issue10() throws IOException {
				final List<String> baseLines = fileToLines(TestConstants.MOCK_FOLDER + "issue10_base.txt");
				final List<String> patchLines = fileToLines(TestConstants.MOCK_FOLDER + "issue10_patch.txt");
				final Patch<String> p = UnifiedDiffUtils.parseUnifiedDiff(patchLines);
				try {
						DiffUtils.patch(baseLines, p);
				} catch (PatchFailedException e) {
						fail(e.getMessage());
				}
		}

		/**
		 * Issue 12
		 */
		@Test
		public void testPatchWithNoDeltas() throws IOException {
				final List<String> lines1 = fileToLines(TestConstants.MOCK_FOLDER + "issue11_1.txt");
				final List<String> lines2 = fileToLines(TestConstants.MOCK_FOLDER + "issue11_2.txt");
				verify(lines1, lines2, "issue11_1.txt", "issue11_2.txt");
		}

		@Test
		public void testDiff5() throws IOException {
				final List<String> lines1 = fileToLines(TestConstants.MOCK_FOLDER + "5A.txt");
				final List<String> lines2 = fileToLines(TestConstants.MOCK_FOLDER + "5B.txt");
				verify(lines1, lines2, "5A.txt", "5B.txt");
		}

		/**
		 * Issue 19
		 */
		@Test
		public void testDiffWithHeaderLineInText() {
				List<String> original = new ArrayList<>();
				List<String> revised = new ArrayList<>();

				original.add("test line1");
				original.add("test line2");
				original.add("test line 4");
				original.add("test line 5");

				revised.add("test line1");
				revised.add("test line2");
				revised.add("@@ -2,6 +2,7 @@");
				revised.add("test line 4");
				revised.add("test line 5");

				Patch<String> patch = DiffUtils.diff(original, revised);
				List<String> udiff = UnifiedDiffUtils.generateUnifiedDiff("original", "revised", original, patch, 10);
				UnifiedDiffUtils.parseUnifiedDiff(udiff);
		}

		/**
		 * Issue 47
		 */
		@Test
		public void testNewFileCreation() {
				List<String> original = new ArrayList<>();
				List<String> revised = new ArrayList<>();

				revised.add("line1");
				revised.add("line2");

				Patch<String> patch = DiffUtils.diff(original, revised);
				List<String> udiff = UnifiedDiffUtils.generateUnifiedDiff(null, "revised", original, patch, 10);

				assertEquals("--- /dev/null", udiff.get(0));
				assertEquals("+++ revised", udiff.get(1));
				assertEquals("@@ -0,0 +1,2 @@", udiff.get(2));

				UnifiedDiffUtils.parseUnifiedDiff(udiff);
		}

		/**
		 * Issue 89
		 */
		@Test
		public void testChangePosition() throws IOException {
				final List<String> patchLines = fileToLines(TestConstants.MOCK_FOLDER + "issue89_patch.txt");
				final Patch<String> patch = UnifiedDiffUtils.parseUnifiedDiff(patchLines);
				List<Integer> realRemoveListOne = Collections.singletonList(3);
				List<Integer> realAddListOne = Arrays.asList(3, 7, 8, 9, 10, 11, 12, 13, 14);
				validateChangePosition(patch, 0, realRemoveListOne, realAddListOne);
				List<Integer> realRemoveListTwo = new ArrayList<>();
				List<Integer> realAddListTwo = Arrays.asList(27, 28);
				validateChangePosition(patch, 1, realRemoveListTwo, realAddListTwo);
		}

		private void validateChangePosition(
						Patch<String> patch, int index, List<Integer> realRemoveList, List<Integer> realAddList) {
				final Chunk<String> originChunk = patch.getDeltas().get(index).getSource();
				List<Integer> removeList = originChunk.getChangePosition();
				assertEquals(realRemoveList.size(), removeList.size());
				for (Integer ele : realRemoveList) {
						assertTrue(realRemoveList.contains(ele));
				}
				for (Integer ele : removeList) {
						assertTrue(realAddList.contains(ele));
				}
				final Chunk<String> targetChunk = patch.getDeltas().get(index).getTarget();
				List<Integer> addList = targetChunk.getChangePosition();
				assertEquals(realAddList.size(), addList.size());
				for (Integer ele : realAddList) {
						assertTrue(addList.contains(ele));
				}
				for (Integer ele : addList) {
						assertTrue(realAddList.contains(ele));
				}
		}

		private void verify(List<String> origLines, List<String> revLines, String originalFile, String revisedFile) {
				Patch<String> patch = DiffUtils.diff(origLines, revLines);
				List<String> unifiedDiff =
								UnifiedDiffUtils.generateUnifiedDiff(originalFile, revisedFile, origLines, patch, 10);

				System.out.println(unifiedDiff.stream().collect(joining("\n")));

				Patch<String> fromUnifiedPatch = UnifiedDiffUtils.parseUnifiedDiff(unifiedDiff);
				List<String> patchedLines;
				try {
						patchedLines = fromUnifiedPatch.applyTo(origLines);
						assertEquals(revLines.size(), patchedLines.size());
						for (int i = 0; i < revLines.size(); i++) {
								String l1 = revLines.get(i);
								String l2 = patchedLines.get(i);
								if (!l1.equals(l2)) {
										fail("Line " + (i + 1) + " of the patched file did not match the revised original");
								}
						}
				} catch (PatchFailedException e) {
						fail(e.getMessage());
				}
		}

		@Test
		public void testFailingPatchByException() throws IOException {
				final List<String> baseLines = fileToLines(TestConstants.MOCK_FOLDER + "issue10_base.txt");
				final List<String> patchLines = fileToLines(TestConstants.MOCK_FOLDER + "issue10_patch.txt");
				final Patch<String> p = UnifiedDiffUtils.parseUnifiedDiff(patchLines);

				// make original not fitting
				baseLines.set(40, baseLines.get(40) + " corrupted ");

				assertThrows(PatchFailedException.class, () -> DiffUtils.patch(baseLines, p));
		}

		@Test
		public void testWrongContextLength() throws IOException {
				List<String> original =
								fileToLines(TestConstants.BASE_FOLDER_RESOURCES + "com/github/difflib/text/issue_119_original.txt");
				List<String> revised =
								fileToLines(TestConstants.BASE_FOLDER_RESOURCES + "com/github/difflib/text/issue_119_revised.txt");

				Patch<String> patch = DiffUtils.diff(original, revised);
				List<String> udiff = UnifiedDiffUtils.generateUnifiedDiff("a/$filename", "b/$filename", original, patch, 3);

				// System.out.println(udiff.stream().collect(joining("\n")));

				assertThat(udiff).contains("@@ -1,4 +1,4 @@");
		}
}