ktor-client-tests/io.ktor.client.tests.utils

Package-level declarations

Types

expect abstract class ClientLoader(timeoutSeconds: Int = 60)

Helper interface to test client.

actual abstract class ClientLoader(timeoutSeconds: Int)

Helper interface to test client.

actual abstract class ClientLoader(val timeoutSeconds: Int)

Helper interface to test client.

actual abstract class ClientLoader(timeoutSeconds: Int)

Helper interface to test client.

actual abstract class ClientLoader(timeoutSeconds: Int)

Helper interface to test client.

TestClientBuilder

class TestClientBuilder<out T : HttpClientEngineConfig>(var config: HttpClientConfig<@UnsafeVariance T>.() -> Unit = {}, var test: suspend TestInfo.(client: HttpClient) -> Unit = {}, var after: suspend (client: HttpClient) -> Unit = {}, var repeatCount: Int = 1, var dumpAfterDelay: Long = -1, var concurrency: Int = 1)

class TestInfo(val threadId: Int, val attempt: Int)

@CoroutinesTimeout(testTimeoutMs = 300000)

abstract class TestWithKtor

Properties

const val TCP_SERVER: String

Proxy server url for tests.

const val TEST_SERVER: String

Web url for tests.

TEST_WEBSOCKET_SERVER

const val TEST_WEBSOCKET_SERVER: String

Websocket server url for tests.

Functions

fun TestClientBuilder<*>.after(block: suspend (client: HttpClient) -> Unit)

assertFailsAndContainsCause

expect inline fun <T : Throwable> assertFailsAndContainsCause(block: () -> Unit)

Asserts that block completed with given type of root cause.

actual inline fun <T : Throwable> assertFailsAndContainsCause(block: () -> Unit)

Check that block completed with given type of root cause.

actual inline fun <T : Throwable> assertFailsAndContainsCause(block: () -> Unit)

Check that block completed with given type of root cause.

actual inline fun <T : Throwable> assertFailsAndContainsCause(block: () -> Unit)

Check that block completed with given type of root cause.

actual inline fun <T : Throwable> assertFailsAndContainsCause(block: () -> Unit)

Check that block completed with given type of root cause.

assertFailsWith

expect inline fun <T : Throwable> assertFailsWith(block: () -> Unit)

Asserts that a block fails with a specific exception of type T being thrown.

actual inline fun <T : Throwable> assertFailsWith(block: () -> Unit)

Asserts that a block fails with a specific exception of type T being thrown.

actual inline fun <T : Throwable> assertFailsWith(block: () -> Unit)

Asserts that a block fails with a specific exception of type T being thrown.

actual inline fun <T : Throwable> assertFailsWith(block: () -> Unit)

Asserts that a block fails with a specific exception of type T being thrown.

actual inline fun <T : Throwable> assertFailsWith(block: () -> Unit)

Asserts that a block fails with a specific exception of type T being thrown.

fun <T : HttpClientEngineConfig> TestClientBuilder<T>.config(block: HttpClientConfig<T>.() -> Unit)

fun makeArray(size: Int): ByteArray

fun makeString(size: Int): String

suspend fun List<PartData>.makeString(): String

fun TestClientBuilder<*>.test(block: suspend TestInfo.(client: HttpClient) -> Unit)

fun testWithEngine(engine: HttpClientEngine, timeoutMillis: Long = 60 * 1000L, block: suspend TestClientBuilder<*>.() -> Unit): TestResult

Perform test with selected client engine.

fun <T : HttpClientEngineConfig> testWithEngine(factory: HttpClientEngineFactory<T>, loader: ClientLoader? = null, timeoutMillis: Long = 60L * 1000L, block: suspend TestClientBuilder<T>.() -> Unit): TestResult

Perform test with selected client engine factory.