Remote API should use paths for affected files relative to specified source directory (#3214)

Author: akash-manna-sky

plugin/src/test/java/io/jenkins/plugins/analysis/core/util/AbsolutePathGeneratorITest.java

@@ -7,7 +7,9 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.util.List;
 import java.util.Locale;
+import net.sf.json.JSONArray;
 
 import hudson.FilePath;
 import hudson.model.FreeStyleProject;
@@ -16,8 +18,10 @@
 
 import io.jenkins.plugins.analysis.core.testutil.IntegrationTestWithJenkinsPerSuite;
 import io.jenkins.plugins.analysis.warnings.Java;
+import io.jenkins.plugins.prism.SourceCodeDirectory;
 
 import static io.jenkins.plugins.analysis.core.assertions.Assertions.*;
+import static net.javacrumbs.jsonunit.assertj.JsonAssertions.*;
 import static org.assertj.core.api.Assumptions.*;
 
 /**
@@ -27,11 +31,49 @@
  */
 class AbsolutePathGeneratorITest extends IntegrationTestWithJenkinsPerSuite {
     private static final String SOURCE_CODE = "public class Test {}";
+    private static final String FILE_NAME = "Test.java";
 
     /** Temporary workspace for the agent. */
     @TempDir
     private File agentWorkspace;
 
+    /**
+     * Verifies that the Remote API returns file paths relative to the configured source directory.
+     * This test addresses JENKINS-68856 where file paths should be relative to the sourceDirectory
+     * when specified, rather than showing the full workspace path.
+     */
+    @Test
+    @Issue("JENKINS-68856")
+    void shouldStripSourcePathPrefixFromFileNamesInRemoteApi() {
+        var agent = createAgentWithWrongWorkspaceFolder();
+        var project = createJobForAgent(agent);
+
+        createFileInAgentWorkspace(agent, project, "Folder/Test.java", SOURCE_CODE);
+        createFileInAgentWorkspace(agent, project, "warnings.txt",
+                "[javac] Test.java:1: warning: Test Warning for Jenkins");
+
+        var javaJob = new Java();
+        javaJob.setPattern("warnings.txt");
+        var recorder = enableWarnings(project, javaJob);
+        recorder.setSourceDirectories(List.of(new SourceCodeDirectory("Folder")));
+
+        var result = scheduleSuccessfulBuild(project);
+        assertThat(result).hasTotalSize(1);
+        assertThat(result.getIssues().get(0)).hasFileName(FILE_NAME);
+
+        assertThat(result).hasInfoMessages("-> resolved paths in source directory (1 found, 0 not found)");
+        assertThat(result).doesNotHaveInfoMessages("-> 0 copied, 1 not in workspace, 0 not-found, 0 with I/O error");
+
+        var json = callJsonRemoteApi(result.getOwner().getUrl() + "java/all/api/json");
+        var object = json.getJSONObject();
+
+        assertThatJson(object).node("issues").isArray();
+        JSONArray issues = object.getJSONArray("issues");
+        assertThat(issues.size()).as("Should have issues").isGreaterThan(0);
+
+        assertThatJson(issues.getJSONObject(0)).node("fileName").isEqualTo(FILE_NAME);
+    }
+
     /**
      * Verifies that the affected files will be copied even if the file name uses the wrong case (Windows only).
      */