naijun0403/kompendium
1
0
Fork 0
Code Issues 15 Pull Requests 5 Actions Packages Projects Releases 58 Wiki Activity

fix: improved error output when an unknown schema is encountered (#327)

Browse Source
This commit is contained in:
Ryan Brink
2022-09-26 08:15:21 -05:00
committed by GitHub
parent b3dcf7dc8b
commit 70345494ab
6 changed files with 36 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
core/src/test/kotlin/io/bkbn/kompendium/core/KompendiumTest.kt
View File

@ -53,12 +53,16 @@ import io.bkbn.kompendium.core.util.TestModules.trailingSlash
import io.bkbn.kompendium.core.util.TestModules.unbackedFieldsResponse
import io.bkbn.kompendium.core.util.TestModules.withOperationId
import io.bkbn.kompendium.json.schema.definition.TypeDefinition
import io.bkbn.kompendium.json.schema.exception.UnknownSchemaException
import io.bkbn.kompendium.oas.component.Components
import io.bkbn.kompendium.oas.security.ApiKeyAuth
import io.bkbn.kompendium.oas.security.BasicAuth
import io.bkbn.kompendium.oas.security.BearerAuth
import io.bkbn.kompendium.oas.security.OAuth
import io.kotest.assertions.throwables.shouldThrow
import io.kotest.core.spec.style.DescribeSpec
import io.kotest.matchers.should
import io.kotest.matchers.string.startWith
import io.ktor.client.HttpClient
import io.ktor.client.engine.cio.CIO
import io.ktor.http.HttpMethod
@ -240,6 +244,12 @@ class KompendiumTest : DescribeSpec({
openApiTestAllSerializers("T0044__nested_type_name.json") { nestedTypeName() }
}
}
describe("Error Handling") {
it("Throws a clear exception when an unidentified type is encountered") {
val exception = shouldThrow<UnknownSchemaException> { openApiTestAllSerializers("") { dateTimeString() } }
exception.message should startWith("An unknown type was encountered: class java.time.Instant")
}
}
describe("Constraints") {
// TODO Assess strategies here
}