UnmanagedMoveTest.php

<?php

/**
 * @file
 * Definition of Drupal\system\Tests\File\UnmanagedMoveTest.
 */
namespace Drupal\system\Tests\File;


/**
 * Unmanaged move related tests.
 */
class UnmanagedMoveTest extends FileTestBase {
  public static function getInfo() {
    return array(
      'name' => 'Unmanaged file moving',
      'description' => 'Tests the unmanaged file move function.',
      'group' => 'File API',
    );
  }

  /**
   * Move a normal file.
   */
  function testNormal() {
    $config = config('system.file');

    // Create a file for testing
    $uri = $this
      ->createUri();

    // Moving to a new name.
    $desired_filepath = 'public://' . $this
      ->randomName();
    $new_filepath = file_unmanaged_move($uri, $desired_filepath, FILE_EXISTS_ERROR);
    $this
      ->assertTrue($new_filepath, 'Move was successful.');
    $this
      ->assertEqual($new_filepath, $desired_filepath, 'Returned expected filepath.');
    $this
      ->assertTrue(file_exists($new_filepath), 'File exists at the new location.');
    $this
      ->assertFalse(file_exists($uri), 'No file remains at the old location.');
    $this
      ->assertFilePermissions($new_filepath, octdec($config
      ->get('chmod.file')));

    // Moving with rename.
    $desired_filepath = 'public://' . $this
      ->randomName();
    $this
      ->assertTrue(file_exists($new_filepath), 'File exists before moving.');
    $this
      ->assertTrue(file_put_contents($desired_filepath, ' '), 'Created a file so a rename will have to happen.');
    $newer_filepath = file_unmanaged_move($new_filepath, $desired_filepath, FILE_EXISTS_RENAME);
    $this
      ->assertTrue($newer_filepath, 'Move was successful.');
    $this
      ->assertNotEqual($newer_filepath, $desired_filepath, 'Returned expected filepath.');
    $this
      ->assertTrue(file_exists($newer_filepath), 'File exists at the new location.');
    $this
      ->assertFalse(file_exists($new_filepath), 'No file remains at the old location.');
    $this
      ->assertFilePermissions($newer_filepath, octdec($config
      ->get('chmod.file')));

    // TODO: test moving to a directory (rather than full directory/file path)
    // TODO: test creating and moving normal files (rather than streams)
  }

  /**
   * Try to move a missing file.
   */
  function testMissing() {

    // Move non-existent file.
    $new_filepath = file_unmanaged_move($this
      ->randomName(), $this
      ->randomName());
    $this
      ->assertFalse($new_filepath, 'Moving a missing file fails.');
  }

  /**
   * Try to move a file onto itself.
   */
  function testOverwriteSelf() {

    // Create a file for testing.
    $uri = $this
      ->createUri();

    // Move the file onto itself without renaming shouldn't make changes.
    $new_filepath = file_unmanaged_move($uri, $uri, FILE_EXISTS_REPLACE);
    $this
      ->assertFalse($new_filepath, 'Moving onto itself without renaming fails.');
    $this
      ->assertTrue(file_exists($uri), 'File exists after moving onto itself.');

    // Move the file onto itself with renaming will result in a new filename.
    $new_filepath = file_unmanaged_move($uri, $uri, FILE_EXISTS_RENAME);
    $this
      ->assertTrue($new_filepath, 'Moving onto itself with renaming works.');
    $this
      ->assertFalse(file_exists($uri), 'Original file has been removed.');
    $this
      ->assertTrue(file_exists($new_filepath), 'File exists after moving onto itself.');
  }

}