Skip to content

Being able to customize RestAssured config #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
TimurKasatkin wants to merge 1 commit into from
Closed

Being able to customize RestAssured config #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
236 changes: 121 additions & 115 deletions kbdd/src/main/kotlin/ru/fix/kbdd/rest/Rest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import io.restassured.path.json.config.JsonPathConfig
import io.restassured.response.Response
import kotlinx.coroutines.CoroutineExceptionHandler
import kotlinx.coroutines.asCoroutineDispatcher
import kotlinx.coroutines.withContext
import kotlinx.coroutines.runInterruptible
import mu.KotlinLogging
import ru.fix.corounit.allure.AllureStep
import ru.fix.kbdd.asserts.AlluredKPath
Expand All @@ -31,22 +31,23 @@ private val log = KotlinLogging.logger { }
object Rest {
private val defaultMapper = jacksonObjectMapper()
private val doNotSendNullsMapper = defaultMapper.copy()
.setSerializationInclusion(JsonInclude.Include.NON_NULL)
.setSerializationInclusion(JsonInclude.Include.NON_NULL)

private fun selectMapper(sendNulls: Boolean = true) =
if (sendNulls) {
defaultMapper
} else {
doNotSendNullsMapper
}
if (sendNulls) {
defaultMapper
} else {
doNotSendNullsMapper
}


private val lastResponse = ThreadLocal<Response>()

var threadPoolSize = 10
var restAssuredConfigCustomizer: RestAssuredConfig.() -> RestAssuredConfig = { this }

private val dispatcher by lazy {
Executors.newFixedThreadPool(10).asCoroutineDispatcher() +
Executors.newFixedThreadPool(threadPoolSize).asCoroutineDispatcher() +
CoroutineExceptionHandler { _, thr -> log.error(thr) {} }
}

Expand All @@ -60,99 +61,104 @@ object Rest {
val dsl = RequestDsl().apply(request)

val config = RestAssuredConfig.config()
.encoderConfig(
EncoderConfig.encoderConfig().defaultContentCharset(Charsets.UTF_8)
.defaultCharsetForContentType(Charsets.UTF_8, ContentType.JSON)
)
.decoderConfig(
DecoderConfig.decoderConfig().defaultContentCharset(Charsets.UTF_8)
.defaultCharsetForContentType(Charsets.UTF_8, ContentType.JSON)
)
.jsonConfig(
// Default value FLOAT_AND_DOUBLE results in rounded fractional values.
// Conversion happens in ConfigurableJsonSlurper. If value fits into Float it converts it by
// calling BigDecimal.floatValue().
// From floatValue() javadoc: "Note that even when the return
// value is finite, this conversion can lose information about the precision".
JsonConfig.jsonConfig().numberReturnType(JsonPathConfig.NumberReturnType.DOUBLE)
)
.let { c ->
val followRedirects = dsl.followRedirects
?: return@let c

c.redirect(c.redirectConfig.followRedirects(followRedirects))
}
.encoderConfig(
EncoderConfig.encoderConfig()
.defaultContentCharset(Charsets.UTF_8)
.defaultCharsetForContentType(Charsets.UTF_8, ContentType.JSON)
)
.decoderConfig(
DecoderConfig.decoderConfig()
.defaultContentCharset(Charsets.UTF_8)
.defaultCharsetForContentType(Charsets.UTF_8, ContentType.JSON)
)
.jsonConfig(
// Default value FLOAT_AND_DOUBLE results in rounded fractional values.
// Conversion happens in ConfigurableJsonSlurper. If value fits into Float it converts it by
// calling BigDecimal.floatValue().
// From floatValue() javadoc: "Note that even when the return
// value is finite, this conversion can lose information about the precision".
JsonConfig.jsonConfig().numberReturnType(JsonPathConfig.NumberReturnType.DOUBLE)
)
.let { config ->
val followRedirects = dsl.followRedirects
?: return@let config

config.redirect(config.redirectConfig.followRedirects(followRedirects))
}.restAssuredConfigCustomizer()

val allureStep = AllureStep.fromCurrentCoroutineContext()

val spec = given()
.filter(HttpAllureAttachmentFilter(allureStep))
.run {
when {
dsl.formParams != null -> contentType(ContentType.URLENC)
dsl.bodyJsonDsl != null -> contentType(ContentType.JSON)
dsl.bodyString != null -> contentType(ContentType.JSON)
dsl.bodyXml != null -> contentType(ContentType.XML)
else -> this
}
}
.config(config)
.run {
dsl.headers?.let { headers(it) } ?: this
}
.run {
dsl.baseUrl?.let { baseUri(it) } ?: this
.filter(HttpAllureAttachmentFilter(allureStep))
.run {
when {
dsl.formParams != null -> contentType(ContentType.URLENC)
dsl.bodyJsonDsl != null -> contentType(ContentType.JSON)
dsl.bodyString != null -> contentType(ContentType.JSON)
dsl.bodyXml != null -> contentType(ContentType.XML)
else -> this
}
.run {
when {
dsl.bodyJsonDsl != null -> {
val selectedMapper = selectMapper(dsl.bodyJsonSendNulls)
val objectNode = selectedMapper.json(dsl.bodyJsonDsl!!)
if (!dsl.bodyJsonSendNulls) {
removeNullFiledsInObjectNodes(listOf(objectNode))
}
val content = selectedMapper.writeValueAsString(objectNode)
body(content)
}
.config(config)
.run {
dsl.headers?.let { headers(it) } ?: this
}
.run {
dsl.baseUrl?.let { baseUri(it) } ?: this
}
.run {
when {
dsl.bodyJsonDsl != null -> {
val selectedMapper = selectMapper(dsl.bodyJsonSendNulls)
val objectNode = selectedMapper.json(dsl.bodyJsonDsl!!)
if (!dsl.bodyJsonSendNulls) {
removeNullFiledsInObjectNodes(listOf(objectNode))
}
val content = selectedMapper.writeValueAsString(objectNode)
body(content)
}

dsl.bodyString != null ->
body(dsl.bodyString!!)
dsl.bodyString != null ->
body(dsl.bodyString!!)

dsl.bodyXml != null ->
body(dsl.bodyXml!!)
dsl.bodyXml != null ->
body(dsl.bodyXml!!)

else -> this
}
}
.run {
dsl.formParams?.let { formParams(it) } ?: this
}
.run {
dsl.queryParams?.let { queryParams(it) } ?: this
}
.run {
dsl.filename?.let { name ->
dsl.fileContent?.let { content ->
multiPart("file", name, content)
}
} ?: this
else -> this
}
}
.run {
dsl.formParams?.let { formParams(it) } ?: this
}
.run {
dsl.queryParams?.let { queryParams(it) } ?: this
}
.run {
dsl.filename?.let { name ->
dsl.fileContent?.let { content ->
multiPart("file", name, content)
}
} ?: this
}


val response = withContext(dispatcher) {
val response = runInterruptible(dispatcher) {
try {
when {
dsl.post != null -> spec.post(dsl.post)
dsl.get != null -> spec.get(dsl.get)
dsl.delete != null -> spec.delete(dsl.delete)
dsl.put != null -> spec.put(dsl.put)
else -> throw IllegalArgumentException(
"Neither post, get, delete or put method was declared in request")
"Neither post, get, delete or put method was declared in request"
)
}
} catch (exc: Exception) {
throw RuntimeException("Failed to execute request with" +
" baseUrl: ${dsl.baseUrl}" +
", path: ${dsl.post ?: dsl.get ?: dsl.delete ?: dsl.put}", exc)
throw RuntimeException(
"Failed to execute request with" +
" baseUrl: ${dsl.baseUrl}" +
", path: ${dsl.post ?: dsl.get ?: dsl.delete ?: dsl.put}", exc
)
}
}

Expand Down Expand Up @@ -284,18 +290,18 @@ object Rest {
*/
fun json(json: Json.() -> Unit): ObjectNode = defaultMapper.json(json)

private suspend fun rawResponse() = lastResponse.get() ?: throw IllegalStateException("Previous response not found")
private fun rawResponse() = lastResponse.get() ?: throw IllegalStateException("Previous response not found")

/**
* provide access to response status code
*/
suspend fun statusCode(): Checkable {
val response = rawResponse()
return AlluredKPath(
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.statusCode,
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "statusCode()"
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.statusCode,
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "statusCode()"
)
}

Expand All @@ -305,10 +311,10 @@ object Rest {
suspend fun statusLine(): Checkable {
val response = rawResponse()
return AlluredKPath(
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.statusLine,
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "statusLine()"
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.statusLine,
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "statusLine()"
)
}

Expand All @@ -318,10 +324,10 @@ object Rest {
suspend fun bodyString(): Checkable {
val response = rawResponse()
return AlluredKPath(
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.body().asString(),
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "bodyString()"
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.body().asString(),
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "bodyString()"
)
}

Expand All @@ -331,46 +337,46 @@ object Rest {
suspend fun bodyJson(): Explorable {
val response = rawResponse()
return AlluredKPath(
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.jsonPath().get<Any?>()!!,
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "bodyJson()"
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.jsonPath().get<Any?>()!!,
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "bodyJson()"
)
}

suspend fun bodyXml(): Explorable {
val response = rawResponse()
return AlluredKPath(
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.xmlPath(),
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "bodyXml()"
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.xmlPath(),
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "bodyXml()"
)
}

suspend fun cookie(): Explorable {
val response = rawResponse()
return AlluredKPath(
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.cookies,
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "cookie()"
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.cookies,
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "cookie()"
)
}

suspend fun headers(): Explorable {
val response = rawResponse()
return AlluredKPath(
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.headers.groupBy {
it.name
}.mapValues {
it.value.joinToString { header ->
header.value
}
},
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "headers()"
parentStep = AllureStep.fromCurrentCoroutineContext(),
node = response.headers.groupBy {
it.name
}.mapValues {
it.value.joinToString { header ->
header.value
}
},
mode = KPath.Mode.IMMEDIATE_ASSERT,
path = "headers()"
)
}

Expand Down
Loading
Loading