mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-02-25 17:13:30 +01:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

Options, Meta APIs: Implement additional tests covering update_option().

Browse Source 
As a follow up to [56681], this changeset adds further tests, primarily focused on ensuring no unnecessary database queries are run.

Props mukesh27, costdev, joemcgill, spacedmonkey.
See #22192.


git-svn-id: https://develop.svn.wordpress.org/trunk@56762 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Felix Arntz 2023-10-03 14:09:07 +00:00
parent ea502c4570
commit 53eff06da7
1 changed files with 258 additions and 120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

378
tests/phpunit/tests/option/option.php
View File

@ -370,73 +370,89 @@ class Tests_Option_Option extends WP_UnitTestCase {
}
/**
* Ensure the database is getting updated when type changes, but not otherwise.
* Tests that update_option() triggers one additional query and returns true
* for some loosely equal old and new values when the old value is retrieved from the cache.
*
* The additional query is triggered to update the value in the database.
*
* @ticket 22192
*
* @covers ::update_option
*
* @dataProvider data_update_option_type_juggling
* @dataProvider data_loosely_equal_values_that_should_update
*
* @param mixed $old_value The old value.
* @param mixed $new_value The new value to try to set.
*/
public function test_update_loosey_options( $old_value, $new_value, $update = false ) {
public function test_update_option_should_update_some_loosely_equal_values_from_cache( $old_value, $new_value ) {
add_option( 'foo', $old_value );
$num_queries = get_num_queries();
// Comparison will happen against value cached during add_option() above.
$updated = update_option( 'foo', $new_value );
if ( $update ) {
$this->assertTrue( $updated, 'This loosely equal option should trigger an update.' );
} else {
$this->assertFalse( $updated, 'Loosely equal option should not trigger an update.' );
}
$this->assertSame( 1, get_num_queries() - $num_queries, 'One additional query should have run to update the value.' );
$this->assertTrue( $updated, 'update_option() should have returned true.' );
}
/**
* Ensure the database is getting updated when type changes, but not otherwise.
* Tests that update_option() triggers two additional queries and returns true
* for some loosely equal old and new values when the old value is retrieved from the database.
*
* The two additional queries are triggered to:
* 1. retrieve the old value from the database, as the option does not exist in the cache.
* 2. update the value in the database.
*
* @ticket 22192
*
* @covers ::update_option
*
* @dataProvider data_update_option_type_juggling
* @dataProvider data_loosely_equal_values_that_should_update
*
* @param mixed $old_value The old value.
* @param mixed $new_value The new value to try to set.
*/
public function test_update_loosey_options_from_db( $old_value, $new_value, $update = false ) {
public function test_update_option_should_update_some_loosely_equal_values_from_db( $old_value, $new_value ) {
add_option( 'foo', $old_value );
$num_queries = get_num_queries();
// Delete cache.
wp_cache_delete( 'alloptions', 'options' );
$updated = update_option( 'foo', $new_value );
if ( $update ) {
$this->assertTrue( $updated, 'This loosely equal option should trigger an update.' );
} else {
$this->assertFalse( $updated, 'Loosely equal option should not trigger an update.' );
}
$this->assertSame( 2, get_num_queries() - $num_queries, 'Two additional queries should have run.' );
$this->assertTrue( $updated, 'update_option() should have returned true.' );
}
/**
* Ensure the database is getting updated when type changes, but not otherwise.
* Tests that update_option() triggers one additional query and returns true
* for some loosely equal old and new values when the old value is retrieved from a refreshed cache.
*
* The additional query is triggered to update the value in the database.
*
* @ticket 22192
*
* @covers ::update_option
*
* @dataProvider data_update_option_type_juggling
* @dataProvider data_loosely_equal_values_that_should_update
*
* @param mixed $old_value The old value.
* @param mixed $new_value The new value to try to set.
*/
public function test_update_loosey_options_from_refreshed_cache( $old_value, $new_value, $update = false ) {
public function test_update_option_should_update_some_loosely_equal_values_from_refreshed_cache( $old_value, $new_value ) {
add_option( 'foo', $old_value );
// Delete and refresh cache from DB.
wp_cache_delete( 'alloptions', 'options' );
wp_load_alloptions();
$updated = update_option( 'foo', $new_value );
$num_queries = get_num_queries();
$updated = update_option( 'foo', $new_value );
if ( $update ) {
$this->assertTrue( $updated, 'This loosely equal option should trigger an update.' );
} else {
$this->assertFalse( $updated, 'Loosely equal option should not trigger an update.' );
}
$this->assertSame( 1, get_num_queries() - $num_queries, 'One additional query should have run to update the value.' );
$this->assertTrue( $updated, 'update_option() should have returned true.' );
}
/**
@ -444,119 +460,239 @@ class Tests_Option_Option extends WP_UnitTestCase {
*
* @return array
*/
public function data_update_option_type_juggling() {
public function data_loosely_equal_values_that_should_update() {
return array(
/*
* Truthy values.
* Loosely equal truthy scalar values should never result in a DB update.
*/
array( '1', '1' ),
array( '1', 1 ),
array( '1', 1.0 ),
array( '1', true ),
array( 1, '1' ),
array( 1, 1 ),
array( 1, 1.0 ),
array( 1, true ),
array( 1.0, '1' ),
array( 1.0, 1 ),
array( 1.0, 1.0 ),
array( 1.0, true ),
array( true, '1' ),
array( true, 1 ),
array( true, 1.0 ),
array( true, true ),
// Falsey values.
'(string) "0" to false' => array( '0', false ),
'empty string to (int) 0' => array( '', 0 ),
'empty string to (float) 0.0' => array( '', 0.0 ),
'(int) 0 to empty string' => array( 0, '' ),
'(int) 0 to false' => array( 0, false ),
'(float) 0.0 to empty string' => array( 0.0, '' ),
'(float) 0.0 to false' => array( 0.0, false ),
'false to (string) "0"' => array( false, '0' ),
'false to (int) 0' => array( false, 0 ),
'false to (float) 0.0' => array( false, 0.0 ),
/*
* Falsey values.
* Loosely equal falsey scalar values only sometimes result in a DB update.
*/
array( '0', '0' ),
array( '0', 0 ),
array( '0', 0.0 ),
array( '0', false, true ), // Should update.
array( '', '' ),
array( '', 0, true ), // Should update.
array( '', 0.0, true ), // Should update.
array( '', false ),
array( 0, '0' ),
array( 0, '', true ), // Should update.
array( 0, 0 ),
array( 0, 0.0 ),
array( 0, false, true ), // Should update.
array( 0.0, '0' ),
array( 0.0, '', true ), // Should update.
array( 0.0, 0 ),
array( 0.0, 0.0 ),
array( 0.0, false, true ), // Should update.
array( false, '0', true ), // Should update.
array( false, '' ),
array( false, 0, true ), // Should update.
array( false, 0.0, true ), // Should update.
array( false, false ),
/*
* Non scalar values.
* Loosely equal non-scalar values should almost always result in an update.
*/
array( false, array(), true ),
array( 'false', array(), true ),
array( '', array(), true ),
array( 0, array(), true ),
array( '0', array(), true ),
array( false, null ), // Does not update.
array( 'false', null, true ),
array( '', null ), // Does not update.
array( 0, null, true ),
array( '0', null, true ),
array( array(), false, true ),
array( array(), 'false', true ),
array( array(), '', true ),
array( array(), 0, true ),
array( array(), '0', true ),
array( array(), null, true ),
array( null, false ), // Does not update.
array( null, 'false', true ),
array( null, '' ), // Does not update.
array( null, 0, true ),
array( null, '0', true ),
array( null, array(), true ),
// Non-scalar values.
'false to array()' => array( false, array() ),
'(string) "false" to array()' => array( 'false', array() ),
'empty string to array()' => array( '', array() ),
'(int 0) to array()' => array( 0, array() ),
'(string) "0" to array()' => array( '0', array() ),
'(string) "false" to null' => array( 'false', null ),
'(int) 0 to null' => array( 0, null ),
'(string) "0" to null' => array( '0', null ),
'array() to false' => array( array(), false ),
'array() to (string) "false"' => array( array(), 'false' ),
'array() to empty string' => array( array(), '' ),
'array() to (int) 0' => array( array(), 0 ),
'array() to (string) "0"' => array( array(), '0' ),
'array() to null' => array( array(), null ),
);
}
/**
* Tests that update_option() stores an option that uses
* an unfiltered default value of (bool) false.
* Tests that update_option() triggers no additional queries and returns false
* for some values when the old value is retrieved from the cache.
*
* @ticket 22192
*
* @covers ::update_option
*
* @dataProvider data_loosely_equal_values_that_should_not_update
* @dataProvider data_strictly_equal_values
*
* @param mixed $old_value The old value.
* @param mixed $new_value The new value to try to set.
*/
public function test_update_option_should_store_option_with_default_value_false() {
public function test_update_option_should_not_update_some_values_from_cache( $old_value, $new_value ) {
add_option( 'foo', $old_value );
$num_queries = get_num_queries();
// Comparison will happen against value cached during add_option() above.
$updated = update_option( 'foo', $new_value );
$this->assertSame( $num_queries, get_num_queries(), 'No additional queries should have run.' );
$this->assertFalse( $updated, 'update_option() should have returned false.' );
}
/**
* Tests that update_option() triggers one additional query and returns false
* for some values when the old value is retrieved from the database.
*
* The additional query is triggered to retrieve the old value from the database.
*
* @ticket 22192
*
* @covers ::update_option
*
* @dataProvider data_loosely_equal_values_that_should_not_update
* @dataProvider data_strictly_equal_values
*
* @param mixed $old_value The old value.
* @param mixed $new_value The new value to try to set.
*/
public function test_update_option_should_not_update_some_values_from_db( $old_value, $new_value ) {
add_option( 'foo', $old_value );
$num_queries = get_num_queries();
// Delete cache.
wp_cache_delete( 'alloptions', 'options' );
$updated = update_option( 'foo', $new_value );
$this->assertSame( 1, get_num_queries() - $num_queries, 'One additional query should have run.' );
$this->assertFalse( $updated, 'update_option() should have returned false.' );
}
/**
* Tests that update_option() triggers no additional queries and returns false
* for some values when the old value is retrieved from a refreshed cache.
*
* @ticket 22192
*
* @covers ::update_option
*
* @dataProvider data_loosely_equal_values_that_should_not_update
* @dataProvider data_strictly_equal_values
*
* @param mixed $old_value The old value.
* @param mixed $new_value The new value to try to set.
*/
public function test_update_option_should_not_update_some_values_from_refreshed_cache( $old_value, $new_value ) {
add_option( 'foo', $old_value );
// Delete and refresh cache from DB.
wp_cache_delete( 'alloptions', 'options' );
wp_load_alloptions();
$num_queries = get_num_queries();
$updated = update_option( 'foo', $new_value );
$this->assertSame( $num_queries, get_num_queries(), 'No additional queries should have run.' );
$this->assertFalse( $updated, 'update_option() should have returned false.' );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_loosely_equal_values_that_should_not_update() {
return array(
// Truthy values.
'(string) "1" to (int) 1' => array( '1', 1 ),
'(string) "1" to (float) 1.0' => array( '1', 1.0 ),
'(string) "1" to true' => array( '1', true ),
'(int) 1 to (string) "1"' => array( 1, '1' ),
'1 to (float) 1.0' => array( 1, 1.0 ),
'(int) 1 to true' => array( 1, true ),
'(float) 1.0 to (string) "1"' => array( 1.0, '1' ),
'(float) 1.0 to (int) 1' => array( 1.0, 1 ),
'1.0 to true' => array( 1.0, true ),
'true to (string) "1"' => array( true, '1' ),
'true to 1' => array( true, 1 ),
'true to (float) 1.0' => array( true, 1.0 ),
// Falsey values.
'(string) "0" to (int) 0' => array( '0', 0 ),
'(string) "0" to (float) 0.0' => array( '0', 0.0 ),
'(int) 0 to (string) "0"' => array( 0, '0' ),
'(int) 0 to (float) 0.0' => array( 0, 0.0 ),
'(float) 0.0 to (string) "0"' => array( 0.0, '0' ),
'(float) 0.0 to (int) 0' => array( 0.0, 0 ),
'empty string to false' => array( '', false ),
'empty string to null' => array( '', null ),
/*
* null as an initial value behaves differently by triggering
* a query, so it is not included in these datasets.
*
* See data_stored_as_empty_string() and its related test.
*/
);
}
/**
* Data provider.
*
* @return array
*/
public function data_strictly_equal_values() {
$obj = new stdClass();
return array(
// Truthy values.
'(string) "1"' => array( '1', '1' ),
'(int) 1' => array( 1, 1 ),
'(float) 1.0' => array( 1.0, 1.0 ),
'true' => array( true, true ),
'string with spaces' => array( ' ', ' ' ),
'non-empty array' => array( array( 'false' ), array( 'false' ) ),
'object' => array( $obj, $obj ),
// Falsey values.
'(string) "0"' => array( '0', '0' ),
'empty string' => array( '', '' ),
'(int) 0' => array( 0, 0 ),
'(float) 0.0' => array( 0.0, 0.0 ),
'empty array' => array( array(), array() ),
/*
* false and null are not included in these datasets
* because false is the default value, which triggers
* a call to add_option().
*
* See data_stored_as_empty_string() and its related test.
*/
);
}
/**
* Tests that update_option() adds a non-existent option when the new value
* is stored as an empty string and false is the default value for the option.
*
* @ticket 22192
*
* @dataProvider data_stored_as_empty_string
*
* @param mixed $new_value A value that casts to an empty string.
*/
public function test_update_option_should_add_option_when_the_new_value_is_stored_as_an_empty_string_and_matches_default_value_false( $new_value ) {
global $wpdb;
$option = 'update_option_default_false';
update_option( $option, false );
$this->assertTrue( update_option( 'foo', $new_value ), 'update_option() should have returned true.' );
$actual = $wpdb->query(
$wpdb->prepare(
"SELECT option_name FROM $wpdb->options WHERE option_name = %s LIMIT 1",
$option
)
);
$actual = $wpdb->get_row( "SELECT option_value FROM $wpdb->options WHERE option_name = 'foo' LIMIT 1" );
$this->assertSame( 1, $actual );
$this->assertIsObject( $actual, 'The option was not added to the database.' );
$this->assertObjectHasProperty( 'option_value', $actual, 'The "option_value" property was not included.' );
$this->assertSame( '', $actual->option_value, 'The value was not stored as an empty string.' );
}
/**
* Tests that update_option() stores an option that uses
* a filtered default value.
* Data provider.
*
* @return array[]
*/
public function data_stored_as_empty_string() {
return array(
'false' => array( false ),
'empty string' => array( '' ),
'null' => array( null ),
);
}
/**
* Tests that update_option() adds a non-existent option that uses a filtered default value.
*
* @ticket 22192
*
* @covers ::update_option
*/
public function test_update_option_should_store_option_with_filtered_default_value() {
public function test_update_option_should_add_option_with_filtered_default_value() {
global $wpdb;
$option = 'update_option_custom_default';
@ -569,20 +705,22 @@ class Tests_Option_Option extends WP_UnitTestCase {
}
);
update_option( $option, $default_value );
$this->assertTrue( update_option( $option, $default_value ), 'update_option() should have returned true.' );
$actual = $wpdb->query(
$actual = $wpdb->get_row(
$wpdb->prepare(
"SELECT option_name FROM $wpdb->options WHERE option_name = %s LIMIT 1",
"SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1",
$option
)
);
$this->assertSame( 1, $actual );
$this->assertIsObject( $actual, 'The option was not added to the database.' );
$this->assertObjectHasProperty( 'option_value', $actual, 'The "option_value" property was not included.' );
$this->assertSame( $default_value, $actual->option_value, 'The value was not stored as an empty string.' );
}
/**
* Tests that a non-existing option is added even when its pre filter returns a value.
* Tests that a non-existent option is added even when its pre filter returns a value.
*
* @ticket 22192
*