FileCopyTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\migrate\Kernel\process;

use Drupal\Core\StreamWrapper\StreamWrapperInterface;
use Drupal\KernelTests\Core\File\FileTestBase;
use Drupal\migrate\MigrateException;
use Drupal\migrate\Plugin\migrate\process\FileCopy;
use Drupal\migrate\MigrateExecutableInterface;
use Drupal\migrate\Plugin\MigrateProcessInterface;
use Drupal\migrate\Row;
use GuzzleHttp\Client;

/**
 * Tests the file_copy process plugin.
 *
 * @coversDefaultClass \Drupal\migrate\Plugin\migrate\process\FileCopy
 *
 * @group migrate
 */
class FileCopyTest extends FileTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'migrate',
    'system',
  ];

  /**
   * The file system service.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->fileSystem = $this->container
      ->get('file_system');
    $this->container
      ->get('stream_wrapper_manager')
      ->registerWrapper('temporary', 'Drupal\\Core\\StreamWrapper\\TemporaryStream', StreamWrapperInterface::LOCAL_NORMAL);
  }

  /**
   * Tests successful imports/copies.
   */
  public function testSuccessfulCopies() {
    $file = $this
      ->createUri(NULL, NULL, 'temporary');
    $file_absolute = $this->fileSystem
      ->realpath($file);
    $data_sets = [
      // Test a local to local copy.
      [
        $this->root . '/core/tests/fixtures/files/image-test.jpg',
        'public://file1.jpg',
      ],
      // Test a temporary file using an absolute path.
      [
        $file_absolute,
        'temporary://test.jpg',
      ],
      // Test a temporary file using a relative path.
      [
        $file_absolute,
        'temporary://core/tests/fixtures/files/test.jpg',
      ],
    ];
    foreach ($data_sets as $data) {
      [
        $source_path,
        $destination_path,
      ] = $data;
      $actual_destination = $this
        ->doTransform($source_path, $destination_path);
      $this
        ->assertFileExists($destination_path);

      // Make sure we didn't accidentally do a move.
      $this
        ->assertFileExists($source_path);
      $this
        ->assertSame($actual_destination, $destination_path, 'The import returned the copied filename.');
    }
  }

  /**
   * Tests successful file reuse.
   *
   * @dataProvider providerSuccessfulReuse
   *
   * @param string $source_path
   *   Source path to copy from.
   * @param string $destination_path
   *   The destination path to copy to.
   */
  public function testSuccessfulReuse($source_path, $destination_path) {
    $file_reuse = $this
      ->doTransform($source_path, $destination_path);
    clearstatcache(TRUE, $destination_path);
    $timestamp = (new \SplFileInfo($file_reuse))
      ->getMTime();
    $this
      ->assertIsInt($timestamp);

    // We need to make sure the modified timestamp on the file is sooner than
    // the attempted migration.
    sleep(1);
    $configuration = [
      'file_exists' => 'use existing',
    ];
    $this
      ->doTransform($source_path, $destination_path, $configuration);
    clearstatcache(TRUE, $destination_path);
    $modified_timestamp = (new \SplFileInfo($destination_path))
      ->getMTime();
    $this
      ->assertEquals($timestamp, $modified_timestamp);
    $this
      ->doTransform($source_path, $destination_path);
    clearstatcache(TRUE, $destination_path);
    $modified_timestamp = (new \SplFileInfo($destination_path))
      ->getMTime();
    $this
      ->assertGreaterThan($timestamp, $modified_timestamp);
  }

  /**
   * Provides the source and destination path files.
   */
  public static function providerSuccessfulReuse() {
    return [
      [
        'local_source_path' => static::getDrupalRoot() . '/core/tests/fixtures/files/image-test.jpg',
        'local_destination_path' => 'public://file1.jpg',
      ],
      [
        'remote_source_path' => 'https://www.drupal.org/favicon.ico',
        'remote_destination_path' => 'public://file2.jpg',
      ],
    ];
  }

  /**
   * Tests successful moves.
   */
  public function testSuccessfulMoves() {
    $file_1 = $this
      ->createUri(NULL, NULL, 'temporary');
    $file_1_absolute = $this->fileSystem
      ->realpath($file_1);
    $file_2 = $this
      ->createUri(NULL, NULL, 'temporary');
    $file_2_absolute = $this->fileSystem
      ->realpath($file_2);
    $local_file = $this
      ->createUri(NULL, NULL, 'public');
    $data_sets = [
      // Test a local to local copy.
      [
        $local_file,
        'public://file1.jpg',
      ],
      // Test a temporary file using an absolute path.
      [
        $file_1_absolute,
        'temporary://test.jpg',
      ],
      // Test a temporary file using a relative path.
      [
        $file_2_absolute,
        'temporary://core/tests/fixtures/files/test.jpg',
      ],
    ];
    foreach ($data_sets as $data) {
      [
        $source_path,
        $destination_path,
      ] = $data;
      $actual_destination = $this
        ->doTransform($source_path, $destination_path, [
        'move' => TRUE,
      ]);
      $this
        ->assertFileExists($destination_path);
      $this
        ->assertFileDoesNotExist($source_path);
      $this
        ->assertSame($actual_destination, $destination_path, 'The importer returned the moved filename.');
    }
  }

  /**
   * Tests that non-existent files throw an exception.
   */
  public function testNonExistentSourceFile() {
    $source = '/non/existent/file';
    $this
      ->expectException(MigrateException::class);
    $this
      ->expectExceptionMessage("File '/non/existent/file' does not exist");
    $this
      ->doTransform($source, 'public://foo.jpg');
  }

  /**
   * Tests that non-writable destination throw an exception.
   *
   * @covers ::transform
   */
  public function testNonWritableDestination() {
    $source = $this
      ->createUri('file.txt', NULL, 'temporary');

    // Create the parent location.
    $this
      ->createDirectory('public://dir');

    // Copy the file under public://dir/subdir1/.
    $this
      ->doTransform($source, 'public://dir/subdir1/file.txt');

    // Check that 'subdir1' was created and the file was successfully migrated.
    $this
      ->assertFileExists('public://dir/subdir1/file.txt');

    // Remove all permissions from public://dir to trigger a failure when
    // trying to create a subdirectory 'subdir2' inside public://dir.
    $this->fileSystem
      ->chmod('public://dir', 0);

    // Check that the proper exception is raised.
    $this
      ->expectException(MigrateException::class);
    $this
      ->expectExceptionMessage("Could not create or write to directory 'public://dir/subdir2'");
    $this
      ->doTransform($source, 'public://dir/subdir2/file.txt');
  }

  /**
   * Tests the 'rename' overwrite mode.
   */
  public function testRenameFile() {
    $source = $this
      ->createUri(NULL, NULL, 'temporary');
    $destination = $this
      ->createUri('foo.txt', NULL, 'public');
    $expected_destination = 'public://foo_0.txt';
    $actual_destination = $this
      ->doTransform($source, $destination, [
      'file_exists' => 'rename',
    ]);
    $this
      ->assertFileExists($expected_destination);
    $this
      ->assertSame($actual_destination, $expected_destination, 'The importer returned the renamed filename.');
  }

  /**
   * Tests that remote URIs are delegated to the download plugin.
   */
  public function testDownloadRemoteUri() {
    $download_plugin = $this
      ->createMock(MigrateProcessInterface::class);
    $download_plugin
      ->expects($this
      ->once())
      ->method('transform');
    $plugin = new FileCopy([], $this
      ->randomMachineName(), [], $this->container
      ->get('stream_wrapper_manager'), $this->container
      ->get('file_system'), $download_plugin);
    $plugin
      ->transform([
      'http://drupal.org/favicon.ico',
      '/destination/path',
    ], $this
      ->createMock(MigrateExecutableInterface::class), new Row([], []), $this
      ->randomMachineName());
  }

  /**
   * Do an import using the destination.
   *
   * @param string $source_path
   *   Source path to copy from.
   * @param string $destination_path
   *   The destination path to copy to.
   * @param array $configuration
   *   Process plugin configuration settings.
   *
   * @return string
   *   The URI of the copied file.
   */
  protected function doTransform($source_path, $destination_path, $configuration = []) {

    // Prepare a mock HTTP client.
    $this->container
      ->set('http_client', $this
      ->createMock(Client::class));
    $plugin = FileCopy::create($this->container, $configuration, 'file_copy', []);
    $executable = $this
      ->prophesize(MigrateExecutableInterface::class)
      ->reveal();
    $row = new Row([], []);
    return $plugin
      ->transform([
      $source_path,
      $destination_path,
    ], $executable, $row, 'foo');
  }

}