add tests

Author: brecht.vermeersch

.gitignore

@@ -1,3 +1,4 @@
 /vendor/
 composer.lock
-.idea
+.idea
+.phpunit.cache

composer.json

@@ -8,6 +8,11 @@
       "AzureOss\\LaravelAzureStorageBlob\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "AzureOss\\LaravelAzureStorageBlob\\Tests": "tests/"
+    }
+  },
   "authors": [
     {
       "name": "Brecht Vermeersch",
@@ -21,7 +26,11 @@
     "azure-oss/storage-blob-flysystem": "^1.1"
   },
   "require-dev": {
-    "laravel/pint": "^1.17"
+    "laravel/pint": "^1.17",
+    "orchestra/testbench": "^9.2",
+    "phpstan/phpstan": "^1.11",
+    "phpstan/phpstan-deprecation-rules": "^1.2",
+    "phpstan/phpstan-strict-rules": "^1.6"
   },
   "extra": {
     "laravel": {

phpstan.neon

@@ -0,0 +1,7 @@
+parameters:
+    level: 9
+    paths:
+        - src
+includes:
+    - vendor/phpstan/phpstan-strict-rules/rules.neon
+    - vendor/phpstan/phpstan-deprecation-rules/rules.neon

phpunit.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.3/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheDirectory=".phpunit.cache"
+         executionOrder="depends,defects"
+         shortenArraysForExportThreshold="10"
+         beStrictAboutOutputDuringTests="true"
+         failOnRisky="true"
+         failOnWarning="true">
+    <php>
+        <env name="AZURE_STORAGE_CONNECTION_STRING" value="UseDevelopmentStorage=true"/>
+        <env name="AZURE_STORAGE_CONTAINER" value="testing"/>
+    </php>
+
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <source ignoreIndirectDeprecations="true" restrictNotices="true" restrictWarnings="true">
+        <include>
+            <directory>src</directory>
+        </include>
+    </source>
+</phpunit>

src/AzureStorageBlobAdapter.php

@@ -10,14 +10,19 @@
 
 /**
  * @internal
+ *
+ * @property AzureBlobStorageAdapter $adapter
  */
 final class AzureStorageBlobAdapter extends FilesystemAdapter
 {
+    /**
+     * @param  array{connection_string: string, container: string, prefix?: string}  $config
+     */
     public function __construct(array $config)
     {
         $serviceClient = BlobServiceClient::fromConnectionString($config['connection_string']);
         $containerClient = $serviceClient->getContainerClient($config['container']);
-        $adapter = new AzureBlobStorageAdapter($containerClient, $config['prefix'] ?? "");
+        $adapter = new AzureBlobStorageAdapter($containerClient, $config['prefix'] ?? '');
 
         parent::__construct(
             new Filesystem($adapter, $config),
@@ -26,17 +31,13 @@ public function __construct(array $config)
         );
     }
 
+    /** @phpstan-ignore-next-line  */
     public function temporaryUrl($path, $expiration, array $options = [])
     {
-        $options["permissions"] = $options["permissions"] ?? "r";
-
-        return $this->adapter->temporaryUrl($path, $expiration, new Config($options));
-    }
-
-    public function temporaryUploadUrl($path, $expiration, array $options = [])
-    {
-        $options["permissions"] = $options["permissions"] ?? "w";
-
-        return $this->adapter->temporaryUrl($path, $expiration, new Config($options));
+        return $this->adapter->temporaryUrl(
+            $path,
+            $expiration,
+            new Config(['permissions' => 'r'])
+        );
     }
-}
+}

src/AzureStorageBlobServiceProvider.php

@@ -15,6 +15,18 @@ final class AzureStorageBlobServiceProvider extends ServiceProvider
     public function boot(): void
     {
         Storage::extend('azure-storage-blob', function (Application $app, array $config): FilesystemAdapter {
+            if (! isset($config['connection_string']) || ! is_string($config['connection_string'])) {
+                throw new \InvalidArgumentException('The [connection_string] must be a string in the disk configuration.');
+            }
+
+            if (! isset($config['container']) && ! is_string($config['container'])) {
+                throw new \InvalidArgumentException('The [container] must be a string in the disk configuration.');
+            }
+
+            if (isset($config['prefix']) && ! is_string($config['prefix'])) {
+                throw new \InvalidArgumentException('The [prefix] must be a string in the disk configuration.');
+            }
+
             return new AzureStorageBlobAdapter($config);
         });
     }

tests/AzureStorageBlobAdapterTest.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace AzureOss\LaravelAzureStorageBlob\Tests;
+
+use AzureOss\LaravelAzureStorageBlob\AzureStorageBlobAdapter;
+use AzureOss\LaravelAzureStorageBlob\AzureStorageBlobServiceProvider;
+use Illuminate\Support\Facades\Http;
+use Illuminate\Support\Facades\Storage;
+use Orchestra\Testbench\TestCase;
+use PHPUnit\Framework\Attributes\Test;
+
+class AzureStorageBlobAdapterTest extends TestCase
+{
+    protected function getPackageProviders($app): array
+    {
+        return [AzureStorageBlobServiceProvider::class];
+    }
+
+    protected function getEnvironmentSetUp($app): void
+    {
+        $app['config']->set('filesystems.disks.azure', [
+            'driver' => 'azure-storage-blob',
+            'connection_string' => env('AZURE_STORAGE_CONNECTION_STRING'),
+            'container' => env('AZURE_STORAGE_CONTAINER'),
+        ]);
+    }
+
+    #[Test]
+    public function it_resolves_from_manager(): void
+    {
+        self::assertInstanceOf(AzureStorageBlobAdapter::class, Storage::disk('azure'));
+    }
+
+    #[Test]
+    public function driver_works(): void
+    {
+        $driver = Storage::disk('azure');
+
+        // cleanup from previous test runs
+        $driver->deleteDirectory('');
+
+        self::assertFalse($driver->exists('file.text'));
+
+        $driver->put('file.txt', 'content');
+
+        self::assertTrue($driver->exists('file.txt'));
+
+        self::assertEquals(
+            'content',
+            $driver->get('file.txt')
+        );
+        self::assertEquals(
+            'content',
+            Http::get($driver->temporaryUrl('file.txt', now()->addMinute()))->body()
+        );
+
+        $driver->copy('file.txt', 'file2.txt');
+
+        self::assertTrue($driver->exists('file2.txt'));
+
+        $driver->move('file2.txt', 'file3.txt');
+
+        self::assertFalse($driver->exists('file2.txt'));
+        self::assertTrue($driver->exists('file3.txt'));
+
+        self::assertCount(2, $driver->allFiles());
+
+        $driver->deleteDirectory('');
+
+        self::assertCount(0, $driver->allFiles());
+    }
+}