Reinstate Azure Blob Storage support

Author: nspyke

README.md

@@ -100,6 +100,7 @@ to interact with your storage.
 2. Cloud storage providers:
    [AsyncAws S3](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#asyncaws-s3),
    [AWS SDK S3](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#aws-sdk-s3),
+   [Azure](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#azure),
    [Google Cloud Storage](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#google-cloud-storage),
    [DigitalOcean Spaces](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#digitalocean-spaces),
    [Scaleway Object Storage](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#scaleway-object-storage)

composer.json

@@ -31,6 +31,7 @@
     "require-dev": {
         "league/flysystem-async-aws-s3": "^2.0|^3.0",
         "league/flysystem-aws-s3-v3": "^2.0|^3.0",
+        "league/flysystem-azure-blob-storage": "^3.0.5",
         "league/flysystem-ftp": "^2.0|^3.0",
         "league/flysystem-google-cloud-storage": "^2.0|^3.0",
         "league/flysystem-memory": "^2.0|^3.0",

docs/2-cloud-storage-providers.md

@@ -4,12 +4,36 @@ One of the core feature of Flysystem is its ability to interact easily with remo
 including many cloud storage providers. This bundle provides the same level of support for these
 cloud providers by providing corresponding adapters in the configuration.
 
+* [Azure](#azure)
 * [AsyncAws S3](#asyncaws-s3)
 * [AWS S3](#aws-sdk-s3)
 * [DigitalOcean Spaces](#digitalocean-spaces)
 * [Scaleway Object Storage](#scaleway-object-storage)
 * [Google Cloud Storage](#google-cloud-storage)
 
+## Azure
+
+### Installation
+
+```
+composer require league/flysystem-azure-blob-storage
+```
+
+### Usage
+
+```yaml
+# config/packages/flysystem.yaml
+
+flysystem:
+    storages:
+        users.storage:
+            adapter: 'azure'
+            options:
+                client: 'azure_client_service' # The service ID of the MicrosoftAzure\Storage\Blob\BlobRestProxy instance
+                container: 'container_name'
+                prefix: 'optional/path/prefix'
+```
+
 ## AsyncAws S3
 
 ### Installation

docs/B-configuration-reference.md

@@ -9,9 +9,13 @@ flysystem:
                 client: 'aws_client_service'
                 bucket: 'bucket_name'
                 prefix: 'optional/path/prefix'
-
+        
         users2.storage:
-            adapter: 'custom_adapter'
+          adapter: 'azure'
+          options:
+            client: 'azure_client_service'
+            container: 'container_name'
+            prefix: 'optional/path/prefix'
 
         users3.storage:
             adapter: 'ftp'
@@ -72,4 +76,6 @@ flysystem:
             options:
                 source: 'flysystem_storage_service_to_use'
 
+        users10.storage:
+          adapter: 'custom_adapter'
 ```

src/Adapter/AdapterDefinitionFactory.php

@@ -31,6 +31,7 @@ public function __construct()
         $this->builders = [
             new Builder\AsyncAwsAdapterDefinitionBuilder(),
             new Builder\AwsAdapterDefinitionBuilder(),
+            new Builder\AzureAdapterDefinitionBuilder(),
             new Builder\FtpAdapterDefinitionBuilder(),
             new Builder\GcloudAdapterDefinitionBuilder(),
             new Builder\LocalAdapterDefinitionBuilder(),

src/Adapter/Builder/AzureAdapterDefinitionBuilder.php

@@ -0,0 +1,57 @@
+<?php
+
+/*
+ * This file is part of the flysystem-bundle project.
+ *
+ * (c) Titouan Galopin <galopintitouan@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace League\FlysystemBundle\Adapter\Builder;
+
+use League\Flysystem\AzureBlobStorage\AzureBlobStorageAdapter;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * @author Titouan Galopin <galopintitouan@gmail.com>
+ *
+ * @internal
+ */
+class AzureAdapterDefinitionBuilder extends AbstractAdapterDefinitionBuilder
+{
+    public function getName(): string
+    {
+        return 'azure';
+    }
+
+    protected function getRequiredPackages(): array
+    {
+        return [
+            AzureBlobStorageAdapter::class => 'league/flysystem-azure-blob-storage',
+        ];
+    }
+
+    protected function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setRequired('client');
+        $resolver->setAllowedTypes('client', 'string');
+
+        $resolver->setRequired('container');
+        $resolver->setAllowedTypes('container', 'string');
+
+        $resolver->setDefault('prefix', '');
+        $resolver->setAllowedTypes('prefix', 'string');
+    }
+
+    protected function configureDefinition(Definition $definition, array $options)
+    {
+        $definition->setClass(AzureBlobStorageAdapter::class);
+        $definition->setArgument(0, new Reference($options['client']));
+        $definition->setArgument(1, $options['container']);
+        $definition->setArgument(2, $options['prefix']);
+    }
+}

tests/Adapter/Builder/AzureAdapterDefinitionBuilderTest.php

@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the flysystem-bundle project.
+ *
+ * (c) Titouan Galopin <galopintitouan@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Tests\League\FlysystemBundle\Adapter\Builder;
+
+use League\Flysystem\AzureBlobStorage\AzureBlobStorageAdapter;
+use League\FlysystemBundle\Adapter\Builder\AzureAdapterDefinitionBuilder;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\Reference;
+
+class AzureAdapterDefinitionBuilderTest extends TestCase
+{
+    public function createBuilder()
+    {
+        return new AzureAdapterDefinitionBuilder();
+    }
+
+    public function provideValidOptions()
+    {
+        yield 'minimal' => [[
+            'client' => 'my_client',
+            'container' => 'container_name',
+        ]];
+
+        yield 'prefix' => [[
+            'client' => 'my_client',
+            'container' => 'container_name',
+            'prefix' => 'prefix/path',
+        ]];
+    }
+
+    /**
+     * @dataProvider provideValidOptions
+     */
+    public function testCreateDefinition($options)
+    {
+        $this->assertSame(AzureBlobStorageAdapter::class, $this->createBuilder()->createDefinition($options)->getClass());
+    }
+
+    public function testOptionsBehavior()
+    {
+        $definition = $this->createBuilder()->createDefinition([
+            'client' => 'my_client',
+            'container' => 'container_name',
+            'prefix' => 'prefix/path',
+        ]);
+
+        $this->assertSame(AzureBlobStorageAdapter::class, $definition->getClass());
+        $this->assertInstanceOf(Reference::class, $definition->getArgument(0));
+        $this->assertSame('my_client', (string) $definition->getArgument(0));
+        $this->assertSame('container_name', $definition->getArgument(1));
+        $this->assertSame('prefix/path', $definition->getArgument(2));
+    }
+}

tests/Adapter/options.yaml

@@ -12,6 +12,13 @@ fs_aws:
         bucket: 'bucket_name'
         prefix: 'optional/path/prefix'
 
+fs_azure:
+    adapter: 'azure'
+    options:
+        client: 'azure_client_service'
+        container: 'container_name'
+        prefix: 'optional/path/prefix'
+
 fs_ftp:
     adapter: 'ftp'
     options:

tests/DependencyInjection/FlysystemExtensionTest.php

@@ -16,6 +16,7 @@
 use Google\Cloud\Storage\Bucket;
 use Google\Cloud\Storage\StorageClient;
 use League\Flysystem\FilesystemOperator;
+use MicrosoftAzure\Storage\Blob\BlobRestProxy;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Dotenv\Dotenv;
 use Tests\League\FlysystemBundle\Kernel\FlysystemAppKernel;
@@ -26,6 +27,7 @@ public function provideFilesystems()
     {
         $fsNames = [
             'fs_aws',
+            'fs_azure',
             'fs_custom',
             'fs_ftp',
             'fs_gcloud',
@@ -99,6 +101,7 @@ private function getClientMocks()
         return [
             'aws_client_service' => $this->createMock(S3Client::class),
             'asyncaws_client_service' => $this->createMock(AsyncS3Client::class),
+            'azure_client_service' => $this->createMock(BlobRestProxy::class),
             'gcloud_client_service' => $gcloud,
         ];
     }

tests/Kernel/config/flysystem.yaml

@@ -14,6 +14,13 @@ flysystem:
                 bucket: '%env(AWS_BUCKET)%'
                 prefix: 'optional/path/prefix'
 
+        fs_azure:
+            adapter: 'azure'
+            options:
+                client: 'azure_client_service'
+                container: 'container_name'
+                prefix: 'optional/path/prefix'
+
         fs_custom:
             adapter: 'custom_adapter'