Merge pull request #4 from sjspereira/enhancement/create-manager-tests

[Enhancement] create manager tests
xray-labs · Jul 14, 2024 · 0800305 · 0800305
2 parents d756d74 + 9375887
commit 0800305
Show file tree

Hide file tree

Showing 49 changed files with 1,773 additions and 127 deletions.
diff --git a/.github/workflows/CI.yaml b/.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=80 --parallel
diff --git a/src/BlobStorage/Concerns/ValidateContainerName.php b/src/BlobStorage/Concerns/ValidateContainerName.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sjpereira\AzureStoragePhpSdk\BlobStorage\Concerns;
+
+use Sjpereira\AzureStoragePhpSdk\Exceptions\InvalidArgumentException;
+
+trait ValidateContainerName
+{
+    /** @throws InvalidArgumentException */
+    protected function validateContainerName(string $name): void
+    {
+        $replaced = preg_replace('/[^a-z0-9-]/', '', $name);
+
+        if ($replaced !== $name) {
+            throw InvalidArgumentException::create("Invalid container name: {$name}");
+        }
+    }
+}
diff --git a/src/BlobStorage/Concerns/ValidateMetadataKey.php b/src/BlobStorage/Concerns/ValidateMetadataKey.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sjpereira\AzureStoragePhpSdk\BlobStorage\Concerns;
+
+use Sjpereira\AzureStoragePhpSdk\Exceptions\InvalidArgumentException;
+
+trait ValidateMetadataKey
+{
+    /** @throws InvalidArgumentException */
+    protected function validateMetadataKey(string $key): void
+    {
+        $message = "Invalid metadata key: {$key}.";
+
+        if (is_numeric($key[0])) {
+            throw InvalidArgumentException::create("{$message} Metadata keys cannot start with a number.");
+        }
+
+        $name = preg_replace('/[^a-z0-9_]/i', '', $key);
+
+        if ($key !== $name) {
+            throw InvalidArgumentException::create("{$message} Only alphanumeric characters and underscores are allowed.");
+        }
+    }
+}
diff --git a/src/BlobStorage/Entities/Account/BlobStorageProperty/BlobProperty.php b/src/BlobStorage/Entities/Account/BlobStorageProperty/BlobProperty.php
@@ -43,31 +43,31 @@ public function __construct(array $blobProperty)
 
         $this->logging = isset($blobProperty['Logging'])
             ? new Logging($blobProperty['Logging'])
-            : null;
+            : null; // @codeCoverageIgnore
 
         $this->hourMetrics = isset($blobProperty['HourMetrics'])
             ? new HourMetrics($blobProperty['HourMetrics'])
-            : null;
+            : null; // @codeCoverageIgnore
 
         $this->minuteMetrics = isset($blobProperty['MinuteMetrics'])
             ? new MinuteMetrics($blobProperty['MinuteMetrics'])
-            : null;
+            : null; // @codeCoverageIgnore
 
         if (isset($blobProperty['Cors'])) {
             $this->cors = isset($blobProperty['Cors']['CorsRule'])
                 ? new Cors($blobProperty['Cors']['CorsRule'])
-                : new Cors([]);
+                : new Cors([]); // @codeCoverageIgnore
         } else {
-            $this->cors = null;
+            $this->cors = null; // @codeCoverageIgnore
         }
 
         $this->deleteRetentionPolicy = isset($blobProperty['DeleteRetentionPolicy'])
             ? new DeleteRetentionPolicy($blobProperty['DeleteRetentionPolicy'])
-            : null;
+            : null; // @codeCoverageIgnore
 
         $this->staticWebsite = isset($blobProperty['StaticWebsite'])
             ? new StaticWebsite($blobProperty['StaticWebsite'])
-            : null;
+            : null; // @codeCoverageIgnore
     }
 
     public function toArray(): array

diff --git a/src/BlobStorage/Entities/Account/BlobStorageProperty/DeleteRetentionPolicy.php b/src/BlobStorage/Entities/Account/BlobStorageProperty/DeleteRetentionPolicy.php
@@ -26,7 +26,7 @@ public function __construct(array $deleteRetentionPolicy)
         $this->allowPermanentDelete = to_boolean($deleteRetentionPolicy['AllowPermanentDelete'] ?? false);
         $this->days                 = isset($deleteRetentionPolicy['Days'])
             ? (int) $deleteRetentionPolicy['Days']
