Merge pull request #469 from fo-code/delta-rename-detection

Enabled rename detection

Author: uhafner

plugin/pom.xml

@@ -28,10 +28,11 @@
     <echarts-api.version>5.3.2-1</echarts-api.version>
     <font-awesome-api.version>6.0.0-1</font-awesome-api.version>
     <plugin-util-api.version>2.16.0</plugin-util-api.version>
-    <data-tables-api.version>1.11.4-3</data-tables-api.version>
-    <forensics-api-plugin.version>1.12.0</forensics-api-plugin.version>
+    <data-tables-api.version>1.11.4-4</data-tables-api.version>
+    <forensics-api-plugin.version>1.13.0</forensics-api-plugin.version>
     <bootstrap5-api.version>5.1.3-6</bootstrap5-api.version>
     <testcontainers.version>1.17.1</testcontainers.version>
+    <jquery3-api.version>3.6.0-3</jquery3-api.version>
   </properties>
 
   <licenses>
@@ -66,6 +67,11 @@
         <artifactId>bootstrap5-api</artifactId>
         <version>${bootstrap5-api.version}</version>
       </dependency>
+      <dependency>
+        <groupId>io.jenkins.plugins</groupId>
+        <artifactId>jquery3-api</artifactId>
+        <version>${jquery3-api.version}</version>
+      </dependency>
     </dependencies>
   </dependencyManagement>
 

plugin/src/main/java/io/jenkins/plugins/forensics/git/delta/DeltaRepositoryCallback.java

@@ -94,6 +94,8 @@ private RemoteResultWrapper<Delta> calculateDelta(final Repository repository) t
             try (DiffFormatter diffFormatter = new DiffFormatter(diffStream)) {
                 diffFormatter.setDiffComparator(RawTextComparator.WS_IGNORE_ALL);
                 diffFormatter.setRepository(repository);
+                // enabling rename detection requires a set repository
+                diffFormatter.setDetectRenames(true);
 
                 final List<DiffEntry> diffEntries = diffFormatter.scan(referenceCommit, currentCommit);
                 final Map<String, FileChanges> fileChangesMap = new HashMap<>();
@@ -103,7 +105,9 @@ private RemoteResultWrapper<Delta> calculateDelta(final Repository repository) t
                 for (DiffEntry diffEntry : diffEntries) {
                     FileEditType fileEditType = getFileEditType(diffEntry.getChangeType());
                     FileChanges fileChanges = createFileChanges(fileEditType, diffEntry, diffFormatter, repository);
-                    fileChangesMap.put(diffEntry.getNewId().name(), fileChanges);
+
+                    String fileId = getFileId(diffEntry, fileEditType);
+                    fileChangesMap.put(fileId, fileChanges);
                 }
 
                 log.logInfo("Creating the Git diff file");
@@ -120,6 +124,26 @@ private RemoteResultWrapper<Delta> calculateDelta(final Repository repository) t
         }
     }
 
