Add java.nio.Path extensions to stdlib-jdk7: part 2

- Add notExists
- Rename isFile to isRegularFile
- Remove forEachBlock
- Rename listFiles
- Add relativeTo extensions
- Remove extra overloads
- Update doc comments
- Address review comments

#KT-19192
This commit is contained in:
AJ
2020-09-28 14:58:37 -07:00
committed by Ilya Gorbunov
parent 03cc0bf6aa
commit b3a87356bd
4 changed files with 378 additions and 379 deletions
+195 -74
View File
@@ -1,23 +1,26 @@
/*
* Copyright 2010-2018 JetBrains s.r.o. and Kotlin Programming Language contributors.
* Copyright 2010-2020 JetBrains s.r.o. and Kotlin Programming Language contributors.
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
*/
package kotlin.jdk7.test
import java.io.IOException
import java.nio.file.*
import kotlin.test.*
class PathExtensionsTest {
private val isCaseInsensitiveFileSystem = Paths.get("C:/") == Paths.get("c:/")
private val isBackslashSeparator = FileSystems.getDefault().separator == "\\"
@Test
fun extension() {
assertEquals("bbb", Paths.get("aaa.bbb").extension)
assertEquals("", Paths.get("aaa").extension)
assertEquals("", Paths.get("aaa.").extension)
// maybe we should think that such files have name .bbb and no extension
assertEquals("bbb", Paths.get(".bbb").extension)
assertEquals("", Paths.get("/my.dir/log").extension)
assertEquals("", Paths.get("/").extension)
}
@Test
@@ -27,6 +30,8 @@ class PathExtensionsTest {
assertEquals("aaa", Paths.get("aaa.").nameWithoutExtension)
assertEquals("", Paths.get(".bbb").nameWithoutExtension)
assertEquals("log", Paths.get("/my.dir/log").nameWithoutExtension)
assertEquals("", Paths.get("").nameWithoutExtension)
assertEquals("", Paths.get("/").nameWithoutExtension)
}
@Test
@@ -74,7 +79,7 @@ class PathExtensionsTest {
}
srcFile.copyTo(dstFile, overwrite = true)
assertTrue(dstFile.isDirectory())
assertTrue(dstFile.listFiles().isEmpty(), "only directory is copied, but not its content")
assertTrue(dstFile.listDirectoryEntries().isEmpty(), "only directory is copied, but not its content")
assertFailsWith(FileAlreadyExistsException::class, "copy dir do not overwrite dir") {
srcFile.copyTo(dstFile)
@@ -82,7 +87,7 @@ class PathExtensionsTest {
srcFile.copyTo(dstFile, overwrite = true)
assertTrue(dstFile.isDirectory())
assertTrue(dstFile.listFiles().isEmpty(), "only directory is copied, but not its content")
assertTrue(dstFile.listDirectoryEntries().isEmpty(), "only directory is copied, but not its content")
dstFile.resolve("somefile2").writeText("some content2")
assertFailsWith(FileAlreadyExistsException::class, "copy dir do not overwrite non-empty dir") {
@@ -116,79 +121,18 @@ class PathExtensionsTest {
private fun compareFiles(src: Path, dst: Path, message: String? = null) {
assertTrue(dst.exists())
assertEquals(src.isFile(), dst.isFile(), message)
if (dst.isFile()) {
assertEquals(src.isRegularFile(), dst.isRegularFile(), message)
if (dst.isRegularFile()) {
assertTrue(src.readBytes().contentEquals(dst.readBytes()), message)
}
}
@Test
fun testBufferedReader() {
val file = Files.createTempFile(null, null)
val lines = listOf("line1", "line2")
Files.write(file, lines)
assertEquals(file.bufferedReader().use { it.readLines() }, lines)
assertEquals(file.bufferedReader(StandardOpenOption.READ).use { it.readLines() }, lines)
assertEquals(file.bufferedReader(1024, StandardOpenOption.READ).use { it.readLines() }, lines)
assertEquals(file.bufferedReader(Charsets.UTF_8, StandardOpenOption.READ).use { it.readLines() }, lines)
assertEquals(file.bufferedReader(Charsets.UTF_8, 1024, StandardOpenOption.READ).use { it.readLines() }, lines)
}
@Test
fun testBufferedWriter() {
val file = Files.createTempFile(null, null)
file.bufferedWriter().use { it.write("line1\n") }
file.bufferedWriter(StandardOpenOption.APPEND).use { it.write("line2\n") }
file.bufferedWriter(Charsets.UTF_8, StandardOpenOption.APPEND).use { it.write("line3\n") }
file.bufferedWriter(1024, StandardOpenOption.APPEND).use { it.write("line4\n") }
file.bufferedWriter(Charsets.UTF_8, 1024, StandardOpenOption.APPEND).use { it.write("line5\n") }
assertEquals(Files.readAllLines(file), listOf("line1", "line2", "line3", "line4", "line5"))
}
@Test
fun testPrintWriter() {
val file = Files.createTempFile(null, null)
val writer = file.printWriter()
val str1 = "Hello, world!"
val str2 = "Everything is wonderful!"
writer.println(str1)
writer.println(str2)
writer.close()
val writer2 = file.printWriter(StandardOpenOption.APPEND)
val str3 = "Hello again!"
writer2.println(str3)
writer2.close()
val writer3 = file.printWriter(Charsets.UTF_8, StandardOpenOption.APPEND)
val str4 = "Hello one last time!"
writer3.println(str4)
writer3.close()
val reader = file.bufferedReader()
assertEquals(str1, reader.readLine())
assertEquals(str2, reader.readLine())
assertEquals(str3, reader.readLine())
assertEquals(str4, reader.readLine())
}
@Test
fun testWriteBytes() {
val file = Files.createTempFile(null, null)
file.writeBytes("Hello".encodeToByteArray())
file.appendBytes(" world!".encodeToByteArray())
assertEquals(file.readText(), "Hello world!")
}
@Test
fun testAttributeGetters() {
fun testAttributeGettersOnFile() {
val file = Files.createTempFile(null, null)
assertTrue(file.exists())
assertTrue(file.isFile())
assertFalse(file.notExists())
assertTrue(file.isRegularFile())
assertFalse(file.isDirectory())
assertFalse(file.isSymbolicLink())
assertTrue(file.isReadable())
@@ -202,14 +146,191 @@ class PathExtensionsTest {
}
@Test
fun testListFiles() {
fun testAttributeGettersOnDirectory() {
val file = Files.createTempDirectory(null)
assertTrue(file.exists())
assertFalse(file.notExists())
assertFalse(file.isRegularFile())
assertTrue(file.isDirectory())
assertFalse(file.isSymbolicLink())
assertTrue(file.isReadable())
assertTrue(file.isWritable())
assertTrue(file.isSameFile(file))
file.isExecutable()
file.isHidden()
}
@Test
fun testAttributeGettersOnNonExistentPath() {
val file = Files.createTempDirectory(null).resolve("foo")
assertFalse(file.exists())
assertTrue(file.notExists())
assertFalse(file.isRegularFile())
assertFalse(file.isDirectory())
assertFalse(file.isSymbolicLink())
assertFalse(file.isReadable())
assertFalse(file.isWritable())
assertTrue(file.isSameFile(file))
file.isExecutable()
// This function will either throw an exception or return false,
// depending on the operating system.
try {
assertFalse(file.isHidden())
} catch (e: IOException) {
}
}
@Test
fun testListDirectoryEntries() {
val dir = Files.createTempDirectory(null)
assertEquals(dir.listFiles().size, 0)
assertEquals(0, dir.listDirectoryEntries().size)
val file = dir.resolve("f1")
Files.createFile(file)
assertEquals(dir.listFiles().size, 1)
assertEquals(listOf(file), dir.listDirectoryEntries())
assertFailsWith<NotDirectoryException> { file.listFiles() }
assertFailsWith<NotDirectoryException> { file.listDirectoryEntries() }
}
@Test
fun testUseDirectoryEntries() {
val dir = Files.createTempDirectory(null)
assertEquals(0, dir.useDirectoryEntries { it.toList() }.size)
val file = dir.resolve("f1")
Files.createFile(file)
assertEquals(listOf(file), dir.useDirectoryEntries { it.toList() })
assertFailsWith<NotDirectoryException> { file.useDirectoryEntries { it.toList() } }
}
@Test
fun testForEachDirectoryEntry() {
val dir = Files.createTempDirectory(null)
val entries = mutableListOf<Path>()
dir.forEachDirectoryEntry { entries.add(it) }
assertTrue(entries.isEmpty())
val file = dir.resolve("f1")
Files.createFile(file)
dir.forEachDirectoryEntry { entries.add(it) }
assertEquals(listOf(file), entries)
assertFailsWith<NotDirectoryException> { file.forEachDirectoryEntry { } }
}
@Test
fun relativeToRooted() {
val file1 = Paths.get("/foo/bar/baz")
val file2 = Paths.get("/foo/baa/ghoo")
assertEquals("../../bar/baz", file1.relativeTo(file2).invariantSeparatorsPath)
val file3 = Paths.get("/foo/bar")
assertEquals("baz", file1.relativeTo(file3).toString())
assertEquals("..", file3.relativeTo(file1).toString())
val file4 = Paths.get("/foo/bar/")
assertEquals("baz", file1.relativeTo(file4).toString())
assertEquals("..", file4.relativeTo(file1).toString())
assertEquals("", file3.relativeTo(file4).toString())
assertEquals("", file4.relativeTo(file3).toString())
val file5 = Paths.get("/foo/baran")
assertEquals("../bar", file3.relativeTo(file5).invariantSeparatorsPath)
assertEquals("../baran", file5.relativeTo(file3).invariantSeparatorsPath)
assertEquals("../bar", file4.relativeTo(file5).invariantSeparatorsPath)
assertEquals("../baran", file5.relativeTo(file4).invariantSeparatorsPath)
if (isBackslashSeparator) {
val file6 = Paths.get("C:\\Users\\Me")
val file7 = Paths.get("C:\\Users\\Me\\Documents")
assertEquals("..", file6.relativeTo(file7).toString())
assertEquals("Documents", file7.relativeTo(file6).toString())
val file8 = Paths.get("""\\my.host\home/user/documents/vip""")
val file9 = Paths.get("""\\my.host\home/other/images/nice""")
assertEquals("../../../user/documents/vip", file8.relativeTo(file9).invariantSeparatorsPath)
assertEquals("../../../other/images/nice", file9.relativeTo(file8).invariantSeparatorsPath)
}
if (isCaseInsensitiveFileSystem) {
assertEquals("bar", Paths.get("C:/bar").relativeTo(Paths.get("c:/")).toString())
}
}
@Test
fun relativeToRelative() {
val nested = Paths.get("foo/bar")
val base = Paths.get("foo")
assertEquals("bar", nested.relativeTo(base).toString())
assertEquals("..", base.relativeTo(nested).toString())
val current = Paths.get(".")
val parent = Paths.get("..")
val outOfRoot = Paths.get("../bar")
assertEquals(Paths.get("../../bar"), outOfRoot.relativeTo(base))
assertEquals("bar", outOfRoot.relativeTo(parent).toString())
assertEquals("..", parent.relativeTo(outOfRoot).toString())
val root = Paths.get("/root")
val files = listOf(nested, base, outOfRoot, current, parent)
val bases = listOf(nested, base, current)
for (file in files)
assertEquals("", file.relativeTo(file).toString(), "file should have empty path relative to itself: $file")
for (file in files) {
@Suppress("NAME_SHADOWING")
for (base in bases) {
val rootedFile = root.resolve(file)
val rootedBase = root.resolve(base)
assertEquals(file.relativeTo(base), rootedFile.relativeTo(rootedBase), "nested: $file, base: $base")
}
}
}
@Test
fun relativeToFails() {
val absolute = Paths.get("/foo/bar/baz")
val relative = Paths.get("foo/bar")
val networkShare1 = Paths.get("""\\my.host\share1/folder""")
val networkShare2 = Paths.get("""\\my.host\share2\folder""")
fun assertFailsRelativeTo(file: Path, base: Path) {
val e = assertFailsWith<IllegalArgumentException>("file: $file, base: $base") { file.relativeTo(base) }
assertNotNull(e.message)
}
val allFiles = listOf(absolute, relative) + if (isBackslashSeparator) listOf(networkShare1, networkShare2) else emptyList()
for (file in allFiles) {
for (base in allFiles) {
if (file != base) assertFailsRelativeTo(file, base)
}
}
if (isBackslashSeparator) {
val fileOnC = Paths.get("C:/dir1")
val fileOnD = Paths.get("D:/dir2")
assertFailsRelativeTo(fileOnC, fileOnD)
}
}
@Test
fun relativeTo() {
assertEquals("kotlin", Paths.get("src/kotlin").relativeTo(Paths.get("src")).toString())
assertEquals("", Paths.get("dir").relativeTo(Paths.get("dir")).toString())
assertEquals("..", Paths.get("dir").relativeTo(Paths.get("dir/subdir")).toString())
assertEquals(Paths.get("../../test"), Paths.get("test").relativeTo(Paths.get("dir/dir")))
}
}