Added new modules; added deprecated key

Author: sksamuel

build.gradle.kts

@@ -2,7 +2,6 @@ import org.gradle.api.tasks.testing.logging.TestExceptionFormat
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
-   id("kotest-publishing-conventions")
    kotlin("jvm") version "1.6.21"
 }
 
@@ -17,19 +16,6 @@ repositories {
    }
 }
 
-dependencies {
-   implementation("io.ktor:ktor-server-core:2.2.4")
-   implementation("io.ktor:ktor-server-auth:2.2.4")
-   implementation("io.swagger.parser.v3:swagger-parser:2.1.12")
-   implementation("io.kotest:kotest-framework-api:5.5.4")
-   testImplementation("io.ktor:ktor-client-apache:2.2.4")
-   testImplementation("io.kotest:kotest-runner-junit5:5.5.4")
-   testImplementation("io.kotest:kotest-assertions-core:5.5.4")
-   testImplementation("io.ktor:ktor-server-test-host:2.2.4")
-   testImplementation("io.ktor:ktor-serialization-jackson:2.2.3")
-   testImplementation("io.ktor:ktor-server-content-negotiation:2.2.3")
-}
-
 tasks.test {
    useJUnitPlatform()
    testLogging {

kotest-extensions-ktor-openapi-model/build.gradle.kts

@@ -0,0 +1,25 @@
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+   id("kotest-publishing-conventions")
+   kotlin("jvm") version "1.6.21"
+}
+
+group = "io.kotest.extensions"
+version = Ci.version
+
+repositories {
+   mavenLocal()
+   mavenCentral()
+   maven {
+      url = uri("https://oss.sonatype.org/content/repositories/snapshots")
+   }
+}
+
+dependencies {
+   api("io.ktor:ktor-server-core:2.2.4")
+}
+
+tasks.withType<KotlinCompile> {
+   kotlinOptions.jvmTarget = "11"
+}

kotest-extensions-ktor-openapi-model/src/main/kotlin/io/kotest/extensions/ktor/openapi/keys.kt

@@ -0,0 +1,17 @@
+package io.kotest.extensions.ktor.openapi
+
+import io.ktor.server.application.ApplicationCall
+import io.ktor.server.application.call
+import io.ktor.util.AttributeKey
+import io.ktor.util.pipeline.PipelineContext
+
+val DescriptionKey: AttributeKey<String> = AttributeKey("KotestOpenApiDescriptionKey")
+val DeprecatedKey: AttributeKey<Boolean> = AttributeKey("KotestOpenApiDeprecatedKey")
+
+fun PipelineContext<*, ApplicationCall>.description(desc: String) {
+   call.attributes.put(DescriptionKey, desc)
+}
+
+fun PipelineContext<*, ApplicationCall>.deprecated(deprecated: Boolean) {
+   if (deprecated) call.attributes.put(DeprecatedKey, deprecated)
+}

kotest-extensions-ktor-openapi-plugin/build.gradle.kts

@@ -0,0 +1,45 @@
+import org.gradle.api.tasks.testing.logging.TestExceptionFormat
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+   id("kotest-publishing-conventions")
+   kotlin("jvm") version "1.6.21"
+}
+
+group = "io.kotest.extensions"
+version = Ci.version
+
+repositories {
+   mavenLocal()
+   mavenCentral()
+   maven {
+      url = uri("https://oss.sonatype.org/content/repositories/snapshots")
+   }
+}
+
+dependencies {
+   api(projects.kotestExtensionsKtorOpenapiModel)
+   implementation("io.ktor:ktor-server-core:2.2.4")
+   implementation("io.ktor:ktor-server-auth:2.2.4")
+   implementation("io.swagger.parser.v3:swagger-parser:2.1.12")
+   implementation("io.kotest:kotest-framework-api:5.5.4")
+   testImplementation("io.ktor:ktor-client-apache:2.2.4")
+   testImplementation("io.kotest:kotest-runner-junit5:5.5.4")
+   testImplementation("io.kotest:kotest-assertions-core:5.5.4")
+   testImplementation("io.ktor:ktor-server-test-host:2.2.4")
+   testImplementation("io.ktor:ktor-serialization-jackson:2.2.3")
+   testImplementation("io.ktor:ktor-server-content-negotiation:2.2.3")
+}
+
+tasks.test {
+   useJUnitPlatform()
+   testLogging {
+      showExceptions = true
+      showStandardStreams = true
+      exceptionFormat = TestExceptionFormat.FULL
+   }
+}
+
+tasks.withType<KotlinCompile> {
+   kotlinOptions.jvmTarget = "11"
+}

src/main/kotlin/io/kotest/extensions/ktor/openapi/KotestOpenApiExtension.kt kotest-extensions-ktor-openapi-plugin/src/main/kotlin/io/kotest/extensions/ktor/openapi/KotestOpenApiExtension.kt

