mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-04-07 06:05:42 +00:00
Filesystem API: Add directory support to WP_Filesystem_Direct::move().
Introduces: - New function: `wp_opcache_invalidate_directory()`, to recursively call `wp_opcache_invalidate()` after overwriting .php files. - New function: `move_dir()`, similar to `copy_dir()` that uses `WP_Filesystem::move()` followed by `wp_opcache_invalidate_directory()`, and has a fallback to `copy_dir()`. Props: costdev, afragen, peterwilsoncc, sergeybiryukov, ironprogrammer, flixos90, bronsonquick, mukesh27, azaozz. Fixes #57375. git-svn-id: https://develop.svn.wordpress.org/trunk@55204 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Andrew Ozz
279
tests/phpunit/tests/filesystem/moveDir.php
Normal file
279
tests/phpunit/tests/filesystem/moveDir.php
Normal file
@@ -0,0 +1,279 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Tests move_dir().
|
||||
*
|
||||
* @group file.php
|
||||
*
|
||||
* @covers ::move_dir
|
||||
*/
|
||||
class Tests_Filesystem_MoveDir extends WP_UnitTestCase {
|
||||
|
||||
/**
|
||||
* The test directory.
|
||||
*
|
||||
* @var string $test_dir
|
||||
*/
|
||||
private static $test_dir;
|
||||
|
||||
/**
|
||||
* The existing 'from' directory path.
|
||||
*
|
||||
* @var string $existing_from
|
||||
*/
|
||||
private static $existing_from;
|
||||
|
||||
/**
|
||||
* The existing 'from' sub-directory path.
|
||||
*
|
||||
* @var string $existing_from_subdir
|
||||
*/
|
||||
private static $existing_from_subdir;
|
||||
|
||||
/**
|
||||
* The existing 'from' file path.
|
||||
*
|
||||
* @var string $existing_from_file
|
||||
*/
|
||||
private static $existing_from_file;
|
||||
|
||||
/**
|
||||
* The existing 'from' sub-directory file path.
|
||||
*
|
||||
* @var string $existing_from_subdir_file
|
||||
*/
|
||||
private static $existing_from_subdir_file;
|
||||
|
||||
/**
|
||||
* The existing 'to' directory file path.
|
||||
*
|
||||
* @var string $existing_to
|
||||
*/
|
||||
private static $existing_to;
|
||||
|
||||
/**
|
||||
* The existing 'to' file path.
|
||||
*
|
||||
* @var string $existing_to_file
|
||||
*/
|
||||
private static $existing_to_file;
|
||||
|
||||
/**
|
||||
* Sets up the filesystem and directory structure properties
|
||||
* before any tests run.
|
||||
*/
|
||||
public static function set_up_before_class() {
|
||||
parent::set_up_before_class();
|
||||
|
||||
require_once ABSPATH . 'wp-admin/includes/file.php';
|
||||
WP_Filesystem();
|
||||
|
||||
self::$test_dir = get_temp_dir() . 'move_dir/';
|
||||
self::$existing_from = self::$test_dir . 'existing_from/';
|
||||
self::$existing_from_subdir = self::$existing_from . 'existing_from_subdir/';
|
||||
self::$existing_from_file = self::$existing_from . 'existing_from_file.txt';
|
||||
self::$existing_from_subdir_file = self::$existing_from_subdir . 'existing_from_subdir_file.txt';
|
||||
self::$existing_to = self::$test_dir . 'existing_to/';
|
||||
self::$existing_to_file = self::$existing_to . 'existing_to_file.txt';
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets up the directory structure before each test.
|
||||
*/
|
||||
public function set_up() {
|
||||
global $wp_filesystem;
|
||||
|
||||
parent::set_up();
|
||||
|
||||
// Create the root directory.
|
||||
$wp_filesystem->mkdir( self::$test_dir );
|
||||
|
||||
// Create the "from" directory structure.
|
||||
$wp_filesystem->mkdir( self::$existing_from );
|
||||
$wp_filesystem->touch( self::$existing_from_file );
|
||||
$wp_filesystem->mkdir( self::$existing_from_subdir );
|
||||
$wp_filesystem->touch( self::$existing_from_subdir_file );
|
||||
|
||||
// Create the "to" directory structure.
|
||||
$wp_filesystem->mkdir( self::$existing_to );
|
||||
$wp_filesystem->touch( self::$existing_to_file );
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes the test directory structure after each test.
|
||||
*/
|
||||
public function tear_down() {
|
||||
global $wp_filesystem;
|
||||
|
||||
// Delete the root directory and its contents.
|
||||
$wp_filesystem->delete( self::$test_dir, true );
|
||||
|
||||
parent::tear_down();
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that move_dir() returns a WP_Error object.
|
||||
*
|
||||
* @ticket 57375
|
||||
*
|
||||
* @dataProvider data_should_return_wp_error
|
||||
*
|
||||
* @param string $from The source directory path.
|
||||
* @param string $to The destination directory path.
|
||||
* @param bool $overwrite Whether to overwrite the destination directory.
|
||||
* @param string $expected The expected WP_Error code.
|
||||
*/
|
||||
public function test_should_return_wp_error( $from, $to, $overwrite, $expected ) {
|
||||
global $wp_filesystem;
|
||||
|
||||
$from = self::$test_dir . $from;
|
||||
$to = self::$test_dir . $to;
|
||||
$result = move_dir( $from, $to, $overwrite );
|
||||
|
||||
$this->assertWPError(
|
||||
$result,
|
||||
'move_dir() did not return a WP_Error object.'
|
||||
);
|
||||
|
||||
$this->assertSame(
|
||||
$expected,
|
||||
$result->get_error_code(),
|
||||
'The expected error code was not returned.'
|
||||
);
|
||||
|
||||
if ( 'source_destination_same_move_dir' !== $expected ) {
|
||||
$this->assertTrue(
|
||||
$wp_filesystem->exists( $from ),
|
||||
'The $from directory does not exist anymore.'
|
||||
);
|
||||
|
||||
if ( false === $overwrite && 'existing_to' === untrailingslashit( $to ) ) {
|
||||
$this->assertTrue(
|
||||
$wp_filesystem->exists( $to ),
|
||||
'The $to directory does not exist anymore.'
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Data provider.
|
||||
*
|
||||
* @return array[]
|
||||
*/
|
||||
public function data_should_return_wp_error() {
|
||||
return array(
|
||||
'$overwrite is false and $to exists' => array(
|
||||
'from' => 'existing_from',
|
||||
'to' => 'existing_to',
|
||||
'overwrite' => false,
|
||||
'expected' => 'destination_already_exists_move_dir',
|
||||
),
|
||||
'same source and destination, source has trailing slash' => array(
|
||||
'from' => 'existing_from/',
|
||||
'to' => 'existing_from',
|
||||
'overwrite' => false,
|
||||
'expected' => 'source_destination_same_move_dir',
|
||||
),
|
||||
'same source and destination, destination has trailing slash' => array(
|
||||
'from' => 'existing_from',
|
||||
'to' => 'existing_from/',
|
||||
'overwrite' => false,
|
||||
'expected' => 'source_destination_same_move_dir',
|
||||
),
|
||||
'same source and destination, source lowercase, destination uppercase' => array(
|
||||
'from' => 'existing_from',
|
||||
'to' => 'EXISTING_FROM',
|
||||
'overwrite' => false,
|
||||
'expected' => 'source_destination_same_move_dir',
|
||||
),
|
||||
'same source and destination, source uppercase, destination lowercase' => array(
|
||||
'from' => 'EXISTING_FROM',
|
||||
'to' => 'existing_from',
|
||||
'overwrite' => false,
|
||||
'expected' => 'source_destination_same_move_dir',
|
||||
),
|
||||
'same source and destination, source and destination in inverted case' => array(
|
||||
'from' => 'ExIsTiNg_FrOm',
|
||||
'to' => 'eXiStInG_fRoM',
|
||||
'overwrite' => false,
|
||||
'expected' => 'source_destination_same_move_dir',
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that move_dir() successfully moves a directory.
|
||||
*
|
||||
* @ticket 57375
|
||||
*
|
||||
* @dataProvider data_should_move_directory
|
||||
*
|
||||
* @param string $from The source directory path.
|
||||
* @param string $to The destination directory path.
|
||||
* @param bool $overwrite Whether to overwrite the destination directory.
|
||||
*/
|
||||
public function test_should_move_directory( $from, $to, $overwrite ) {
|
||||
global $wp_filesystem;
|
||||
|
||||
$from = self::$test_dir . $from;
|
||||
$to = self::$test_dir . $to;
|
||||
$result = move_dir( $from, $to, $overwrite );
|
||||
|
||||
$this->assertTrue(
|
||||
$result,
|
||||
'The directory was not moved.'
|
||||
);
|
||||
|
||||
$this->assertFalse(
|
||||
$wp_filesystem->exists( $from ),
|
||||
'The source directory still exists.'
|
||||
);
|
||||
|
||||
$this->assertTrue(
|
||||
$wp_filesystem->exists( $to ),
|
||||
'The destination directory does not exist.'
|
||||
);
|
||||
|
||||
$dirlist = $wp_filesystem->dirlist( $to, true, true );
|
||||
|
||||
// Prevent PHP array sorting bugs from breaking tests.
|
||||
$to_contents = array_keys( $dirlist );
|
||||
|
||||
$this->assertSameSets(
|
||||
array(
|
||||
'existing_from_file.txt',
|
||||
'existing_from_subdir',
|
||||
),
|
||||
$to_contents,
|
||||
'The expected files were not moved.'
|
||||
);
|
||||
|
||||
$this->assertSame(
|
||||
array( 'existing_from_subdir_file.txt' ),
|
||||
array_keys( $dirlist['existing_from_subdir']['files'] ),
|
||||
'Sub-directory files failed to move.'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Data provider.
|
||||
*
|
||||
* @return array[]
|
||||
*/
|
||||
public function data_should_move_directory() {
|
||||
return array(
|
||||
'$overwrite is false and $to does not exist' => array(
|
||||
'from' => 'existing_from',
|
||||
'to' => 'non_existing_to',
|
||||
'overwrite' => false,
|
||||
),
|
||||
'$overwrite is true and $to exists' => array(
|
||||
'from' => 'existing_from',
|
||||
'to' => 'existing_to',
|
||||
'overwrite' => true,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
}
|
||||
101
tests/phpunit/tests/filesystem/wpOpcacheInvalidateDirectory.php
Normal file
101
tests/phpunit/tests/filesystem/wpOpcacheInvalidateDirectory.php
Normal file
@@ -0,0 +1,101 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Tests wp_opcache_invalidate_directory().
|
||||
*
|
||||
* @group file.php
|
||||
*
|
||||
* @covers ::wp_opcache_invalidate_directory
|
||||
*/
|
||||
class Tests_Filesystem_WpOpcacheInvalidateDirectory extends WP_UnitTestCase {
|
||||
|
||||
/**
|
||||
* Sets up the filesystem before any tests run.
|
||||
*/
|
||||
public static function set_up_before_class() {
|
||||
global $wp_filesystem;
|
||||
|
||||
parent::set_up_before_class();
|
||||
|
||||
if ( ! $wp_filesystem ) {
|
||||
require_once ABSPATH . 'wp-admin/includes/file.php';
|
||||
WP_Filesystem();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that wp_opcache_invalidate_directory() returns a WP_Error object
|
||||
* when the $dir argument invalid.
|
||||
*
|
||||
* @ticket 57375
|
||||
*
|
||||
* @dataProvider data_should_trigger_error_with_invalid_dir
|
||||
*
|
||||
* @param mixed $dir An invalid directory path.
|
||||
*/
|
||||
public function test_should_trigger_error_with_invalid_dir( $dir ) {
|
||||
$this->expectError();
|
||||
$this->expectErrorMessage(
|
||||
'<code>wp_opcache_invalidate_directory()</code>',
|
||||
'The expected error was not triggered.'
|
||||
);
|
||||
|
||||
wp_opcache_invalidate_directory( $dir );
|
||||
}
|
||||
|
||||
/**
|
||||
* Data provider.
|
||||
*
|
||||
* @return array[]
|
||||
*/
|
||||
public function data_should_trigger_error_with_invalid_dir() {
|
||||
return array(
|
||||
'an empty string' => array( '' ),
|
||||
'a string with spaces' => array( ' ' ),
|
||||
'a string with tabs' => array( "\t" ),
|
||||
'a string with new lines' => array( "\n" ),
|
||||
'a string with carriage returns' => array( "\r" ),
|
||||
'int -1' => array( -1 ),
|
||||
'int 0' => array( 0 ),
|
||||
'int 1' => array( 1 ),
|
||||
'float -1.0' => array( -1.0 ),
|
||||
'float 0.0' => array( 0.0 ),
|
||||
'float 1.0' => array( 1.0 ),
|
||||
'false' => array( false ),
|
||||
'true' => array( true ),
|
||||
'null' => array( null ),
|
||||
'an empty array' => array( array() ),
|
||||
'a non-empty array' => array( array( 'directory_path' ) ),
|
||||
'an empty object' => array( new stdClass() ),
|
||||
'a non-empty object' => array( (object) array( 'directory_path' ) ),
|
||||
'INF' => array( INF ),
|
||||
'NAN' => array( NAN ),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that wp_opcache_invalidate_directory() does not trigger an error
|
||||
* with a valid directory.
|
||||
*
|
||||
* @ticket 57375
|
||||
*
|
||||
* @dataProvider data_should_not_trigger_error_wp_opcache_valid_directory
|
||||
*
|
||||
* @param string $dir A directory path.
|
||||
*/
|
||||
public function test_should_not_trigger_error_wp_opcache_valid_directory( $dir ) {
|
||||
$this->assertNull( wp_opcache_invalidate_directory( $dir ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Data provider.
|
||||
*
|
||||
* @return array[]
|
||||
*/
|
||||
public function data_should_not_trigger_error_wp_opcache_valid_directory() {
|
||||
return array(
|
||||
'an existing directory' => array( DIR_TESTDATA ),
|
||||
'a non-existent directory' => array( 'non_existent_directory' ),
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user