Move validation tests to apollo-ast (#6868)

Author: martinbonnin

libraries/apollo-ast/src/jvmTest/kotlin/com/apollographql/apollo/graphql/ast/test/ExecutableValidationTest.kt

@@ -0,0 +1,77 @@
+package com.apollographql.apollo.graphql.ast.test
+
+import com.apollographql.apollo.ast.DirectiveRedefinition
+import com.apollographql.apollo.ast.GraphQLIssue
+import com.apollographql.apollo.ast.Schema
+import com.apollographql.apollo.ast.parseAsGQLDocument
+import com.apollographql.apollo.ast.toGQLDocument
+import com.apollographql.apollo.ast.validateAsExecutable
+import com.apollographql.apollo.ast.validateAsSchema
+import com.google.testing.junit.testparameterinjector.TestParameter
+import com.google.testing.junit.testparameterinjector.TestParameterInjector
+import com.google.testing.junit.testparameterinjector.TestParameterValuesProvider
+import okio.buffer
+import okio.source
+import org.junit.Test
+import org.junit.runner.RunWith
+import java.io.File
+
+@RunWith(TestParameterInjector::class)
+class ExecutableValidationTest {
+  @Test
+  fun testValidation(@TestParameter(valuesProvider = ParametersProvider::class) graphQLFile: File) {
+    findSchemaAndCheck(graphQLFile) { schema ->
+      val parseResult = graphQLFile.source().buffer().parseAsGQLDocument(graphQLFile.name)
+      val issues = if (parseResult.issues.isNotEmpty()) {
+        parseResult.issues
+      } else {
+        parseResult.getOrThrow().validateAsExecutable(schema = schema).issues
+      }
+
+      issues.serialize()
+    }
+  }
+
+  private fun findSchemaAndCheck(graphQLFile: File, block: (schema: Schema) -> String) {
+    var parent = graphQLFile.parentFile
+
+    // We're in src/test/validation/operation/...
+    // Find the closest schema
+    var schema: Schema? = null
+    while (parent.name != "test") {
+      val candidate = parent.resolve("schema.graphqls")
+      if (candidate.exists()) {
+        val pragmas = candidate.pragmas()
+        schema = candidate.toGQLDocument().validateAsSchema(
+            candidate.pragmas().toSchemaValidationOptions()
+        ).let {
+          it.issues.forEach {
+            when (it) {
+              is DirectiveRedefinition -> if (Pragma.allowDirectiveRedefinition in pragmas) return@forEach
+              is GraphQLIssue -> error("Cannot validate schema: $it")
+              else -> error("Unexpected issue type: ${it::class.simpleName}")
+            }
+          }
+          it.value!!
+        }
+        break
+      }
+      parent = parent.parentFile
+    }
+    check(schema != null) {
+      "Cannot find a schema for $graphQLFile"
+    }
+
+    val actual = block(schema)
+
+    checkExpected(graphQLFile) {
+      actual
+    }
+  }
+  class ParametersProvider : TestParameterValuesProvider() {
+    override fun provideValues(context: Context?): List<File> {
+      return findFiles("test-fixtures/validation/executable")
+          .filter { it.name.endsWith(".graphql") }
+    }
+  }
+}

libraries/apollo-ast/src/jvmTest/kotlin/com/apollographql/apollo/graphql/ast/test/MergerTest.kt

@@ -1,7 +1,5 @@
 package com.apollographql.apollo.graphql.ast.test
 
-import com.apollographql.apollo.ast.MergeOptions
-import com.apollographql.apollo.ast.ParserOptions
 import com.apollographql.apollo.ast.mergeExtensions
 import com.apollographql.apollo.ast.parseAsGQLDocument
 import com.google.testing.junit.testparameterinjector.TestParameter
@@ -26,13 +24,8 @@ class MergerTest {
 
   class ParametersProvider : TestParameterValuesProvider() {
     override fun provideValues(context: Context?): List<File> {
-      return File("test-fixtures/merger/")
-          .listFiles()!!
+      return findFiles("test-fixtures/merger")
           .filter { it.name.endsWith(".graphql") && !it.name.endsWith(".expected.graphql") }
-          .sortedBy { it.name }
-          .filter {
-            testFilterMatches(it.name)
-          }
     }
   }
 }

libraries/apollo-ast/src/jvmTest/kotlin/com/apollographql/apollo/graphql/ast/test/ParserTest.kt

@@ -21,13 +21,8 @@ class ParserTest {
 
   class ParametersProvider : TestParameterValuesProvider() {
     override fun provideValues(context: Context?): List<File> {
-      return File("test-fixtures/parser/")
-          .listFiles()!!
-          .filter { it.name.endsWith(".graphql") && !it.name.endsWith(".expected.graphql") }
-          .sortedBy { it.name }
-          .filter {
-            testFilterMatches(it.name)
-          }
+      return findFiles("test-fixtures/parser")
+          .filter { it.extension in setOf("graphql", "graphqls")  }
     }
   }
 }

libraries/apollo-ast/src/jvmTest/kotlin/com/apollographql/apollo/graphql/ast/test/SchemaValidationTest.kt

@@ -0,0 +1,33 @@
+package com.apollographql.apollo.graphql.ast.test
+
+import com.apollographql.apollo.ast.toGQLDocument
+import com.apollographql.apollo.ast.validateAsSchema
+import com.google.testing.junit.testparameterinjector.TestParameter
+import com.google.testing.junit.testparameterinjector.TestParameterInjector
+import com.google.testing.junit.testparameterinjector.TestParameterValuesProvider
+import org.junit.Test
+import org.junit.runner.RunWith
+import java.io.File
+
+@RunWith(TestParameterInjector::class)
+class SchemaValidationTest {
+  @Test
+  fun testValidation(@TestParameter(valuesProvider = ParametersProvider::class) graphqlsFile: File) {
+
+    checkExpected(graphqlsFile) {
+      val pragmas = graphqlsFile.pragmas()
+      val parseResult = graphqlsFile.toGQLDocument().validateAsSchema(
+          pragmas.toSchemaValidationOptions()
+      )
+
+      parseResult.issues.serialize()
+    }
+  }
+
+  class ParametersProvider : TestParameterValuesProvider() {
+    override fun provideValues(context: Context?): List<File> {
+      return findFiles("test-fixtures/validation/schema")
+          .filter { it.name.endsWith(".graphqls") }
+    }
+  }
+}

libraries/apollo-ast/src/jvmTest/kotlin/com/apollographql/apollo/graphql/ast/test/fixtures.kt

@@ -6,13 +6,14 @@ import com.apollographql.apollo.ast.Issue
 import com.apollographql.apollo.ast.MergeOptions
 import com.apollographql.apollo.ast.ParserOptions
 import com.apollographql.apollo.ast.SchemaValidationOptions
+import com.apollographql.apollo.ast.builtinForeignSchemas
 import com.apollographql.apollo.ast.toUtf8
 import java.io.File
 import kotlin.test.assertEquals
 
 private const val separator = "\n------------\n"
 
-private fun List<Issue>.serialize() = joinToString(separator) {
+internal fun List<Issue>.serialize() = joinToString(separator) {
   "${it.javaClass.simpleName} (${it.sourceLocation?.line}:${it.sourceLocation?.column})\n${it.message}"
 }
 
@@ -37,14 +38,14 @@ internal fun testFilterMatches(value: String): Boolean {
 }
 
 /**
- * Run the block and checks the result against the .expected file. Will overwrite the result if required
+ * Run the block and checks the result against the .expected.graphql file. Will overwrite the result if required
  *
  * @param block the callback to produce the result.
  */
 internal fun checkExpected(graphQLFile: File, block: (File) -> String) {
   val actual = block(graphQLFile)
 
-  val expectedFile = File(graphQLFile.parent, graphQLFile.nameWithoutExtension + ".expected.graphql")
+  val expectedFile = File(graphQLFile.parent, graphQLFile.nameWithoutExtension + ".expected")
   val expected = try {
     expectedFile.readText()
   } catch (e: Exception) {
@@ -58,10 +59,26 @@ internal fun checkExpected(graphQLFile: File, block: (File) -> String) {
   }
 }
 
+internal fun findFiles(path: String): List<File> {
+  return File(path)
+      .walk()
+      .filter {
+        testFilterMatches(it.name)
+      }
+      .toList()
+      .sortedBy { it.name }
+}
 enum class Pragma {
-  allowMergingFieldDefinitions,
+  // Parser
   allowDirectivesOnDirectives,
   allowServiceCapabilities,
+  // Merger
+  allowMergingFieldDefinitions,
+  // Schema validation
+  addBuiltinForeignSchemas,
+  addKotlinLabsDefinitions,
+  //
+  allowDirectiveRedefinition,
 }
 
 fun File.pragmas(): List<Pragma> =
@@ -82,4 +99,17 @@ fun List<Pragma>.toParserOptions(): ParserOptions {
 
 fun List<Pragma>.toMergerOptions(): MergeOptions {
   return MergeOptions(Pragma.allowMergingFieldDefinitions in this)
+}
+
+fun List<Pragma>.toSchemaValidationOptions(): SchemaValidationOptions {
+  return SchemaValidationOptions.Builder()
+      .apply {
+        if (Pragma.addBuiltinForeignSchemas in this@toSchemaValidationOptions) {
+          foreignSchemas(builtinForeignSchemas())
+        }
+        if (Pragma.addKotlinLabsDefinitions in this@toSchemaValidationOptions) {
+          addKotlinLabsDefinitions(true)
+        }
+      }
+      .build()
 }