commonMain.aws.smithy.kotlin.runtime.httptest.TestEngine.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
package aws.smithy.kotlin.runtime.httptest

import aws.smithy.kotlin.runtime.http.Headers
import aws.smithy.kotlin.runtime.http.HttpBody
import aws.smithy.kotlin.runtime.http.HttpCall
import aws.smithy.kotlin.runtime.http.HttpStatusCode
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngineBase
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngineConfig
import aws.smithy.kotlin.runtime.http.request.HttpRequest
import aws.smithy.kotlin.runtime.http.response.HttpResponse
import aws.smithy.kotlin.runtime.operation.ExecutionContext
import aws.smithy.kotlin.runtime.time.Instant

/**
 * A simplistic [HttpClientEngine] suitable for integration testing. This engine yields a hardcoded
 * [HttpClientEngineConfig.Default] for its configuration.
 * @param name The name of this engine, which is used in constructing a coroutine context. By default, the name is
 * "test".
 * @param roundTripImpl A lambda which specifies the result of a call to `roundTrip`. By default, this returns an
 * HTTP 200 response with no headers and no body.
 */
@Suppress("ktlint:standard:function-naming")
public fun TestEngine(
    name: String = "test",
    roundTripImpl: suspend (ExecutionContext, HttpRequest) -> HttpCall = { _, request ->
        val resp = HttpResponse(HttpStatusCode.OK, Headers.Empty, HttpBody.Empty)
        val now = Instant.now()
        HttpCall(request, resp, now, now)
    },
): HttpClientEngine =
    object : HttpClientEngineBase(name) {
        override val config: HttpClientEngineConfig = HttpClientEngineConfig.Default

        override suspend fun roundTrip(context: ExecutionContext, request: HttpRequest): HttpCall =
            roundTripImpl(context, request)
    }