diff --git a/src/ConnectionTester.php b/src/ConnectionTester.php index 3561e4f..5739d9f 100644 --- a/src/ConnectionTester.php +++ b/src/ConnectionTester.php @@ -4,6 +4,8 @@ declare(strict_types=1); namespace Drupal\flysystem; +use League\Flysystem\Filesystem; +use League\Flysystem\FilesystemException; use Drupal\flysystem\Adapter\FilesystemFactoryInterface; use Drupal\flysystem\Entity\FlysystemFileSystemConfigEntityInterface; use Psr\Log\LoggerInterface; @@ -55,7 +57,7 @@ class ConnectionTester { $adapter = $driverInstance->buildAdapter($resolvedConfig); // Wrap in a Filesystem and attempt a lightweight operation. - $filesystem = new \League\Flysystem\Filesystem($adapter); + $filesystem = new Filesystem($adapter); $filesystem->listContents('')->toArray(); $this->logger->info( @@ -67,7 +69,7 @@ class ConnectionTester { sprintf("Connection successful for '%s' (%s).", $scheme, $driver) ); } - catch (\League\Flysystem\FilesystemException $e) { + catch (FilesystemException $e) { $message = sprintf( "Filesystem operation failed for '%s' (%s): %s", $scheme, $driver, $e->getMessage() diff --git a/src/Controller/FlysystemImageStyleDownloadController.php b/src/Controller/FlysystemImageStyleDownloadController.php index 45ebad2..6f10728 100644 --- a/src/Controller/FlysystemImageStyleDownloadController.php +++ b/src/Controller/FlysystemImageStyleDownloadController.php @@ -4,6 +4,8 @@ declare(strict_types=1); namespace Drupal\flysystem\Controller; +use Symfony\Component\HttpFoundation\File\Exception\FileException; +use Drupal\Core\StreamWrapper\StreamWrapperManager; use Drupal\Core\File\FileSystemInterface; use Drupal\Core\Image\ImageFactory; use Drupal\Core\Lock\LockBackendInterface; @@ -14,7 +16,6 @@ use Drupal\image\ImageStyleInterface; use League\Flysystem\FilesystemException; use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\HttpFoundation\Request; -use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpFoundation\StreamedResponse; use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; @@ -99,7 +100,7 @@ class FlysystemImageStyleDownloadController extends ImageStyleDownloadController return $response; } } - catch (\Symfony\Component\HttpFoundation\File\Exception\FileException $e) { + catch (FileException $e) { // Fall through to stream from Flysystem. } catch (ServiceUnavailableHttpException $e) { @@ -113,13 +114,13 @@ class FlysystemImageStyleDownloadController extends ImageStyleDownloadController } // Reconstruct derivative URI to stream from the remote adapter. - $target = $request->query->get('file'); + $target = $request->query->get('file'); $image_uri = $scheme . '://' . $target; $derivative_uri = $image_style->buildUri($image_uri); try { $fs = $this->flysystemFactory->getFilesystem($required_derivative_scheme); - $derivative_target = \Drupal\Core\StreamWrapper\StreamWrapperManager::getTarget($derivative_uri); + $derivative_target = StreamWrapperManager::getTarget($derivative_uri); if (!$fs->fileExists($derivative_target)) { throw new NotFoundHttpException(); diff --git a/src/Controller/FlysystemPrivateFileController.php b/src/Controller/FlysystemPrivateFileController.php index ff579cd..f28985f 100644 --- a/src/Controller/FlysystemPrivateFileController.php +++ b/src/Controller/FlysystemPrivateFileController.php @@ -90,7 +90,7 @@ class FlysystemPrivateFileController implements ContainerInjectionInterface { throw new AccessDeniedHttpException('This controller only serves private Flysystem files.'); } - // Image style derivative path: styles/{style_name}/{scheme}/path/to/file + // Image style derivative path: styles/{style_name}/{scheme}/path/to/file. if (preg_match('#^styles/([^/]+)/' . preg_quote($scheme, '#') . '/(.+)$#', $file, $matches)) { return $this->deliverDerivative($request, $scheme, $matches[1], $matches[2], $definition); } @@ -163,7 +163,7 @@ class FlysystemPrivateFileController implements ContainerInjectionInterface { $original_path = $file; } - $original_uri = $scheme . '://' . $original_path; + $original_uri = $scheme . '://' . $original_path; // The derivative URI is built from the original URI by the image style, // giving us the correct target path in the adapter (including any @@ -266,7 +266,6 @@ class FlysystemPrivateFileController implements ContainerInjectionInterface { curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, TRUE); curl_exec($ch); - curl_close($ch); }, 200, $headers, diff --git a/src/FileSystem/FlysystemFileSystem.php b/src/FileSystem/FlysystemFileSystem.php index 577f57d..e379a9f 100644 --- a/src/FileSystem/FlysystemFileSystem.php +++ b/src/FileSystem/FlysystemFileSystem.php @@ -4,6 +4,8 @@ declare(strict_types=1); namespace Drupal\flysystem\FileSystem; +use Drupal\Core\StreamWrapper\StreamWrapperManager; +use League\Flysystem\FileAttributes; use Drupal\Core\File\Exception\DirectoryNotReadyException; use Drupal\Core\File\Exception\FileException; use Drupal\Core\File\Exception\FileExistsException; @@ -230,7 +232,7 @@ class FlysystemFileSystem implements FileSystemInterface { // // This is called by GDToolkit::save() with 'temporary://' so that image // derivatives can be written to a temp file before being moved into place. - $scheme = \Drupal\Core\StreamWrapper\StreamWrapperManager::getScheme($directory); + $scheme = StreamWrapperManager::getScheme($directory); if ($scheme) { if ($this->streamWrapperManager->isValidScheme($scheme)) { $wrapper = $this->streamWrapperManager->getViaScheme($scheme); @@ -425,8 +427,8 @@ class FlysystemFileSystem implements FileSystemInterface { while ($this->uriExists($destination)) { $counter++; - $info = pathinfo($basename); - $ext = isset($info['extension']) ? '.' . $info['extension'] : ''; + $info = pathinfo($basename); + $ext = isset($info['extension']) ? '.' . $info['extension'] : ''; $destination = $directory . '/' . $info['filename'] . '_' . $counter . $ext; } @@ -550,7 +552,7 @@ class FlysystemFileSystem implements FileSystemInterface { foreach ($fs->listContents($target, TRUE) as $item) { $itemPath = $scheme . '://' . $item->path(); - if ($item instanceof \League\Flysystem\FileAttributes) { + if ($item instanceof FileAttributes) { if ($callback) { $callback($itemPath); } @@ -676,8 +678,10 @@ class FlysystemFileSystem implements FileSystemInterface { * 0755 (rwxr-xr-x) → PUBLIC (group/other have read/execute) */ private function modeToVisibility(int $mode): string { - $ownerPerms = ($mode >> 6) & 7; // Bits 8–6: owner rwx. - $groupOther = $mode & 0o077; // Bits 5–0: group rwx + other rwx. + // Bits 8–6: owner rwx. + $ownerPerms = ($mode >> 6) & 7; + // Bits 5–0: group rwx + other rwx. + $groupOther = $mode & 0o077; return ($groupOther === 0 && $ownerPerms > 0) ? Visibility::PRIVATE : Visibility::PUBLIC; } @@ -691,8 +695,8 @@ class FlysystemFileSystem implements FileSystemInterface { return $fileExists; } return match ($fileExists) { - FileSystemInterface::EXISTS_REPLACE => FileExists::Replace, - FileSystemInterface::EXISTS_ERROR => FileExists::Error, + FileExists::Replace => FileExists::Replace, + FileExists::Error => FileExists::Error, default => FileExists::Rename, }; } @@ -862,16 +866,16 @@ class FlysystemFileSystem implements FileSystemInterface { } if ($depth >= $options['min_depth'] && preg_match($mask, $filename)) { - $file = new \stdClass(); - $file->uri = $uri; - $file->name = pathinfo($filename, PATHINFO_FILENAME); + $file = new \stdClass(); + $file->uri = $uri; + $file->name = pathinfo($filename, PATHINFO_FILENAME); $file->filename = $filename; if ($options['callback']) { ($options['callback'])($uri, $file); } - $keyName = $options['key']; + $keyName = $options['key']; $files[$file->$keyName] = $file; } } @@ -924,7 +928,7 @@ class FlysystemFileSystem implements FileSystemInterface { foreach ($contents as $item) { // Skip DirectoryAttributes — scanDirectory() returns files only. - if (!$item instanceof \League\Flysystem\FileAttributes) { + if (!$item instanceof FileAttributes) { continue; } diff --git a/src/Form/FlysystemFilesystemForm.php b/src/Form/FlysystemFilesystemForm.php index 0b9e6eb..a331088 100644 --- a/src/Form/FlysystemFilesystemForm.php +++ b/src/Form/FlysystemFilesystemForm.php @@ -4,6 +4,7 @@ declare(strict_types=1); namespace Drupal\flysystem\Form; +use Drupal\flysystem\Entity\FlysystemFileSystemConfigEntityInterface; use Drupal\Core\Entity\EntityForm; use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Site\Settings; @@ -174,8 +175,8 @@ class FlysystemFilesystemForm extends EntityForm { // Must live in form() (not actions()) to be rendered in the DOM. $result = $form_state->get('connection_test_result'); if ($result) { - $class = $result->success ? 'messages--status' : 'messages--error'; - $message = $result->success + $class = $result->success ? 'messages--status' : 'messages--error'; + $message = $result->success ? $this->t('Connection successful.') : $this->t('Connection failed: %message', ['%message' => $result->message]); $resultValue = $message; @@ -221,8 +222,10 @@ class FlysystemFilesystemForm extends EntityForm { // --------------------------------------------------------------------------- // Local driver fields. - // --------------------------------------------------------------------------- + /** + * --------------------------------------------------------------------------- + */ private function buildLocalFields(array &$fieldset, array $config): void { $fieldset['root'] = [ '#type' => 'textfield', @@ -235,8 +238,10 @@ class FlysystemFilesystemForm extends EntityForm { // --------------------------------------------------------------------------- // S3-compatible driver fields. - // --------------------------------------------------------------------------- + /** + * --------------------------------------------------------------------------- + */ private function buildS3Fields(array &$fieldset, array $config): void { $fieldset['bucket'] = [ '#type' => 'textfield', @@ -319,8 +324,10 @@ class FlysystemFilesystemForm extends EntityForm { // --------------------------------------------------------------------------- // AWS S3 driver fields. - // --------------------------------------------------------------------------- + /** + * --------------------------------------------------------------------------- + */ private function buildAwsS3Fields(array &$fieldset, array $config): void { $fieldset['bucket'] = [ '#type' => 'textfield', @@ -402,8 +409,10 @@ class FlysystemFilesystemForm extends EntityForm { // --------------------------------------------------------------------------- // SFTP driver fields. - // --------------------------------------------------------------------------- + /** + * --------------------------------------------------------------------------- + */ private function buildSftpFields(array &$fieldset, array $config): void { $fieldset['host'] = [ '#type' => 'textfield', @@ -584,12 +593,18 @@ class FlysystemFilesystemForm extends EntityForm { }; } + /** + * + */ private function validateLocalConfig(FormStateInterface $form_state, array $config): void { if (empty($config['root'])) { $form_state->setErrorByName('driver_config][root', $this->t('Root directory is required.')); } } + /** + * + */ private function validateS3Config(FormStateInterface $form_state, array $config): void { if (empty($config['bucket'])) { $form_state->setErrorByName('driver_config][bucket', $this->t('Bucket name is required.')); @@ -599,6 +614,9 @@ class FlysystemFilesystemForm extends EntityForm { } } + /** + * + */ private function validateAwsS3Config(FormStateInterface $form_state, array $config): void { if (empty($config['bucket'])) { $form_state->setErrorByName('driver_config][bucket', $this->t('Bucket name is required.')); @@ -608,6 +626,9 @@ class FlysystemFilesystemForm extends EntityForm { } } + /** + * + */ private function validateSftpConfig(FormStateInterface $form_state, array $config): void { if (empty($config['host'])) { $form_state->setErrorByName('driver_config][host', $this->t('Host is required.')); @@ -619,7 +640,7 @@ class FlysystemFilesystemForm extends EntityForm { $form_state->setErrorByName('driver_config][root', $this->t('Root path is required.')); } - $auth = $config['auth'] ?? []; + $auth = $config['auth'] ?? []; $hasPassword = !empty($auth['password_key_id']); $hasPrivateKey = !empty($auth['private_key_key_id']); @@ -725,10 +746,16 @@ class FlysystemFilesystemForm extends EntityForm { }; } + /** + * + */ private function buildLocalConfig(array $raw): array { return ['root' => $raw['root'] ?? '']; } + /** + * + */ private function buildS3Config(array $raw): array { $config = [ 'bucket' => $raw['bucket'] ?? '', @@ -754,6 +781,9 @@ class FlysystemFilesystemForm extends EntityForm { return array_filter($config, fn($v) => $v !== '' && $v !== NULL); } + /** + * + */ private function buildAwsS3Config(array $raw): array { $config = [ 'bucket' => $raw['bucket'] ?? '', @@ -779,6 +809,9 @@ class FlysystemFilesystemForm extends EntityForm { return array_filter($config, fn($v) => $v !== '' && $v !== NULL); } + /** + * + */ private function buildSftpConfig(array $raw): array { $auth = $raw['auth'] ?? []; @@ -813,7 +846,7 @@ class FlysystemFilesystemForm extends EntityForm { * * Used by the "Test connection" button to test before saving. */ - private function buildEntityFromFormState(FormStateInterface $form_state): \Drupal\flysystem\Entity\FlysystemFileSystemConfigEntityInterface { + private function buildEntityFromFormState(FormStateInterface $form_state): FlysystemFileSystemConfigEntityInterface { /** @var \Drupal\flysystem\Entity\FlysystemFileSystemConfigEntity $entity */ $entity = clone $this->entity; $entity->set('driver', $form_state->getValue('driver') ?? $entity->getDriver()); diff --git a/tests/src/Functional/FlysystemFilesystemFormTest.php b/tests/src/Functional/FlysystemFilesystemFormTest.php index 3b22e9d..c5fd7df 100644 --- a/tests/src/Functional/FlysystemFilesystemFormTest.php +++ b/tests/src/Functional/FlysystemFilesystemFormTest.php @@ -4,7 +4,8 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Functional; -use Drupal\Core\Site\Settings; +use PHPUnit\Framework\Attributes\Group; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\flysystem\Entity\FlysystemFileSystemConfigEntity; use Drupal\Tests\BrowserTestBase; @@ -18,6 +19,8 @@ use Drupal\Tests\BrowserTestBase; * * @group flysystem */ +#[Group('flysystem')] +#[RunTestsInSeparateProcesses] class FlysystemFilesystemFormTest extends BrowserTestBase { /** @@ -164,21 +167,17 @@ class FlysystemFilesystemFormTest extends BrowserTestBase { // rendered after an Ajax driver-select change — BrowserTestBase has no // JavaScript engine so the driver_config fields for non-default drivers // are never present in the DOM. - - // S3 driver validation tests — tested at HTTP level (no Ajax needed) because // BrowserTestBase::submitForm() POSTs directly without requiring the Ajax // driver-select flow. The driver_config fields don't need to be in the // rendered DOM; they just need to be in the POST body. - // S3/SFTP driver field validation is tested in // FlysystemFilesystemFormJavascriptTest (which uses a real browser and can // trigger the Ajax driver-select before submitting). BrowserTestBase cannot // reach driver_config fields because they are only rendered after Ajax fires. - // --------------------------------------------------------------------------- // Create / edit / delete. - // --------------------------------------------------------------------------- + // ---------------------------------------------------------------------------. /** * A valid local filesystem entity can be created via the form. @@ -379,17 +378,6 @@ class FlysystemFilesystemFormTest extends BrowserTestBase { // --------------------------------------------------------------------------- // Driver field switching. // --------------------------------------------------------------------------- - - - - - - - - - - - // --------------------------------------------------------------------------- // "Test connection" button. // --------------------------------------------------------------------------- @@ -409,7 +397,7 @@ class FlysystemFilesystemFormTest extends BrowserTestBase { $this->assertSession()->buttonExists('Test connection'); } - /** + /** * A connection test with an invalid local root shows a failure message. */ public function testConnectionTestButtonShowsFailureForInvalidConfig(): void { diff --git a/tests/src/FunctionalJavascript/FlysystemFilesystemFormJavascriptTest.php b/tests/src/FunctionalJavascript/FlysystemFilesystemFormJavascriptTest.php index 4bbd4eb..12b2011 100644 --- a/tests/src/FunctionalJavascript/FlysystemFilesystemFormJavascriptTest.php +++ b/tests/src/FunctionalJavascript/FlysystemFilesystemFormJavascriptTest.php @@ -4,6 +4,8 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\FunctionalJavascript; +use PHPUnit\Framework\Attributes\Group; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\FunctionalJavascriptTests\WebDriverTestBase; /** @@ -20,6 +22,9 @@ use Drupal\FunctionalJavascriptTests\WebDriverTestBase; * @group flysystem * @group javascript */ +#[Group('flysystem')] +#[Group('javascript')] +#[RunTestsInSeparateProcesses] class FlysystemFilesystemFormJavascriptTest extends WebDriverTestBase { /** @@ -46,7 +51,6 @@ class FlysystemFilesystemFormJavascriptTest extends WebDriverTestBase { // Driver field switching via Ajax. // --------------------------------------------------------------------------- - /** * Switching to the S3-compatible driver shows S3-specific fields. */ @@ -130,7 +134,7 @@ class FlysystemFilesystemFormJavascriptTest extends WebDriverTestBase { $page = $this->getSession()->getPage(); - // local is the default driver — root field should already be present. + // Local is the default driver — root field should already be present. $this->assertSession()->fieldExists('driver_config[root]'); // Switch to s3 — this triggers Ajax. @@ -152,7 +156,7 @@ class FlysystemFilesystemFormJavascriptTest extends WebDriverTestBase { $page->fillField('label', 'Ajax test filesystem'); $page->fillField('public_url_base', 'https://example.com/files'); - // local is the default — no need to switch, which avoids the + // Local is the default — no need to switch, which avoids the // "no Ajax requests" error from selecting an already-selected value. $page->fillField('driver_config[root]', sys_get_temp_dir()); @@ -163,6 +167,4 @@ class FlysystemFilesystemFormJavascriptTest extends WebDriverTestBase { $this->assertNotEmpty($resultDiv->getText()); } - - } diff --git a/tests/src/Kernel/Controller/FlysystemImageStyleDownloadControllerTest.php b/tests/src/Kernel/Controller/FlysystemImageStyleDownloadControllerTest.php index c417520..ff26fdf 100644 --- a/tests/src/Kernel/Controller/FlysystemImageStyleDownloadControllerTest.php +++ b/tests/src/Kernel/Controller/FlysystemImageStyleDownloadControllerTest.php @@ -4,6 +4,10 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Kernel\Controller; +use PHPUnit\Framework\Attributes\Group; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; +use Symfony\Component\HttpKernel\Exception\HttpException; +use Symfony\Component\HttpFoundation\File\Exception\FileException; use Drupal\Core\Site\Settings; use Drupal\flysystem\Controller\FlysystemImageStyleDownloadController; use Drupal\image\Entity\ImageStyle; @@ -36,6 +40,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; * @group flysystem * @coversDefaultClass \Drupal\flysystem\Controller\FlysystemImageStyleDownloadController */ +#[Group('flysystem')] +#[RunTestsInSeparateProcesses] class FlysystemImageStyleDownloadControllerTest extends KernelTestBase { /** @@ -173,7 +179,7 @@ class FlysystemImageStyleDownloadControllerTest extends KernelTestBase { */ public function testRouteCollectionBuildsWithoutFatal(): void { // This must not throw. If the regression is present it throws: - // TypeError: Call to a member function getDirectoryPath() on false + // TypeError: Call to a member function getDirectoryPath() on false. $this->container->get('router.builder')->rebuild(); $this->assertTrue(TRUE, 'Route collection built without fatal error.'); } @@ -201,7 +207,7 @@ class FlysystemImageStyleDownloadControllerTest extends KernelTestBase { $response = $controller->deliver($request, 'public', $style, 'public'); $this->assertNotInstanceOf(StreamedResponse::class, $response); } - catch (\Symfony\Component\HttpKernel\Exception\HttpException $e) { + catch (HttpException $e) { // Core threw an HTTP exception (404/403) — confirms delegation worked. $this->assertTrue(TRUE); } @@ -232,7 +238,7 @@ class FlysystemImageStyleDownloadControllerTest extends KernelTestBase { catch (NotFoundHttpException $e) { $this->assertTrue(TRUE); } - catch (\Symfony\Component\HttpFoundation\File\Exception\FileException $e) { + catch (FileException $e) { $this->assertTrue(TRUE); } } diff --git a/tests/src/Kernel/Entity/FlysystemFileSystemConfigEntityTest.php b/tests/src/Kernel/Entity/FlysystemFileSystemConfigEntityTest.php index 0097526..4ce7386 100644 --- a/tests/src/Kernel/Entity/FlysystemFileSystemConfigEntityTest.php +++ b/tests/src/Kernel/Entity/FlysystemFileSystemConfigEntityTest.php @@ -4,6 +4,8 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Kernel\Entity; +use PHPUnit\Framework\Attributes\Group; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\flysystem\Entity\FlysystemFileSystemConfigEntity; use Drupal\flysystem\Exception\AdapterConfigurationException; use Drupal\KernelTests\KernelTestBase; @@ -18,6 +20,8 @@ use Drupal\KernelTests\KernelTestBase; * @group flysystem * @coversDefaultClass \Drupal\flysystem\Entity\FlysystemFileSystemConfigEntity */ +#[Group('flysystem')] +#[RunTestsInSeparateProcesses] class FlysystemFileSystemConfigEntityTest extends KernelTestBase { /** diff --git a/tests/src/Unit/Adapter/AdapterDefinitionTest.php b/tests/src/Unit/Adapter/AdapterDefinitionTest.php index 494cf56..53ded63 100644 --- a/tests/src/Unit/Adapter/AdapterDefinitionTest.php +++ b/tests/src/Unit/Adapter/AdapterDefinitionTest.php @@ -4,6 +4,7 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Unit\Adapter; +use PHPUnit\Framework\Attributes\Group; use Drupal\flysystem\Adapter\AdapterDefinition; use Drupal\Tests\UnitTestCase; @@ -11,6 +12,7 @@ use Drupal\Tests\UnitTestCase; * @coversDefaultClass \Drupal\flysystem\Adapter\AdapterDefinition * @group flysystem */ +#[Group('flysystem')] class AdapterDefinitionTest extends UnitTestCase { // --------------------------------------------------------------------------- diff --git a/tests/src/Unit/Adapter/AsyncAwsS3AdapterDriverTest.php b/tests/src/Unit/Adapter/AsyncAwsS3AdapterDriverTest.php index 0eb1ea0..92abcd9 100644 --- a/tests/src/Unit/Adapter/AsyncAwsS3AdapterDriverTest.php +++ b/tests/src/Unit/Adapter/AsyncAwsS3AdapterDriverTest.php @@ -4,6 +4,7 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Unit\Adapter; +use PHPUnit\Framework\Attributes\Group; use Drupal\flysystem\Adapter\AsyncAwsS3AdapterDriver; use Drupal\flysystem\Exception\AdapterConfigurationException; use League\Flysystem\AsyncAwsS3\AsyncAwsS3Adapter; @@ -14,8 +15,12 @@ use Drupal\Tests\UnitTestCase; * @coversDefaultClass \Drupal\flysystem\Adapter\AsyncAwsS3AdapterDriver * @group flysystem */ +#[Group('flysystem')] class AsyncAwsS3AdapterDriverTest extends UnitTestCase { + /** + * + */ private function baseConfig(array $overrides = []): array { return array_merge([ 'bucket' => 'test-bucket', @@ -101,7 +106,7 @@ class AsyncAwsS3AdapterDriverTest extends UnitTestCase { */ public function testBuildAdapterDefaultVisibilityIsPublic(): void { // No default_visibility key — should default to public without throwing. - $config = $this->baseConfig(); + $config = $this->baseConfig(); unset($config['default_visibility']); $adapter = (new AsyncAwsS3AdapterDriver())->buildAdapter($config); $this->assertInstanceOf(AsyncAwsS3Adapter::class, $adapter); diff --git a/tests/src/Unit/Adapter/AwsS3AdapterDriverTest.php b/tests/src/Unit/Adapter/AwsS3AdapterDriverTest.php index 96c62b0..61d4abc 100644 --- a/tests/src/Unit/Adapter/AwsS3AdapterDriverTest.php +++ b/tests/src/Unit/Adapter/AwsS3AdapterDriverTest.php @@ -4,6 +4,7 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Unit\Adapter; +use PHPUnit\Framework\Attributes\Group; use Aws\CommandInterface; use Aws\S3\S3Client; use Drupal\flysystem\Adapter\AwsS3AdapterDriver; @@ -18,8 +19,12 @@ use Psr\Http\Message\RequestInterface; * @coversDefaultClass \Drupal\flysystem\Adapter\AwsS3AdapterDriver * @group flysystem */ +#[Group('flysystem')] class AwsS3AdapterDriverTest extends UnitTestCase { + /** + * + */ private function baseConfig(array $overrides = []): array { return array_merge([ 'bucket' => 'test-bucket', @@ -192,9 +197,9 @@ class AwsS3AdapterDriverTest extends UnitTestCase { ->with($command, '+1800 seconds') ->willReturn($psrRequest); - $driver = new AwsS3AdapterDriver(); - $config = $this->baseConfig(['presigned_expiry' => 1800]); - $cacheKey = md5(serialize([$config['region'], []])); + $driver = new AwsS3AdapterDriver(); + $config = $this->baseConfig(['presigned_expiry' => 1800]); + $cacheKey = md5(serialize([$config['region'], []])); $reflection = new \ReflectionProperty(AwsS3AdapterDriver::class, 'clients'); $reflection->setValue($driver, [$cacheKey => $s3Client]); diff --git a/tests/src/Unit/Adapter/FilesystemFactoryTest.php b/tests/src/Unit/Adapter/FilesystemFactoryTest.php index dd2d7b7..a56d15e 100644 --- a/tests/src/Unit/Adapter/FilesystemFactoryTest.php +++ b/tests/src/Unit/Adapter/FilesystemFactoryTest.php @@ -4,6 +4,7 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Unit\Adapter; +use PHPUnit\Framework\Attributes\Group; use Drupal\Core\Config\ConfigFactoryInterface; use Drupal\Core\Config\ImmutableConfig; use Drupal\Core\Site\Settings; @@ -17,8 +18,12 @@ use Psr\Log\NullLogger; * @coversDefaultClass \Drupal\flysystem\Adapter\FilesystemFactory * @group flysystem */ +#[Group('flysystem')] class FilesystemFactoryTest extends UnitTestCase { + /** + * + */ private function buildFactory(array $settingsData = [], array $configData = []): FilesystemFactory { new Settings($settingsData); @@ -186,7 +191,6 @@ class FilesystemFactoryTest extends UnitTestCase { $factory->getFilesystem('no_root'); } - // --------------------------------------------------------------------------- // Built-in scheme blocking. // --------------------------------------------------------------------------- @@ -255,7 +259,6 @@ class FilesystemFactoryTest extends UnitTestCase { $this->assertContains('media', $schemes); } - /** * @covers ::hasScheme * @covers ::getSchemes @@ -264,6 +267,7 @@ class FilesystemFactoryTest extends UnitTestCase { * hasScheme() returns FALSE and getSchemes() excludes them even when they * appear in settings.php. */ + /** * @covers ::hasScheme * @covers ::getSchemes diff --git a/tests/src/Unit/Adapter/LocalAdapterDriverTest.php b/tests/src/Unit/Adapter/LocalAdapterDriverTest.php index 7668548..0554391 100644 --- a/tests/src/Unit/Adapter/LocalAdapterDriverTest.php +++ b/tests/src/Unit/Adapter/LocalAdapterDriverTest.php @@ -4,6 +4,7 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Unit\Adapter; +use PHPUnit\Framework\Attributes\Group; use Drupal\flysystem\Adapter\LocalAdapterDriver; use Drupal\flysystem\Exception\AdapterConfigurationException; use League\Flysystem\FilesystemAdapter; @@ -14,6 +15,7 @@ use Drupal\Tests\UnitTestCase; * @coversDefaultClass \Drupal\flysystem\Adapter\LocalAdapterDriver * @group flysystem */ +#[Group('flysystem')] class LocalAdapterDriverTest extends UnitTestCase { /** diff --git a/tests/src/Unit/Adapter/SftpAdapterDriverTest.php b/tests/src/Unit/Adapter/SftpAdapterDriverTest.php index 8873992..99eacc4 100644 --- a/tests/src/Unit/Adapter/SftpAdapterDriverTest.php +++ b/tests/src/Unit/Adapter/SftpAdapterDriverTest.php @@ -4,6 +4,7 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Unit\Adapter; +use PHPUnit\Framework\Attributes\Group; use Drupal\flysystem\Adapter\SftpAdapterDriver; use Drupal\flysystem\Exception\AdapterConfigurationException; use League\Flysystem\FilesystemAdapter; @@ -14,8 +15,12 @@ use Drupal\Tests\UnitTestCase; * @coversDefaultClass \Drupal\flysystem\Adapter\SftpAdapterDriver * @group flysystem */ +#[Group('flysystem')] class SftpAdapterDriverTest extends UnitTestCase { + /** + * + */ private function baseConfig(array $overrides = []): array { return array_merge([ 'host' => 'sftp.example.com', diff --git a/tests/src/Unit/ConnectionTestResultTest.php b/tests/src/Unit/ConnectionTestResultTest.php index 5a092a1..a88e4dd 100644 --- a/tests/src/Unit/ConnectionTestResultTest.php +++ b/tests/src/Unit/ConnectionTestResultTest.php @@ -4,6 +4,7 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Unit; +use PHPUnit\Framework\Attributes\Group; use Drupal\flysystem\ConnectionTestResult; use Drupal\Tests\UnitTestCase; @@ -11,6 +12,7 @@ use Drupal\Tests\UnitTestCase; * @coversDefaultClass \Drupal\flysystem\ConnectionTestResult * @group flysystem */ +#[Group('flysystem')] class ConnectionTestResultTest extends UnitTestCase { /** diff --git a/tests/src/Unit/ConnectionTesterTest.php b/tests/src/Unit/ConnectionTesterTest.php index 82c4e3b..61cd44a 100644 --- a/tests/src/Unit/ConnectionTesterTest.php +++ b/tests/src/Unit/ConnectionTesterTest.php @@ -4,6 +4,8 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Unit; +use PHPUnit\Framework\Attributes\Group; +use League\Flysystem\UnableToListContents; use Drupal\flysystem\Adapter\AdapterDriverInterface; use Drupal\flysystem\Adapter\FilesystemFactoryInterface; use Drupal\flysystem\ConnectionTester; @@ -20,6 +22,7 @@ use Psr\Log\NullLogger; * @coversDefaultClass \Drupal\flysystem\ConnectionTester * @group flysystem */ +#[Group('flysystem')] class ConnectionTesterTest extends UnitTestCase { /** @@ -112,10 +115,16 @@ class ConnectionTesterTest extends UnitTestCase { public function testSuccessIsLoggedAtInfoLevel(): void { $logged = []; $logger = new class($logged) extends AbstractLogger { + public function __construct(private array &$log) {} + + /** + * + */ public function log($level, $message, array $context = []): void { $this->log[] = ['level' => $level, 'message' => $message]; } + }; $tester = new ConnectionTester( @@ -212,10 +221,16 @@ class ConnectionTesterTest extends UnitTestCase { public function testAdapterBuildFailureIsLoggedAtWarningLevel(): void { $logged = []; $logger = new class($logged) extends AbstractLogger { + public function __construct(private array &$log) {} + + /** + * + */ public function log($level, $message, array $context = []): void { $this->log[] = ['level' => $level, 'message' => $message]; } + }; $driver = $this->createMock(AdapterDriverInterface::class); @@ -242,7 +257,7 @@ class ConnectionTesterTest extends UnitTestCase { // the adapter in a mock that throws on listContents. $adapter = $this->createMock(FilesystemAdapter::class); $adapter->method('listContents') - ->willThrowException(new \League\Flysystem\UnableToListContents('Connection refused', 0)); + ->willThrowException(new UnableToListContents('Connection refused', 0)); $driver = $this->buildDriver($adapter); $tester = new ConnectionTester($this->buildFactory($driver), new NullLogger()); diff --git a/tests/src/Unit/Controller/FlysystemPrivateFileControllerTest.php b/tests/src/Unit/Controller/FlysystemPrivateFileControllerTest.php index a600c3b..ca73c20 100644 --- a/tests/src/Unit/Controller/FlysystemPrivateFileControllerTest.php +++ b/tests/src/Unit/Controller/FlysystemPrivateFileControllerTest.php @@ -4,6 +4,10 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Unit\Controller; +use PHPUnit\Framework\Attributes\Group; +use Drupal\flysystem\Adapter\AdapterDriverInterface; +use Drupal\file\FileInterface; +use Symfony\Component\HttpKernel\Exception\ServiceUnavailableHttpException; use Drupal\Core\Entity\EntityStorageInterface; use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Session\AccountInterface; @@ -23,10 +27,14 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; * @coversDefaultClass \Drupal\flysystem\Controller\FlysystemPrivateFileController * @group flysystem */ +#[Group('flysystem')] class FlysystemPrivateFileControllerTest extends UnitTestCase { private Filesystem $filesystem; + /** + * + */ protected function setUp(): void { parent::setUp(); @@ -67,7 +75,7 @@ class FlysystemPrivateFileControllerTest extends UnitTestCase { // Use a plain AdapterDriverInterface mock (not AwsS3AdapterDriver) so // streamFromAdapter() takes the direct readStream() path rather than // attempting a curl presigned URL request, which would fail in unit tests. - $driver = $this->createMock(\Drupal\flysystem\Adapter\AdapterDriverInterface::class); + $driver = $this->createMock(AdapterDriverInterface::class); $factory = $this->createMock(FilesystemFactoryInterface::class); $factory->method('hasScheme')->willReturn(TRUE); @@ -84,7 +92,7 @@ class FlysystemPrivateFileControllerTest extends UnitTestCase { $fileEntities = []; foreach ($fileOwners as $uri => $ownerId) { - $file = $this->createMock(\Drupal\file\FileInterface::class); + $file = $this->createMock(FileInterface::class); $file->method('getOwnerId')->willReturn($ownerId); $fileEntities[$uri][] = $file; } @@ -309,7 +317,7 @@ class FlysystemPrivateFileControllerTest extends UnitTestCase { // Receiving a 503 confirms the extension was stripped correctly and // the original file was located. $this->expectException( - \Symfony\Component\HttpKernel\Exception\ServiceUnavailableHttpException::class + ServiceUnavailableHttpException::class ); $controller->serveFile( diff --git a/tests/src/Unit/FileSystem/FlysystemFileSystemTest.php b/tests/src/Unit/FileSystem/FlysystemFileSystemTest.php index cfade31..97489f9 100644 --- a/tests/src/Unit/FileSystem/FlysystemFileSystemTest.php +++ b/tests/src/Unit/FileSystem/FlysystemFileSystemTest.php @@ -4,8 +4,9 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Unit\FileSystem; -use Drupal\Core\File\Exception\DirectoryNotReadyException; -use Drupal\Core\File\Exception\FileException; +use PHPUnit\Framework\Attributes\Group; +use Drupal\Core\File\Exception\FileExistsException; +use Drupal\Component\Utility\DeprecationHelper; use Drupal\Core\File\FileExists; use Drupal\Core\Site\Settings; use Drupal\Core\StreamWrapper\StreamWrapperManagerInterface; @@ -20,6 +21,7 @@ use Psr\Log\NullLogger; * @coversDefaultClass \Drupal\flysystem\FileSystem\FlysystemFileSystem * @group flysystem */ +#[Group('flysystem')] class FlysystemFileSystemTest extends UnitTestCase { /** @@ -37,6 +39,9 @@ class FlysystemFileSystemTest extends UnitTestCase { */ private const SCHEME = 'flysystem+local'; + /** + * + */ protected function setUp(): void { parent::setUp(); @@ -117,7 +122,7 @@ class FlysystemFileSystemTest extends UnitTestCase { public function testSaveDataWithErrorThrowsWhenFileExists(): void { $this->inMemoryFs->write('data/exists.txt', 'existing'); - $this->expectException(\Drupal\Core\File\Exception\FileExistsException::class); + $this->expectException(FileExistsException::class); $this->fileSystem->saveData( 'new content', $this->uri('data/exists.txt'), @@ -479,8 +484,8 @@ class FlysystemFileSystemTest extends UnitTestCase { * @covers ::basename */ public function testBasename(): void { - $this->assertSame('file.txt', $this->fileSystem->basename($this->uri('path/to/file.txt'))); - $this->assertSame('file', $this->fileSystem->basename($this->uri('path/to/file.txt'), '.txt')); + $this->assertSame('file.txt', DeprecationHelper::backwardsCompatibleCall(\Drupal::VERSION, '11.3.0', fn() => basename($this->uri('path/to/file.txt')), fn() => $this->fileSystem->basename($this->uri('path/to/file.txt')))); + $this->assertSame('file', DeprecationHelper::backwardsCompatibleCall(\Drupal::VERSION, '11.3.0', fn() => basename($this->uri('path/to/file.txt'), '.txt'), fn() => $this->fileSystem->basename($this->uri('path/to/file.txt'), '.txt'))); } // --------------------------------------------------------------------------- diff --git a/tests/src/Unit/Routing/FlysystemRouteSubscriberTest.php b/tests/src/Unit/Routing/FlysystemRouteSubscriberTest.php index ffbac56..f97dcd0 100644 --- a/tests/src/Unit/Routing/FlysystemRouteSubscriberTest.php +++ b/tests/src/Unit/Routing/FlysystemRouteSubscriberTest.php @@ -4,7 +4,9 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Unit\Routing; -use Drupal\Core\StreamWrapper\StreamWrapperInterface; +use PHPUnit\Framework\Attributes\Group; +use Drupal\Core\StreamWrapper\LocalStream; +use Drupal\flysystem\StreamWrapper\FlysystemStreamWrapper; use Drupal\Core\StreamWrapper\StreamWrapperManagerInterface; use Drupal\flysystem\Adapter\AdapterDefinition; use Drupal\flysystem\Adapter\FilesystemFactoryInterface; @@ -17,6 +19,7 @@ use Symfony\Component\Routing\RouteCollection; * @coversDefaultClass \Drupal\flysystem\Routing\FlysystemRouteSubscriber * @group flysystem */ +#[Group('flysystem')] class FlysystemRouteSubscriberTest extends UnitTestCase { private const PUBLIC_DIR = 'sites/default/files'; @@ -51,7 +54,7 @@ class FlysystemRouteSubscriberTest extends UnitTestCase { $manager = $this->createMock(StreamWrapperManagerInterface::class); - $publicWrapper = $this->createMock(\Drupal\Core\StreamWrapper\LocalStream::class); + $publicWrapper = $this->createMock(LocalStream::class); $publicWrapper->method('getDirectoryPath')->willReturn(self::PUBLIC_DIR); $manager->method('getViaScheme')->willReturn($publicWrapper); @@ -59,7 +62,7 @@ class FlysystemRouteSubscriberTest extends UnitTestCase { function (string $scheme) use ($schemes) { $writable = $schemes[$scheme]['writable'] ?? TRUE; return $writable - ? \Drupal\flysystem\StreamWrapper\FlysystemStreamWrapper::class + ? FlysystemStreamWrapper::class : NULL; } ); @@ -259,7 +262,7 @@ class FlysystemRouteSubscriberTest extends UnitTestCase { */ public function testMultipleSchemesRegisterSeparateImageStyleRoutes(): void { $subscriber = $this->buildSubscriber([ - 'media' => ['driver' => 's3', 'visibility' => 'public'], + 'media' => ['driver' => 's3', 'visibility' => 'public'], 'flylocal' => ['driver' => 'local', 'visibility' => 'public'], ]); $collection = $this->getRoutes($subscriber); @@ -343,7 +346,6 @@ class FlysystemRouteSubscriberTest extends UnitTestCase { ); } - // --------------------------------------------------------------------------- // Internal read-only schemes skipped. // --------------------------------------------------------------------------- @@ -355,6 +357,7 @@ class FlysystemRouteSubscriberTest extends UnitTestCase { * somehow present in the factory's scheme list (e.g. via a misconfigured * config entity). No routes must be registered for them. */ + /** * @covers ::alterRoutes * diff --git a/tests/src/Unit/StreamWrapper/FlysystemStreamWrapperManagerTest.php b/tests/src/Unit/StreamWrapper/FlysystemStreamWrapperManagerTest.php index d809f84..69f696c 100644 --- a/tests/src/Unit/StreamWrapper/FlysystemStreamWrapperManagerTest.php +++ b/tests/src/Unit/StreamWrapper/FlysystemStreamWrapperManagerTest.php @@ -4,6 +4,8 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Unit\StreamWrapper; +use PHPUnit\Framework\Attributes\Group; +use Drupal\Core\StreamWrapper\StreamWrapperManagerInterface; use Drupal\Core\Config\ConfigFactoryInterface; use Drupal\Core\Config\ImmutableConfig; use Drupal\Core\Site\Settings; @@ -27,11 +29,23 @@ use Psr\Log\NullLogger; * stream_wrapper services by FlysystemServiceProvider::alter(). Config-entity * schemes are discovered and registered lazily by this class on first access. */ +#[Group('flysystem +FlysystemStreamWrapperManager is a PHP stream-wrapper registration helper +for Flysystem schemes. It does NOT implement StreamWrapperManagerInterface +and does NOT replace Drupal core\'s stream_wrapper_manager service. +Core\'s StreamWrapperManager is kept intact so that built-in schemes +(public://, private://, temporary://, etc.) continue to resolve correctly. +Settings.php schemes are registered at container-build time as tagged +stream_wrapper services by FlysystemServiceProvider::alter(). Config-entity +schemes are discovered and registered lazily by this class on first access.')] class FlysystemStreamWrapperManagerTest extends UnitTestCase { private FilesystemFactory $factory; private FlysystemStreamWrapperManager $manager; + /** + * + */ protected function setUp(): void { parent::setUp(); @@ -64,6 +78,9 @@ class FlysystemStreamWrapperManagerTest extends UnitTestCase { $this->manager = new FlysystemStreamWrapperManager($this->factory); } + /** + * + */ protected function tearDown(): void { parent::tearDown(); foreach (['testlocal', 'testcfg'] as $scheme) { @@ -381,7 +398,7 @@ class FlysystemStreamWrapperManagerTest extends UnitTestCase { */ public function testDoesNotImplementStreamWrapperManagerInterface(): void { $this->assertNotInstanceOf( - \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface::class, + StreamWrapperManagerInterface::class, $this->manager, 'FlysystemStreamWrapperManager must NOT implement StreamWrapperManagerInterface. ' . 'Replacing core\'s stream_wrapper_manager breaks ImageStyleRoutes::routes() ' diff --git a/tests/src/Unit/StreamWrapper/FlysystemStreamWrapperTest.php b/tests/src/Unit/StreamWrapper/FlysystemStreamWrapperTest.php index 19dc991..9f1bcb0 100644 --- a/tests/src/Unit/StreamWrapper/FlysystemStreamWrapperTest.php +++ b/tests/src/Unit/StreamWrapper/FlysystemStreamWrapperTest.php @@ -4,6 +4,8 @@ declare(strict_types=1); namespace Drupal\Tests\flysystem\Unit\StreamWrapper; +use PHPUnit\Framework\Attributes\Group; +use Drupal\flysystem\Adapter\AdapterDefinition; use Drupal\flysystem\Adapter\FilesystemFactoryInterface; use Drupal\flysystem\StreamWrapper\FlysystemStreamWrapper; use League\Flysystem\Filesystem; @@ -16,11 +18,16 @@ use Drupal\Tests\UnitTestCase; * * Uses the InMemory adapter — no filesystem I/O required. */ +#[Group('flysystem +Uses the InMemory adapter — no filesystem I/O required.')] class FlysystemStreamWrapperTest extends UnitTestCase { private FlysystemStreamWrapper $wrapper; private Filesystem $filesystem; + /** + * + */ protected function setUp(): void { parent::setUp(); @@ -103,7 +110,8 @@ class FlysystemStreamWrapperTest extends UnitTestCase { $this->wrapper->stream_open($uri, 'r', 0, $opened); $this->assertFalse($this->wrapper->stream_eof()); - $this->wrapper->stream_read(100); // Read past end. + // Read past end. + $this->wrapper->stream_read(100); $this->assertTrue($this->wrapper->stream_eof()); $this->wrapper->stream_close(); } @@ -160,7 +168,7 @@ class FlysystemStreamWrapperTest extends UnitTestCase { $uri = 'flysystem+local://rewinddir'; $this->wrapper->dir_opendir($uri, 0); - $first = $this->wrapper->dir_readdir(); + $first = $this->wrapper->dir_readdir(); $this->wrapper->dir_rewinddir(); $second = $this->wrapper->dir_readdir(); $this->wrapper->dir_closedir(); @@ -266,7 +274,7 @@ class FlysystemStreamWrapperTest extends UnitTestCase { string $drupalBaseUrl = 'https://mysite.example.com', string $publicDirectoryPath = 'sites/default/files', ): FlysystemStreamWrapper { - $definition = new \Drupal\flysystem\Adapter\AdapterDefinition( + $definition = new AdapterDefinition( scheme: $defProps['scheme'] ?? 'media', driver: $defProps['driver'] ?? 'local', config: $defProps['config'] ?? [], @@ -293,13 +301,20 @@ class FlysystemStreamWrapperTest extends UnitTestCase { // Do not call parent — no context setup needed. } + /** + * + */ protected function getDrupalBaseUrl(): string { return $this->testBaseUrl . '/'; } + /** + * + */ protected function getPublicDirectoryPath(): ?string { return $this->testDirPath; } + }; $wrapper->setFactory($factory);