-            : null;
+            : null; // @codeCoverageIgnore
     }
 
     public function toArray(): array

diff --git a/src/BlobStorage/Entities/Account/BlobStorageProperty/HourMetrics.php b/src/BlobStorage/Entities/Account/BlobStorageProperty/HourMetrics.php
@@ -33,7 +33,7 @@ public function __construct(array $hourMetrics)
         $this->retentionPolicyEnabled = to_boolean($hourMetrics['RetentionPolicy']['Enabled'] ?? false);
         $this->retentionPolicyDays    = isset($hourMetrics['RetentionPolicy']['Days'])
             ? (int) $hourMetrics['RetentionPolicy']['Days']
-            : null;
+            : null; // @codeCoverageIgnore
     }
 
     public function toArray(): array

diff --git a/src/BlobStorage/Entities/Account/BlobStorageProperty/Logging.php b/src/BlobStorage/Entities/Account/BlobStorageProperty/Logging.php
@@ -36,7 +36,7 @@ public function __construct(array $logging)
         $this->retentionPolicyEnabled = to_boolean($logging['RetentionPolicy']['Enabled'] ?? false);
         $this->retentionPolicyDays    = isset($logging['RetentionPolicy']['Days'])
             ? (int) $logging['RetentionPolicy']['Days']
-            : null;
+            : null; // @codeCoverageIgnore
     }
 
     public function toArray(): array

diff --git a/src/BlobStorage/Entities/Account/BlobStorageProperty/MinuteMetrics.php b/src/BlobStorage/Entities/Account/BlobStorageProperty/MinuteMetrics.php
@@ -33,7 +33,7 @@ public function __construct(array $minuteMetrics)
         $this->retentionPolicyEnabled = to_boolean($minuteMetrics['RetentionPolicy']['Enabled'] ?? false);
         $this->retentionPolicyDays    = isset($minuteMetrics['RetentionPolicy']['Days'])
             ? (int) $minuteMetrics['RetentionPolicy']['Days']
-            : null;
+            : null; // @codeCoverageIgnore
     }
 
     public function toArray(): array

diff --git a/src/BlobStorage/Entities/Account/KeyInfo.php b/src/BlobStorage/Entities/Account/KeyInfo.php
@@ -23,11 +23,13 @@
      */
     public function __construct(array $keyInfo)
     {
+        // @codeCoverageIgnoreStart
         if (!isset($keyInfo['Start'], $keyInfo['Expiry'])) {
             throw RequiredFieldException::missingField(
                 !isset($keyInfo['Start']) ? 'Start' : 'Expiry'
             );
         }
+        // @codeCoverageIgnoreEnd
 
         $this->start  = new DateTimeImmutable($keyInfo['Start']);
         $this->expiry = new DateTimeImmutable($keyInfo['Expiry']);

diff --git a/src/BlobStorage/Entities/Blob/Blob.php b/src/BlobStorage/Entities/Blob/Blob.php
@@ -44,7 +44,7 @@ public function __construct(array $blob)
         $name = ($blob['Name'] ?? '');
 
         if (empty($name)) {
-            throw RequiredFieldException::missingField('Name');
+            throw RequiredFieldException::missingField('Name'); // @codeCoverageIgnore
         }
 
         $this->name                 = $name;

diff --git a/src/BlobStorage/Entities/Blob/BlobMetadata.php b/src/BlobStorage/Entities/Blob/BlobMetadata.php
@@ -5,14 +5,16 @@
 namespace Sjpereira\AzureStoragePhpSdk\BlobStorage\Entities\Blob;
 
 use DateTimeImmutable;
+use Sjpereira\AzureStoragePhpSdk\BlobStorage\Concerns\ValidateMetadataKey;
 use Sjpereira\AzureStoragePhpSdk\BlobStorage\Resource;
-use Sjpereira\AzureStoragePhpSdk\Exceptions\InvalidArgumentException;
 
 /**
  * @phpstan-type BlobMetadataHeaders array{Content-Length?: string, Last-Modified?: string, ETag?: string, Vary?: string, Server?: string, x-ms-request-id?: string, x-ms-version?: string, Date?: string}
  */
 final readonly class BlobMetadata
 {
+    use ValidateMetadataKey;
+
     public ?int $contentLength;
 
     public ?DateTimeImmutable $lastModified;
@@ -92,19 +94,4 @@ public function getMetadataToSave(): array
 
         return array_filter($metadata, fn (mixed $value) => $value !== null);
     }
-
-    protected function validateMetadataKey(string $key): void
-    {
-        $message = "Invalid metadata key: {$key}.";
-
-        if (is_numeric($key[0])) {
-            throw InvalidArgumentException::create("{$message} Metadata keys cannot start with a number.");
-        }
-
-        $name = preg_replace('/[^a-z0-9_]/i', '', $key);
-
-        if ($key !== $name) {
-            throw InvalidArgumentException::create("{$message} Only alphanumeric characters and underscores are allowed.");
-        }
-    }
 }
