wordpress-develop/tests/phpunit/tests/multisite/cleanDirsizeCache.php
Tonya Mork 40ac5de838 Coding Standards: Add visibility to methods in tests/phpunit/tests/.
Adds a `public` visibility to test fixtures, tests, data providers, and callbacks methods.

Adds a `private` visibility to helper methods within test classes.

Renames callbacks and helpers that previously started with a `_` prefix. Why? For consistency and to leverage using the method visibility. Further naming standardizations is beyond the scope of this commit.

Props costdev, jrf, hellofromTonya.
Fixes #54177.

git-svn-id: https://develop.svn.wordpress.org/trunk@52010 602fd350-edb4-49c9-b593-d223f7449a82
2021-11-04 15:22:47 +00:00

320 lines
11 KiB
PHP

<?php
if ( is_multisite() ) :
/**
* Tests specific to the directory size caching in multisite.
*
* @ticket 19879
* @group multisite
*/
class Tests_Multisite_CleanDirsizeCache extends WP_UnitTestCase {
/**
* Test whether dirsize_cache values are used correctly with a more complex dirsize cache mock.
*
* @ticket 19879
*/
public function test_get_dirsize_cache_in_recurse_dirsize_mock() {
$blog_id = self::factory()->blog->create();
switch_to_blog( $blog_id );
/*
* Our comparison of space relies on an initial value of 0. If a previous test has failed
* or if the `src` directory already contains a directory with site content, then the initial
* expectation will be polluted. We create sites until an empty one is available.
*/
while ( 0 !== get_space_used() ) {
restore_current_blog();
$blog_id = self::factory()->blog->create();
switch_to_blog( $blog_id );
}
// Clear the dirsize cache.
delete_transient( 'dirsize_cache' );
// Set the dirsize cache to our mock.
set_transient( 'dirsize_cache', $this->get_mock_dirsize_cache_for_site( $blog_id ) );
$upload_dir = wp_upload_dir();
// Check recurse_dirsize() against the mock. The cache should match.
$this->assertSame( 21, recurse_dirsize( $upload_dir['basedir'] . '/2/1' ) );
$this->assertSame( 22, recurse_dirsize( $upload_dir['basedir'] . '/2/2' ) );
$this->assertSame( 2, recurse_dirsize( $upload_dir['basedir'] . '/2' ) );
$this->assertSame( 11, recurse_dirsize( $upload_dir['basedir'] . '/1/1' ) );
$this->assertSame( 12, recurse_dirsize( $upload_dir['basedir'] . '/1/2' ) );
$this->assertSame( 13, recurse_dirsize( $upload_dir['basedir'] . '/1/3' ) );
$this->assertSame( 1, recurse_dirsize( $upload_dir['basedir'] . '/1' ) );
$this->assertSame( 42, recurse_dirsize( $upload_dir['basedir'] . '/custom_directory' ) );
// No cache match, upload directory should be empty and return 0.
$this->assertSame( 0, recurse_dirsize( $upload_dir['basedir'] ) );
// No cache match on non existing directory should return false.
$this->assertFalse( recurse_dirsize( $upload_dir['basedir'] . '/does_not_exist' ) );
// Cleanup.
$this->remove_added_uploads();
restore_current_blog();
}
/**
* Test whether the dirsize_cache invalidation works given a file path as input.
*
* @ticket 19879
*/
public function test_clean_dirsize_cache_file_input_mock() {
$blog_id = self::factory()->blog->create();
switch_to_blog( $blog_id );
/*
* Our comparison of space relies on an initial value of 0. If a previous test has failed
* or if the `src` directory already contains a directory with site content, then the initial
* expectation will be polluted. We create sites until an empty one is available.
*/
while ( 0 !== get_space_used() ) {
restore_current_blog();
$blog_id = self::factory()->blog->create();
switch_to_blog( $blog_id );
}
$upload_dir = wp_upload_dir();
$cache_key_prefix = untrailingslashit( $upload_dir['basedir'] );
// Clear the dirsize cache.
delete_transient( 'dirsize_cache' );
// Set the dirsize cache to our mock.
set_transient( 'dirsize_cache', $this->get_mock_dirsize_cache_for_site( $blog_id ) );
$this->assertArrayHasKey( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) );
$this->assertArrayHasKey( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) );
$this->assertArrayHasKey( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) );
// Invalidation should also respect the directory tree up.
// Should work fine with path to directory OR file.
clean_dirsize_cache( $upload_dir['basedir'] . '/2/1/file.dummy' );
$this->assertArrayNotHasKey( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) );
$this->assertArrayNotHasKey( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) );
// Other cache paths should not be invalidated.
$this->assertArrayHasKey( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) );
// Cleanup.
$this->remove_added_uploads();
restore_current_blog();
}
/**
* Test whether the dirsize_cache invalidation works given a directory path as input.
*
* @ticket 19879
*/
public function test_clean_dirsize_cache_folder_input_mock() {
$blog_id = self::factory()->blog->create();
switch_to_blog( $blog_id );
/*
* Our comparison of space relies on an initial value of 0. If a previous test has failed
* or if the `src` directory already contains a directory with site content, then the initial
* expectation will be polluted. We create sites until an empty one is available.
*/
while ( 0 !== get_space_used() ) {
restore_current_blog();
$blog_id = self::factory()->blog->create();
switch_to_blog( $blog_id );
}
$upload_dir = wp_upload_dir();
$cache_key_prefix = untrailingslashit( $upload_dir['basedir'] );
// Clear the dirsize cache.
delete_transient( 'dirsize_cache' );
// Set the dirsize cache to our mock.
set_transient( 'dirsize_cache', $this->get_mock_dirsize_cache_for_site( $blog_id ) );
$this->assertArrayHasKey( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) );
$this->assertArrayHasKey( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) );
$this->assertArrayHasKey( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) );
// Invalidation should also respect the directory tree up.
// Should work fine with path to directory OR file.
clean_dirsize_cache( $upload_dir['basedir'] . '/2/1' );
$this->assertArrayNotHasKey( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) );
$this->assertArrayNotHasKey( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) );
// Other cache paths should not be invalidated.
$this->assertArrayHasKey( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) );
// Cleanup.
$this->remove_added_uploads();
restore_current_blog();
}
/**
* Test whether dirsize_cache values are used correctly with a simple real upload.
*
* @ticket 19879
*/
public function test_get_dirsize_cache_in_recurse_dirsize_upload() {
$blog_id = self::factory()->blog->create();
switch_to_blog( $blog_id );
/*
* Our comparison of space relies on an initial value of 0. If a previous test has failed
* or if the `src` directory already contains a directory with site content, then the initial
* expectation will be polluted. We create sites until an empty one is available.
*/
while ( 0 !== get_space_used() ) {
restore_current_blog();
$blog_id = self::factory()->blog->create();
switch_to_blog( $blog_id );
}
// Clear the dirsize cache.
delete_transient( 'dirsize_cache' );
$upload_dir = wp_upload_dir();
$this->assertSame( 0, recurse_dirsize( $upload_dir['path'] ) );
// Upload a file to the new site using wp_upload_bits().
$filename = __FUNCTION__ . '.jpg';
$contents = __FUNCTION__ . '_contents';
$file = wp_upload_bits( $filename, null, $contents );
$calc_size = recurse_dirsize( $upload_dir['path'] );
$size = filesize( $file['file'] );
$this->assertSame( $size, $calc_size );
// `dirsize_cache` should now be filled after upload and recurse_dirsize() call.
$cache_path = untrailingslashit( $upload_dir['path'] );
$this->assertIsArray( get_transient( 'dirsize_cache' ) );
$this->assertSame( $size, get_transient( 'dirsize_cache' )[ $cache_path ] );
// Cleanup.
$this->remove_added_uploads();
restore_current_blog();
}
/**
* Test whether the filter to calculate space for an existing directory works as expected.
*
* @ticket 19879
*/
public function test_pre_recurse_dirsize_filter() {
add_filter( 'pre_recurse_dirsize', array( $this, 'filter_pre_recurse_dirsize' ) );
$upload_dir = wp_upload_dir();
$this->assertSame( 1042, recurse_dirsize( $upload_dir['path'] ) );
remove_filter( 'pre_recurse_dirsize', array( $this, 'filter_pre_recurse_dirsize' ) );
}
public function filter_pre_recurse_dirsize() {
return 1042;
}
private function get_mock_dirsize_cache_for_site( $site_id ) {
$prefix = wp_upload_dir()['basedir'];
return array(
"$prefix/2/2" => 22,
"$prefix/2/1" => 21,
"$prefix/2" => 2,
"$prefix/1/3" => 13,
"$prefix/1/2" => 12,
"$prefix/1/1" => 11,
"$prefix/1" => 1,
"$prefix/custom_directory" => 42,
);
}
/*
* Test that 5.6+ gracefully handles the old 5.5 transient structure.
*
* @ticket 51913
*/
public function test_5_5_transient_structure_compat() {
$blog_id = self::factory()->blog->create();
switch_to_blog( $blog_id );
/*
* Our comparison of space relies on an initial value of 0. If a previous test has failed
* or if the `src` directory already contains a directory with site content, then the initial
* expectation will be polluted. We create sites until an empty one is available.
*/
while ( 0 !== get_space_used() ) {
restore_current_blog();
$blog_id = self::factory()->blog->create();
switch_to_blog( $blog_id );
}
// Clear the dirsize cache.
delete_transient( 'dirsize_cache' );
// Set the dirsize cache to our mock.
set_transient( 'dirsize_cache', $this->get_mock_5_5_dirsize_cache( $blog_id ) );
$upload_dir = wp_upload_dir();
/*
* The cached size should be ignored, because it's in the old format. The function
* will try to fetch a live value, but in this case the folder doesn't actually
* exist on disk, so the function should fail.
*/
$this->assertFalse( recurse_dirsize( $upload_dir['basedir'] . '/2/1' ) );
/*
* Now that it's confirmed that old cached values aren't being returned, create the
* folder on disk, so that the the rest of the function can be tested.
*/
wp_mkdir_p( $upload_dir['basedir'] . '/2/1' );
$filename = $upload_dir['basedir'] . '/2/1/this-needs-to-exist.txt';
file_put_contents( $filename, 'this file is 21 bytes' );
// Clear the dirsize cache.
delete_transient( 'dirsize_cache' );
// Set the dirsize cache to our mock.
set_transient( 'dirsize_cache', $this->get_mock_5_5_dirsize_cache( $blog_id ) );
/*
* Now that the folder exists, the old cached value should be overwritten
* with the size, using the current format.
*/
$this->assertSame( 21, recurse_dirsize( $upload_dir['basedir'] . '/2/1' ) );
$this->assertSame( 21, get_transient( 'dirsize_cache' )[ $upload_dir['basedir'] . '/2/1' ] );
// No cache match on non existing directory should return false.
$this->assertFalse( recurse_dirsize( $upload_dir['basedir'] . '/does_not_exist' ) );
// Cleanup.
$this->remove_added_uploads();
rmdir( $upload_dir['basedir'] . '/2/1' );
restore_current_blog();
}
private function get_mock_5_5_dirsize_cache( $site_id ) {
$prefix = untrailingslashit( wp_upload_dir()['basedir'] );
return array(
"$prefix/2/2" => array( 'size' => 22 ),
"$prefix/2/1" => array( 'size' => 21 ),
"$prefix/2" => array( 'size' => 2 ),
"$prefix/1/3" => array( 'size' => 13 ),
"$prefix/1/2" => array( 'size' => 12 ),
"$prefix/1/1" => array( 'size' => 11 ),
"$prefix/1" => array( 'size' => 1 ),
"$prefix/custom_directory" => array( 'size' => 42 ),
);
}
}
endif;