commonMain.io.telereso.kmp.core.test.TestUtils.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-test Show documentation
Core classes and tools while developing kmp projects
There is a newer version: 0.7.0-wasm.2
/*
 * MIT License
 *
 * Copyright (c) 2023 Telereso
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package io.telereso.kmp.core.test

import app.cash.sqldelight.db.QueryResult
import app.cash.sqldelight.db.SqlDriver
import app.cash.sqldelight.db.SqlSchema
import io.telereso.kmp.core.Platform
import io.telereso.kmp.core.SqlDriverFactory
import io.telereso.kmp.core.Task
import io.telereso.kmp.core.getPlatform
import io.telereso.kmp.core.test.TestUtils.Companion.dbCounter
import kotlinx.coroutines.test.TestResult
import kotlinx.coroutines.test.TestScope
import kotlinx.coroutines.test.runTest

class TestUtils {

    companion object {
        const val RESOURCE_PATH = "./src/commonTest/resources"
        var dbCounter = 0
    }
}

expect class TestSqlDriverFactory(
    sqlDriverFactory: SqlDriverFactory,
    overrideName: Boolean = true
) : SqlDriverFactory {
    override fun getSchema(): SqlSchema>?
    override suspend fun createDriver(): SqlDriver
}

fun SqlDriverFactory.databaseName(overrideName: Boolean): String {
    return if (overrideName) "${++dbCounter}-${databaseName}" else databaseName
}

expect class Resource(name: String) {
    val name: String

    suspend fun exists(): Boolean
    suspend fun readText(): String
    suspend fun writeText(text: String)
}

fun Resource.existsTask() = Task.execute { exists() }

fun Resource.readTextTask() = Task.execute { readText() }

fun Resource.writeTextTask(text: String) = Task.execute { writeText(text) }


val isPlatformBrowser get() = getPlatform().type == Platform.Type.BROWSER

fun runTestWithoutBrowser(
    testBody: suspend TestScope.() -> Unit
): TestResult {
    return runTest {
        if (isPlatformBrowser) return@runTest
        testBody()
    }
}

fun runTestWithout(
    vararg platforms: Platform.Type,
    testBody: suspend TestScope.() -> Unit
): TestResult {
    return runTest {
        if (platforms.contains(getPlatform().type)) return@runTest
        testBody()
    }
}

fun runTestOnlyOn(
    vararg platforms: Platform.Type,
    testBody: suspend TestScope.() -> Unit
): TestResult {
    return runTest {
        if (platforms.contains(getPlatform().type))
            testBody()
    }
}