@@ -49,6 +49,7 @@ class OpenApiBuilder(private val config: OpenApiConfig) {
 
          val op = Operation()
          op.description = tracesByMethod.firstNotNullOfOrNull { it.description }
+         op.deprecated = tracesByMethod.any { it.deprecated }
          op.responses = ApiResponses()
          op.parameters = mutableListOf()
 

src/main/kotlin/io/kotest/extensions/ktor/openapi/OpenApiBuilder.kt kotest-extensions-ktor-openapi-plugin/src/main/kotlin/io/kotest/extensions/ktor/openapi/OpenApiBuilder.kt

@@ -36,6 +36,7 @@ data class Trace(
    var contentType: ContentType? = null,
    var responseBody: String? = null,
    var description: String?,
+   var deprecated: Boolean = false,
    var pathParameterExamples: Map<String, String?>,
 ) {
    companion object {

src/main/kotlin/io/kotest/extensions/ktor/openapi/Tracer.kt kotest-extensions-ktor-openapi-plugin/src/main/kotlin/io/kotest/extensions/ktor/openapi/Tracer.kt

@@ -5,20 +5,16 @@ import io.ktor.http.content.ByteArrayContent
 import io.ktor.http.content.OutgoingContent
 import io.ktor.http.content.OutputStreamContent
 import io.ktor.http.content.TextContent
-import io.ktor.server.application.ApplicationCall
-import io.ktor.server.application.call
 import io.ktor.server.application.createApplicationPlugin
 import io.ktor.server.application.hooks.CallSetup
 import io.ktor.server.application.hooks.ResponseBodyReadyForSend
 import io.ktor.server.application.hooks.ResponseSent
 import io.ktor.server.request.httpMethod
 import io.ktor.server.routing.Routing
 import io.ktor.util.AttributeKey
-import io.ktor.util.pipeline.PipelineContext
 import io.ktor.utils.io.ByteChannel
 import io.ktor.utils.io.jvm.javaio.copyTo
 import java.io.ByteArrayOutputStream
-import java.nio.ByteBuffer
 import java.nio.file.Path
 import java.nio.file.Paths
 
@@ -71,6 +67,7 @@ val KotestOpenApi = createApplicationPlugin("OpenApi", createConfiguration = ::O
          val trace = call.attributes[traceKey]
          trace.status = call.response.status()
          trace.description = call.attributes.getOrNull(DescriptionKey)
+         trace.deprecated = call.attributes.getOrNull(DeprecatedKey) ?: false
          trace.pathParameterExamples = trace.pathParameters.associateWith { call.parameters[it] }
          this@createApplicationPlugin.pluginConfig.tracer.addTrace(trace)
       }
@@ -114,9 +111,3 @@ val KotestOpenApi = createApplicationPlugin("OpenApi", createConfiguration = ::O
       }
    }
 }
-
-val DescriptionKey: AttributeKey<String> = AttributeKey("KotestOpenApiDescriptionKey")
-
-fun PipelineContext<*, ApplicationCall>.description(desc: String) {
-   call.attributes.put(DescriptionKey, desc)
-}

src/main/kotlin/io/kotest/extensions/ktor/openapi/authenticators.kt kotest-extensions-ktor-openapi-plugin/src/main/kotlin/io/kotest/extensions/ktor/openapi/authenticators.kt

@@ -3,6 +3,7 @@ package io.kotest.extensions.ktor.openapi
 import io.kotest.core.spec.style.FunSpec
 import io.ktor.client.request.delete
 import io.ktor.client.request.get
+import io.ktor.client.request.patch
 import io.ktor.client.request.post
 import io.ktor.http.HttpStatusCode
 import io.ktor.server.application.call
@@ -12,6 +13,7 @@ import io.ktor.server.auth.basic
 import io.ktor.server.response.respond
 import io.ktor.server.routing.delete
 import io.ktor.server.routing.get
+import io.ktor.server.routing.patch
 import io.ktor.server.routing.post
 import io.ktor.server.routing.route
 import io.ktor.server.testing.testApplication
@@ -41,14 +43,21 @@ class OpenApiTest : FunSpec() {
                      description("Returns the user identified by the foo param")
                      call.respond(HttpStatusCode.OK)
                   }
+                  patch("/patchme") {
+                     deprecated(true)
+                     call.respond(HttpStatusCode.OK)
+                  }
                }
                authenticate("auth1", "auth2") {
                   get("/users/{foo}") { call.respond(HttpStatusCode.OK) }
-                  delete("/with/param1/{foo}/even/{param2}") { call.respond(HttpStatusCode.OK) }
+                  delete("/with/param1/{foo}/even/{param2}") {
+                     call.respond(HttpStatusCode.OK)
+                  }
                }
                post("/bar2") { call.respond(HttpStatusCode.OK, "some response body") }
             }
             client.get("/internal/foo1")
+            client.patch("/internal/patchme")
             client.post("/bar2").status
             client.get("/users/154363")
             client.delete("/with/param1/foo/even/param2")

src/main/kotlin/io/kotest/extensions/ktor/openapi/OpenApiPlugin.kt kotest-extensions-ktor-openapi-plugin/src/main/kotlin/io/kotest/extensions/ktor/openapi/plugin.kt

@@ -0,0 +1,12 @@
+enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")
+rootProject.name = "kotest-extensions-ktor-openapi"
+
+pluginManagement {
+  repositories {
+    mavenCentral()
+    gradlePluginPortal()
+  }
+}
+
+include("kotest-extensions-ktor-openapi-model")
+include("kotest-extensions-ktor-openapi-plugin")