Simplify test trait setup (nuwave#2364)

spawnia · web-flow · commit a94535975091 · 2023-03-24T14:45:00.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,9 +9,11 @@ You can find and compare releases at the [GitHub release page](https://github.co
 
 ## Unreleased
 
+## v6.2.0
+
 ### Changed
 
-- Automatically setup `RefreshSchemaCache` trait.
+- Automatically set up test traits `RefreshSchemaCache` and `TestsSubscriptions`
 
 ## v6.1.0
 
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -7,6 +7,16 @@ This document provides guidance for upgrading between major versions of Lighthou
 The configuration options often change between major versions.
 Compare your `lighthouse.php` against the latest [default configuration](src/lighthouse.php).
 
+## v6 to v7
+
+### Leverage automatic test trait setup
+
+Methods you need to explicitly call to set up test traits were removed in favor of automatically set up test traits.
+Keep in mind they only work when your test class extends `Illuminate\Foundation\Testing\TestCase`.
+
+- Just remove calls to `Nuwave\Lighthouse\Testing\RefreshesSchemaCache::bootRefreshesSchemaCache()`.
+- Replace calls to `Nuwave\Lighthouse\Testing\MakesGraphQLRequests::setUpSubscriptionEnvironment()` with ` use Nuwave\Lighthouse\Testing\TestsSubscriptions`.
+
 ## v5 to v6
 
 ### `messages` on `@rules` and `@rulesForArray`
diff --git a/docs/6/testing/phpunit.md b/docs/6/testing/phpunit.md
@@ -4,8 +4,10 @@ Lighthouse makes it easy to add automated tests through [PHPUnit](https://phpuni
 
 ## Setup
 
-Lighthouse offers some useful test helpers that make it easy to call your API
-from within a PHPUnit test. Just add the `MakesGraphQLRequests` trait to your test class.
+Lighthouse offers some useful test helpers.
+Keep in mind they only work when your test class extends `Illuminate\Foundation\Testing\TestCase`.
+
+The `MakesGraphQLRequests` trait make it easy to call your API:
 
 ```diff
 +use Nuwave\Lighthouse\Testing\MakesGraphQLRequests;
@@ -18,8 +20,8 @@ abstract class TestCase extends BaseTestCase
 }
 ```
 
-Enabling the schema cache speeds up your tests. To ensure the schema is fresh
-before running tests, add the `RefreshesSchemaCache` trait to your test class and call it during set up.
+Enabling the schema cache speeds up your tests.
+To ensure the schema is fresh before running tests, add the `RefreshesSchemaCache` trait:
 
 ```diff
 +use Nuwave\Lighthouse\Testing\RefreshesSchemaCache;
@@ -29,13 +31,19 @@ abstract class TestCase extends BaseTestCase
 {
     use CreatesApplication;
 +   use RefreshesSchemaCache;
+}
+```
 
-    protected function setUp(): void
-    {
-        parent::setUp();
-+       $this->bootRefreshesSchemaCache();
-+       $this->setUpSubscriptionEnvironment(); // Only if you are using subscriptions
-    }
+If you want to test subscriptions, add the `TestsSubscriptions` trait:
+
+```diff
++use Nuwave\Lighthouse\Testing\TestsSubscriptions;
+use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
+
+abstract class TestCase extends BaseTestCase
+{
+    use CreatesApplication;
++   use TestsSubscriptions;
 }
 ```
 
diff --git a/docs/master/testing/phpunit.md b/docs/master/testing/phpunit.md
@@ -4,8 +4,10 @@ Lighthouse makes it easy to add automated tests through [PHPUnit](https://phpuni
 
 ## Setup
 
-Lighthouse offers some useful test helpers that make it easy to call your API
-from within a PHPUnit test. Just add the `MakesGraphQLRequests` trait to your test class.
+Lighthouse offers some useful test helpers.
+Keep in mind they only work when your test class extends `Illuminate\Foundation\Testing\TestCase`.
+
+The `MakesGraphQLRequests` trait make it easy to call your API:
 
 ```diff
 +use Nuwave\Lighthouse\Testing\MakesGraphQLRequests;
@@ -18,8 +20,8 @@ abstract class TestCase extends BaseTestCase
 }
 ```
 
-Enabling the schema cache speeds up your tests. To ensure the schema is fresh
-before running tests, add the `RefreshesSchemaCache` trait to your test class and call it during set up.
+Enabling the schema cache speeds up your tests.
+To ensure the schema is fresh before running tests, add the `RefreshesSchemaCache` trait:
 
 ```diff
 +use Nuwave\Lighthouse\Testing\RefreshesSchemaCache;
@@ -29,13 +31,19 @@ abstract class TestCase extends BaseTestCase
 {
     use CreatesApplication;
 +   use RefreshesSchemaCache;
+}
+```
 
-    protected function setUp(): void
-    {
-        parent::setUp();
-+       $this->bootRefreshesSchemaCache();
-+       $this->setUpSubscriptionEnvironment(); // Only if you are using subscriptions
-    }
+If you want to test subscriptions, add the `TestsSubscriptions` trait:
+
+```diff
++use Nuwave\Lighthouse\Testing\TestsSubscriptions;
+use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
+
+abstract class TestCase extends BaseTestCase
+{
+    use CreatesApplication;
++   use TestsSubscriptions;
 }
 ```
 
diff --git a/src/Testing/MakesGraphQLRequests.php b/src/Testing/MakesGraphQLRequests.php
@@ -232,6 +232,10 @@ protected function rethrowGraphQLErrors(): void
         $config->set('lighthouse.error_handlers', [RethrowingErrorHandler::class]);
     }
 
+    /**
+     * @deprecated use TestsSubscriptions
+     * TODO remove in the next major version
+     */
     protected function setUpSubscriptionEnvironment(): void
     {
         $app = Container::getInstance();
diff --git a/src/Testing/MakesGraphQLRequestsLumen.php b/src/Testing/MakesGraphQLRequestsLumen.php
@@ -253,6 +253,10 @@ protected function rethrowGraphQLErrors(): void
         $config->set('lighthouse.error_handlers', [RethrowingErrorHandler::class]);
     }
 
+    /**
+     * @deprecated use TestsSubscriptions
+     * TODO remove in the next major version
+     */
     protected function setUpSubscriptionEnvironment(): void
     {
         $app = Container::getInstance();
diff --git a/src/Testing/RefreshesSchemaCache.php b/src/Testing/RefreshesSchemaCache.php
@@ -24,7 +24,7 @@ trait RefreshesSchemaCache
      */
     protected static string $lockFilePath = __DIR__ . '/schema-cache-refreshing';
 
-    protected function bootRefreshesSchemaCache(): void
+    protected function setUpRefreshesSchemaCache(): void
     {
         if (! static::$schemaCacheWasRefreshed) {
             // We utilize the filesystem as shared mutable state to coordinate between processes,
@@ -48,8 +48,11 @@ protected function bootRefreshesSchemaCache(): void
         }
     }
 
-    protected function setUpRefreshesSchemaCache(): void
+    /**
+     * @deprecated TODO leverage automatic test trait setup, this method will be removed in the next major version
+     */
+    protected function bootRefreshesSchemaCache(): void
     {
-        $this->bootRefreshesSchemaCache();
+        $this->setUpRefreshesSchemaCache();
     }
 }
diff --git a/src/Testing/TestsSubscriptions.php b/src/Testing/TestsSubscriptions.php
@@ -0,0 +1,39 @@
+<?php declare(strict_types=1);
+
+namespace Nuwave\Lighthouse\Testing;
+
+use Illuminate\Container\Container;
+use Illuminate\Contracts\Config\Repository as ConfigRepository;
+use Nuwave\Lighthouse\Subscriptions\Broadcasters\LogBroadcaster;
+use Nuwave\Lighthouse\Subscriptions\BroadcastManager;
+use Nuwave\Lighthouse\Subscriptions\Contracts\Broadcaster;
+
+/**
+ * Sets up the environment for testing subscriptions.
+ */
+trait TestsSubscriptions
+{
+    protected function setUpTestsSubscriptions(): void
+    {
+        $app = Container::getInstance();
+
+        $config = $app->make(ConfigRepository::class);
+        $config->set('lighthouse.subscriptions.queue_broadcasts', false);
+        $config->set('lighthouse.subscriptions.storage', 'array');
+        $config->set('lighthouse.subscriptions.storage_ttl', null);
+
+        // binding an instance to the container, so it can be spied on
+        $app->bind(Broadcaster::class, static fn (ConfigRepository $config): \Nuwave\Lighthouse\Subscriptions\Broadcasters\LogBroadcaster => new LogBroadcaster(
+            $config->get('lighthouse.subscriptions.broadcasters.log'),
+        ));
+
+        $broadcastManager = $app->make(BroadcastManager::class);
+        assert($broadcastManager instanceof BroadcastManager);
+
+        // adding a custom driver which is a spied version of log driver
+        $broadcastManager->extend('mock', fn () => $this->spy(LogBroadcaster::class)->makePartial());
+
+        // set the custom driver as the default driver
+        $config->set('lighthouse.subscriptions.broadcaster', 'mock');
+    }
+}
diff --git a/tests/EnablesSubscriptionServiceProvider.php b/tests/EnablesSubscriptionServiceProvider.php
@@ -4,7 +4,7 @@
 
 use Nuwave\Lighthouse\Subscriptions\SubscriptionServiceProvider;
 
-trait TestsSubscriptions
+trait EnablesSubscriptionServiceProvider
 {
     protected function getPackageProviders($app): array
     {
diff --git a/tests/Integration/Subscriptions/Broadcast/BroadcastDBTest.php b/tests/Integration/Subscriptions/Broadcast/BroadcastDBTest.php
@@ -6,12 +6,12 @@
 use Nuwave\Lighthouse\Execution\Utils\Subscription;
 use Nuwave\Lighthouse\Subscriptions\SubscriptionBroadcaster;
 use Tests\DBTestCase;
-use Tests\TestsSubscriptions;
+use Tests\EnablesSubscriptionServiceProvider;
 use Tests\Utils\Models\Task;
 
 final class BroadcastDBTest extends DBTestCase
 {
-    use TestsSubscriptions;
+    use EnablesSubscriptionServiceProvider;
 
     protected string $schema = /** @lang GraphQL */ '
     type Task {
diff --git a/tests/Integration/Subscriptions/EchoBroadcaster/AuthorizeRequestsTest.php b/tests/Integration/Subscriptions/EchoBroadcaster/AuthorizeRequestsTest.php
@@ -4,14 +4,14 @@
 
 use Illuminate\Testing\TestResponse;
 use Nuwave\Lighthouse\Subscriptions\Storage\RedisStorageManager;
+use Tests\EnablesSubscriptionServiceProvider;
 use Tests\TestCase;
 use Tests\TestsRedis;
-use Tests\TestsSubscriptions;
 
 final class AuthorizeRequestsTest extends TestCase
 {
     use TestsRedis;
-    use TestsSubscriptions;
+    use EnablesSubscriptionServiceProvider;
 
     protected string $schema = /** @lang GraphQL */ '
     type Task {
diff --git a/tests/Integration/Subscriptions/SerializerTest.php b/tests/Integration/Subscriptions/SerializerTest.php
@@ -6,12 +6,12 @@
 use Nuwave\Lighthouse\Execution\ContextFactory;
 use Nuwave\Lighthouse\Subscriptions\Serializer;
 use Tests\DBTestCase;
-use Tests\TestsSubscriptions;
+use Tests\EnablesSubscriptionServiceProvider;
 use Tests\Utils\Models\User;
 
 final class SerializerTest extends DBTestCase
 {
-    use TestsSubscriptions;
+    use EnablesSubscriptionServiceProvider;
 
     public function testWillSerializeUserModelAndRetrieveItFromTheDatabaseWhenUnserializing(): void
     {
diff --git a/tests/Integration/Subscriptions/Storage/RedisStorageManagerTest.php b/tests/Integration/Subscriptions/Storage/RedisStorageManagerTest.php
@@ -6,14 +6,14 @@
 use Illuminate\Testing\TestResponse;
 use Nuwave\Lighthouse\Subscriptions\Storage\RedisStorageManager;
 use Nuwave\Lighthouse\Subscriptions\Subscriber;
+use Tests\EnablesSubscriptionServiceProvider;
 use Tests\TestCase;
 use Tests\TestsRedis;
-use Tests\TestsSubscriptions;
 
 final class RedisStorageManagerTest extends TestCase
 {
     use TestsRedis;
-    use TestsSubscriptions;
+    use EnablesSubscriptionServiceProvider;
 
     protected string $schema = /** @lang GraphQL */ '
     type Task {
diff --git a/tests/Integration/Subscriptions/SubscriptionTest.php b/tests/Integration/Subscriptions/SubscriptionTest.php
@@ -12,21 +12,23 @@
 use Nuwave\Lighthouse\Subscriptions\BroadcastManager;
 use Nuwave\Lighthouse\Subscriptions\Storage\CacheStorageManager;
 use Nuwave\Lighthouse\Subscriptions\Subscriber;
+use Nuwave\Lighthouse\Testing\TestsSubscriptions;
+use Tests\EnablesSubscriptionServiceProvider;
 use Tests\TestCase;
 use Tests\TestsRedis;
-use Tests\TestsSubscriptions;
 use Tests\Utils\Models\User;
 
 final class SubscriptionTest extends TestCase
 {
+    use EnablesSubscriptionServiceProvider;
     use TestsSubscriptions;
     use TestsRedis;
 
     protected function setUp(): void
     {
         parent::setUp();
 
-        $this->setUpSubscriptionEnvironment();
+        $this->setUpTestsSubscriptions();
 
         $this->mockResolverExpects($this->any())
             ->willReturnCallback(static fn (mixed $root, array $args): array => $args);
diff --git a/tests/Unit/Subscriptions/BroadcastManagerTest.php b/tests/Unit/Subscriptions/BroadcastManagerTest.php
@@ -10,12 +10,12 @@
 use Nuwave\Lighthouse\Subscriptions\Contracts\Broadcaster;
 use Nuwave\Lighthouse\Subscriptions\Subscriber;
 use Symfony\Component\HttpFoundation\Response;
+use Tests\EnablesSubscriptionServiceProvider;
 use Tests\TestCase;
-use Tests\TestsSubscriptions;
 
 final class BroadcastManagerTest extends TestCase
 {
-    use TestsSubscriptions;
+    use EnablesSubscriptionServiceProvider;
 
     /**
      * @var \Nuwave\Lighthouse\Subscriptions\BroadcastManager
diff --git a/tests/Unit/Subscriptions/Broadcasters/EchoBroadcasterTest.php b/tests/Unit/Subscriptions/Broadcasters/EchoBroadcasterTest.php
@@ -9,12 +9,12 @@
 use Nuwave\Lighthouse\Subscriptions\Events\EchoSubscriptionEvent;
 use Nuwave\Lighthouse\Subscriptions\Subscriber;
 use PHPUnit\Framework\Constraint\Callback;
+use Tests\EnablesSubscriptionServiceProvider;
 use Tests\TestCase;
-use Tests\TestsSubscriptions;
 
 final class EchoBroadcasterTest extends TestCase
 {
-    use TestsSubscriptions;
+    use EnablesSubscriptionServiceProvider;
 
     public function testBroadcast(): void
     {
diff --git a/tests/Unit/Subscriptions/Broadcasters/PusherBroadcasterTest.php b/tests/Unit/Subscriptions/Broadcasters/PusherBroadcasterTest.php
@@ -7,12 +7,12 @@
 use Nuwave\Lighthouse\Subscriptions\BroadcastManager;
 use Nuwave\Lighthouse\Subscriptions\Subscriber;
 use Psr\Log\LoggerInterface;
+use Tests\EnablesSubscriptionServiceProvider;
 use Tests\TestCase;
-use Tests\TestsSubscriptions;
 
 final class PusherBroadcasterTest extends TestCase
 {
-    use TestsSubscriptions;
+    use EnablesSubscriptionServiceProvider;
 
     public function testPusherUsesLoggerInterface(): void
     {
diff --git a/tests/Unit/Subscriptions/Iterators/IteratorTest.php b/tests/Unit/Subscriptions/Iterators/IteratorTest.php
@@ -10,12 +10,12 @@
 use Nuwave\Lighthouse\Execution\ResolveInfo;
 use Nuwave\Lighthouse\Subscriptions\Contracts\SubscriptionIterator;
 use Nuwave\Lighthouse\Subscriptions\Subscriber;
+use Tests\EnablesSubscriptionServiceProvider;
 use Tests\TestCase;
-use Tests\TestsSubscriptions;
 
 abstract class IteratorTest extends TestCase
 {
-    use TestsSubscriptions;
+    use EnablesSubscriptionServiceProvider;
 
     public function assertIteratesOverItemsWithCallback(SubscriptionIterator $iterator): void
     {
diff --git a/tests/Unit/Subscriptions/Storage/CacheStorageManagerTest.php b/tests/Unit/Subscriptions/Storage/CacheStorageManagerTest.php
@@ -6,12 +6,12 @@
 use GraphQL\Utils\AST;
 use Nuwave\Lighthouse\Subscriptions\Storage\CacheStorageManager;
 use Nuwave\Lighthouse\Subscriptions\Subscriber;
+use Tests\EnablesSubscriptionServiceProvider;
 use Tests\TestCase;
-use Tests\TestsSubscriptions;
 
 final class CacheStorageManagerTest extends TestCase
 {
-    use TestsSubscriptions;
+    use EnablesSubscriptionServiceProvider;
 
     protected CacheStorageManager $storage;
 
diff --git a/tests/Unit/Subscriptions/Storage/RedisStorageManagerTest.php b/tests/Unit/Subscriptions/Storage/RedisStorageManagerTest.php
diff --git a/tests/Unit/Subscriptions/SubscriberTest.php b/tests/Unit/Subscriptions/SubscriberTest.php
diff --git a/tests/Unit/Subscriptions/SubscriptionTest.php b/tests/Unit/Subscriptions/SubscriptionTest.php

Original file line number	Diff line number	Diff line change
`@@ -232,6 +232,10 @@ protected function rethrowGraphQLErrors(): void`
`232`	`232`	`$config->set('lighthouse.error_handlers', [RethrowingErrorHandler::class]);`
`233`	`233`	`}`
`234`	`234`
	`235`	`+ /**`
	`236`	`+ * @deprecated use TestsSubscriptions`
	`237`	`+ * TODO remove in the next major version`
	`238`	`+ */`
`235`	`239`	`protected function setUpSubscriptionEnvironment(): void`
`236`	`240`	`{`
`237`	`241`	`$app = Container::getInstance();`
Original file line number	Diff line number	Diff line change
`@@ -253,6 +253,10 @@ protected function rethrowGraphQLErrors(): void`
`253`	`253`	`$config->set('lighthouse.error_handlers', [RethrowingErrorHandler::class]);`
`254`	`254`	`}`
`255`	`255`
	`256`	`+ /**`
	`257`	`+ * @deprecated use TestsSubscriptions`
	`258`	`+ * TODO remove in the next major version`
	`259`	`+ */`
`256`	`260`	`protected function setUpSubscriptionEnvironment(): void`
`257`	`261`	`{`
`258`	`262`	`$app = Container::getInstance();`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ trait RefreshesSchemaCache`
`24`	`24`	`*/`
`25`	`25`	`protected static string $lockFilePath = __DIR__ . '/schema-cache-refreshing';`
`26`	`26`
`27`		`- protected function bootRefreshesSchemaCache(): void`
	`27`	`+ protected function setUpRefreshesSchemaCache(): void`
`28`	`28`	`{`
`29`	`29`	`if (! static::$schemaCacheWasRefreshed) {`
`30`	`30`	`// We utilize the filesystem as shared mutable state to coordinate between processes,`
`@@ -48,8 +48,11 @@ protected function bootRefreshesSchemaCache(): void`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`
`51`		`- protected function setUpRefreshesSchemaCache(): void`
	`51`	`+ /**`
	`52`	`+ * @deprecated TODO leverage automatic test trait setup, this method will be removed in the next major version`
	`53`	`+ */`
	`54`	`+ protected function bootRefreshesSchemaCache(): void`
`52`	`55`	`{`
`53`		`- $this->bootRefreshesSchemaCache();`
	`56`	`+ $this->setUpRefreshesSchemaCache();`
`54`	`57`	`}`
`55`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`use Nuwave\Lighthouse\Subscriptions\SubscriptionServiceProvider;`
`6`	`6`
`7`		`-trait TestsSubscriptions`
	`7`	`+trait EnablesSubscriptionServiceProvider`
`8`	`8`	`{`
`9`	`9`	`protected function getPackageProviders($app): array`
`10`	`10`	`{`