Skip to content

Commit

Permalink
8315241: (fs) Move toRealPath tests in java/nio/file/Path/Misc.java t…
Browse files Browse the repository at this point in the history 
…o separate JUnit 5 test

Reviewed-by: rriggs
  • Loading branch information
Brian Burkhalter committed Aug 30, 2023
1 parent 8e4cda0 commit dd64a4a
Show file tree
Hide file tree
Showing 2 changed files with 193 additions and 143 deletions.
145 changes: 2 additions & 143 deletions test/jdk/java/nio/file/Path/Misc.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2008, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2008, 2023, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
Expand All @@ -22,7 +22,7 @@
*/

/* @test
* @bug 4313887 6838333 7029979 8295753
* @bug 4313887 6838333 7029979
* @summary Unit test for miscellenous java.nio.file.Path methods
* @library .. /test/lib
* @build jdk.test.lib.Platform
Expand All @@ -32,28 +32,17 @@
import java.io.*;
import java.nio.file.*;

import static java.nio.file.LinkOption.*;

import jdk.test.lib.Platform;

public class Misc {
static boolean supportsLinks;

public static void main(String[] args) throws IOException {
Path dir = TestUtil.createTemporaryDirectory();
try {
supportsLinks = TestUtil.supportsLinks(dir);

// equals and hashCode methods
testEqualsAndHashCode();

// toFile method
testToFile(dir);

// toRealPath method
testToRealPath(dir);


} finally {
TestUtil.removeAll(dir);
}
Expand Down Expand Up @@ -92,136 +81,6 @@ static void testToFile(Path dir) throws IOException {
assertTrue(d.toPath().equals(dir));
}

/**
* Exercise toRealPath method
*/
static void testToRealPath(Path dir) throws IOException {
final Path file = Files.createFile(dir.resolve("foo"));
final Path link = dir.resolve("link");

/**
* Test: toRealPath() will access same file as toRealPath(NOFOLLOW_LINKS)
*/
assertTrue(Files.isSameFile(file.toRealPath(), file.toRealPath(NOFOLLOW_LINKS)));

/**
* Test: toRealPath should fail if file does not exist
*/
Path doesNotExist = dir.resolve("DoesNotExist");
try {
doesNotExist.toRealPath();
throw new RuntimeException("IOException expected");
} catch (IOException expected) {
}
try {
doesNotExist.toRealPath(NOFOLLOW_LINKS);
throw new RuntimeException("IOException expected");
} catch (IOException expected) {
}

/**
* Test: toRealPath() should resolve links
*/
if (supportsLinks) {
Path resolvedFile = file;
if (Platform.isWindows()) {
// Path::toRealPath does not work with environments using the
// legacy subst mechanism. This is a workaround to keep the
// test working if 'dir' points to a location on a subst drive.
// See JDK-8213216.
//
Path tempLink = dir.resolve("tempLink");
Files.createSymbolicLink(tempLink, dir.toAbsolutePath());
Path resolvedDir = tempLink.toRealPath();
Files.delete(tempLink);
resolvedFile = resolvedDir.resolve(file.getFileName());
}

Files.createSymbolicLink(link, resolvedFile.toAbsolutePath());
assertTrue(link.toRealPath().equals(resolvedFile.toRealPath()));
Files.delete(link);
}

/**
* Test: toRealPath(NOFOLLOW_LINKS) should not resolve links
*/
if (supportsLinks) {
Files.createSymbolicLink(link, file.toAbsolutePath());
assertTrue(link.toRealPath(NOFOLLOW_LINKS).getFileName().equals(link.getFileName()));
Files.delete(link);
}

/**
* Test: toRealPath(NOFOLLOW_LINKS) with broken link
*/
if (supportsLinks) {
Path broken = Files.createSymbolicLink(link, doesNotExist);
assertTrue(link.toRealPath(NOFOLLOW_LINKS).getFileName().equals(link.getFileName()));
Files.delete(link);
}

/**
* Test: toRealPath should eliminate "."
*/
assertTrue(dir.resolve(".").toRealPath().equals(dir.toRealPath()));
assertTrue(dir.resolve(".").toRealPath(NOFOLLOW_LINKS).equals(dir.toRealPath(NOFOLLOW_LINKS)));

/**
* Test: toRealPath should eliminate ".." when it doesn't follow a
* symbolic link
*/
Path subdir = Files.createDirectory(dir.resolve("subdir"));
assertTrue(subdir.resolve("..").toRealPath().equals(dir.toRealPath()));
assertTrue(subdir.resolve("..").toRealPath(NOFOLLOW_LINKS).equals(dir.toRealPath(NOFOLLOW_LINKS)));

/**
* Test: toRealPath yields accurate case of path elements when
* not following links
*/
if (Platform.isOSX()) {
// theTarget = dir/subdir/theTarget
Path theTarget = Path.of(subdir.toString(), "theTarget");
Files.createFile(theTarget);

// dir/theLink -> dir/subdir
Path theLink = Path.of(dir.toString(), "theLink");
Files.createSymbolicLink(theLink, subdir);

// thePath = dir/thelink/thetarget (all lower case)
Path thePath = Path.of(dir.toString(), "thelink", "thetarget");
Path noFollow = thePath.toRealPath(NOFOLLOW_LINKS);
int nc = noFollow.getNameCount();

// Real path should retain case as dir/theLink/theTarget
assertTrue(noFollow.getName(nc - 2).equals(Path.of("theLink")));
assertTrue(noFollow.getName(nc - 1).equals(Path.of("theTarget")));
assertTrue(noFollow.toString().equals(
Path.of(dir.toString(), "theLink", "theTarget").toString()));

// Test where a link is preceded by ".." in the path
Path superBeforeLink =
Path.of(subdir.toString(), "..", "thelink", "thetarget");
noFollow = superBeforeLink.toRealPath(NOFOLLOW_LINKS);
nc = noFollow.getNameCount();
assertTrue(noFollow.getName(nc - 2).equals(Path.of("theLink")));
assertTrue(noFollow.getName(nc - 1).equals(Path.of("theTarget")));

// Test where a link is followed by ".." in the path
Path linkBeforeSuper =
Path.of(dir.toString(), "thelink", "..", "subdir", "thetarget");
noFollow = linkBeforeSuper.toRealPath(NOFOLLOW_LINKS);
nc = noFollow.getNameCount();
assertTrue(noFollow.getName(nc - 4).equals(Path.of("theLink")));
assertTrue(noFollow.getName(nc - 1).equals(Path.of("theTarget")));

Files.delete(theTarget);
}

// clean-up
Files.delete(subdir);
Files.delete(file);
}

