Ticket #19879: 19879_Unit_Tests_comment-fix.patch

tests/phpunit/tests/multisite/dirsizeCache.php

@@ +1 @@
+<?php
+
+if ( is_multisite() ) :
+
+        /**
+         * Tests specific to the dirsize caching in multisites
+         *
+         * @group multisite
+         */
+        class Tests_Multisite_Dirsize_Cache extends WP_UnitTestCase {
+                protected $suppress = false;
+
+                function setUp() {
+                        global $wpdb;
+                        parent::setUp();
+                        $this->suppress = $wpdb->suppress_errors();
+                }
+
+                function tearDown() {
+                        global $wpdb;
+                        $wpdb->suppress_errors( $this->suppress );
+                        parent::tearDown();
+                }
+
+                /*
+                 * Test whether the values from the dirsize_cache will be used correctly using a more complex dirsize cache mock
+                 */
+                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 content 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 folder should be empty and return 0
+                        $this->assertSame( 0, recurse_dirsize( $upload_dir['basedir'] ) );
+
+                        // No cache match on non existing folder should return false
+                        $this->assertSame( false, recurse_dirsize( $upload_dir['basedir'] . '/does_not_exist' ) );
+
+                        // Cleanup
+                        $this->remove_added_uploads();
+                        restore_current_blog();
+                }
+
+                /*
+                 * Test whether the invalidation of the dirsize_cache works
+                 * Given a file path as input
+                 */
+                function test_invalidate_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 content 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 = normalize_dirsize_cache_path( $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->assertSame( true, array_key_exists( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) ) );
+                        $this->assertSame( true, array_key_exists( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) ) );
+                        $this->assertSame( true, array_key_exists( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) ) );
+
+                        // Invalidation should also respect the directory tree up
+                        // Should work fine with path to folder OR file
+                        invalidate_dirsize_cache( $upload_dir['basedir'] . '/2/1/file.dummy' );
+
+                        $this->assertSame( false, array_key_exists( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) ) );
+                        $this->assertSame( false, array_key_exists( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) ) );
+
+                        // Other cache paths should not be invalidated
+                        $this->assertSame( true, array_key_exists( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) ) );
+
+                        // Cleanup
+                        $this->remove_added_uploads();
+                        restore_current_blog();
+                }
+
+                /*
+                 * Test whether the invalidation of the dirsize_cache works
+                 * Given a folder path as input
+                 */
+                function test_invalidate_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 content 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 = normalize_dirsize_cache_path( $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->assertSame( true, array_key_exists( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) ) );
+                        $this->assertSame( true, array_key_exists( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) ) );
+                        $this->assertSame( true, array_key_exists( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) ) );
+
+                        // Invalidation should also respect the directory tree up
+                        // Should work fine with path to folder OR file
+                        invalidate_dirsize_cache( $upload_dir['basedir'] . '/2/1' );
+
+                        $this->assertSame( false, array_key_exists( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) ) );
+                        $this->assertSame( false, array_key_exists( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) ) );
+
+                        // Other cache paths should not be invalidated
+                        $this->assertSame( true, array_key_exists( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) ) );
+
+                        // Cleanup
+                        $this->remove_added_uploads();
+                        restore_current_blog();
+                }
+
+                /**
+                 * Test whether the values from the dirsize_cache will be used correctly using a simple real upload
+                 */
+                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 content 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 = normalize_dirsize_cache_path( $upload_dir['path'] );
+                        $this->assertSame( true, is_array( 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
+                 */
+                function test_recurse_dirsize_calculate_current_dirsize_filter() {
+                        add_filter( 'calculate_current_dirsize', array( $this, '_filter_calculate_current_dirsize' ) );
+
+                        $upload_dir = wp_upload_dir();
+                        $this->assertSame( 1042, recurse_dirsize( $upload_dir['path'] ) );
+
+                        remove_filter( 'calculate_current_dirsize', array( $this, '_filter_calculate_current_dirsize' ) );
+                }
+
+                function _filter_calculate_current_dirsize() {
+                        return 1042;
+                }
+
+                function _get_mock_dirsize_cache_for_site( $site_id ) {
+                        return
+                                [
+                                        "wp-content/uploads/sites/$site_id/2/2"              => 22,
+                                        "wp-content/uploads/sites/$site_id/2/1"              => 21,
+                                        "wp-content/uploads/sites/$site_id/2"                => 2,
+                                        "wp-content/uploads/sites/$site_id/1/3"              => 13,
+                                        "wp-content/uploads/sites/$site_id/1/2"              => 12,
+                                        "wp-content/uploads/sites/$site_id/1/1"              => 11,
+                                        "wp-content/uploads/sites/$site_id/1"                => 1,
+                                        "wp-content/uploads/sites/$site_id/custom_directory" => 42
+                                ];
+                }
+        }
+endif;