org.http4k.testing.approvalSource.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http4k-testing-approval Show documentation

Http4k support for Approval Testing

There is a newer version: 5.35.1.0

Show newest version

package org.http4k.testing

import java.io.File
import java.io.InputStream
import java.io.OutputStream

fun interface ReadResource {
    fun input(): InputStream?
}

interface ReadWriteResource : ReadResource {
    fun output(): OutputStream
}

/**
 * The backing store where the approved and actual content will be stored.
 */
interface ApprovalSource {
    fun actualFor(testName: String): ReadWriteResource
    fun approvedFor(testName: String): ReadResource
}

/**
 * Read the approval file from the file system, using an optional suffix
 */
class FileSystemApprovalSource(private val base: File, private val suffix: String = "") : ApprovalSource {
    override fun actualFor(testName: String): ReadWriteResource =
        FileReadWriteResource(File(base, "$testName.actual$suffix"))

    override fun approvedFor(testName: String): ReadResource =
        FileReadWriteResource(File(base, "$testName.approved$suffix"))
}

internal class FileReadWriteResource(private val target: File) : ReadWriteResource {
    override fun input() = if (target.exists()) target.inputStream() else null

    override fun output(): OutputStream =
        with(target) {
            if (!parentFile.exists() && !parentFile.mkdirs()) throw IllegalAccessException("Could not create dir ${parentFile.absolutePath}")
            if (exists() && !delete()) throw IllegalAccessException("Could not delete $absolutePath")

            object : OutputStream() {
                private val output by lazy { outputStream() }
                override fun write(b: Int) {
                    output.write(b)
                }
            }
        }

    override fun toString(): String = target.absolutePath
}