Refactor federation validation unit tests (ExpediaGroup#540)

* Refactor federaion validation unit tests

Create new unit tests that call the the federation validation functions directly so we don't have to create a entire schema. This will make it easier to clear out other areas now that we delete these tests

* Add javadocs to unit test

* Update graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/federation/FederatedSchemaValidatorTest.kt

Co-Authored-By: Dariusz Kuc <[email protected]>

* Update unit test to valid key directive

* Update requires directive tests

* Add id field for proper @key

* Update requires directive tests

* Remove unused varialbe

* Add federation directive tests with annotations

* Fix ktlint

* Update graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/federation/FederatedSchemaValidatorTest.kt

Co-Authored-By: Dariusz Kuc <[email protected]>

* Update graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/federation/FederatedSchemaValidatorTest.kt

Co-Authored-By: Dariusz Kuc <[email protected]>

* Update directive names

* Update test description for key directive

* Update test name

* Update graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/federation/validation/ValidateKeySetFieldKtTest.kt

Co-Authored-By: Dariusz Kuc <[email protected]>

Co-authored-by: Dariusz Kuc <[email protected]>

Author: smyrick

graphql-kotlin-federation/pom.xml

@@ -42,6 +42,10 @@
                                             <counter>INSTRUCTION</counter>
                                             <minimum>0.95</minimum>
                                         </limit>
+                                        <limit>
+                                            <counter>BRANCH</counter>
+                                            <minimum>0.94</minimum>
+                                        </limit>
                                     </limits>
                                 </rule>
                             </rules>

graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/FederatedSchemaGeneratorHooks.kt

@@ -19,6 +19,7 @@ package com.expediagroup.graphql.federation
 import com.expediagroup.graphql.annotations.GraphQLName
 import com.expediagroup.graphql.extensions.print
 import com.expediagroup.graphql.federation.directives.FieldSet
+import com.expediagroup.graphql.federation.directives.KEY_DIRECTIVE_NAME
 import com.expediagroup.graphql.federation.directives.extendsDirectiveType
 import com.expediagroup.graphql.federation.execution.EntityResolver
 import com.expediagroup.graphql.federation.execution.FederatedTypeRegistry
@@ -91,7 +92,7 @@ open class FederatedSchemaGeneratorHooks(private val federatedTypeRegistry: Fede
         val entityTypeNames = originalSchema.allTypesAsList
             .asSequence()
             .filterIsInstance<GraphQLObjectType>()
-            .filter { type -> type.getDirective("key") != null }
+            .filter { type -> type.getDirective(KEY_DIRECTIVE_NAME) != null }
             .map { it.name }
             .toSet()
 

graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/FederatedSchemaValidator.kt

@@ -16,6 +16,11 @@
 
 package com.expediagroup.graphql.federation
 
+import com.expediagroup.graphql.federation.directives.EXTENDS_DIRECTIVE_NAME
+import com.expediagroup.graphql.federation.directives.EXTERNAL_DIRECTIVE_NAME
+import com.expediagroup.graphql.federation.directives.KEY_DIRECTIVE_NAME
+import com.expediagroup.graphql.federation.directives.PROVIDES_DIRECTIVE_NAME
+import com.expediagroup.graphql.federation.directives.REQUIRES_DIRECTIVE_NAME
 import com.expediagroup.graphql.federation.exception.InvalidFederatedSchema
 import com.expediagroup.graphql.federation.extensions.isFederatedType
 import com.expediagroup.graphql.federation.validation.validateDirective
@@ -55,29 +60,29 @@ class FederatedSchemaValidator {
     private fun validate(federatedType: String, fields: List<GraphQLFieldDefinition>, directives: Map<String, GraphQLDirective>) {
         val errors = mutableListOf<String>()
         val fieldMap = fields.associateBy { it.name }
-        val extendedType = directives.containsKey("extends")
+        val extendedType = directives.containsKey(EXTENDS_DIRECTIVE_NAME)
 
         // [OK]    @key directive is specified
         // [OK]    @key references valid existing fields
         // [OK]    @key on @extended type references @external fields
         // [ERROR] @key references fields resulting in list
         // [ERROR] @key references fields resulting in union
         // [ERROR] @key references fields resulting in interface
-        errors.addAll(validateDirective(federatedType, "key", directives, fieldMap, extendedType))
+        errors.addAll(validateDirective(federatedType, KEY_DIRECTIVE_NAME, directives, fieldMap, extendedType))
 
         for (field in fields) {
-            if (field.getDirective("requires") != null) {
+            if (field.getDirective(REQUIRES_DIRECTIVE_NAME) != null) {
                 errors.addAll(validateRequiresDirective(federatedType, field, fieldMap, extendedType))
             }
 
-            if (field.getDirective("provides") != null) {
+            if (field.getDirective(PROVIDES_DIRECTIVE_NAME) != null) {
                 errors.addAll(validateProvidesDirective(federatedType, field))
             }
         }
 
         // [ERROR] federated base type references @external fields
         if (!extendedType) {
-            val externalFields = fields.filter { it.getDirective("external") != null }.map { it.name }
+            val externalFields = fields.filter { it.getDirective(EXTERNAL_DIRECTIVE_NAME) != null }.map { it.name }
             if (externalFields.isNotEmpty()) {
                 errors.add("base $federatedType type has fields marked with @external directive, fields=$externalFields")
             }

graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/directives/ExtendsDirective.kt

@@ -19,7 +19,7 @@ package com.expediagroup.graphql.federation.directives
 import com.expediagroup.graphql.annotations.GraphQLDirective
 import graphql.introspection.Introspection
 
-private const val NAME = "extends"
+internal const val EXTENDS_DIRECTIVE_NAME = "extends"
 private const val DESCRIPTION = "Marks target object as extending part of the federated schema"
 
 /**
@@ -53,14 +53,14 @@ private const val DESCRIPTION = "Marks target object as extending part of the fe
  * @see KeyDirective
  */
 @GraphQLDirective(
-    name = NAME,
+    name = EXTENDS_DIRECTIVE_NAME,
     description = DESCRIPTION,
     locations = [Introspection.DirectiveLocation.OBJECT, Introspection.DirectiveLocation.INTERFACE]
 )
 annotation class ExtendsDirective
 
-val extendsDirectiveType: graphql.schema.GraphQLDirective = graphql.schema.GraphQLDirective.newDirective()
-    .name(NAME)
+internal val extendsDirectiveType: graphql.schema.GraphQLDirective = graphql.schema.GraphQLDirective.newDirective()
+    .name(EXTENDS_DIRECTIVE_NAME)
     .description(DESCRIPTION)
     .validLocations(Introspection.DirectiveLocation.OBJECT, Introspection.DirectiveLocation.INTERFACE)
     .build()

graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/directives/ExternalDirective.kt

@@ -52,8 +52,10 @@ import graphql.introspection.Introspection
  * @see RequiresDirective
  */
 @GraphQLDirective(
-    name = "external",
+    name = EXTERNAL_DIRECTIVE_NAME,
     description = "Marks target field as external meaning it will be resolved by federated schema",
     locations = [Introspection.DirectiveLocation.FIELD_DEFINITION]
 )
 annotation class ExternalDirective
+
+internal const val EXTERNAL_DIRECTIVE_NAME = "external"

graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/directives/KeyDirective.kt

@@ -55,8 +55,10 @@ import graphql.introspection.Introspection
  * @see ExternalDirective
  */
 @GraphQLDirective(
-    name = "key",
+    name = KEY_DIRECTIVE_NAME,
     description = "Space separated list of primary keys needed to access federated object",
     locations = [Introspection.DirectiveLocation.OBJECT, Introspection.DirectiveLocation.INTERFACE]
 )
 annotation class KeyDirective(val fields: FieldSet)
+
+internal const val KEY_DIRECTIVE_NAME = "key"

graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/directives/ProvidesDirective.kt

@@ -68,8 +68,10 @@ import graphql.introspection.Introspection
  * @see ExtendsDirective
  */
 @GraphQLDirective(
-    name = "provides",
+    name = PROVIDES_DIRECTIVE_NAME,
     description = "Specifies the base type field set that will be selectable by the gateway",
     locations = [Introspection.DirectiveLocation.FIELD_DEFINITION]
 )
 annotation class ProvidesDirective(val fields: FieldSet)
+
+internal const val PROVIDES_DIRECTIVE_NAME = "provides"

graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/directives/RequiresDirective.kt

@@ -73,8 +73,10 @@ import graphql.introspection.Introspection
  * @see kotlin.properties.Delegates.notNull
  */
 @GraphQLDirective(
-    name = "requires",
+    name = REQUIRES_DIRECTIVE_NAME,
     description = "Specifies required input field set from the base type for a resolver",
     locations = [Introspection.DirectiveLocation.FIELD_DEFINITION]
 )
 annotation class RequiresDirective(val fields: FieldSet)
+
+internal const val REQUIRES_DIRECTIVE_NAME = "requires"

graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/extensions/GraphQLDirectiveContainerExtensions.kt

@@ -16,8 +16,10 @@
 
 package com.expediagroup.graphql.federation.extensions
 
+import com.expediagroup.graphql.federation.directives.EXTENDS_DIRECTIVE_NAME
+import com.expediagroup.graphql.federation.directives.KEY_DIRECTIVE_NAME
 import graphql.schema.GraphQLDirectiveContainer
 
-internal fun GraphQLDirectiveContainer.isFederatedType() = this.getDirective("key") != null || isExtendedType()
+internal fun GraphQLDirectiveContainer.isFederatedType() = this.getDirective(KEY_DIRECTIVE_NAME) != null || isExtendedType()
 
-internal fun GraphQLDirectiveContainer.isExtendedType() = this.getDirective("extends") != null
+internal fun GraphQLDirectiveContainer.isExtendedType() = this.getDirective(EXTENDS_DIRECTIVE_NAME) != null

graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/validation/validateKeySetField.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.federation.validation
 
+import com.expediagroup.graphql.federation.directives.EXTERNAL_DIRECTIVE_NAME
 import graphql.schema.GraphQLFieldDefinition
 import graphql.schema.GraphQLInterfaceType
 import graphql.schema.GraphQLList
@@ -24,7 +25,7 @@ import graphql.schema.GraphQLUnionType
 
 internal fun validateKeySetField(targetField: GraphQLFieldDefinition?, extendedType: Boolean, errors: MutableList<String>, validatedDirective: String) {
     if (null != targetField) {
-        val externalField = targetField.getDirective("external") != null
+        val externalField = targetField.getDirective(EXTERNAL_DIRECTIVE_NAME) != null
         if (extendedType && !externalField) {
             errors.add("$validatedDirective specifies invalid field set - extended type incorrectly references local field=${targetField.name}")
         } else if (!extendedType && externalField) {

graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/validation/validateProvidesDirective.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.federation.validation
 
+import com.expediagroup.graphql.federation.directives.PROVIDES_DIRECTIVE_NAME
 import com.expediagroup.graphql.federation.extensions.isExtendedType
 import graphql.schema.GraphQLFieldDefinition
 import graphql.schema.GraphQLObjectType
@@ -38,7 +39,7 @@ internal fun validateProvidesDirective(federatedType: String, field: GraphQLFiel
             // @provides is applicable on both base and federated types and always references @external fields
             validateDirective(
                 "$federatedType.${field.name}",
-                "provides",
+                PROVIDES_DIRECTIVE_NAME,
                 field.directivesByName,
                 returnTypeFields,
                 true)

graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/validation/validateRequiresDirective.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.federation.validation
 
+import com.expediagroup.graphql.federation.directives.REQUIRES_DIRECTIVE_NAME
 import graphql.schema.GraphQLFieldDefinition
 
 // [OK]    @requires references valid fields marked @external
@@ -24,7 +25,7 @@ import graphql.schema.GraphQLFieldDefinition
 internal fun validateRequiresDirective(validatedType: String, validatedField: GraphQLFieldDefinition, fieldMap: Map<String, GraphQLFieldDefinition>, extendedType: Boolean): List<String> {
     val errors = mutableListOf<String>()
     if (extendedType) {
-        errors.addAll(validateDirective("$validatedType.${validatedField.name}", "requires", validatedField.directivesByName, fieldMap, extendedType))
+        errors.addAll(validateDirective("$validatedType.${validatedField.name}", REQUIRES_DIRECTIVE_NAME, validatedField.directivesByName, fieldMap, extendedType))
     } else {
         errors.add("base $validatedType type has fields marked with @requires directive, validatedField=${validatedField.name}")
     }

graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/federation/FederatedSchemaGeneratorTest.kt

@@ -20,6 +20,7 @@ import com.expediagroup.graphql.TopLevelObject
 import com.expediagroup.graphql.extensions.print
 import com.expediagroup.graphql.federation.data.queries.simple.NestedQuery
 import com.expediagroup.graphql.federation.data.queries.simple.SimpleQuery
+import com.expediagroup.graphql.federation.directives.KEY_DIRECTIVE_NAME
 import com.expediagroup.graphql.federation.execution.FederatedTypeRegistry
 import graphql.schema.GraphQLUnionType
 import org.junit.jupiter.api.Assertions.assertEquals
@@ -112,7 +113,7 @@ class FederatedSchemaGeneratorTest {
         assertEquals(FEDERATED_SDL, schema.print().trim())
         val productType = schema.getObjectType("Book")
         assertNotNull(productType)
-        assertNotNull(productType.getDirective("key"))
+        assertNotNull(productType.getDirective(KEY_DIRECTIVE_NAME))
 
         val entityUnion = schema.getType("_Entity") as? GraphQLUnionType
         assertNotNull(entityUnion)