Allow object-cache.php to not be being loaded locally (#617)

* Test disabling object-cache locally

* Finish up disabling object cache locally

* CHANGELOG

Author: srtfisher

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+- Add a `without_local_object_cache()` method to prevent the `object-cache.php` drop-in from being loaded locally.
+
 ### Changed
 
 - Disable `spatie/once`'s cache if found during unit testing.

src/mantle/testing/class-utils.php

@@ -437,6 +437,19 @@ public static function is_debug_mode(): bool {
 		);
 	}
 
+	/**
+	 * Check if we're running in a CI (Continuous Integration) environment.
+	 */
+	public static function is_ci(): bool {
+		return (
+			! empty( $_SERVER['GITHUB_ENV'] )
+			|| ( ! empty( $_SERVER['CI'] ) && in_array( $_SERVER['CI'], [ 'true', '1' ], true ) )
+			|| ! empty( $_SERVER['GITHUB_REPOSITORY_OWNER'] )
+			|| ! empty( $_SERVER['GITHUB_WORKFLOW'] )
+			|| ! empty( $_SERVER['GITHUB_EVENT_NAME'] )
+		);
+	}
+
 	/**
 	 * Run a system command and return the output.
 	 *

src/mantle/testing/concerns/trait-rsync-installation.php

@@ -212,6 +212,20 @@ public function with_object_cache( bool|string $install = true ): static {
 		return $this;
 	}
 
+	/**
+	 * Skip the local object cache when running the tests.
+	 *
+	 * Useful for local development where the object cache may be causing issues.
+	 * Will not disable the object cache drop-in when run in GitHub Actions.
+	 *
+	 * @param bool $skip Whether to skip the local object cache.
+	 */
+	public function without_local_object_cache( bool $skip = true ): static {
+		putenv( 'MANTLE_SKIP_LOCAL_OBJECT_CACHE=' . ( $skip ? '1' : '0' ) );
+
+		return $this;
+	}
+
 	/**
 	 * Install SQLite db.php drop-in into the codebase.
 	 *

src/mantle/testing/install-wordpress.php

@@ -1,8 +1,6 @@
 <?php // phpcs:disable
 /**
- * Installs WordPress for the purpose of the unit-tests
- *
- * @todo Reuse the init/load code in init.php
+ * Installs WordPress for the purpose of the unit-tests.
  */
 
 use Mantle\Testing\Utils;

src/mantle/testing/wordpress-bootstrap.php

@@ -210,6 +210,20 @@
 	remove_filter( 'pre_wp_load_alloptions', 'Automattic\\VIP\\Core\\OptionsAPI\\pre_wp_load_alloptions_protections', 999 );
 } );
 
+// Disable the object-cache.php drop if the MANTLE_SKIP_LOCAL_OBJECT_CACHE
+// environment variable is set.
+tests_add_filter( 'enable_loading_object_cache_dropin', function ( $enable_object_cache ) {
+	if ( Utils::env_bool( 'MANTLE_SKIP_LOCAL_OBJECT_CACHE', false ) && ! Utils::is_ci() ) {
+		if ( Utils::is_debug_mode() ) {
+			Utils::info( 'Skipping local object cache drop-in.' );
+		}
+
+		return false;
+	}
+
+	return $enable_object_cache;
+} );
+
 // Load WordPress.
 require_once ABSPATH . '/wp-settings.php';
 
@@ -223,7 +237,7 @@
 	$_SERVER['REQUEST_TIME_FLOAT'] = (float) $_SERVER['REQUEST_TIME_FLOAT'];
 }
 
-// Disable VIP's alloptions protections during unit testing.
+// Remove the disabling of VIP's alloptions protections during unit testing.
 remove_filter( 'pre_wp_load_alloptions', 'Automattic\\VIP\\Core\\OptionsAPI\\pre_wp_load_alloptions_protections', 999 );
 
 // Delete any default posts & related data.

tests/bootstrap.php

@@ -14,11 +14,10 @@
 // Enable debugging flag for local development on the testing framework.
 // define( 'MANTLE_TESTING_DEBUG', true );
 
-( new \NunoMaduro\Collision\Provider() )->register();
-
 \Mantle\Testing\manager()
 	->maybe_rsync_plugin()
 	->with_vip_mu_plugins()
 	->install_plugin( 'logger', 'https://github.com/alleyinteractive/logger/archive/refs/heads/develop.zip' )
 	->install_plugin( 'jetpack', '12.4' )
+	->without_local_object_cache()
 	->install();