use attachment paths relative to build workspace root

Author: axeluhl

java/com.sap.sailing.selenium.test/src/com/sap/sailing/selenium/core/ScreenShotRule.java

@@ -6,7 +6,6 @@
 import java.io.InputStream;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.nio.file.StandardCopyOption;
 import java.util.UUID;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -72,34 +71,54 @@ private void captureScreenshots(ExtensionContext context) {
                     if (driver instanceof TakesScreenshot) {
                         source = new ByteArrayInputStream(((TakesScreenshot) driver).getScreenshotAs(OutputType.BYTES));
                     }
-                    try {
-                        final File destinationDir = new File(screenshotFolder, context.getRequiredTestClass().getName());
-                        destinationDir.mkdirs();
-                        final File destination = new File(destinationDir, filename + SCREENSHOT_FILE_EXTENSION);
-                        // copy screenshot
-                        Files.copy(source, destination.toPath(), StandardCopyOption.REPLACE_EXISTING);
-                        // base folder as Path (correct way)
-                        final Path base = screenshotFolder.toPath().toAbsolutePath().normalize();
-                        final Path file = destination.toPath().toAbsolutePath().normalize();
-                        // relative path for Jenkins attachment plugin
-                        final Path relative = base.relativize(file);
-                        // ATTENTION: required for JUnit Attachment Plugin
-                        final String attachmentLine = String.format(ATTACHMENT_FORMAT, relative.toString().replace("\\", "/"));
-                        System.out.println(attachmentLine);
-                        System.out.flush(); // replaced System.out may not auto-flush
-                        // duplicate to System.err because tycho-surefire may read test stuff from there
-                        System.err.println(attachmentLine);
-                        System.err.flush(); // replaced System.err may not auto-flush
-                    } catch (IOException exception) {
-                        throw new RuntimeException(exception);
-                    }
+                    final File destinationDir = new File(screenshotFolder, context.getRequiredTestClass().getName());
+                    destinationDir.mkdirs();
+                    final File destination = new File(destinationDir, filename + SCREENSHOT_FILE_EXTENSION);
+                    // Absolute path to the screenshot file
+                    final Path absoluteFile = destination.toPath().toAbsolutePath().normalize();
+                    // Jenkins JUnit Attachments Plugin resolves [[ATTACHMENT|<path>]] markers against
+                    // the build's workspace root ($WORKSPACE), not against the directory containing the
+                    // JUnit XML. So we relativize against the workspace root (the repo root, identified
+                    // by walking up to the enclosing .git directory) and emit a workspace-relative path.
+                    final Path workspaceRoot = findWorkspaceRoot(absoluteFile);
+                    final Path attachmentPath = workspaceRoot != null
+                            ? workspaceRoot.relativize(absoluteFile)
+                            : screenshotFolder.toPath().toAbsolutePath().normalize().relativize(absoluteFile);
+                    // ATTENTION: required for JUnit Attachment Plugin
+                    final String attachmentLine = String.format(ATTACHMENT_FORMAT,
+                            attachmentPath.toString().replace("\\", "/")) + System.lineSeparator();
+                    System.out.print(attachmentLine);
+                    System.out.flush();
+                    System.err.print(attachmentLine);
+                    System.err.flush();
                 } catch (Exception e) {
                     logger.log(Level.WARNING, "Could not capture screenshot for window: " + window.getWindowHandle(), e);
                 }
             });
         }
     }
-    
+
+    /**
+     * Walks up from the given path until it finds a directory containing a {@code .git}
+     * entry (file or directory — submodule worktrees use a file). Returns that ancestor
+     * directory, which corresponds to the Jenkins build workspace root for repository
+     * checkouts. Returns {@code null} if no such ancestor exists (e.g. running outside
+     * any git checkout), in which case callers should fall back to a different base.
+     */
+    private static Path findWorkspaceRoot(final Path startFrom) {
+        Path current = startFrom.toAbsolutePath().normalize();
+        if (Files.isRegularFile(current)) {
+            current = current.getParent();
+        }
+        while (current != null) {
+            if (Files.exists(current.resolve(".git"))) {
+                return current;
+            }
+            current = current.getParent();
+        }
+        return null;
+    }
+
     private InputStream getScreenshotNotSupportedImage() {
         return AbstractSeleniumTest.class.getResourceAsStream(NOT_SUPPORTED_IMAGE);
     }