feat: standardize casting of GraphQLType (#167)

smyrick · dariuszkuc · commit 2b88d2d1793f · 2019-02-18T12:26:19.000-06:00
* feat: standardize casting of GraphQLType

* test: use junit as test annotation

* test: simplify unit tests

* test: move unit tests

* test: fix recursive types that had a self reference

* feat: log casting class
diff --git a/src/main/kotlin/com/expedia/graphql/exceptions/CouldNotCastGraphQLType.kt b/src/main/kotlin/com/expedia/graphql/exceptions/CouldNotCastGraphQLType.kt
@@ -0,0 +1,10 @@
+package com.expedia.graphql.exceptions
+
+import graphql.schema.GraphQLType
+import kotlin.reflect.KClass
+
+/**
+ * Thrown when the casting a GraphQLType to some parent type is invalid
+ */
+class CouldNotCastGraphQLType(type: GraphQLType, kClass: KClass<*>)
+    : GraphQLKotlinException("Could not cast GraphQLType $type to $kClass")
diff --git a/src/main/kotlin/com/expedia/graphql/generator/extensions/graphQLExtensions.kt b/src/main/kotlin/com/expedia/graphql/generator/extensions/graphQLExtensions.kt
@@ -1,5 +1,6 @@
 package com.expedia.graphql.generator.extensions
 
+import com.expedia.graphql.exceptions.CouldNotCastGraphQLType
 import com.expedia.graphql.exceptions.NestingNonNullTypeException
 import graphql.schema.GraphQLArgument
 import graphql.schema.GraphQLDirective
@@ -30,6 +31,12 @@ internal fun GraphQLType.wrapInNonNull(type: KType): GraphQLType = when {
     else -> GraphQLNonNull.nonNull(this)
 }
 
+@Throws(CouldNotCastGraphQLType::class)
+internal inline fun <reified T : GraphQLType> GraphQLType.safeCast(): T {
+    if (this !is T) throw CouldNotCastGraphQLType(this, T::class)
+    return this
+}
+
 internal fun GraphQLDirectiveContainer.getAllDirectives(): List<GraphQLDirective> {
     // A function without directives may still be rewired if the arguments have directives
     // see https://github.com/ExpediaDotCom/graphql-kotlin/wiki/Schema-Directives for details
diff --git a/src/main/kotlin/com/expedia/graphql/generator/types/DirectiveTypeBuilder.kt b/src/main/kotlin/com/expedia/graphql/generator/types/DirectiveTypeBuilder.kt
@@ -4,10 +4,10 @@ import com.expedia.graphql.generator.SchemaGenerator
 import com.expedia.graphql.generator.TypeBuilder
 import com.expedia.graphql.generator.extensions.getSimpleName
 import com.expedia.graphql.generator.extensions.getValidProperties
+import com.expedia.graphql.generator.extensions.safeCast
 import com.google.common.base.CaseFormat
 import graphql.schema.GraphQLArgument
 import graphql.schema.GraphQLDirective
-import graphql.schema.GraphQLInputType
 import kotlin.reflect.KAnnotatedElement
 import com.expedia.graphql.annotations.GraphQLDirective as GraphQLDirectiveAnnotation
 
@@ -39,7 +39,7 @@ internal class DirectiveTypeBuilder(generator: SchemaGenerator) : TypeBuilder(ge
             val argument = GraphQLArgument.newArgument()
                 .name(propertyName)
                 .value(value)
-                .type(type as? GraphQLInputType)
+                .type(type.safeCast())
                 .build()
 
             builder.argument(argument)
diff --git a/src/main/kotlin/com/expedia/graphql/generator/types/FunctionTypeBuilder.kt b/src/main/kotlin/com/expedia/graphql/generator/types/FunctionTypeBuilder.kt
@@ -9,9 +9,9 @@ import com.expedia.graphql.generator.extensions.getName
 import com.expedia.graphql.generator.extensions.getTypeOfFirstArgument
 import com.expedia.graphql.generator.extensions.isGraphQLContext
 import com.expedia.graphql.generator.extensions.isInterface
+import com.expedia.graphql.generator.extensions.safeCast
 import graphql.schema.GraphQLArgument
 import graphql.schema.GraphQLFieldDefinition
-import graphql.schema.GraphQLInputType
 import graphql.schema.GraphQLOutputType
 import java.util.concurrent.CompletableFuture
 import kotlin.reflect.KFunction
@@ -48,10 +48,10 @@ internal class FunctionTypeBuilder(generator: SchemaGenerator) : TypeBuilder(gen
 
         val typeFromHooks = config.hooks.willResolveMonad(fn.returnType)
         val returnType = getWrappedReturnType(typeFromHooks)
-        builder.type(graphQLTypeOf(returnType) as GraphQLOutputType)
+        builder.type(graphQLTypeOf(returnType).safeCast<GraphQLOutputType>())
         val graphQLType = builder.build()
 
-        return config.hooks.onRewireGraphQLType(returnType, graphQLType) as GraphQLFieldDefinition
+        return config.hooks.onRewireGraphQLType(returnType, graphQLType).safeCast()
     }
 
     private fun getWrappedReturnType(returnType: KType): KType =
@@ -70,12 +70,12 @@ internal class FunctionTypeBuilder(generator: SchemaGenerator) : TypeBuilder(gen
         val builder = GraphQLArgument.newArgument()
             .name(parameter.getName())
             .description(parameter.getGraphQLDescription())
-            .type(graphQLTypeOf(parameter.type, true) as GraphQLInputType)
+            .type(graphQLTypeOf(parameter.type, true).safeCast())
 
         generator.directives(parameter).forEach {
             builder.withDirective(it)
         }
 
-        return config.hooks.onRewireGraphQLType(parameter.type, builder.build()) as GraphQLArgument
+        return config.hooks.onRewireGraphQLType(parameter.type, builder.build()).safeCast()
     }
 }
diff --git a/src/main/kotlin/com/expedia/graphql/generator/types/InputObjectTypeBuilder.kt b/src/main/kotlin/com/expedia/graphql/generator/types/InputObjectTypeBuilder.kt
@@ -7,6 +7,7 @@ import com.expedia.graphql.generator.extensions.getPropertyDescription
 import com.expedia.graphql.generator.extensions.getSimpleName
 import com.expedia.graphql.generator.extensions.getValidProperties
 import com.expedia.graphql.generator.extensions.isPropertyGraphQLID
+import com.expedia.graphql.generator.extensions.safeCast
 import graphql.schema.GraphQLInputObjectField
 import graphql.schema.GraphQLInputObjectType
 import graphql.schema.GraphQLInputType
@@ -32,7 +33,7 @@ internal class InputObjectTypeBuilder(generator: SchemaGenerator) : TypeBuilder(
 
         builder.description(prop.getPropertyDescription(parentClass))
         builder.name(prop.name)
-        builder.type(graphQLTypeOf(prop.returnType, true, prop.isPropertyGraphQLID(parentClass)) as? GraphQLInputType)
+        builder.type(graphQLTypeOf(prop.returnType, true, prop.isPropertyGraphQLID(parentClass)).safeCast<GraphQLInputType>())
 
         return builder.build()
     }
diff --git a/src/main/kotlin/com/expedia/graphql/generator/types/InterfaceTypeBuilder.kt b/src/main/kotlin/com/expedia/graphql/generator/types/InterfaceTypeBuilder.kt
@@ -14,7 +14,7 @@ import kotlin.reflect.KClass
 
 internal class InterfaceTypeBuilder(generator: SchemaGenerator) : TypeBuilder(generator) {
     internal fun interfaceType(kClass: KClass<*>): GraphQLType {
-        return state.cache.buildIfNotUnderConstruction(kClass) { _ ->
+        return state.cache.buildIfNotUnderConstruction(kClass) {
             val builder = GraphQLInterfaceType.newInterface()
 
             builder.name(kClass.getSimpleName())
diff --git a/src/main/kotlin/com/expedia/graphql/generator/types/ObjectTypeBuilder.kt b/src/main/kotlin/com/expedia/graphql/generator/types/ObjectTypeBuilder.kt
@@ -16,7 +16,7 @@ import kotlin.reflect.full.createType
 internal class ObjectTypeBuilder(generator: SchemaGenerator) : TypeBuilder(generator) {
 
     internal fun objectType(kClass: KClass<*>, interfaceType: GraphQLInterfaceType? = null): GraphQLType {
-        return state.cache.buildIfNotUnderConstruction(kClass) { _ ->
+        return state.cache.buildIfNotUnderConstruction(kClass) {
             val builder = GraphQLObjectType.newObject()
 
             builder.name(kClass.getSimpleName())
@@ -30,8 +30,12 @@ internal class ObjectTypeBuilder(generator: SchemaGenerator) : TypeBuilder(gener
                 builder.withInterface(interfaceType)
             } else {
                 kClass.getValidSuperclasses(config.hooks)
-                    .mapNotNull { objectFromReflection(it.createType(), false) as? GraphQLInterfaceType }
-                    .forEach { builder.withInterface(it) }
+                    .map { objectFromReflection(it.createType(), false) }
+                    .forEach {
+                        when (it) {
+                            is GraphQLInterfaceType -> builder.withInterface(it)
+                        }
+                    }
             }
 
             kClass.getValidProperties(config.hooks)
diff --git a/src/main/kotlin/com/expedia/graphql/generator/types/PropertyTypeBuilder.kt b/src/main/kotlin/com/expedia/graphql/generator/types/PropertyTypeBuilder.kt
@@ -5,6 +5,7 @@ import com.expedia.graphql.generator.TypeBuilder
 import com.expedia.graphql.generator.extensions.getPropertyDeprecationReason
 import com.expedia.graphql.generator.extensions.getPropertyDescription
 import com.expedia.graphql.generator.extensions.isPropertyGraphQLID
+import com.expedia.graphql.generator.extensions.safeCast
 import graphql.schema.GraphQLFieldDefinition
 import graphql.schema.GraphQLOutputType
 import kotlin.reflect.KClass
@@ -13,7 +14,8 @@ import kotlin.reflect.KProperty
 @Suppress("Detekt.UnsafeCast")
 internal class PropertyTypeBuilder(generator: SchemaGenerator) : TypeBuilder(generator) {
     internal fun property(prop: KProperty<*>, parentClass: KClass<*>): GraphQLFieldDefinition {
-        val propertyType = graphQLTypeOf(type = prop.returnType, annotatedAsID = prop.isPropertyGraphQLID(parentClass)) as GraphQLOutputType
+        val propertyType = graphQLTypeOf(type = prop.returnType, annotatedAsID = prop.isPropertyGraphQLID(parentClass))
+            .safeCast<GraphQLOutputType>()
 
         val fieldBuilder = GraphQLFieldDefinition.newFieldDefinition()
             .description(prop.getPropertyDescription(parentClass))
@@ -27,6 +29,7 @@ internal class PropertyTypeBuilder(generator: SchemaGenerator) : TypeBuilder(gen
         }
 
         val field = fieldBuilder.build()
-        return config.hooks.onRewireGraphQLType(prop.returnType, field) as GraphQLFieldDefinition
+
+        return config.hooks.onRewireGraphQLType(prop.returnType, field).safeCast()
     }
 }
diff --git a/src/main/kotlin/com/expedia/graphql/generator/types/UnionTypeBuilder.kt b/src/main/kotlin/com/expedia/graphql/generator/types/UnionTypeBuilder.kt
@@ -16,7 +16,7 @@ import kotlin.reflect.full.createType
 
 internal class UnionTypeBuilder(generator: SchemaGenerator) : TypeBuilder(generator) {
     internal fun unionType(kClass: KClass<*>): GraphQLType {
-        return state.cache.buildIfNotUnderConstruction(kClass) { _ ->
+        return state.cache.buildIfNotUnderConstruction(kClass) {
             val builder = GraphQLUnionType.newUnionType()
 
             builder.name(kClass.getSimpleName())
@@ -30,10 +30,9 @@ internal class UnionTypeBuilder(generator: SchemaGenerator) : TypeBuilder(genera
 
                 val key = TypesCacheKey(it.kotlin.createType(), false)
 
-                if (objectType is GraphQLTypeReference) {
-                    builder.possibleType(objectType)
-                } else {
-                    builder.possibleType(objectType as? GraphQLObjectType)
+                when (objectType) {
+                    is GraphQLTypeReference -> builder.possibleType(objectType)
+                    is GraphQLObjectType -> builder.possibleType(objectType)
                 }
 
                 if (state.cache.doesNotContain(it.kotlin)) {
diff --git a/src/test/kotlin/com/expedia/graphql/DirectiveWiringHelperTest.kt b/src/test/kotlin/com/expedia/graphql/DirectiveWiringHelperTest.kt
@@ -15,7 +15,7 @@ import graphql.schema.idl.SchemaDirectiveWiringEnvironment
 import graphql.schema.idl.WiringFactory
 import graphql.util.TraversalControl
 import graphql.util.TraverserContext
-import kotlin.test.Test
+import org.junit.jupiter.api.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
 import kotlin.test.assertNotEquals
diff --git a/src/test/kotlin/com/expedia/graphql/generator/SchemaGeneratorAsyncTests.kt b/src/test/kotlin/com/expedia/graphql/generator/SchemaGeneratorAsyncTests.kt
@@ -9,9 +9,9 @@ import graphql.schema.GraphQLNonNull
 import io.reactivex.Maybe
 import io.reactivex.Observable
 import io.reactivex.Single
+import org.junit.jupiter.api.Test
 import java.util.concurrent.CompletableFuture
 import kotlin.reflect.KType
-import kotlin.test.Test
 import kotlin.test.assertEquals
 
 class SchemaGeneratorAsyncTests {
diff --git a/src/test/kotlin/com/expedia/graphql/generator/SchemaGeneratorTest.kt b/src/test/kotlin/com/expedia/graphql/generator/SchemaGeneratorTest.kt
@@ -14,9 +14,9 @@ import graphql.GraphQL
 import graphql.Scalars
 import graphql.schema.GraphQLNonNull
 import graphql.schema.GraphQLObjectType
+import org.junit.jupiter.api.Test
 import java.net.CookieManager
 import java.util.UUID
-import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
 import kotlin.test.assertNotNull
diff --git a/src/test/kotlin/com/expedia/graphql/generator/extensions/AnnotationExtensionsTest.kt b/src/test/kotlin/com/expedia/graphql/generator/extensions/AnnotationExtensionsTest.kt
@@ -3,8 +3,8 @@ package com.expedia.graphql.generator.extensions
 import com.expedia.graphql.annotations.GraphQLDescription
 import com.expedia.graphql.annotations.GraphQLID
 import com.expedia.graphql.annotations.GraphQLIgnore
+import org.junit.jupiter.api.Test
 import kotlin.reflect.full.declaredMemberProperties
-import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFalse
 import kotlin.test.assertNull
diff --git a/src/test/kotlin/com/expedia/graphql/generator/extensions/GraphQLExtensionsTest.kt b/src/test/kotlin/com/expedia/graphql/generator/extensions/GraphQLExtensionsTest.kt
@@ -1,5 +1,6 @@
 package com.expedia.graphql.generator.extensions
 
+import com.expedia.graphql.exceptions.CouldNotCastGraphQLType
 import com.expedia.graphql.exceptions.NestingNonNullTypeException
 import graphql.schema.GraphQLArgument
 import graphql.schema.GraphQLDirective
@@ -24,8 +25,8 @@ import io.mockk.every
 import io.mockk.mockk
 import io.mockk.spyk
 import io.mockk.verify
+import org.junit.jupiter.api.Test
 import kotlin.reflect.KType
-import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
 import kotlin.test.assertFalse
@@ -250,4 +251,21 @@ internal class GraphQLExtensionsTest {
         assertTrue(result is GraphQLUnionType)
         verify(exactly = 1) { mockWiring.onUnion(mockEnvironment) }
     }
+
+    @Test
+    fun `safeCast valid type passes`() {
+        val type: GraphQLType = GraphQLInterfaceType("name", "description", emptyList(), mockk())
+
+        val castedType = type.safeCast<GraphQLInterfaceType>()
+        assertEquals("name", castedType.name)
+    }
+
+    @Test
+    fun `safeCast valid type to the wrong type fails`() {
+        val type: GraphQLType = GraphQLObjectType("name", "description", emptyList(), mockk())
+
+        assertFailsWith(CouldNotCastGraphQLType::class) {
+            type.safeCast<GraphQLInterfaceType>()
+        }
+    }
 }
diff --git a/src/test/kotlin/com/expedia/graphql/generator/extensions/KClassExtensionsTest.kt b/src/test/kotlin/com/expedia/graphql/generator/extensions/KClassExtensionsTest.kt
@@ -3,10 +3,10 @@ package com.expedia.graphql.generator.extensions
 import com.expedia.graphql.exceptions.CouldNotGetNameOfKClassException
 import com.expedia.graphql.hooks.NoopSchemaGeneratorHooks
 import com.expedia.graphql.hooks.SchemaGeneratorHooks
+import org.junit.jupiter.api.Test
 import kotlin.reflect.KClass
 import kotlin.reflect.KFunction
 import kotlin.reflect.KProperty
-import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
 import kotlin.test.assertFalse
diff --git a/src/test/kotlin/com/expedia/graphql/generator/filters/SuperclassFiltersKtTest.kt b/src/test/kotlin/com/expedia/graphql/generator/filters/SuperclassFiltersKtTest.kt
@@ -1,7 +1,7 @@
 package com.expedia.graphql.generator.filters
 
+import org.junit.jupiter.api.Test
 import kotlin.reflect.KClass
-import kotlin.test.Test
 import kotlin.test.assertFalse
 import kotlin.test.assertTrue
 
diff --git a/src/test/kotlin/com/expedia/graphql/generator/types/MutationTypeBuilderTest.kt b/src/test/kotlin/com/expedia/graphql/generator/types/MutationTypeBuilderTest.kt
@@ -7,8 +7,8 @@ import com.expedia.graphql.exceptions.InvalidMutationTypeException
 import com.expedia.graphql.generator.extensions.isTrue
 import com.expedia.graphql.hooks.SchemaGeneratorHooks
 import graphql.schema.GraphQLFieldDefinition
+import org.junit.jupiter.api.Test
 import kotlin.reflect.KFunction
-import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
 import kotlin.test.assertFalse
diff --git a/src/test/kotlin/com/expedia/graphql/generator/types/ObjectTypeBuilderTest.kt b/src/test/kotlin/com/expedia/graphql/generator/types/ObjectTypeBuilderTest.kt
@@ -11,7 +11,7 @@ import kotlin.test.assertEquals
 import kotlin.test.assertNotNull
 
 @Suppress("Detekt.UnusedPrivateClass")
-internal class ObjectTypeTest : TypeTestHelper() {
+internal class ObjectTypeBuilderTest : TypeTestHelper() {
 
     private lateinit var builder: ObjectTypeBuilder
 
diff --git a/src/test/kotlin/com/expedia/graphql/generator/types/QueryTypeBuilderTest.kt b/src/test/kotlin/com/expedia/graphql/generator/types/QueryTypeBuilderTest.kt
@@ -8,8 +8,8 @@ import com.expedia.graphql.exceptions.InvalidSchemaException
 import com.expedia.graphql.generator.extensions.isTrue
 import com.expedia.graphql.hooks.SchemaGeneratorHooks
 import graphql.schema.GraphQLFieldDefinition
+import org.junit.jupiter.api.Test
 import kotlin.reflect.KFunction
-import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
 import kotlin.test.assertFalse
diff --git a/src/test/kotlin/com/expedia/graphql/generator/types/ScalarTypeBuilderTest.kt b/src/test/kotlin/com/expedia/graphql/generator/types/ScalarTypeBuilderTest.kt
@@ -3,12 +3,12 @@ package com.expedia.graphql.generator.types
 import com.expedia.graphql.exceptions.InvalidIdTypeException
 import graphql.Scalars
 import graphql.schema.GraphQLScalarType
+import org.junit.jupiter.api.Test
 import java.math.BigDecimal
 import java.math.BigInteger
 import java.util.UUID
 import kotlin.reflect.KType
 import kotlin.reflect.full.createType
-import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
 
diff --git a/src/test/kotlin/com/expedia/graphql/generator/types/TypeTestHelper.kt b/src/test/kotlin/com/expedia/graphql/generator/types/TypeTestHelper.kt
@@ -35,6 +35,7 @@ internal open class TypeTestHelper {
 
     private var scalarTypeBuilder: ScalarTypeBuilder? = null
     private var objectTypeBuilder: ObjectTypeBuilder? = null
+    private var interfaceTypeBuilder: InterfaceTypeBuilder? = null
     private var directiveTypeBuilder: DirectiveTypeBuilder? = null
     private var functionTypeBuilder: FunctionTypeBuilder? = null
     private var propertyTypeBuilder: PropertyTypeBuilder? = null
@@ -72,6 +73,11 @@ internal open class TypeTestHelper {
             objectTypeBuilder!!.objectType(it.invocation.args[0] as KClass<*>, it.invocation.args[1] as GraphQLInterfaceType?)
         }
 
+        interfaceTypeBuilder = spyk(InterfaceTypeBuilder(generator))
+        every { generator.interfaceType(any()) } answers {
+            interfaceTypeBuilder!!.interfaceType(it.invocation.args[0] as KClass<*>)
+        }
+
         directiveTypeBuilder = spyk(DirectiveTypeBuilder(generator))
         every { generator.directives(any()) } answers {
             val directives = directiveTypeBuilder!!.directives(it.invocation.args[0] as KAnnotatedElement)
diff --git a/src/test/kotlin/com/expedia/graphql/hooks/SchemaGeneratorHooksTest.kt b/src/test/kotlin/com/expedia/graphql/hooks/SchemaGeneratorHooksTest.kt
@@ -9,11 +9,11 @@ import graphql.schema.GraphQLFieldDefinition
 import graphql.schema.GraphQLObjectType
 import graphql.schema.GraphQLSchema
 import graphql.schema.GraphQLType
+import org.junit.jupiter.api.Test
 import kotlin.reflect.KFunction
 import kotlin.reflect.KProperty
 import kotlin.reflect.KType
 import kotlin.reflect.full.createType
-import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFalse
 import kotlin.test.assertNotNull
diff --git a/src/test/kotlin/com/expedia/graphql/integration/NodeGraphTest.kt b/src/test/kotlin/com/expedia/graphql/integration/NodeGraphTest.kt
@@ -3,7 +3,7 @@ package com.expedia.graphql.integration
 import com.expedia.graphql.TopLevelObject
 import com.expedia.graphql.testSchemaConfig
 import com.expedia.graphql.toSchema
-import kotlin.test.Test
+import org.junit.jupiter.api.Test
 import kotlin.test.assertEquals
 
 class NodeGraphTest {
diff --git a/src/test/kotlin/com/expedia/graphql/integration/OptionalResultsTest.kt b/src/test/kotlin/com/expedia/graphql/integration/OptionalResultsTest.kt
@@ -4,7 +4,7 @@ import com.expedia.graphql.TopLevelObject
 import com.expedia.graphql.testSchemaConfig
 import com.expedia.graphql.toSchema
 import graphql.GraphQL
-import kotlin.test.Test
+import org.junit.jupiter.api.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertNotNull
 import kotlin.test.assertNull
diff --git a/src/test/kotlin/com/expedia/graphql/integration/RecursiveInterfaceTest.kt b/src/test/kotlin/com/expedia/graphql/integration/RecursiveInterfaceTest.kt
diff --git a/src/test/kotlin/com/expedia/graphql/integration/RecursiveUnionTest.kt b/src/test/kotlin/com/expedia/graphql/integration/RecursiveUnionTest.kt