diff --git a/src/BlobStorage/Entities/Blob/BlobProperty.php b/src/BlobStorage/Entities/Blob/BlobProperty.php
@@ -49,7 +49,7 @@
 
     public string $contentType;
 
-    public string $etag;
+    public string $eTag;
 
     public ?string $contentMD5;
 
@@ -144,7 +144,7 @@ public function __construct(array $property)
         $this->leaseStatus                 = $property['x-ms-lease-status'] ?? null;
         $this->contentLength               = (int) ($property['Content-Length'] ?? 0);
         $this->contentType                 = $property['Content-Type'] ?? '';
-        $this->etag                        = $property['ETag'] ?? '';
+        $this->eTag                        = $property['ETag'] ?? '';
         $this->contentMD5                  = $property['Content-MD5'] ?? null;
         $this->contentEncoding             = $property['Content-Encoding'] ?? null;
         $this->contentLanguage             = $property['Content-Language'] ?? null;

diff --git a/src/BlobStorage/Entities/Blob/BlobTag.php b/src/BlobStorage/Entities/Blob/BlobTag.php
@@ -132,7 +132,6 @@ protected function mountTags(array $tags): array
                 }
 
                 $this->validateTagKey($key = $tag['Key']);
-
                 $this->validateTagValue($tag['Value']);
 
                 $tagsParsed[$key] = $tag['Value'];

diff --git a/src/BlobStorage/Entities/Blob/File.php b/src/BlobStorage/Entities/Blob/File.php
@@ -23,11 +23,11 @@
 
     public string $contentMD5;
 
-    public string $lastModified;
+    public DateTimeImmutable $lastModified;
 
     public string $acceptRanges;
 
-    public string $etag;
+    public string $eTag;
 
     public string $vary;
 
