doc / ch.tutteli.atrium.api.fluent.en_GB / toBeASymbolicLink

toBeASymbolicLink

fun <T : Path> Expect<T>.toBeASymbolicLink(): Expect<T> (source)

Expects that the subject of this expectation (a Path) is a symbolic link; meaning that there is a file system entry at the location the Path points to and that is a symbolic link.

This assertion is not atomic with respect to concurrent file system operations on the paths the assertion works on. Its result, in particular its extended explanations, may be wrong if such concurrent file system operations take place.

val target = tempDir.newFile("target")
val link = Files.createSymbolicLink(tempDir.resolve("link"), target)

// Passes, because subject `link` is a symbolic link
expect(link).toBeASymbolicLink()

val file = tempDir.newFile("somePath")

fails { // because subject `path` is a not a symbolic link
    expect(file).toBeASymbolicLink()
}

Return
an Expect for the subject of this expectation.

Since
0.17.0