Writing tests

Author: Sammyjo20

.gitignore

@@ -3,3 +3,4 @@ composer.lock
 vendor
 .php-cs-fixer.cache
 .phpunit.result.cache
+tests/Fixtures/Saloon

composer.json

@@ -26,6 +26,7 @@
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.5",
+        "league/flysystem": "^3.0",
         "pestphp/pest": "^1.21",
         "spatie/ray": "^1.33"
     },

src/Exceptions/DirectoryNotFoundException.php

@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use Exception;
-
-class DirectoryNotFoundException extends Exception
+class DirectoryNotFoundException extends SaloonException
 {
     /**
      * Constructor

src/Exceptions/OAuthConfigValidationException.php

@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use \Exception;
-
-class OAuthConfigValidationException extends Exception
+class OAuthConfigValidationException extends SaloonException
 {
     //
 }

src/Exceptions/UnableToCreateDirectoryException.php

@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use Exception;
-
-class UnableToCreateDirectoryException extends Exception
+class UnableToCreateDirectoryException extends SaloonException
 {
     /**
      * Constructor

src/Exceptions/UnableToCreateFileException.php

@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use Exception;
-
-class UnableToCreateFileException extends Exception
+class UnableToCreateFileException extends SaloonException
 {
     /**
      * Constructor

src/Http/SaloonRequest.php

@@ -52,6 +52,13 @@ abstract class SaloonRequest implements SaloonRequestInterface
      */
     private ?SaloonConnector $loadedConnector = null;
 
+    /**
+     * Denotes if the request is being used to record a fixture.
+     *
+     * @var bool
+     */
+    protected bool $isRecordingFixture = false;
+
     /**
      * Define the endpoint for the request.
      *
@@ -176,6 +183,39 @@ public function traitExistsOnConnector(string $trait): bool
         return array_key_exists($trait, class_uses($this->getConnector()));
     }
 
+    /**
+     * Set if the request is being used to record a fixture.
+     *
+     * @param bool $value
+     * @return $this
+     */
+    public function setIsRecordingFixture(bool $value): static
+    {
+        $this->isRecordingFixture = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get if the request is recording a fixture.
+     *
+     * @return bool
+     */
+    public function isRecordingFixture(): bool
+    {
+        return $this->isRecordingFixture;
+    }
+
+    /**
+     * Get if the request is not recording a fixture.
+     *
+     * @return bool
+     */
+    public function isNotRecordingFixture(): bool
+    {
+        return ! $this->isRecordingFixture();
+    }
+
     /**
      * Dynamically proxy other methods to the connector.
      *

src/Managers/RequestManager.php

@@ -278,7 +278,7 @@ private function createResponse(array $requestOptions, Response $response, Reque
         // If we are mocking, we should record the request and response on the mock manager,
         // so we can run assertions on the responses.
 
-        if ($this->isMocking()) {
+        if ($this->isMocking() && $request->isNotRecordingFixture()) {
             $response->setMocked(true);
             $this->mockClient->recordResponse($response);
         }

src/Traits/ManagesGuzzle.php

@@ -105,6 +105,8 @@ private function bootHandlers(HandlerStack $handlerStack): HandlerStack
             // we will register the fixture recorder middleware.
 
             if (is_null($mockResponse) && $mockObject instanceof Fixture) {
+                $this->request->setIsRecordingFixture(true);
+
                 $handlerStack->push(new FixtureRecorderMiddleware($mockObject), 'saloonFixtureMiddleware');
             }
         }

tests/Feature/MockRequestTest.php

@@ -1,5 +1,7 @@
 <?php
 
+use League\Flysystem\Filesystem;
+use League\Flysystem\Local\LocalFilesystemAdapter;
 use Sammyjo20\Saloon\Http\Fixture;
 use Sammyjo20\Saloon\Http\MockResponse;
 use Sammyjo20\Saloon\Clients\MockClient;
@@ -12,6 +14,15 @@
 use Sammyjo20\Saloon\Tests\Fixtures\Connectors\QueryParameterConnector;
 use Sammyjo20\Saloon\Tests\Fixtures\Requests\DifferentServiceUserRequest;
 use Sammyjo20\Saloon\Tests\Fixtures\Requests\QueryParameterConnectorRequest;
+use function PHPUnit\Framework\assertFileDoesNotExist;
+use function PHPUnit\Framework\assertFileExists;
+
+$filesystem = new Filesystem(new LocalFilesystemAdapter('tests/Fixtures/Saloon'));
+
+beforeEach(function () use ($filesystem) {
+    $filesystem->deleteDirectory('/');
+    $filesystem->createDirectory('/');
+});
 
 test('a request can be mocked with a sequence', function () {
     $mockClient = new MockClient([
@@ -224,19 +235,24 @@ function (SaloonRequest $request): MockResponse {
     expect($sequenceResponse->json())->toEqual(['request_class' => UserRequest::class]);
 });
 
-test('you can tell the mock client to record requests and it will store recorded requests as a fixture', function () {
+test('you can use a fixture mock response and it will record the request for future use', function () use ($filesystem) {
     $mockClient = new MockClient([
         UserRequest::class => MockResponse::fixture('user'),
-        ErrorRequest::class => MockResponse::fixture('error'),
     ]);
 
-    $response = UserRequest::make()->send($mockClient);
+    expect($filesystem->fileExists('user.json'))->toBeFalse();
+
+    $responseA = UserRequest::make()->send($mockClient);
 
-    $errorResponse = ErrorRequest::make()->send($mockClient);
+    expect($responseA->isMocked())->toBeFalse();
+    expect($responseA->status())->toEqual(200);
+
+    expect($filesystem->fileExists('user.json'))->toBeTrue();
 
-    dd($errorResponse->status());
+    $responseB = UserRequest::make()->send($mockClient);
 
-    dd($response->json());
+    expect($responseB->isMocked())->toBeTrue();
+    expect($responseB->status())->toEqual(200);
 });
 
 // Tests: Make sure the fixture works with all the mocking types including closures