+    /**
+     * Gets the ID of the edited file, which is represented by the passed {@link DiffEntry}. If it is a deleted file,
+     * the old ID before the edit is taken in order to provide always unique IDs.
+     *
+     * @param diffEntry
+     *         Represents the edits of a file
+     * @param fileEditType
+     *         The {@link FileEditType}
+     *
+     * @return the file ID
+     */
+    private String getFileId(final DiffEntry diffEntry, final FileEditType fileEditType) {
+        if (FileEditType.DELETE.equals(fileEditType)) {
+            return diffEntry.getOldId().name();
+        }
+        else {
+            return diffEntry.getNewId().name();
+        }
+    }
+
     /**
      * Creates an instance of {@link FileChanges} which wraps the information about all changes made to a specific
      * file.
@@ -141,20 +165,27 @@ private FileChanges createFileChanges(final FileEditType fileEditType, final Dif
             final DiffFormatter diffFormatter, final Repository repository)
             throws IOException {
         String filePath;
+        String oldFilePath;
         String fileContent;
-        if (fileEditType == FileEditType.DELETE) {
-            // file path and content of deleted files have to be read using old ID
-            filePath = diffEntry.getOldPath();
+        if (fileEditType.equals(FileEditType.DELETE)) {
             fileContent = getFileContent(diffEntry.getOldId().toObjectId(), repository);
+            oldFilePath = diffEntry.getOldPath();
+            filePath = "";
         }
         else {
-            filePath = diffEntry.getNewPath();
+            if (fileEditType.equals(FileEditType.ADD)) {
+                oldFilePath = "";
+            }
+            else {
+                oldFilePath = diffEntry.getOldPath();
+            }
             fileContent = getFileContent(diffEntry.getNewId().toObjectId(), repository);
+            filePath = diffEntry.getNewPath();
         }
 
         diffFormatter.format(diffEntry);
 
-        FileChanges fileChanges = new FileChanges(filePath, fileContent, fileEditType, new HashMap<>());
+        FileChanges fileChanges = new FileChanges(filePath, oldFilePath, fileContent, fileEditType, new HashMap<>());
 
         for (Edit edit : diffFormatter.toFileHeader(diffEntry).toEditList()) {
             createChange(edit).ifPresent(fileChanges::addChange);

plugin/src/test/java/io/jenkins/plugins/forensics/git/delta/GitDeltaCalculatorITest.java

@@ -34,6 +34,7 @@
  */
 class GitDeltaCalculatorITest extends GitITest {
     private static final String EMPTY_SCM_KEY = "";
+    private static final String EMPTY_FILE_PATH = "";
 
     /**
      * The delta result should be empty if there are invalid commits.
@@ -109,6 +110,7 @@ void shouldDetermineAddedFile() {
         Delta delta = result.get();
         FileChanges fileChanges = getSingleFileChanges(delta);
         assertThat(fileChanges.getFileName()).isEqualTo(newFileName);
+        assertThat(fileChanges.getOldFileName()).isEqualTo(EMPTY_FILE_PATH);
         assertThat(fileChanges.getFileEditType()).isEqualTo(FileEditType.ADD);
         assertThat(fileChanges.getFileContent()).isEqualTo(content);
     }
@@ -133,7 +135,8 @@ void shouldDetermineModifiedFile() {
 
         Delta delta = result.get();
         FileChanges fileChanges = getSingleFileChanges(delta);
-        assertThat(fileChanges.getFileName()).isEqualTo(GitITest.INITIAL_FILE);
+        assertThat(fileChanges.getFileName()).isEqualTo(INITIAL_FILE);
+        assertThat(fileChanges.getOldFileName()).isEqualTo(INITIAL_FILE);
         assertThat(fileChanges.getFileEditType()).isEqualTo(FileEditType.MODIFY);
         assertThat(fileChanges.getFileContent()).isEqualTo(content);
     }
@@ -150,7 +153,7 @@ void shouldDetermineDeletedFile() {
         String content = "content";
         commitFile(content);
         Run<?, ?> referenceBuild = buildSuccessfully(job);
-        git("rm", GitITest.INITIAL_FILE);
+        git("rm", INITIAL_FILE);
         commit("test");
         Run<?, ?> build = buildSuccessfully(job);
 
@@ -159,11 +162,39 @@ void shouldDetermineDeletedFile() {
 
         Delta delta = result.get();
         FileChanges fileChanges = getSingleFileChanges(delta);
-        assertThat(fileChanges.getFileName()).isEqualTo(GitITest.INITIAL_FILE);
+        assertThat(fileChanges.getFileName()).isEqualTo(EMPTY_FILE_PATH);
+        assertThat(fileChanges.getOldFileName()).isEqualTo(INITIAL_FILE);
         assertThat(fileChanges.getFileEditType()).isEqualTo(FileEditType.DELETE);
         assertThat(fileChanges.getFileContent()).isEqualTo(content);
     }
 
+    /**
+     * A renamed file should be determined.
+     */
+    @Test
+    void shouldDetermineRenamedFile() {
+        FreeStyleProject job = createJobWithReferenceRecorder();
+        GitDeltaCalculator deltaCalculator = createDeltaCalculator();
+        FilteredLog log = createLog();
+
+        String content = "content";
+        commitFile(content);
+        Run<?, ?> referenceBuild = buildSuccessfully(job);
+        git("rm", INITIAL_FILE);
+        writeFileAsAuthorFoo(content);
+        Run<?, ?> build = buildSuccessfully(job);
+
+        Optional<Delta> result = deltaCalculator.calculateDelta(build, referenceBuild, EMPTY_SCM_KEY, log);
+        assertThat(result).isNotEmpty();
+
+        Delta delta = result.get();
+        FileChanges fileChanges = getSingleFileChanges(delta);
+        assertThat(fileChanges.getFileName()).isEqualTo(ADDITIONAL_FILE);
+        assertThat(fileChanges.getOldFileName()).isEqualTo(INITIAL_FILE);
+        assertThat(fileChanges.getFileEditType()).isEqualTo(FileEditType.RENAME);
+        assertThat(fileChanges.getFileContent()).isEqualTo(content);
+    }
+
     /**
      * Added lines within a specific file should be determined.
      */