@@ -52,19 +52,15 @@
     /** @param FileType $options */
     public function __construct(string $name, string $content, array $options = [])
     {
-        // if (empty($content)) {
-
-        // }
-
         $this->content = $content;
         $this->name    = $name;
 
         $this->contentLength      = (int) ($options['Content-Length'] ?? strlen($this->content));
         $this->contentType        = $options['Content-Type'] ?? $this->detectContentType();
         $this->contentMD5         = $options['Content-MD5'] ?? base64_encode(md5($this->content, binary: true));
-        $this->lastModified       = $options['Last-Modified'] ?? '';
+        $this->lastModified       = new DateTimeImmutable($options['Last-Modified'] ?? 'now');
         $this->acceptRanges       = $options['Accept-Ranges'] ?? '';
-        $this->etag               = $options['ETag'] ?? '';
+        $this->eTag               = $options['ETag'] ?? '';
         $this->vary               = $options['Vary'] ?? '';
         $this->server             = $options['Server'] ?? '';
         $this->xMsRequestId       = $options['x-ms-request-id'] ?? '';

diff --git a/src/BlobStorage/Entities/Blob/Properties.php b/src/BlobStorage/Entities/Blob/Properties.php
@@ -9,14 +9,15 @@
 /**
  * @phpstan-type PropertiesType array{Creation-Time?: string, Last-Modified?: string, Etag?: string, LeaseStatus?: string, LeaseState?: string, Owner?: string, Group?: string, Permissions?: string, Acl?: string, ResourceType?: string, Placeholder?: string, Content-Length?: string, Content-Type?: string, Content-Encoding?: string, Content-Language?: string, Content-MD5?: string, Cache-Control?: string, x-ms-blob-sequence-number?: string, BlobType?: string, AccessTier?: string, LeaseDuration?: string, CopyId?: string, CopyStatus?: string, CopySource?: string, CopyProgress?: string, CopyCompletionTime?: string, CopyStatusDescription?: string, ServerEncrypted?: string, CustomerProvidedKeySha256?: string, EncryptionContext?: string, EncryptionScope?: string, IncrementalCopy?: string, AccessTierInferred?: string, AccessTierChangeTime?: string, TagCount?: string, RehydratePriority?: string, ExpiryTime?: string, DeletedTime?: string, RemainingRetentionDays?: string}
  * @suppressWarnings(PHPMD.TooManyFields)
+ * @suppressWarnings(PHPMD.CyclomaticComplexity)
  */
 final readonly class Properties
 {
     public DateTimeImmutable $creationTime;
 
     public DateTimeImmutable $lastModified;
 
-    public string $etag;
+    public string $eTag;
 
     public string $leaseStatus;
 
@@ -95,7 +96,7 @@ public function __construct(array $property)
     {
         $this->creationTime              = new DateTimeImmutable($property['Creation-Time'] ?? 'now');
         $this->lastModified              = new DateTimeImmutable($property['Last-Modified'] ?? 'now');
-        $this->etag                      = $property['Etag'] ?? '';
+        $this->eTag                      = $property['Etag'] ?? '';
         $this->leaseStatus               = $property['LeaseStatus'] ?? '';
         $this->leaseState                = $property['LeaseState'] ?? '';
         $this->ownerUserId               = $property['Owner'] ?? '';
@@ -105,11 +106,11 @@ public function __construct(array $property)
         $this->resourceType              = $property['ResourceType'] ?? '';
         $this->placeholder               = $property['Placeholder'] ?? '';
         $this->contentLength             = $property['Content-Length'] ?? '';
-        $this->contentType               = json_encode($property['Content-Type'] ?? []) ?: '';
-        $this->contentEncoding           = json_encode($property['Content-Encoding'] ?? []) ?: '';
-        $this->contentLanguage           = json_encode($property['Content-Language'] ?? []) ?: '';
-        $this->contentMD5                = json_encode($property['Content-MD5'] ?? []) ?: '';
-        $this->cacheControl              = json_encode($property['Cache-Control'] ?? []) ?: '';
+        $this->contentType               = isset($property['Content-Type']) && !empty($property['Content-Type']) ? $property['Content-Type'] : '';
+        $this->contentEncoding           = isset($property['Content-Encoding']) && !empty($property['Content-Encoding']) ? $property['Content-Encoding'] : '';
+        $this->contentLanguage           = isset($property['Content-Language']) && !empty($property['Content-Language']) ? $property['Content-Language'] : '';
+        $this->contentMD5                = isset($property['Content-MD5']) && !empty($property['Content-MD5']) ? $property['Content-MD5'] : '';
+        $this->cacheControl              = isset($property['Cache-Control']) && !empty($property['Cache-Control']) ? $property['Cache-Control'] : '';
         $this->blobSequenceNumber        = (int) ($property['x-ms-blob-sequence-number'] ?? 0);
         $this->blobType                  = $property['BlobType'] ?? '';
         $this->accessTier                = $property['AccessTier'] ?? '';
@@ -120,12 +121,12 @@ public function __construct(array $property)
         $this->copyProgress              = $property['CopyProgress'] ?? '';
         $this->copyCompletionTime        = new DateTimeImmutable($property['CopyCompletionTime'] ?? 'now');
         $this->copyStatusDescription     = $property['CopyStatusDescription'] ?? '';
-        $this->serverEncrypted           = (bool) ($property['ServerEncrypted'] ?? false);
+        $this->serverEncrypted           = to_boolean($property['ServerEncrypted'] ?? false);
         $this->customerProvidedKeySha256 = $property['CustomerProvidedKeySha256'] ?? '';
         $this->encryptionContext         = $property['EncryptionContext'] ?? '';
         $this->encryptionScope           = $property['EncryptionScope'] ?? '';
-        $this->incrementalCopy           = (bool) ($property['IncrementalCopy'] ?? false);
-        $this->accessTierInferred        = (bool) ($property['AccessTierInferred'] ?? false);
+        $this->incrementalCopy           = to_boolean($property['IncrementalCopy'] ?? false);
+        $this->accessTierInferred        = to_boolean($property['AccessTierInferred'] ?? false);
         $this->accessTierChangeTime      = new DateTimeImmutable($property['AccessTierChangeTime'] ?? 'now');
         $this->tagCount                  = (int) ($property['TagCount'] ?? 0);
         $this->rehydratePriority         = $property['RehydratePriority'] ?? '';

diff --git a/src/BlobStorage/Entities/Container/AccessLevel/ContainerAccessLevel.php b/src/BlobStorage/Entities/Container/AccessLevel/ContainerAccessLevel.php
@@ -33,7 +33,7 @@ public function __construct(array $containerAccessLevel)
         $this->id = $containerAccessLevel['Id'] ?? '';
 
         if ($this->id === '') {
-            throw RequiredFieldException::missingField('Id');
+            throw RequiredFieldException::missingField('Id'); // @codeCoverageIgnore
         }
 
         $this->accessPolicyStart      = isset($containerAccessLevel['AccessPolicy']['Start']) ? new DateTimeImmutable($containerAccessLevel['AccessPolicy']['Start']) : null;

diff --git a/src/BlobStorage/Entities/Container/ContainerLease.php b/src/BlobStorage/Entities/Container/ContainerLease.php
@@ -20,7 +20,7 @@ final class ContainerLease
 
     public readonly DateTimeImmutable $lastModified;
 
-    public readonly string $etag;
+    public readonly string $eTag;
 
     public readonly string $server;
 
@@ -36,7 +36,7 @@ final class ContainerLease
     public function __construct(array $containerLease)
     {
         $this->lastModified = new DateTimeImmutable($containerLease['Last-Modified'] ?? 'now');
-        $this->etag         = $containerLease['ETag'] ?? '';
+        $this->eTag         = $containerLease['ETag'] ?? '';
         $this->server       = $containerLease['Server'] ?? '';
         $this->requestId    = $containerLease[Resource::REQUEST_ID] ?? '';
         $this->version      = $containerLease[Resource::AUTH_VERSION] ?? '';
@@ -74,7 +74,7 @@ public function break(?string $leaseId = null): self
     protected function ensureLeaseIdIsset(): void
     {
         if (empty($this->leaseId)) {
-            throw RequiredFieldException::missingField('leaseId');
+            throw RequiredFieldException::missingField('leaseId'); // @codeCoverageIgnore
         }
     }
 }
diff --git a/src/BlobStorage/Entities/Container/Containers.php b/src/BlobStorage/Entities/Container/Containers.php
@@ -18,7 +18,7 @@ final class Containers extends Collection
     public function __construct(protected ContainerManager $manager, array $containers = [])
     {
         if (is_string(array_keys($containers)[0])) {
-            $containers = [$containers];
+            $containers = [$containers]; // @codeCoverageIgnore
         }
 
         /** @var ContainerType[] $containers */

diff --git a/src/BlobStorage/Entities/Container/Properties.php b/src/BlobStorage/Entities/Container/Properties.php
@@ -13,7 +13,7 @@
 {
     public DateTimeImmutable $lastModified;
 
-    public string $etag;
+    public string $eTag;
 
     public string $leaseStatus;
 
@@ -37,7 +37,7 @@
     public function __construct(array $property)
     {
         $this->lastModified                          = new DateTimeImmutable($property['Last-Modified'] ?? 'now');
-        $this->etag                                  = $property['Etag'] ?? '';
+        $this->eTag                                  = $property['Etag'] ?? '';
         $this->leaseStatus                           = $property['LeaseStatus'] ?? '';
         $this->leaseState                            = $property['LeaseState'] ?? '';
         $this->defaultEncryptionScope                = $property['DefaultEncryptionScope'] ?? '';

diff --git a/src/BlobStorage/Managers/Account/PreflightBlobRequestManager.php b/src/BlobStorage/Managers/Account/PreflightBlobRequestManager.php
@@ -83,8 +83,11 @@ protected function request(HttpVerb $verb, string $origin, array $headers = []):
                 ->withHeaders($options)
                 ->withoutAuthentication()
                 ->options('');
+
+            // @codeCoverageIgnoreStart
         } catch (RequestExceptionInterface $e) {
             throw RequestException::createFromRequestException($e);
         }
+        // @codeCoverageIgnoreEnd
     }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -132,7 +132,6 @@ protected function mountTags(array $tags): array @@
                     }
                     $this->validateTagKey($key = $tag['Key']);
                     $this->validateTagValue($tag['Value']);
                     $tagsParsed[$key] = $tag['Value'];
@@ Expand Down @@