Filesystem Extender and Tests (#2732)

2025-07-30 21:20:24 +02:00 · 2021-04-19 16:25:08 -04:00
parent 804564a09a
commit 4fea0ebdee
7 changed files with 442 additions and 30 deletions
--- a/framework/core/tests/integration/extenders/FilesystemTest.php
+++ b/framework/core/tests/integration/extenders/FilesystemTest.php
@@ -0,0 +1,156 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * For detailed copyright and license information, please view the
+ * LICENSE file that was distributed with this source code.
+ */
+
+namespace Flarum\Tests\integration\extenders;
+
+use Flarum\Extend;
+use Flarum\Filesystem\DriverInterface;
+use Flarum\Foundation\Config;
+use Flarum\Foundation\Paths;
+use Flarum\Http\UrlGenerator;
+use Flarum\Settings\SettingsRepositoryInterface;
+use Flarum\Testing\integration\RetrievesAuthorizedUsers;
+use Flarum\Testing\integration\TestCase;
+use Illuminate\Contracts\Filesystem\Cloud;
+use Illuminate\Filesystem\FilesystemAdapter;
+use InvalidArgumentException;
+use League\Flysystem\Adapter\Local;
+use League\Flysystem\Adapter\NullAdapter;
+use League\Flysystem\Filesystem as LeagueFilesystem;
+
+class FilesystemTest extends TestCase
+{
+    use RetrievesAuthorizedUsers;
+
+    /**
+     * @test
+     */
+    public function custom_disk_doesnt_exist_by_default()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->app()->getContainer()->make('filesystem')->disk('flarum-uploads');
+    }
+
+    /**
+     * @test
+     */
+    public function custom_disk_exists_if_added_and_uses_local_adapter_by_default()
+    {
+        $this->extend((new Extend\Filesystem)->disk('flarum-uploads', function (Paths $paths, UrlGenerator $url) {
+            return [
+                'root' => "$paths->public/assets/uploads",
+                'url'  => $url->to('forum')->path('assets/uploads')
+            ];
+        }));
+
+        $uploadsDisk = $this->app()->getContainer()->make('filesystem')->disk('flarum-uploads');
+
+        $this->assertEquals(get_class($uploadsDisk->getDriver()->getAdapter()), Local::class);
+    }
+
+    /**
+     * @test
+     */
+    public function custom_disk_exists_if_added_via_invokable_class_and_uses_local_adapter_by_default()
+    {
+        $this->extend((new Extend\Filesystem)->disk('flarum-uploads', UploadsDisk::class));
+
+        $uploadsDisk = $this->app()->getContainer()->make('filesystem')->disk('flarum-uploads');
+
+        $this->assertEquals(get_class($uploadsDisk->getDriver()->getAdapter()), Local::class);
+    }
+
+    /**
+     * @test
+     */
+    public function disk_uses_local_adapter_if_configured_adapter_unavailable()
+    {
+        $this->app()->getContainer()->make(SettingsRepositoryInterface::class)->set('disk_driver.flarum-assets', 'nonexistent_driver');
+
+        $assetsDisk = $this->app()->getContainer()->make('filesystem')->disk('flarum-assets');
+
+        $this->assertEquals(get_class($assetsDisk->getDriver()->getAdapter()), Local::class);
+    }
+
+    /**
+     * @test
+     */
+    public function disk_uses_local_adapter_if_configured_adapter_from_config_file_unavailable()
+    {
+        $this->overrideConfigWithDiskDriver();
+
+        $assetsDisk = $this->app()->getContainer()->make('filesystem')->disk('flarum-assets');
+
+        $this->assertEquals(get_class($assetsDisk->getDriver()->getAdapter()), Local::class);
+    }
+
+    /**
+     * @test
+     */
+    public function disk_uses_custom_adapter_if_configured_and_available()
+    {
+        $this->extend(
+            (new Extend\Filesystem)->driver('null', NullFilesystemDriver::class)
+        );
+
+        $this->app()->getContainer()->make(SettingsRepositoryInterface::class)->set('disk_driver.flarum-assets', 'null');
+
+        $assetsDisk = $this->app()->getContainer()->make('filesystem')->disk('flarum-assets');
+
+        $this->assertEquals(get_class($assetsDisk->getDriver()->getAdapter()), NullAdapter::class);
+    }
+
+    /**
+     * @test
+     */
+    public function disk_uses_custom_adapter_from_config_file_if_configured_and_available()
+    {
+        $this->extend(
+            (new Extend\Filesystem)->driver('null', NullFilesystemDriver::class)
+        );
+
+        $this->overrideConfigWithDiskDriver();
+
+        $assetsDisk = $this->app()->getContainer()->make('filesystem')->disk('flarum-assets');
+
+        $this->assertEquals(get_class($assetsDisk->getDriver()->getAdapter()), NullAdapter::class);
+    }
+
+    protected function overrideConfigWithDiskDriver()
+    {
+        $tmp = $this->tmpDir();
+        $configArr = include "$tmp/config.php";
+        $configArr = array_merge($configArr, ['disk_driver' => [
+            'flarum-assets' => 'null'
+        ]]);
+
+        $config = new Config($configArr);
+
+        $this->app()->getContainer()->instance('flarum.config', $config);
+    }
+}
+
+class NullFilesystemDriver implements DriverInterface
+{
+    public function build(string $diskName, SettingsRepositoryInterface $settings, Config $config, array $localConfig): Cloud
+    {
+        return new FilesystemAdapter(new LeagueFilesystem(new NullAdapter()));
+    }
+}
+
+class UploadsDisk
+{
+    public function __invoke(Paths $paths, UrlGenerator $url)
+    {
+        return [
+            'root' => "$paths->public/assets/uploads",
+            'url'  => $url->to('forum')->path('assets/uploads')
+        ];
+    }
+}