jvmTest.com.bkahlert.kommons.test.JvmFixturesKtTest.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kommons-test Show documentation
Kommons Test is a Kotlin Multiplatform Library to ease testing.
There is a newer version: 2.8.0
package com.bkahlert.kommons.test

import com.bkahlert.kommons.test.com.bkahlert.kommons.deleteOnExit
import com.bkahlert.kommons.test.com.bkahlert.kommons.listDirectoryEntriesRecursively
import com.bkahlert.kommons.test.fixtures.GifImageFixture
import com.bkahlert.kommons.test.fixtures.HtmlDocumentFixture
import com.bkahlert.kommons.test.fixtures.SvgImageFixture
import com.bkahlert.kommons.test.fixtures.TextDocumentFixture
import io.kotest.assertions.throwables.shouldThrow
import io.kotest.inspectors.forAny
import io.kotest.inspectors.forNone
import io.kotest.matchers.collections.shouldHaveSize
import io.kotest.matchers.paths.shouldBeADirectory
import io.kotest.matchers.should
import io.kotest.matchers.shouldBe
import io.kotest.matchers.string.shouldEndWith
import io.kotest.matchers.string.shouldStartWith
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.io.TempDir
import java.nio.file.FileAlreadyExistsException
import java.nio.file.Path
import java.nio.file.Paths
import kotlin.io.path.createFile
import kotlin.io.path.div
import kotlin.io.path.exists
import kotlin.io.path.pathString
import kotlin.io.path.readBytes
import kotlin.io.path.readText

class JvmFixturesKtTest {

    @Test fun file_name() = test {
        SvgImageFixture.fileName shouldBe Paths.get("kommons.svg")
    }

    @Test fun input_stream() = test {
        GifImageFixture.inputStream().readBytes() shouldBe GifImageFixture.bytes
        SvgImageFixture.inputStream().readBytes() shouldBe SvgImageFixture.bytes
    }

    @Test fun reader() = test {
        SvgImageFixture.reader().readText() shouldBe SvgImageFixture.contents
    }

    @Test fun copy_to(@TempDir tempDir: Path) = test {
        SvgImageFixture.copyTo(tempDir / "file") should {
            it.exists() shouldBe true
            it.readText() shouldBe SvgImageFixture.contents
        }

        shouldThrow { GifImageFixture.copyTo(tempDir / "file") }

        GifImageFixture.copyTo(tempDir / "file", overwrite = true) should {
            it.exists() shouldBe true
            it.readBytes() shouldBe GifImageFixture.bytes
        }
    }

    @Test fun copy_to_directory(@TempDir tempDir: Path) = test {
        SvgImageFixture.copyToDirectory(tempDir) should {
            it.exists() shouldBe true
            it.readText() shouldBe SvgImageFixture.contents
            it.fileName.pathString shouldBe "kommons.svg"
        }

        tempDir.resolve("pixels.gif").createFile()
        shouldThrow { GifImageFixture.copyToDirectory(tempDir) }

        GifImageFixture.copyToDirectory(tempDir, overwrite = true) should {
            it.exists() shouldBe true
            it.readBytes() shouldBe GifImageFixture.bytes
        }
    }

    @Test fun copy_to_temp_file() = test {
        GifImageFixture.copyToTempFile().deleteOnExit() should {
            it.exists() shouldBe true
            it.readBytes() shouldBe GifImageFixture.bytes
            it.fileName.pathString shouldStartWith "pixels."
            it.fileName.pathString shouldEndWith ".gif"
        }
    }

    @Test fun copy_to_temp_text_file() = test {
        SvgImageFixture.copyToTempTextFile().deleteOnExit() should {
            it.exists() shouldBe true
            it.readText() shouldBe SvgImageFixture.contents
            it.fileName.pathString shouldStartWith "kommons."
            it.fileName.pathString shouldEndWith ".svg"
        }

        SvgImageFixture.copyToTempTextFile(Charsets.ISO_8859_1) should {
            it.exists() shouldBe true
            it.readText(Charsets.ISO_8859_1) shouldBe SvgImageFixture.contents
            it.fileName.pathString shouldStartWith "kommons."
            it.fileName.pathString shouldEndWith ".svg"
        }
    }


    @Test fun create_any_file(@TempDir tempDir: Path) {
        tempDir.createAnyFile("my.file") should {
            it.exists() shouldBe true
            it.readText() shouldBe SvgImageFixture.contents
            it.fileName.pathString shouldBe "my.file"
        }
        tempDir.createAnyFile() should {
            it.exists() shouldBe true
            it.readText() shouldBe SvgImageFixture.contents
            it.fileName.pathString shouldBe "kommons.svg"
        }
    }

    @Test fun create_random_file(@TempDir tempDir: Path) {
        tempDir.createRandomFile("my.file") should {
            it.exists() shouldBe true
            listOf(GifImageFixture, HtmlDocumentFixture, SvgImageFixture, TextDocumentFixture).forAny { fixture ->
                it.readBytes() shouldBe fixture.bytes
            }
            it.fileName.pathString shouldBe "my.file"
        }

        tempDir.createRandomFile(GifImageFixture, HtmlDocumentFixture) should {
            it.exists() shouldBe true
            listOf(GifImageFixture, HtmlDocumentFixture).forAny { fixture ->
                it.readBytes() shouldBe fixture.bytes
                it.fileName.pathString shouldBe fixture.name
            }
            listOf(SvgImageFixture, TextDocumentFixture).forNone { fixture ->
                it.readBytes() shouldBe fixture.bytes
                it.fileName.pathString shouldBe fixture.name
            }
        }
    }

    @Test fun create_directory_with_files(@TempDir tempDir: Path) {
        tempDir.createDirectoryWithFiles() should {
            it.exists() shouldBe true
            it.resolve("pixels.gif").readBytes() shouldBe GifImageFixture.contents
            it.resolve("kommons.svg").readText() shouldBe SvgImageFixture.contents
            it.resolve("docs") should { docs ->
                docs.shouldBeADirectory()
                docs.resolve("hello-world.html").readText() shouldBe HtmlDocumentFixture.contents
                docs.resolve("unicode.txt").readText() shouldBe TextDocumentFixture.contents
            }
        }

        tempDir.createDirectoryWithFiles()

        tempDir.listDirectoryEntriesRecursively() shouldHaveSize 12
    }
}