Skip to content

Simplify SymLink creation in eclipse.core.tests #1486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HannesWell merged 1 commit into from
Oct 25, 2026
+14 −51
Merged

Simplify SymLink creation in eclipse.core.tests #1486

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 14 additions & 51 deletions ...s/org.eclipse.core.tests.harness/src/org/eclipse/core/tests/harness/FileSystemHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,9 @@
import static org.eclipse.core.tests.harness.TestHarnessPlugin.PI_HARNESS;
import static org.eclipse.core.tests.harness.TestHarnessPlugin.log;

import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.file.FileSystemException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.concurrent.Callable;
Expand Down Expand Up @@ -109,60 +108,23 @@ public static void clear(java.io.File file) {

/**
* Creates a symbolic link. Should only be called on platforms where symbolic
* links can actually be created, i.e. an "ln" command is available.
* links can actually be created, i.e. an "ln" command is available respectively
* if {@link #canCreateSymLinks()} returns {@code true}.
*
* @param basedir folder in which the symbolic link should be created
* @param linkName name of the symbolic link
* @param linkTarget target to which the symbolic link should point
* @param isDir <code>true</code> if the link should point to a folder
* @throws IllegalStateException in case symlink creation is not supported
* @throws IOException in case the creation of the symlink failed for
* other reasons
* @param isDir unused, retained for compatibility
* @throws FileSystemException if the link could not be created, e.g.
* due to missing privileges on Windows
* @throws UnsupportedOperationException if symbolic links are generally not
* supported on the current platform
* @throws IOException in case the creation of the symlink
* failed for other reasons
*/
public static void createSymLink(File basedir, String linkName, String linkTarget, boolean isDir)
throws IOException {
// The following code creates even a link if
// Files.createSymbolicLink(new File(basedir, linkName).toPath(), new
// File(basedir, linkTarget).toPath());
// would throw java.nio.file.FileSystemException "missing rights"
//
Process process = startSymlinkCreation(basedir, linkName, linkTarget, isDir);
try {
int exitcode = process.waitFor();
if (exitcode != 0) {
// xxx wrong charset. from jdk17+ we could use Console.charset()
try (BufferedReader reader = new BufferedReader(new InputStreamReader(process.getErrorStream()))) {
String result = reader.readLine();
throw new IllegalStateException("Creating symlink is unsupported: " + result);
}
}
} catch (InterruptedException e) {
throw new IOException("Creating symlink failed due to interrupted exception", e);
}
}

private static Process startSymlinkCreation(File basedir, String linkName, String linkTarget, boolean isDir)
throws IOException {
// Deliberately use an empty environment to make the test reproducible.
String[] environmentParameters = {};
if (Platform.getOS().equals(Platform.OS_WIN32)) {
return startSymlinkCreationOnWindows(basedir, linkName, linkTarget, isDir, environmentParameters);
}
String[] cmd = { "ln", "-s", linkTarget, linkName };
return Runtime.getRuntime().exec(cmd, environmentParameters, basedir);
}

private static Process startSymlinkCreationOnWindows(File basedir, String linkName, String linkTarget,
boolean isDir, String[] environmentParameters) throws IOException {
// use File.getPath to avoid 'Illegal argument - ".."' for using "../"
// instead of "..\"
if (isDir) {
String[] cmd = { "cmd", "/c", "mklink", "/d", new File(linkName).getPath(),
new File(linkTarget).getPath() };
return Runtime.getRuntime().exec(cmd, environmentParameters, basedir);
}
String[] cmd = { "cmd", "/c", "mklink", new File(linkName).getPath(), new File(linkTarget).getPath() };
return Runtime.getRuntime().exec(cmd, environmentParameters, basedir);
Files.createSymbolicLink(basedir.toPath().resolve(linkName), Path.of(linkTarget));
}

/**
Expand All @@ -185,8 +147,9 @@ public static boolean canCreateSymLinks() throws IOException {
// Clean up if the link was created.
new File(tempDir.toFile(), linkName).delete();
canCreateSymLinks = Boolean.TRUE;
} catch (IllegalStateException e) {
// This exception indicates that creation of the symlink failed.
} catch (FileSystemException | UnsupportedOperationException e) {
// Creating the symlink failed, e.g. due to missing privileges or because
// symlinks are generally not supported on the current platform.
canCreateSymLinks = Boolean.FALSE;
}
} else {
Expand Down
Loading