Merge pull request #18 from xray-labs/enhancement/update-pest-to-v3

[Enhancement] update pest to v3

.github/workflows/CI.yaml

@@ -35,4 +35,4 @@ jobs:
         run: ./vendor/bin/phpstan analyse
 
       - name: Run Pest
-        run: ./vendor/bin/pest --coverage --min=100 --parallel
+        run: ./vendor/bin/pest --coverage --min=76 --parallel

captainhook.json

@@ -27,7 +27,7 @@
                 "action": "./vendor/bin/phpstan analyse"
             },
             {
-                "action": "./vendor/bin/pest --coverage --min=100 --parallel"
+                "action": "./vendor/bin/pest --coverage --min=76 --parallel"
             }
         ]
     },

composer.json

@@ -25,7 +25,7 @@
     "require-dev": {
         "laravel/pint": "^1.16",
         "phpstan/phpstan": "^1.11",
-        "pestphp/pest": "^2.34",
+        "pestphp/pest": "^3.0",
         "symfony/var-dumper": "^7.0",
         "phpmd/phpmd": "^2.15",
         "squizlabs/php_codesniffer": "^3.10",

phpstan.neon

@@ -6,7 +6,7 @@ parameters:
     ignoreErrors:
         -
             messages:
-                - '#Call to an undefined method Pest\\PendingCalls\\TestCall\:\:expect\(\)#'
+                - '#Call to an undefined method Pest\\PendingCalls\\TestCall\:\:(expect|preset)\(\)#'
                 - '#Undefined variable\: \$this#'
                 - '#Call to an undefined method Pest(\\Mixins)?\\Expectation\<.+?\>\:\:[a-zA-Z]+?\(\)#'
                 - '#Access to an undefined property Pest(\\Mixins)?\\Expectation\<.+?\>\:\:\$[a-zA-Z]+?#'

phpunit.xml

@@ -21,7 +21,7 @@
         </include>
 
         <exclude>
-            <directory suffix=".php">./src/Tests</directory>
+            <directory suffix=".php">./src/Fakes</directory>
         </exclude>
     </source>
 </phpunit>

src/BlobStorage/BlobStorageClient.php

@@ -4,15 +4,18 @@
 
 namespace Xray\AzureStoragePhpSdk\BlobStorage;
 
+use Xray\AzureStoragePhpSdk\BlobStorage\Concerns\HasFakeRequest;
 use Xray\AzureStoragePhpSdk\BlobStorage\Managers\Blob\BlobManager;
 use Xray\AzureStoragePhpSdk\BlobStorage\Managers\{AccountManager, ContainerManager};
 use Xray\AzureStoragePhpSdk\Contracts\Authentication\Auth;
 use Xray\AzureStoragePhpSdk\Contracts\Http\Request as RequestContract;
 use Xray\AzureStoragePhpSdk\Contracts\{Converter, Parser};
 use Xray\AzureStoragePhpSdk\Http\Request;
 
-final class BlobStorageClient
+class BlobStorageClient
 {
+    use HasFakeRequest;
+
     public function __construct(protected RequestContract $request)
     {
         azure_app()->instance(RequestContract::class, $this->request);
@@ -22,6 +25,7 @@ public function __construct(protected RequestContract $request)
     /** @param array{version?: string, parser?: Parser, converter?: Converter} $config */
     public static function create(Auth $auth, array $config = []): static
     {
+        /** @phpstan-ignore-next-line */
         return new static(new Request($auth, new Config($config)));
     }
 

src/BlobStorage/Concerns/HasFakeRequest.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Xray\AzureStoragePhpSdk\BlobStorage\Concerns;
+
+use Xray\AzureStoragePhpSdk\BlobStorage\Config;
+use Xray\AzureStoragePhpSdk\Contracts\Authentication\Auth;
+use Xray\AzureStoragePhpSdk\Contracts\{Converter, Parser};
+use Xray\AzureStoragePhpSdk\Fakes\Http\RequestFake;
+
+trait HasFakeRequest
+{
+    /** @param array{version?: string, parser?: Parser, converter?: Converter} $config */
+    public static function fake(?Auth $auth = null, array $config = []): static
+    {
+        /** @phpstan-ignore-next-line */
+        return new static(new RequestFake($auth, new Config($config)));
+    }
+}

src/BlobStorage/Concerns/ValidateContainerName.php

@@ -13,7 +13,7 @@ protected function validateContainerName(string $name): void
     {
         $replaced = preg_replace('/[^a-z0-9-]/', '', $name);
 
-        if ($replaced !== $name) {
+        if (trim($name) === '' || $replaced !== $name) {
             throw InvalidArgumentException::create("Invalid container name: {$name}");
         }
     }

src/BlobStorage/Resource.php

@@ -64,23 +64,42 @@ final class Resource
 
     public static function canonicalize(string $uri): string
     {
-        /** @var array<string, string> */
-        $parsed = parse_url($uri);
+        $parsed = static::parseUrl($uri);
 
-        parse_str($parsed['query'] ?? '', $queryParams);
-
-        ksort($queryParams);
+        ksort($parsed['query']);
 
         $result = '';
 
         /**
          * @var string $value
          * @var string $key
          */
-        foreach ($queryParams as $key => $value) {
+        foreach ($parsed['query'] as $key => $value) {
             $result .= mb_convert_case($key, MB_CASE_LOWER, 'UTF-8') . ':' . $value . "\n";
         }
 
-        return $parsed['path'] . "\n" . rtrim($result, "\n");
+        return "{$parsed['path']}\n" . rtrim($result, "\n");
+    }
+
+    /** @return array{path: string, query: array<string, string>} */
+    protected static function parseUrl(string $uri): array
+    {
+        /** @var array<string, string> */
+        $parsed = parse_url($uri);
+
+        /** @var string $path */
+        $path = $parsed['path'] ?? '';
+
+        $queryParams = trim($parsed['query'] ?? '') === ''
+            ? []
+            : array_reduce(explode('&', $parsed['query']), function (array $carry, string $query): array {
+                $parts = explode('=', $query);
+
+                $carry[$parts[0]] = $parts[1];
+
+                return $carry;
+            }, []);
+
+        return ['path' => $path, 'query' => $queryParams];
     }
 }

src/Exceptions/CouldNotCreateTempFileException.php

@@ -6,7 +6,7 @@
 
 use Exception;
 
-class CouldNotCreateTempFileException extends Exception
+final class CouldNotCreateTempFileException extends Exception
 {
     protected function __construct(string $message)
     {

src/Exceptions/InvalidResourceTypeException.php

@@ -6,7 +6,7 @@
 
 use Exception;
 
-class InvalidResourceTypeException extends Exception
+final class InvalidResourceTypeException extends Exception
 {
     public static function create(string $message): self
     {

src/Exceptions/ManagerNotSetException.php

@@ -6,7 +6,7 @@
 
 use Exception;
 
-class ManagerNotSetException extends Exception
+final class ManagerNotSetException extends Exception
 {
     protected function __construct(string $message)
     {

src/Exceptions/RequestException/FailedAuthenticationException.php

@@ -6,7 +6,7 @@
 
 use Xray\AzureStoragePhpSdk\Exceptions\RequestException;
 
-class FailedAuthenticationException extends RequestException
+final class FailedAuthenticationException extends RequestException
 {
     //
 }

src/Exceptions/UnableToConvertException.php

@@ -6,7 +6,7 @@
 
 use Exception;
 
-class UnableToConvertException extends Exception
+final class UnableToConvertException extends Exception
 {
     protected function __construct(string $message)
     {

src/Exceptions/UnableToParseException.php

@@ -6,7 +6,7 @@
 
 use Exception;
 
-class UnableToParseException extends Exception
+final class UnableToParseException extends Exception
 {
     protected function __construct(string $message)
     {

src/Tests/Http/Concerns/HasAuthAssertions.php → src/Fakes/Http/Concerns/HasAuthAssertions.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Xray\AzureStoragePhpSdk\Tests\Http\Concerns;
+namespace Xray\AzureStoragePhpSdk\Fakes\Http\Concerns;
 
 use PHPUnit\Framework\Assert;
 

src/Tests/Http/Concerns/HasHttpAssertions.php → src/Fakes/Http/Concerns/HasHttpAssertions.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Xray\AzureStoragePhpSdk\Tests\Http\Concerns;
+namespace Xray\AzureStoragePhpSdk\Fakes\Http\Concerns;
 
 use PHPUnit\Framework\Assert;
 

src/Tests/Http/Concerns/HasSharableHttp.php → src/Fakes/Http/Concerns/HasSharableHttp.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Xray\AzureStoragePhpSdk\Tests\Http\Concerns;
+namespace Xray\AzureStoragePhpSdk\Fakes\Http\Concerns;
 
 use Xray\AzureStoragePhpSdk\BlobStorage\Enums\HttpVerb;
 use Xray\AzureStoragePhpSdk\Http\Headers;

src/Tests/Http/RequestFake.php → src/Fakes/Http/RequestFake.php

@@ -2,16 +2,16 @@
 
 declare(strict_types=1);
 
-namespace Xray\AzureStoragePhpSdk\Tests\Http;
+namespace Xray\AzureStoragePhpSdk\Fakes\Http;
 
 use Closure;
 use Xray\AzureStoragePhpSdk\Authentication\SharedKeyAuth;
 use Xray\AzureStoragePhpSdk\BlobStorage\Config;
 use Xray\AzureStoragePhpSdk\BlobStorage\Enums\HttpVerb;
 use Xray\AzureStoragePhpSdk\Contracts\Authentication\Auth;
 use Xray\AzureStoragePhpSdk\Contracts\Http\{Request, Response};
+use Xray\AzureStoragePhpSdk\Fakes\Http\Concerns\{HasAuthAssertions, HasHttpAssertions, HasSharableHttp};
 use Xray\AzureStoragePhpSdk\Http\Headers;
-use Xray\AzureStoragePhpSdk\Tests\Http\Concerns\{HasAuthAssertions, HasHttpAssertions, HasSharableHttp};
 
 /**
  * @phpstan-type Method array{endpoint: string, body?: string}

src/Tests/Http/ResponseFake.php → src/Fakes/Http/ResponseFake.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Xray\AzureStoragePhpSdk\Tests\Http;
+namespace Xray\AzureStoragePhpSdk\Fakes\Http;
 
 use Xray\AzureStoragePhpSdk\Contracts\Http\Response;
 use Xray\AzureStoragePhpSdk\Http\Response as BaseResponse;

src/Http/Request.php

@@ -13,7 +13,7 @@
 use Xray\AzureStoragePhpSdk\Contracts\Http\{Request as RequestContract, Response as ResponseContract};
 
 /** @suppressWarnings(PHPMD.ExcessiveParameterList) */
-class Request implements RequestContract
+final class Request implements RequestContract
 {
     use HasAuthenticatedRequest;
     use HasSharingMethods;

tests/Feature/Application/ApplicationTest.php

@@ -5,7 +5,8 @@
 use Xray\AzureStoragePhpSdk\Application\Application;
 use Xray\AzureStoragePhpSdk\Exceptions\InvalidArgumentException;
 
-uses()->group('applications');
+pest()->group('applications');
+covers(Application::class);
 
 afterEach(fn () => Application::getInstance()->flush());
 

tests/Feature/Authentication/MicrosoftEntraIdTest.php

@@ -6,10 +6,11 @@
 use Xray\AzureStoragePhpSdk\BlobStorage\Enums\HttpVerb;
 use Xray\AzureStoragePhpSdk\Contracts\Authentication\Auth;
 use Xray\AzureStoragePhpSdk\Exceptions\RequiredFieldException;
-use Xray\AzureStoragePhpSdk\Tests\Http\RequestFake;
+use Xray\AzureStoragePhpSdk\Fakes\Http\RequestFake;
 use Xray\Tests\Fakes\ClientFake;
 
-uses()->group('authentications');
+pest()->group('authentications');
+covers(MicrosoftEntraId::class);
 
 it('should implements Auth interface', function () {
     expect(MicrosoftEntraId::class)

tests/Feature/Authentication/SharedAccessSignature/UserDelegationSasTest.php

@@ -9,9 +9,10 @@
 use Xray\AzureStoragePhpSdk\Contracts\Authentication\SharedAccessSignature;
 use Xray\AzureStoragePhpSdk\Exceptions\Authentication\InvalidAuthenticationMethodException;
 use Xray\AzureStoragePhpSdk\Exceptions\InvalidResourceTypeException;
-use Xray\AzureStoragePhpSdk\Tests\Http\{RequestFake, ResponseFake};
+use Xray\AzureStoragePhpSdk\Fakes\Http\{RequestFake, ResponseFake};
 
-uses()->group('authentications', 'shared-access-signatures');
+pest()->group('authentications', 'shared-access-signatures');
+covers(UserDelegationSas::class);
 
 it('should implements SharedAccessSignature interface', function () {
     expect(UserDelegationSas::class)

tests/Feature/Authentication/SharedKeyAuthTest.php

@@ -7,10 +7,11 @@
 use Xray\AzureStoragePhpSdk\BlobStorage\Resource;
 use Xray\AzureStoragePhpSdk\Contracts\Authentication\Auth;
 use Xray\AzureStoragePhpSdk\Exceptions\RequiredFieldException;
+use Xray\AzureStoragePhpSdk\Fakes\Http\RequestFake;
 use Xray\AzureStoragePhpSdk\Http\Headers;
-use Xray\AzureStoragePhpSdk\Tests\Http\RequestFake;
 
-uses()->group('authentications');
+pest()->group('authentications');
+covers(SharedKeyAuth::class);
 
 it('should implements Auth interface', function () {
     expect(SharedKeyAuth::class)

tests/Feature/BlobStorage/BlobStorageClientTest.php

@@ -6,9 +6,10 @@
 use Xray\AzureStoragePhpSdk\BlobStorage\Managers\Blob\BlobManager;
 use Xray\AzureStoragePhpSdk\BlobStorage\Managers\{AccountManager, ContainerManager};
 use Xray\AzureStoragePhpSdk\BlobStorage\{BlobStorageClient, Config};
-use Xray\AzureStoragePhpSdk\Tests\Http\RequestFake;
+use Xray\AzureStoragePhpSdk\Fakes\Http\RequestFake;
 
-uses()->group('blob-storage');
+pest()->group('blob-storage');
+covers(BlobStorageClient::class);
 
 it('should be able to get blob storage managers', function (string $method, string $class, array $parameters = []) {
     $request = new RequestFake();

tests/Feature/BlobStorage/BlobStorageConfigTest.php

@@ -6,7 +6,8 @@
 use Xray\AzureStoragePhpSdk\Contracts\Converter;
 use Xray\AzureStoragePhpSdk\Parsers\XmlParser;
 
-uses()->group('blob-storage');
+pest()->group('blob-storage');
+covers(Config::class);
 
 it('should set default config value if none of the optional ones are provided', function () {
     expect(new Config())

tests/Feature/BlobStorage/BlobStorateResouceTest.php

@@ -4,11 +4,15 @@
 
 use Xray\AzureStoragePhpSdk\BlobStorage\Resource;
 
-uses()->group('blob-storage');
+pest()->group('blob-storage');
+covers(Resource::class);
 
-it('should canonicalize resource correctly', function () {
-    $uri = 'https://account.blob.core.windows.net/container/?RestType=service&Comp=properties';
+it('should canonicalize resource correctly', function (string $query, string $expected) {
+    $uri = "https://account.blob.core.windows.net/container/?{$query}";
 
     expect(Resource::canonicalize($uri))
-        ->toBe("/container/\ncomp:properties\nresttype:service");
-});
+        ->toBe("/container/\n{$expected}");
+})->with([
+    'With Query Params'    => ['RestType=service&Comp=properties', "comp:properties\nresttype:service"],
+    'Without Query Params' => ['', ''],
+]);

tests/Feature/BlobStorage/Concerns/HasFakeRequestTest.php

@@ -0,0 +1,26 @@
+<?php
+
+use Xray\AzureStoragePhpSdk\BlobStorage\Concerns\HasFakeRequest;
+use Xray\AzureStoragePhpSdk\Contracts\Http\Request as RequestContract;
+use Xray\AzureStoragePhpSdk\Fakes\Http\RequestFake;
+
+pest()->group('blob-storage', 'concerns');
+covers(HasFakeRequest::class);
+
+it('should create a fake instance', function () {
+    $class = ClientToHasFakeRequestTest::fake();
+
+    expect($class)
+        ->toBeInstanceOf(ClientToHasFakeRequestTest::class)
+        ->request->toBeInstanceOf(RequestFake::class);
+});
+
+readonly class ClientToHasFakeRequestTest
+{
+    use HasFakeRequest;
+
+    public function __construct(public RequestContract $request)
+    {
+        //
+    }
+}