static void assertTrue(boolean okay) {
if (!okay)
throw new RuntimeException("Assertion Failed");
Expand Down
191 changes: 191 additions & 0 deletions test/jdk/java/nio/file/Path/ToRealPath.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
/*
* Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/

/* @test
* @bug 8295753
* @summary Verify correct operation of Path.toRealPath
* @library .. /test/lib
* @build ToRealPath jdk.test.lib.Platform
* @run junit ToRealPath
*/

import java.io.IOException;
import java.io.UncheckedIOException;
import java.nio.file.Files;
import java.nio.file.Path;

import jdk.test.lib.Platform;

import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.EnabledIf;
import org.junit.jupiter.api.condition.EnabledOnOs;
import org.junit.jupiter.api.condition.OS;

import static java.nio.file.LinkOption.*;
import static org.junit.jupiter.api.Assertions.*;

public class ToRealPath {
static final boolean SUPPORTS_LINKS;
static final Path DIR;
static final Path SUBDIR;
static final Path FILE;
static final Path LINK;

static {
try {
DIR = TestUtil.createTemporaryDirectory();
SUBDIR = Files.createDirectory(DIR.resolve("subdir"));
FILE = Files.createFile(DIR.resolve("foo"));
LINK = DIR.resolve("link");
SUPPORTS_LINKS = TestUtil.supportsLinks(DIR);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
};

public boolean supportsLinks() {
return SUPPORTS_LINKS;
}

@Test
public void locateSameFile() throws IOException {
assertTrue(Files.isSameFile(FILE.toRealPath(),
FILE.toRealPath(NOFOLLOW_LINKS)));
}

@Test
public void failNotExist() {
Path doesNotExist = DIR.resolve("DoesNotExist");
assertThrows(IOException.class, () -> doesNotExist.toRealPath());
}

@Test
public void failNotExistNoFollow() {
Path doesNotExist = DIR.resolve("DoesNotExist");
assertThrows(IOException.class,
() -> doesNotExist.toRealPath(NOFOLLOW_LINKS));
}

@EnabledIf("supportsLinks")
@Test
public void shouldResolveLinks() throws IOException {
Path resolvedFile = FILE;
if (Platform.isWindows()) {
// Path::toRealPath does not work with environments using the
// legacy subst mechanism. This is a workaround to keep the
// test working if 'dir' points to a location on a subst drive.
// See JDK-8213216.
//
Path tempLink = DIR.resolve("tempLink");
Files.createSymbolicLink(tempLink, DIR.toAbsolutePath());
Path resolvedDir = tempLink.toRealPath();
Files.delete(tempLink);
resolvedFile = resolvedDir.resolve(FILE.getFileName());
}

Files.createSymbolicLink(LINK, resolvedFile.toAbsolutePath());
assertTrue(LINK.toRealPath().equals(resolvedFile.toRealPath()));
Files.delete(LINK);
}

@Test
@EnabledIf("supportsLinks")
public void shouldNotResolveLinks() throws IOException {
Files.createSymbolicLink(LINK, FILE.toAbsolutePath());
assertEquals(LINK.toRealPath(NOFOLLOW_LINKS).getFileName(),
LINK.getFileName());
Files.delete(LINK);
}

@Test
public void eliminateDot() throws IOException {
assertEquals(DIR.resolve(".").toRealPath(),
DIR.toRealPath());
}

@Test
public void eliminateDotNoFollow() throws IOException {
assertEquals(DIR.resolve(".").toRealPath(NOFOLLOW_LINKS),
DIR.toRealPath(NOFOLLOW_LINKS));
}

@Test
public void eliminateDots() throws IOException {
assertEquals(SUBDIR.resolve("..").toRealPath(),
DIR.toRealPath());
}

@Test
public void eliminateDotsNoFollow() throws IOException {
assertEquals(SUBDIR.resolve("..").toRealPath(NOFOLLOW_LINKS),
DIR.toRealPath(NOFOLLOW_LINKS));
}

@Test
@EnabledOnOs(OS.MAC)
public final void macOSTests() throws IOException {
// theTarget = dir/subdir/theTarget
Path theTarget = Path.of(SUBDIR.toString(), "theTarget");
Files.createFile(theTarget);

// dir/theLink -> dir/subdir
Path theLink = Path.of(DIR.toString(), "theLink");
Files.createSymbolicLink(theLink, SUBDIR);

// thePath = dir/thelink/thetarget (all lower case)
Path thePath = Path.of(DIR.toString(), "thelink", "thetarget");
Path noFollow = thePath.toRealPath(NOFOLLOW_LINKS);
int nc = noFollow.getNameCount();

// Real path should retain case as dir/theLink/theTarget
assertEquals(noFollow.getName(nc - 2), Path.of("theLink"));
assertEquals(noFollow.getName(nc - 1), Path.of("theTarget"));
assertEquals(noFollow.toString(),
Path.of(DIR.toString(), "theLink", "theTarget").toString());

// Test where a link is preceded by ".." in the path
Path superBeforeLink =
Path.of(SUBDIR.toString(), "..", "thelink", "thetarget");
noFollow = superBeforeLink.toRealPath(NOFOLLOW_LINKS);
nc = noFollow.getNameCount();
assertEquals(noFollow.getName(nc - 2), Path.of("theLink"));
assertEquals(noFollow.getName(nc - 1), Path.of("theTarget"));

// Test where a link is followed by ".." in the path
Path linkBeforeSuper =
Path.of(DIR.toString(), "thelink", "..", "subdir", "thetarget");
noFollow = linkBeforeSuper.toRealPath(NOFOLLOW_LINKS);
nc = noFollow.getNameCount();
assertEquals(noFollow.getName(nc - 4), Path.of("theLink"));
assertEquals(noFollow.getName(nc - 1), Path.of("theTarget"));

Files.delete(theTarget);
}

@AfterAll
public static void cleanup() throws IOException {
Files.delete(SUBDIR);
Files.delete(FILE);
}
}

3 comments on commit dd64a4a

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review

Issues

@GoeLin
Copy link
Member

@GoeLin GoeLin commented on dd64a4a Jan 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/backport jdk21u-dev

@openjdk
Copy link

@openjdk openjdk bot commented on dd64a4a Jan 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GoeLin the backport was successfully created on the branch backport-GoeLin-dd64a4a4 in my personal fork of openjdk/jdk21u-dev. To create a pull request with this backport targeting openjdk/jdk21u-dev:master, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit dd64a4a4 from the openjdk/jdk repository.

The commit being backported was authored by Brian Burkhalter on 30 Aug 2023 and was reviewed by Roger Riggs.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jdk21u-dev:

$ git fetch https://github.com/openjdk-bots/jdk21u-dev.git backport-GoeLin-dd64a4a4:backport-GoeLin-dd64a4a4
$ git checkout backport-GoeLin-dd64a4a4
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk21u-dev.git backport-GoeLin-dd64a4a4

Please sign in to comment.