infix fun <T> Expect<T>.toBe(expected: T): Expect<T>
Expects that the subject of the assertion is (equal to) expected.
expect(12) toBe 12 // holds
fails {
expect(12) toBe 11
}
// holds, toBe is based on equality, use isSameAs for identity
expect(listOf(1)) toBe listOf(1)
fails { // because array has not implemented equals, so is equivalent to isSameAs
expect(arrayOf(1)) toBe arrayOf(1)
}
AssertionError - Might throw an AssertionError if the assertion made is not correct.
Return
An Expect for the current subject of the assertion.
infix fun <T : CharSequence> Expect<T>.toBe(empty: empty): Expect<T>
Expects that the subject of the assertion (a CharSequence) CharSequence.kotlin.text.isEmpty.
empty - Use the pseudo-keyword empty.
AssertionError - Might throw an AssertionError if the assertion made is not correct.
Return
This assertion container to support a fluent API.
@JvmName("toBeNull") infix fun <T : BigDecimal> Expect<T?>.toBe(expected: Nothing?): Expect<T?>
Expects that the subject of the assertion (a BigDecimal) is null.
AssertionError - Might throw an AssertionError if the assertion made is not correct.
Return
An Expect for the current subject of the assertion.
infix fun <E, T : Optional<E>> Expect<T>.toBe(present: present): FeatureExpect<T, E>
Expects that the subject of the assertion (an Optional) is present and returns an Expect for the inner type E.
Shortcut for more or less something like feature(Optional<T>::get) but with error handling; yet it
depends on the underlying implementation though.
AssertionError - Might throw an AssertionError if the given assertion is not a success.
Return
The newly created Expect for the inner type E.
Since
0.12.0
infix fun <E, T : Optional<E>> Expect<T>.toBe(present: PresentWithCreator<E>): Expect<T>
Expects that the subject of the assertion (an Optional) is present and that it holds all assertions the given PresentWithCreator.assertionCreator creates.
AssertionError - Might throw an AssertionError if the given assertions are not success.
Return
An Expect for the current subject of the assertion.
Since
0.12.0
infix fun <T : Path> Expect<T>.toBe(existing: existing): Expect<T>
Expects that the subject of the assertion (a Path) exists; meaning that there is a file system entry at the location the Path points to.
This assertion resolves symbolic links. Therefore, if a symbolic link exists at the location the subject points to, then the search will continue at that location.
AssertionError - Might throw an AssertionError if the assertion made is not correct.
Return
An Expect for the current subject of the assertion.
Since
0.12.0
infix fun <T : Path> Expect<T>.toBe(readable: readable): Expect<T>
Expects that the subject of the assertion (a Path) is readable; meaning that there is a file system entry at the location the Path points to and that the current thread has the permission to read from it.
This assertion resolves symbolic links. Therefore, if a symbolic link exists at the location the subject points to, search will continue at the location the link points at.
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.
AssertionError - Might throw an AssertionError if the assertion made is not correct.
Return
An Expect for the current subject of the assertion.
Since
0.12.0
infix fun <T : Path> Expect<T>.toBe(writable: writable): Expect<T>
Expects that the subject of the assertion (a Path) is writable; meaning that there is a file system entry at the location the Path points to and that the current thread has the permission to write to it.
This assertion resolves symbolic links. Therefore, if a symbolic link exists at the location the subject points to, search will continue at the location the link points at.
AssertionError - Might throw an AssertionError if the assertion made is not correct.
Return
An Expect for the current subject of the assertion.
Since
0.12.0
infix fun <T : Path> Expect<T>.toBe(executable: executable): Expect<T>
Expects that the subject of the assertion (a Path) is executable; meaning that there is a file system entry at the location the Path points to and that the current thread has the permission to execute it.
The semantics of “permission to execute it” may differ when checking access to a directory. For example, on UNIX systems, it means that the Java virtual machine has permission to search the directory in order to access file or subdirectories.
This assertion resolves symbolic links. Therefore, if a symbolic link exists at the location the subject points to, search will continue at the location the link points at.
AssertionError - Might throw an AssertionError if the assertion made is not correct.
Return
An Expect for the current subject of the assertion.
Since
0.14.0
infix fun <T : Path> Expect<T>.toBe(aRegularFile: aRegularFile): Expect<T>
Expects that the subject of the assertion (a Path) is a file; meaning that there is a file system entry at the location the Path points to and that is a regular file.
This assertion resolves symbolic links. Therefore, if a symbolic link exists at the location the subject points to, search will continue at the location the link points at.
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.
AssertionError - Might throw an AssertionError if the assertion made is not correct.
Return
An Expect for the current subject of the assertion.
Since
0.12.0
infix fun <T : Path> Expect<T>.toBe(aDirectory: aDirectory): Expect<T>
Expects that the subject of the assertion (a Path) is a directory; meaning that there is a file system entry at the location the Path points to and that is a directory.
This assertion resolves symbolic links. Therefore, if a symbolic link exists at the location the subject points to, search will continue at the location the link points at.
This assertion is not atomic with respect to concurrent file system operations on the paths the assertion9 works on. Its result, in particular its extended explanations, may be wrong if such concurrent file system operations take place.
AssertionError - Might throw an AssertionError if the assertion made is not correct.
Return
An Expect for the current subject of the assertion.
Since
0.12.0
infix fun <T : Path> Expect<T>.toBe(absolute: absolute): Expect<T>
Expects that the subject of the assertion (a Path) is an absolute path; meaning that the Path specified in this instance starts at the file system root.
AssertionError - Might throw an AssertionError if the assertion made is not correct.
Return
An Expect for the current subject of the assertion.
Since
0.14.0
infix fun <T : Path> Expect<T>.toBe(relative: relative): Expect<T>
Expects that the subject of the assertion (a Path) is a relative path; meaning that the Path specified in this instance does not start at the file system root.
AssertionError - Might throw an AssertionError if the assertion made is not correct.
Return
An Expect for the current subject of the assertion.
Since
0.14.0