|
| 1 | +/* |
| 2 | + * The MIT License |
| 3 | + * |
| 4 | + * Copyright (c) 2026 |
| 5 | + * |
| 6 | + * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | + * of this software and associated documentation files (the "Software"), to deal |
| 8 | + * in the Software without restriction, including without limitation the rights |
| 9 | + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 10 | + * copies of the Software, and to permit persons to whom the Software is |
| 11 | + * furnished to do so, subject to the following conditions: |
| 12 | + * |
| 13 | + * The above copyright notice and this permission notice shall be included in |
| 14 | + * all copies or substantial portions of the Software. |
| 15 | + * |
| 16 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 22 | + * THE SOFTWARE. |
| 23 | + */ |
| 24 | + |
| 25 | +package hudson.model; |
| 26 | + |
| 27 | +import static org.junit.jupiter.api.Assertions.assertTrue; |
| 28 | + |
| 29 | +import java.io.IOException; |
| 30 | +import java.nio.file.Files; |
| 31 | +import java.nio.file.Path; |
| 32 | +import java.util.concurrent.atomic.AtomicReference; |
| 33 | + |
| 34 | +/** |
| 35 | + * Utility methods for Windows specific details on tests. |
| 36 | + * |
| 37 | + * @author Mark Waite |
| 38 | + */ |
| 39 | +public class WindowsUtil { |
| 40 | + |
| 41 | + private static final AtomicReference<Boolean> symlinkSupported = new AtomicReference<>(); |
| 42 | + |
| 43 | + /** |
| 44 | + * Fail the test if running in CI and symlinks are not supported. |
| 45 | + * We do not want to fail the test on a developer computer if |
| 46 | + * symlinks are not enabled, but we do want to fail the test if a |
| 47 | + * CI agent on Windows does not have symbolic links enabled. |
| 48 | + */ |
| 49 | + private static void assertConfiguration(boolean supported) { |
| 50 | + if (System.getenv("CI") != null) { |
| 51 | + assertTrue(supported, "Jenkins CI configurations must enable symlinks on Windows"); |
| 52 | + } |
| 53 | + } |
| 54 | + |
| 55 | + /** |
| 56 | + * Returns true if Windows allows a symbolic link to be created. |
| 57 | + * |
| 58 | + * @return true if Windows allows a symbolic link to be created. |
| 59 | + * @throws IOException if creation or removal of temporary files fails |
| 60 | + */ |
| 61 | + public static boolean isWindowsSymlinkSupported() throws IOException { |
| 62 | + // Fast path, don't acquire unnecessary lock |
| 63 | + Boolean supported = symlinkSupported.get(); |
| 64 | + if (supported != null) { |
| 65 | + assertConfiguration(supported); |
| 66 | + return supported; |
| 67 | + } |
| 68 | + synchronized (WindowsUtil.class) { |
| 69 | + supported = symlinkSupported.get(); |
| 70 | + if (supported != null) { |
| 71 | + assertConfiguration(supported); |
| 72 | + return supported; |
| 73 | + } |
| 74 | + Path tempDir = Files.createTempDirectory("symlink-check"); |
| 75 | + Path target = Files.createFile(tempDir.resolve("target.txt")); |
| 76 | + Path link = tempDir.resolve("link.txt"); |
| 77 | + |
| 78 | + try { |
| 79 | + Files.createSymbolicLink(link, target); |
| 80 | + Files.delete(link); |
| 81 | + symlinkSupported.set(true); |
| 82 | + } catch (IOException | UnsupportedOperationException uoe) { |
| 83 | + symlinkSupported.set(false); |
| 84 | + } finally { |
| 85 | + Files.delete(target); |
| 86 | + Files.delete(tempDir); |
| 87 | + } |
| 88 | + } |
| 89 | + assertConfiguration(symlinkSupported.get()); |
| 90 | + return symlinkSupported.get(); |
| 91 | + } |
| 92 | +} |
0 commit comments