Example for doing a full schema unit test

examples/graphql_examples/tests/src/Kernel/Schema/ExampleSchemaTest.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace Drupal\Tests\graphql_example\Kernel;
+
+use Drupal\Core\Cache\CacheableMetadata;
+use Drupal\node\Entity\Node;
+use Drupal\node\Entity\NodeType;
+use Drupal\Tests\graphql\Kernel\GraphQLTestBase;
+use Drupal\user\Entity\User;
+
+/**
+ * Runs unit tests agains the `example` schema defined in `graphql_examples`.
+ *
+ * @group graphql
+ */
+class ExampleSchemaTest extends GraphQLTestBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static $modules = ['graphql_examples'];
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function setUp() :void {
+ parent::setUp();
+ // Create the "article" node type since the schema relies on it.
+ NodeType::create([
+ 'type' => 'article',
+ 'name' => 'Article',
+ ]);
+
+ // Create a test-server that uses the schema plugin defined in this module.
+ $this->createTestServer('example', '/graphql');
+ }
+
+ /**
+ * Test the example schema for article listing.
+ */
+ public function testExampleSchema() : void {
+ // Create two authors.
+ $userA = User::create([
+ 'name' => 'A',
+ ]);
+ $userA->save();
+
+ $userB = User::create([
+ 'name' => 'B',
+ ]);
+ $userB->save();
+
+ // Create three articles.
+ Node::create([
+ 'type' => 'article',
+ 'title' => 'One',
+ 'uid' => $userA->id(),
+ ])->save();
+
+ Node::create([
+ 'type' => 'article',
+ 'title' => 'Two',
+ 'uid' => $userB->id(),
+ ])->save();
+
+ Node::create([
+ 'type' => 'article',
+ 'title' => 'Three',
+ 'uid' => $userA->id(),
+ ])->save();
+
+ // Execute the query and run assertions against its response content.
+ $this->assertResults('{ articles { total, items { title, author } } }', [], [
+ 'articles' => [
+ 'total' => 3,
+ 'items' => [
+ ['title' => 'ONE', 'author' => 'A'],
+ ['title' => 'TWO', 'author' => 'B'],
+ ['title' => 'THREE', 'author' => 'A'],
+ ],
+ ],
+ ], $this->defaultCacheMetaData()
+ ->addCacheContexts(['user.node_grants:view'])
+ ->addCacheTags(['node:1', 'node:2', 'node:3', 'node_list', 'user:3', 'user:4'])
+ );
+ }
+
+}

phpcs.xml.dist

@@ -123,10 +123,10 @@
  <exclude-pattern>src/Plugin/GraphQL/Schema/SdlSchemaPluginBase.php</exclude-pattern>
  <exclude-pattern>src/Plugin/DataProducerPluginManager.php</exclude-pattern>
  <exclude-pattern>src/Controller/RequestController.php</exclude-pattern>
- <exclude-pattern>examples/graphql_example/src/Wrappers/QueryConnection.php</exclude-pattern>
- <exclude-pattern>examples/graphql_example/src/Plugin/GraphQL/DataProducer/QueryArticles.php</exclude-pattern>
- <exclude-pattern>examples/graphql_example/src/Plugin/GraphQL/Schema/ExampleSchema.php</exclude-pattern>
- <exclude-pattern>examples/graphql_example/src/Plugin/GraphQL/SchemaExtension/ExampleSchemaExtension.php</exclude-pattern>
+ <exclude-pattern>examples/graphql_examples/src/Wrappers/QueryConnection.php</exclude-pattern>
+ <exclude-pattern>examples/graphql_examples/src/Plugin/GraphQL/DataProducer/QueryArticles.php</exclude-pattern>
+ <exclude-pattern>examples/graphql_examples/src/Plugin/GraphQL/Schema/ExampleSchema.php</exclude-pattern>
+ <exclude-pattern>examples/graphql_examples/src/Plugin/GraphQL/SchemaExtension/ExampleSchemaExtension.php</exclude-pattern>
  <exclude-pattern>tests/src/Traits/MockingTrait.php</exclude-pattern>
  <exclude-pattern>tests/src/Traits/DataProducerExecutionTrait.php</exclude-pattern>
  <exclude-pattern>tests/src/Kernel/ResolverBuilderTest.php</exclude-pattern>
@@ -193,8 +193,8 @@
  <exclude-pattern>src/Plugin/DataProducerPluginManager.php</exclude-pattern>
  <exclude-pattern>src/Plugin/DataProducerPluginCachingInterface.php</exclude-pattern>
  <exclude-pattern>src/Controller/RequestController.php</exclude-pattern>
- <exclude-pattern>examples/graphql_example/src/Wrappers/QueryConnection.php</exclude-pattern>
- <exclude-pattern>examples/graphql_example/src/Plugin/GraphQL/DataProducer/QueryArticles.php</exclude-pattern>
+ <exclude-pattern>examples/graphql_examples/src/Wrappers/QueryConnection.php</exclude-pattern>
+ <exclude-pattern>examples/graphql_examples/src/Plugin/GraphQL/DataProducer/QueryArticles.php</exclude-pattern>
  <exclude-pattern>tests/src/Traits/DataProducerExecutionTrait.php</exclude-pattern>
  <exclude-pattern>tests/src/Kernel/ResolverBuilderTest.php</exclude-pattern>
  <exclude-pattern>tests/src/Kernel/DataProducer/XML/XMLTestBase.php</exclude-pattern>