Delete dirsize_cache transient before getting WP disk size (#559)

cssjoe · web-flow · commit 6dea035fbe7a · 2023-07-17T11:21:38.000-04:00
* Delete dirsize_cache transient before getting WP disk size
* Fix PHP lint test for PHP 5.6
* Test PHP 5.6 on WP 6.2
* Update WP installed script
* Update .travis.yml
* Migrate deprecated phpunit.xml
* Fix PHPUnit tests
diff --git a/.travis.yml b/.travis.yml
@@ -21,7 +21,7 @@ matrix:
         # Lock file has phpunit 7. Remove it and install phpunit 5 for php 5.6.
         - composer remove --dev phpunit/phpunit && composer require --dev phpunit/phpunit ^5
         - composer install -o
-        - bash bin/install-wp-tests.sh wordpress_test root '' localhost $WP_VERSION
+        - bash bin/install-wp-tests.sh wordpress_test root '' localhost 6.2
         # We are only running phpcs on php 5.6. @todo fix with php 7 and 8.
         - yarn run php-codesniffer
     -
@@ -48,8 +48,8 @@ matrix:
         - bash bin/install-wp-tests.sh wordpress_test root '' localhost $WP_VERSION
 
 script:
-  - find . -name composer -prune -o -name node_modules -prune -o -name '*.php' -exec php -lf {} \; > /dev/null
-  - vendor/phpunit/phpunit/phpunit --debug
+  - find . \( -name composer -o -name node_modules -o -name phpunit -o -name phpunit-polyfills -o -name code-unit-reverse-lookup \) -prune -o -name '*.php' -exec php -lf {} \; > /dev/null
+  - vendor/phpunit/phpunit/phpunit --debug --verbose
   - yarn run js-lint
   # Remove dev scripts.
   - composer install -o --no-dev
@@ -60,8 +60,11 @@ deploy:
     skip_cleanup: true
     on:
       tags: true
+      php: 5.6
   - provider: releases
     api_key: "${GITHUB_TOKEN}"
     file: "boldgrid-backup.zip"
+    skip_cleanup: true
     on:
       tags: true
+      php: 5.6
diff --git a/admin/class-boldgrid-backup-admin-filelist.php b/admin/class-boldgrid-backup-admin-filelist.php
@@ -95,6 +95,9 @@ public function get_size() {
 
 		$size = 0;
 
+		// Delete transient "dirsize_cache" that WordPress sets when using recurse_dirsize(); used for Site Health info, our REST endpoint, and here.
+		delete_transient( 'dirsize_cache' );
+
 		foreach ( $this->filelist_filter as $file ) {
 			$file_path = ABSPATH . $file;
 
diff --git a/admin/class-boldgrid-backup-admin-test.php b/admin/class-boldgrid-backup-admin-test.php
@@ -693,13 +693,12 @@ public function get_disk_space( $get_wp_size = true ) {
 	 * Get the WordPress total file size.
 	 *
 	 * @since 1.0
-	 * @access private
 	 *
 	 * @see get_filtered_filelist
 	 *
 	 * @return int|bool The total size for the WordPress file system in bytes, or FALSE on error.
 	 */
-	private function get_wp_size() {
+	public function get_wp_size() {
 		// Save time, use transients.
 		$transient = get_transient( 'boldgrid_backup_wp_size' );
 
diff --git a/bin/install-wp-tests.sh b/bin/install-wp-tests.sh
@@ -1,7 +1,10 @@
 #!/usr/bin/env bash
+# WordPress scaffolding for tests of the W3 Total Cache WordPress plugin by BoldGrid.
+# @link https://make.wordpress.org/cli/handbook/misc/plugin-unit-tests/
+# @link https://github.com/wp-cli/sample-plugin/blob/master/bin/install-wp-tests.sh
 
 if [ $# -lt 3 ]; then
-	echo "usage: $0 <db-name> <db-user> <db-pass> [db-host] [wp-version]"
+	echo "usage: $0 <db-name> <db-user> <db-pass> [db-host] [wp-version] [skip-database-creation]"
 	exit 1
 fi
 
@@ -10,27 +13,86 @@ DB_USER=$2
 DB_PASS=$3
 DB_HOST=${4-localhost}
 WP_VERSION=${5-latest}
+SKIP_DB_CREATE=${6-false}
 
-WP_TESTS_DIR=${WP_TESTS_DIR-/tmp/wordpress-tests-lib}
-WP_CORE_DIR=${WP_CORE_DIR-/tmp/wordpress/}
+TMPDIR=${TMPDIR-/tmp}
+TMPDIR=$(echo $TMPDIR | sed -e "s/\/$//")
+WP_TESTS_DIR=${WP_TESTS_DIR-$TMPDIR/wordpress-tests-lib}
+WP_CORE_DIR=${WP_CORE_DIR-$TMPDIR/wordpress/}
+
+download() {
+    if [ `which curl` ]; then
+        curl -s "$1" > "$2";
+    elif [ `which wget` ]; then
+        wget -nv -O "$2" "$1"
+    fi
+}
+
+if [[ $WP_VERSION =~ ^[0-9]+\.[0-9]+$ ]]; then
+	WP_TESTS_TAG="branches/$WP_VERSION"
+elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0-9]+ ]]; then
+	if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then
+		# version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
+		WP_TESTS_TAG="tags/${WP_VERSION%??}"
+	else
+		WP_TESTS_TAG="tags/$WP_VERSION"
+	fi
+elif [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
+	WP_TESTS_TAG="trunk"
+else
+	# http serves a single offer, whereas https serves multiple. we only want one
+	download http://api.wordpress.org/core/version-check/1.7/ /tmp/wp-latest.json
+	grep '[0-9]+\.[0-9]+(\.[0-9]+)?' /tmp/wp-latest.json
+	LATEST_VERSION=$(grep -o '"version":"[^"]*' /tmp/wp-latest.json | sed 's/"version":"//')
+	if [[ -z "$LATEST_VERSION" ]]; then
+		echo "Latest WordPress version could not be found"
+		exit 1
+	fi
+	WP_TESTS_TAG="tags/$LATEST_VERSION"
+fi
 
 set -ex
 
 install_wp() {
+
+	if [ -d $WP_CORE_DIR ]; then
+		return;
+	fi
+
 	mkdir -p $WP_CORE_DIR
 
-	if [ $WP_VERSION == 'latest' ]; then
-		local ARCHIVE_NAME='latest'
+	if [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
+		mkdir -p $TMPDIR/wordpress-nightly
+		download https://wordpress.org/nightly-builds/wordpress-latest.zip  $TMPDIR/wordpress-nightly/wordpress-nightly.zip
+		unzip -q $TMPDIR/wordpress-nightly/wordpress-nightly.zip -d $TMPDIR/wordpress-nightly/
+		mv $TMPDIR/wordpress-nightly/wordpress/* $WP_CORE_DIR
 	else
-		local ARCHIVE_NAME="wordpress-$WP_VERSION"
+		if [ $WP_VERSION == 'latest' ]; then
+			local ARCHIVE_NAME='latest'
+		elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+ ]]; then
+			# https serves multiple offers, whereas http serves single.
+			download https://api.wordpress.org/core/version-check/1.7/ $TMPDIR/wp-latest.json
+			if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then
+				# version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
+				LATEST_VERSION=${WP_VERSION%??}
+			else
+				# otherwise, scan the releases and get the most up to date minor version of the major release
+				local VERSION_ESCAPED=`echo $WP_VERSION | sed 's/\./\\\\./g'`
+				LATEST_VERSION=$(grep -o '"version":"'$VERSION_ESCAPED'[^"]*' $TMPDIR/wp-latest.json | sed 's/"version":"//' | head -1)
+			fi
+			if [[ -z "$LATEST_VERSION" ]]; then
+				local ARCHIVE_NAME="wordpress-$WP_VERSION"
+			else
+				local ARCHIVE_NAME="wordpress-$LATEST_VERSION"
+			fi
+		else
+			local ARCHIVE_NAME="wordpress-$WP_VERSION"
+		fi
+		download https://wordpress.org/${ARCHIVE_NAME}.tar.gz  $TMPDIR/wordpress.tar.gz
+		tar --strip-components=1 -zxmf $TMPDIR/wordpress.tar.gz -C $WP_CORE_DIR
 	fi
 
-	# Install the WordPress files.
-	# Unzip quietly (-qq) so the automated tests are not flooded with the unzip output.
-	wget -nv -O /tmp/wordpress-latest.zip https://wordpress.org/nightly-builds/wordpress-latest.zip
-	unzip -qq /tmp/wordpress-latest.zip -d /tmp
-
-	wget -nv -O $WP_CORE_DIR/wp-content/db.php https://raw.github.com/markoheijnen/wp-mysqli/master/db.php
+	download https://raw.github.com/markoheijnen/wp-mysqli/master/db.php $WP_CORE_DIR/wp-content/db.php
 }
 
 install_test_suite() {
@@ -41,21 +103,33 @@ install_test_suite() {
 		local ioption='-i'
 	fi
 
-	# set up testing suite
-	mkdir -p $WP_TESTS_DIR
-	cd $WP_TESTS_DIR
-	# As each new version of WP is released, the branch should be updated in the 2 lines below.
-	svn co --quiet https://develop.svn.wordpress.org/branches/5.9/tests/phpunit/includes/
-	wget -nv -O wp-tests-config.php https://develop.svn.wordpress.org/branches/5.9/wp-tests-config-sample.php
-	sed $ioption "s:dirname( __FILE__ ) . '/build/':'$WP_CORE_DIR':" "$WP_TESTS_DIR"/wp-tests-config.php
-	sed $ioption "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR':" "$WP_TESTS_DIR"/wp-tests-config.php
-	sed $ioption "s/youremptytestdbnamehere/$DB_NAME/" wp-tests-config.php
-	sed $ioption "s/yourusernamehere/$DB_USER/" wp-tests-config.php
-	sed $ioption "s/yourpasswordhere/$DB_PASS/" wp-tests-config.php
-	sed $ioption "s|localhost|${DB_HOST}|" wp-tests-config.php
+	# set up testing suite if it doesn't yet exist
+	if [ ! -d $WP_TESTS_DIR ]; then
+		# set up testing suite
+		mkdir -p $WP_TESTS_DIR
+		svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/includes/ $WP_TESTS_DIR/includes
+		svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/data/ $WP_TESTS_DIR/data
+	fi
+
+	if [ ! -f wp-tests-config.php ]; then
+		download https://develop.svn.wordpress.org/${WP_TESTS_TAG}/wp-tests-config-sample.php "$WP_TESTS_DIR"/wp-tests-config.php
+		# remove all forward slashes in the end
+		WP_CORE_DIR=$(echo $WP_CORE_DIR | sed "s:/\+$::")
+		sed $ioption "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR/':" "$WP_TESTS_DIR"/wp-tests-config.php
+		sed $ioption "s/youremptytestdbnamehere/$DB_NAME/" "$WP_TESTS_DIR"/wp-tests-config.php
+		sed $ioption "s/yourusernamehere/$DB_USER/" "$WP_TESTS_DIR"/wp-tests-config.php
+		sed $ioption "s/yourpasswordhere/$DB_PASS/" "$WP_TESTS_DIR"/wp-tests-config.php
+		sed $ioption "s|localhost|${DB_HOST}|" "$WP_TESTS_DIR"/wp-tests-config.php
+	fi
+
 }
 
 install_db() {
+
+	if [ ${SKIP_DB_CREATE} = "true" ]; then
+		return 0
+	fi
+
 	# parse DB_HOST for port or socket references
 	local PARTS=(${DB_HOST//\:/ })
 	local DB_HOSTNAME=${PARTS[0]};
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,27 +1,21 @@
-<phpunit
-	bootstrap="tests/bootstrap.php"
-	backupGlobals="false"
-	colors="true"
-	convertErrorsToExceptions="true"
-	convertNoticesToExceptions="true"
-	convertWarningsToExceptions="true"
-	>
-	<testsuites>
-		<testsuite name="tests">
-			<directory suffix=".php">./tests/</directory>
-		</testsuite>
-	</testsuites>
-	<filter>
-		<whitelist>
-			<directory>./</directory>
-		</whitelist>
-	</filter>
-	<groups>
-		<exclude>
-			<group>ajax</group>
-		</exclude>
-	</groups>
-	<php>
-		 <ini name="display_errors" value="true"/>
-	</php>
+<?xml version="1.0"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="tests/bootstrap.php" backupGlobals="false" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory>./</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="tests">
+      <directory suffix=".php">./tests/</directory>
+    </testsuite>
+  </testsuites>
+  <groups>
+    <exclude>
+      <group>ajax</group>
+    </exclude>
+  </groups>
+  <php>
+    <ini name="display_errors" value="true"/>
+  </php>
 </phpunit>
diff --git a/rest/class-boldgrid-backup-rest-test.php b/rest/class-boldgrid-backup-rest-test.php
@@ -152,21 +152,21 @@ public function get_item( $request ) {
 
 		$preflight_test = new Boldgrid_Backup_Admin_Test( $this->core );
 
-		$disk_space   = $preflight_test->get_disk_space( false );
-		$disk_abspath = get_dirsize( ABSPATH );
-		$disk_db      = $preflight_test->get_database_size();
+		$disk_space = $preflight_test->get_disk_space( false );
+		$disk_wp    = $preflight_test->get_wp_size();
+		$disk_db    = $preflight_test->get_database_size();
 
 		$settings = array(
 			'passed'            => $preflight_test->run_functionality_tests(),
 			'php_version'       => phpversion(),
 			'wordpress_version' => $wp_version,
 			'abspath'           => ABSPATH,
-			'disk_abspath'      => $disk_abspath,
+			'disk_abspath'      => $disk_wp,
 			'disk_database'     => $disk_db,
 			'disk_total'        => $disk_space[0],
 			'disk_used'         => $disk_space[1],
 			'disk_free'         => $disk_space[2],
-			'disk_post_backup'  => $disk_space[2] - $disk_abspath - $disk_db,
+			'disk_post_backup'  => $disk_space[2] - $disk_wp - $disk_db,
 		);
 
 		return $this->prepare_item_for_response( $settings, $request );
diff --git a/tests/admin/test-class-boldgrid-backup-admin-auto-updates.php b/tests/admin/test-class-boldgrid-backup-admin-auto-updates.php
@@ -188,25 +188,25 @@ public function test_maybe_update_plugin() {
 	 */
 	public function test_maybe_update_theme() {
 		// Test does not update if this theme hasn't been configured yet.
-		$twentytwenty_test_settings = $this->default_test_settings;
-		update_option( 'boldgrid_backup_settings', $twentytwenty_test_settings );
+		$twentytwentytwo_test_settings = $this->default_test_settings;
+		update_option( 'boldgrid_backup_settings', $twentytwentytwo_test_settings );
 		$auto_updates = new Boldgrid_backup_Admin_Auto_Updates();
-		$this->assertFalse( $auto_updates->maybe_update_theme( 'twentytwenty' ) );
+		$this->assertFalse( $auto_updates->maybe_update_theme( 'twentytwentytwo' ) );
 
 		// Test does not update if this theme has updates disabled.
-		$twentytwenty_test_settings['auto_update']['themes']['twentytwenty'] = '0';
-		update_option( 'boldgrid_backup_settings', $twentytwenty_test_settings );
+		$twentytwentytwo_test_settings['auto_update']['themes']['twentytwentytwo'] = '0';
+		update_option( 'boldgrid_backup_settings', $twentytwentytwo_test_settings );
 		$auto_updates->set_settings();
-		$this->assertFalse( $auto_updates->maybe_update_theme( 'twentytwenty' ) );
+		$this->assertFalse( $auto_updates->maybe_update_theme( 'twentytwentytwo' ) );
 
 		// Test that updates do occur if enabled.
-		$twentytwenty_test_settings['auto_update']['themes']['twentytwenty'] = '1';
-		update_option( 'boldgrid_backup_settings', $twentytwenty_test_settings );
+		$twentytwentytwo_test_settings['auto_update']['themes']['twentytwentytwo'] = '1';
+		update_option( 'boldgrid_backup_settings', $twentytwentytwo_test_settings );
 		$auto_updates->set_settings();
-		$this->assertTrue( $auto_updates->maybe_update_theme( 'twentytwenty' ) );
+		$this->assertTrue( $auto_updates->maybe_update_theme( 'twentytwentytwo' ) );
 
 		$themes = new \Boldgrid\Library\Library\Theme\Themes();
-		$theme  = $themes->getFromStylesheet( 'twentytwenty' );
+		$theme  = $themes->getFromStylesheet( 'twentytwentytwo' );
 		$theme->setUpdateData();
 		$days = $theme->updateData->days; //phpcs:ignore WordPress.NamingConventions.ValidVariableName
 
@@ -216,22 +216,22 @@ public function test_maybe_update_theme() {
 			->getMock();
 		$mock_auto_updates->method( 'is_premium_done' )
 			->will( $this->returnValue( false ) );
-		$this->assertTrue( $mock_auto_updates->maybe_update_theme( 'twentytwenty' ) );
+		$this->assertTrue( $mock_auto_updates->maybe_update_theme( 'twentytwentytwo' ) );
 
 		// Test updates will occur if within the day's option with premium active.
 		$mock_auto_updates = $this->getMockBuilder( Boldgrid_backup_Admin_Auto_Updates::class )
 			->setMethods( array( 'is_premium_done' ) )
 			->getMock();
 		$mock_auto_updates->method( 'is_premium_done' )
 			->will( $this->returnValue( true ) );
-		$this->assertTrue( $mock_auto_updates->maybe_update_theme( 'twentytwenty' ) );
+		$this->assertTrue( $mock_auto_updates->maybe_update_theme( 'twentytwentytwo' ) );
 
 		// Test updates will not occur if not within the day's option with premium active.
-		$twentytwenty_test_settings['auto_update']['days']                   = (int) $days + 10;
-		$twentytwenty_test_settings['auto_update']['timely-updates-enabled'] = true;
-		update_option( 'boldgrid_backup_settings', $twentytwenty_test_settings );
+		$twentytwentytwo_test_settings['auto_update']['days']                   = (int) $days + 10;
+		$twentytwentytwo_test_settings['auto_update']['timely-updates-enabled'] = true;
+		update_option( 'boldgrid_backup_settings', $twentytwentytwo_test_settings );
 		$mock_auto_updates->set_settings();
-		$this->assertFalse( $mock_auto_updates->maybe_update_theme( 'twentytwenty' ) );
+		$this->assertFalse( $mock_auto_updates->maybe_update_theme( 'twentytwentytwo' ) );
 	}
 
 	/**
@@ -265,8 +265,8 @@ public function test_auto_update_themes() {
 			->will( $this->returnValue( true ) );
 		$themes = new \Boldgrid\Library\Library\Theme\Themes();
 		foreach ( $themes->get() as $theme ) {
-			if ( 'twentytwenty' === $theme->stylesheet ) {
-				$this->assertTrue( $mock_auto_updates->auto_update_themes( true, (object) array( 'theme' => 'twentytwenty' ) ) );
+			if ( 'twentytwentytwo' === $theme->stylesheet ) {
+				$this->assertTrue( $mock_auto_updates->auto_update_themes( true, (object) array( 'theme' => 'twentytwentytwo' ) ) );
 			}
 		}
 
@@ -277,8 +277,8 @@ public function test_auto_update_themes() {
 			->will( $this->returnValue( false ) );
 		$themes = new \Boldgrid\Library\Library\Theme\Themes();
 		foreach ( $themes->get() as $theme ) {
-			if ( 'twentytwenty' === $theme->stylesheet ) {
-				$this->assertFalse( $mock_auto_updates->auto_update_themes( true, (object) array( 'theme' => 'twentytwenty' ) ) );
+			if ( 'twentytwentytwo' === $theme->stylesheet ) {
+				$this->assertFalse( $mock_auto_updates->auto_update_themes( true, (object) array( 'theme' => 'twentytwentytwo' ) ) );
 			}
 		}
 	}
diff --git a/tests/rest/class-boldgrid-backup-rest-case.php b/tests/rest/class-boldgrid-backup-rest-case.php
@@ -85,12 +85,12 @@ public function set_up() {
 
 		do_action( 'rest_api_init' );
 
-		$this->editor_id = $this->factory->user->create( array(
+		$this->editor_id = $this->factory()->user->create( array(
 			'role'         => 'editor',
 			'display_name' => 'test_editor',
 		) );
 
-		$this->admin_id = $this->factory->user->create( array(
+		$this->admin_id = $this->factory()->user->create( array(
 			'role'         => 'administrator',
 			'display_name' => 'test_admin',
 		) );

Original file line number	Diff line number	Diff line change
`@@ -693,13 +693,12 @@ public function get_disk_space( $get_wp_size = true ) {`
`693`	`693`	`* Get the WordPress total file size.`
`694`	`694`	`*`
`695`	`695`	`* @since 1.0`
`696`		`- * @access private`
`697`	`696`	`*`
`698`	`697`	`* @see get_filtered_filelist`
`699`	`698`	`*`
`700`	`699`	`* @return int\|bool The total size for the WordPress file system in bytes, or FALSE on error.`
`701`	`700`	`*/`
`702`		`- private function get_wp_size() {`
	`701`	`+ public function get_wp_size() {`
`703`	`702`	`// Save time, use transients.`
`704`	`703`	`$transient = get_transient( 'boldgrid_backup_wp_size' );`
`705`	`704`