LegacyFileSystemTest.php

<?php

declare (strict_types=1);
namespace Drupal\KernelTests\Core\File;

use Drupal\Core\File\FileSystem;
use Drupal\Core\File\FileSystemInterface;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\IgnoreDeprecations;
use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;

/**
 * Tests the legacy file system functions.
 */
class LegacyFileSystemTest extends FileTestBase {
  
  /**
   * The file system under test.
   */
  protected FileSystemInterface $fileSystem;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->fileSystem = $this->container
      ->get('file_system');
  }
  
  /**
   * Tests copy with deprecated file exists.
   *
   * @legacy-covers ::copy
   */
  public function testCopyWithDeprecatedFileExists() : void {
    $uri = 'public://test.txt';
    touch($uri);
    $this->expectDeprecation('Passing the $fileExists argument as an integer to Drupal\\Core\\File\\FileSystem::copy() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\File\\FileExists enum instead. See https://www.drupal.org/node/3426517');
    $newUri = $this->fileSystem
      ->copy($uri, $uri, FileSystemInterface::EXISTS_RENAME);
    $this->assertFileExists($newUri);
  }
  
  /**
   * Tests move with deprecated file exists.
   *
   * @legacy-covers ::move
   */
  public function testMoveWithDeprecatedFileExists() : void {
    $uri = 'public://test.txt';
    touch($uri);
    $this->expectDeprecation('Passing the $fileExists argument as an integer to Drupal\\Core\\File\\FileSystem::move() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\File\\FileExists enum instead. See https://www.drupal.org/node/3426517');
    $newUri = $this->fileSystem
      ->move($uri, $uri, FileSystemInterface::EXISTS_RENAME);
    $this->assertFileExists($newUri);
  }
  
  /**
   * Tests save data with deprecated file exists.
   *
   * @legacy-covers ::saveData
   */
  public function testSaveDataWithDeprecatedFileExists() : void {
    $data = $this->randomMachineName(8);
    $uri = 'public://test.txt';
    touch($uri);
    $this->expectDeprecation('Passing the $fileExists argument as an integer to Drupal\\Core\\File\\FileSystem::saveData() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\File\\FileExists enum instead. See https://www.drupal.org/node/3426517');
    $newUri = $this->fileSystem
      ->saveData($data, $uri, FileSystemInterface::EXISTS_RENAME);
    $this->assertFileExists($newUri);
  }
  
  /**
   * Tests get destination filename with deprecated file exists.
   *
   * @legacy-covers ::getDestinationFilename
   */
  public function testGetDestinationFilenameWithDeprecatedFileExists() : void {
    $uri = 'public://test.txt';
    touch($uri);
    $newUri = $this->fileSystem
      ->getDestinationFilename($uri, FileSystemInterface::EXISTS_RENAME);
    $this->assertStringStartsWith('public://test_', $newUri);
    $this->assertNotEquals($newUri, $uri);
  }
  
  /**
   * Tests copy with out of bounds int positive.
   *
   * @legacy-covers ::copy
   */
  public function testCopyWithOutOfBoundsIntPositive() : void {
    $uri = 'public://test.txt';
    $destination = 'public://test2.txt';
    touch($uri);
    $this->expectDeprecation('Passing the $fileExists argument as an integer to Drupal\\Core\\File\\FileSystem::copy() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\File\\FileExists enum instead. See https://www.drupal.org/node/3426517');
    $this->fileSystem
      ->copy($uri, $destination, \PHP_INT_MAX);
  }
  
  /**
   * Tests copy with out of bounds int negative.
   *
   * @legacy-covers ::copy
   */
  public function testCopyWithOutOfBoundsIntNegative() : void {
    $uri = 'public://test.txt';
    $destination = 'public://test2.txt';
    touch($uri);
    $this->expectDeprecation('Passing the $fileExists argument as an integer to Drupal\\Core\\File\\FileSystem::copy() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\File\\FileExists enum instead. See https://www.drupal.org/node/3426517');
    $this->fileSystem
      ->copy($uri, $destination, \PHP_INT_MIN);
  }

}