wordpress-develop/tests/phpunit/tests/term/meta.php
Sergey Biryukov ddb409edca Build/Test Tools: Implement use of the void solution.
> PHPUnit 8.0.0 introduced a `void` return type declaration to the "fixture" methods – `setUpBeforeClass()`, `setUp()`, `tearDown()` and `tearDownAfterClass()`. As the `void` return type was not introduced until PHP 7.1, this makes it more difficult to create cross-version compatible tests when using fixtures, due to signature mismatches.
>
> The `Yoast\PHPUnitPolyfills\TestCases\TestCase` overcomes the signature mismatch by having two versions. The correct one will be loaded depending on the PHPUnit version being used.
>
> When using this TestCase, if an individual test, or another TestCase which extends this TestCase, needs to overload any of the "fixture" methods, it should do so by using a snake_case variant of the original fixture method name, i.e. `set_up_before_class()`, `set_up()`, `assert_pre_conditions()`, `assert_post_conditions()`, `tear_down()`, and `tear_down_after_class()`.
>
> The snake_case methods will automatically be called by PHPUnit.
>
> > IMPORTANT: The snake_case methods should not call the PHPUnit parent, i.e. do not use `parent::setUp()` from within an overloaded `set_up()` method. If necessary, DO call `parent::set_up()`.

Reference: https://github.com/Yoast/PHPUnit-Polyfills#testcases

This commit renames all declared fixture methods, and calls to parent versions of those fixture methods, from camelCase to snake_case.

Follow-up to [51559-51567].

Props jrf, hellofromTonya, johnbillion, netweb, dd32, pputzer, SergeyBiryukov.
See #46149.

git-svn-id: https://develop.svn.wordpress.org/trunk@51568 602fd350-edb4-49c9-b593-d223f7449a82
2021-08-07 10:29:41 +00:00

602 lines
16 KiB
PHP

<?php
/**
* @group taxonomy
* @group meta
* @ticket 10142
*/
class Tests_Term_Meta extends WP_UnitTestCase {
private $last_register_meta_call = array(
'object_type' => '',
'meta_key' => '',
'args' => array(),
);
public function set_up() {
parent::set_up();
register_taxonomy( 'wptests_tax', 'post' );
}
public function test_add() {
$t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
$this->assertNotEmpty( add_term_meta( $t, 'foo', 'bar' ) );
}
public function test_add_unique() {
$t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
$this->assertNotEmpty( add_term_meta( $t, 'foo', 'bar' ) );
$this->assertFalse( add_term_meta( $t, 'foo', 'bar', true ) );
}
public function test_delete() {
$t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $t, 'foo', 'bar' );
$this->assertTrue( delete_term_meta( $t, 'foo' ) );
}
public function test_delete_with_invalid_meta_key_should_return_false() {
$t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
$this->assertFalse( delete_term_meta( $t, 'foo' ) );
}
public function test_delete_should_respect_meta_value() {
$t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $t, 'foo', 'bar' );
add_term_meta( $t, 'foo', 'baz' );
$this->assertTrue( delete_term_meta( $t, 'foo', 'bar' ) );
$metas = get_term_meta( $t, 'foo', false );
$this->assertSame( array( 'baz' ), $metas );
}
public function test_get_with_no_key_should_fetch_all_keys() {
$t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $t, 'foo', 'bar' );
add_term_meta( $t, 'foo1', 'baz' );
$found = get_term_meta( $t );
$expected = array(
'foo' => array( 'bar' ),
'foo1' => array( 'baz' ),
);
$this->assertSameSets( $expected, $found );
}
public function test_get_with_key_should_fetch_all_for_key() {
$t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $t, 'foo', 'bar' );
add_term_meta( $t, 'foo', 'baz' );
add_term_meta( $t, 'foo1', 'baz' );
$found = get_term_meta( $t, 'foo' );
$expected = array( 'bar', 'baz' );
$this->assertSameSets( $expected, $found );
}
public function test_get_should_respect_single_true() {
$t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $t, 'foo', 'bar' );
add_term_meta( $t, 'foo', 'baz' );
$found = get_term_meta( $t, 'foo', true );
$this->assertSame( 'bar', $found );
}
public function test_update_should_pass_to_add_when_no_value_exists_for_key() {
$t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
$actual = update_term_meta( $t, 'foo', 'bar' );
$this->assertIsInt( $actual );
$this->assertNotEmpty( $actual );
$meta = get_term_meta( $t, 'foo', true );
$this->assertSame( 'bar', $meta );
}
public function test_update_should_return_true_when_updating_existing_value_for_key() {
$t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $t, 'foo', 'bar' );
$actual = update_term_meta( $t, 'foo', 'baz' );
$this->assertTrue( $actual );
$meta = get_term_meta( $t, 'foo', true );
$this->assertSame( 'baz', $meta );
}
public function test_term_meta_should_be_lazy_loaded_for_all_terms_in_wp_query_loop() {
global $wpdb;
// Clear any previous term IDs from the queue.
wp_metadata_lazyloader()->reset_queue( 'term' );
$p = self::factory()->post->create( array( 'post_status' => 'publish' ) );
register_taxonomy( 'wptests_tax', 'post' );
$terms = self::factory()->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
wp_set_object_terms( $p, $terms, 'wptests_tax' );
foreach ( $terms as $t ) {
add_term_meta( $t, 'foo', 'bar' );
}
// Create another term, which should *not* be lazy loaded because it's unattached.
$orphan_term = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $orphan_term, 'foo', 'bar' );
// Force results to be cached, even when using extended cache.
add_action( 'pre_get_posts', array( $this, 'set_cache_results' ) );
$this->go_to( get_permalink( $p ) );
remove_action( 'pre_get_posts', array( $this, 'set_cache_results' ) );
if ( have_posts() ) {
while ( have_posts() ) {
the_post();
// First request will hit the database.
$num_queries = $wpdb->num_queries;
$this->assertSame( 'bar', get_term_meta( $terms[0], 'foo', true ) );
$num_queries++;
$this->assertSame( $num_queries, $wpdb->num_queries );
// Second and third requests should be in cache.
$this->assertSame( 'bar', get_term_meta( $terms[1], 'foo', true ) );
$this->assertSame( 'bar', get_term_meta( $terms[2], 'foo', true ) );
$this->assertSame( $num_queries, $wpdb->num_queries );
// Querying a term not primed should result in a hit.
$num_queries++;
$this->assertSame( 'bar', get_term_meta( $orphan_term, 'foo', true ) );
$this->assertSame( $num_queries, $wpdb->num_queries );
}
}
}
public static function set_cache_results( $q ) {
$q->set( 'cache_results', true );
}
/**
* @ticket 36593
*/
public function test_lazy_load_term_meta_should_fall_back_on_update_post_term_cache() {
$q = new WP_Query(
array(
'update_post_term_cache' => true,
)
);
$this->assertTrue( $q->get( 'lazy_load_term_meta' ) );
$q = new WP_Query(
array(
'update_post_term_cache' => false,
)
);
$this->assertFalse( $q->get( 'lazy_load_term_meta' ) );
}
/**
* @ticket 36593
*/
public function test_lazy_load_term_meta_false() {
global $wpdb;
$p = self::factory()->post->create( array( 'post_status' => 'publish' ) );
register_taxonomy( 'wptests_tax', 'post' );
$terms = self::factory()->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
wp_set_object_terms( $p, $terms, 'wptests_tax' );
foreach ( $terms as $t ) {
add_term_meta( $t, 'foo', 'bar' );
}
$q = new WP_Query(
array(
'cache_results' => true,
'update_post_term_cache' => true,
'lazy_load_term_meta' => false,
)
);
if ( $q->have_posts() ) {
while ( $q->have_posts() ) {
$q->the_post();
// Requests will hit the database.
$num_queries = $wpdb->num_queries;
$this->assertSame( 'bar', get_term_meta( $terms[0], 'foo', true ) );
$num_queries++;
$this->assertSame( $num_queries, $wpdb->num_queries );
$this->assertSame( 'bar', get_term_meta( $terms[1], 'foo', true ) );
$num_queries++;
$this->assertSame( $num_queries, $wpdb->num_queries );
}
}
}
public function test_adding_term_meta_should_bust_get_terms_cache() {
$terms = self::factory()->term->create_many( 2, array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $terms[0], 'foo', 'bar' );
// Prime cache.
$found = get_terms(
'wptests_tax',
array(
'hide_empty' => false,
'fields' => 'ids',
'meta_query' => array(
array(
'key' => 'foo',
'value' => 'bar',
),
),
)
);
$this->assertSameSets( array( $terms[0] ), $found );
add_term_meta( $terms[1], 'foo', 'bar' );
$found = get_terms(
'wptests_tax',
array(
'hide_empty' => false,
'fields' => 'ids',
'meta_query' => array(
array(
'key' => 'foo',
'value' => 'bar',
),
),
)
);
$this->assertSameSets( array( $terms[0], $terms[1] ), $found );
}
public function test_updating_term_meta_should_bust_get_terms_cache() {
$terms = self::factory()->term->create_many( 2, array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $terms[0], 'foo', 'bar' );
add_term_meta( $terms[1], 'foo', 'baz' );
// Prime cache.
$found = get_terms(
'wptests_tax',
array(
'hide_empty' => false,
'fields' => 'ids',
'meta_query' => array(
array(
'key' => 'foo',
'value' => 'bar',
),
),
)
);
$this->assertSameSets( array( $terms[0] ), $found );
update_term_meta( $terms[1], 'foo', 'bar' );
$found = get_terms(
'wptests_tax',
array(
'hide_empty' => false,
'fields' => 'ids',
'meta_query' => array(
array(
'key' => 'foo',
'value' => 'bar',
),
),
)
);
$this->assertSameSets( array( $terms[0], $terms[1] ), $found );
}
public function test_deleting_term_meta_should_bust_get_terms_cache() {
$terms = self::factory()->term->create_many( 2, array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $terms[0], 'foo', 'bar' );
add_term_meta( $terms[1], 'foo', 'bar' );
// Prime cache.
$found = get_terms(
'wptests_tax',
array(
'hide_empty' => false,
'fields' => 'ids',
'meta_query' => array(
array(
'key' => 'foo',
'value' => 'bar',
),
),
)
);
$this->assertSameSets( array( $terms[0], $terms[1] ), $found );
delete_term_meta( $terms[1], 'foo', 'bar' );
$found = get_terms(
'wptests_tax',
array(
'hide_empty' => false,
'fields' => 'ids',
'meta_query' => array(
array(
'key' => 'foo',
'value' => 'bar',
),
),
)
);
$this->assertSameSets( array( $terms[0] ), $found );
}
/**
* @ticket 34544
*/
public function test_add_term_meta_should_return_error_when_term_id_is_shared() {
global $wpdb;
update_option( 'finished_splitting_shared_terms', false );
register_taxonomy( 'wptests_tax', 'post' );
register_taxonomy( 'wptests_tax_2', 'post' );
register_taxonomy( 'wptests_tax_3', 'post' );
$t1 = wp_insert_term( 'Foo', 'wptests_tax' );
$t2 = wp_insert_term( 'Foo', 'wptests_tax_2' );
$t3 = wp_insert_term( 'Foo', 'wptests_tax_3' );
// Manually modify because shared terms shouldn't naturally occur.
$wpdb->update(
$wpdb->term_taxonomy,
array( 'term_id' => $t1['term_id'] ),
array( 'term_taxonomy_id' => $t2['term_taxonomy_id'] ),
array( '%d' ),
array( '%d' )
);
$wpdb->update(
$wpdb->term_taxonomy,
array( 'term_id' => $t1['term_id'] ),
array( 'term_taxonomy_id' => $t3['term_taxonomy_id'] ),
array( '%d' ),
array( '%d' )
);
$found = add_term_meta( $t1['term_id'], 'bar', 'baz' );
$this->assertWPError( $found );
$this->assertSame( 'ambiguous_term_id', $found->get_error_code() );
}
/**
* @ticket 34544
*/
public function test_update_term_meta_should_return_error_when_term_id_is_shared() {
global $wpdb;
update_option( 'finished_splitting_shared_terms', false );
register_taxonomy( 'wptests_tax', 'post' );
$t1 = wp_insert_term( 'Foo', 'wptests_tax' );
add_term_meta( $t1['term_id'], 'foo', 'bar' );
register_taxonomy( 'wptests_tax_2', 'post' );
register_taxonomy( 'wptests_tax_3', 'post' );
$t2 = wp_insert_term( 'Foo', 'wptests_tax_2' );
$t3 = wp_insert_term( 'Foo', 'wptests_tax_3' );
// Manually modify because shared terms shouldn't naturally occur.
$wpdb->update(
$wpdb->term_taxonomy,
array( 'term_id' => $t1['term_id'] ),
array( 'term_taxonomy_id' => $t2['term_taxonomy_id'] ),
array( '%d' ),
array( '%d' )
);
$wpdb->update(
$wpdb->term_taxonomy,
array( 'term_id' => $t1['term_id'] ),
array( 'term_taxonomy_id' => $t3['term_taxonomy_id'] ),
array( '%d' ),
array( '%d' )
);
$found = update_term_meta( $t1['term_id'], 'foo', 'baz' );
$this->assertWPError( $found );
$this->assertSame( 'ambiguous_term_id', $found->get_error_code() );
}
/**
* @ticket 34626
*/
public function test_term_meta_should_be_deleted_when_term_is_deleted() {
$t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $t, 'foo', 'bar' );
add_term_meta( $t, 'foo1', 'bar' );
$this->assertSame( 'bar', get_term_meta( $t, 'foo', true ) );
$this->assertSame( 'bar', get_term_meta( $t, 'foo1', true ) );
$this->assertTrue( wp_delete_term( $t, 'wptests_tax' ) );
$this->assertSame( '', get_term_meta( $t, 'foo', true ) );
$this->assertSame( '', get_term_meta( $t, 'foo1', true ) );
}
/**
* @ticket 35991
*/
public function test_has_term_meta() {
$t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
$term_meta_id = add_term_meta( $t, 'foo', 'bar' );
$meta = has_term_meta( $t );
$this->assertCount( 1, $meta );
$expected = array(
'meta_key' => 'foo',
'meta_value' => 'bar',
'meta_id' => $term_meta_id,
'term_id' => $t,
);
$found = $meta[0];
$this->assertEquals( $expected, $found );
}
/**
* @ticket 35991
*/
public function test_has_term_meta_empty_results() {
$t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
$meta = has_term_meta( $t );
$this->assertSame( array(), $meta );
}
/**
* @ticket 38323
* @dataProvider data_register_term_meta
*/
public function test_register_term_meta( $taxonomy, $meta_key, $args ) {
add_filter( 'register_meta_args', array( $this, 'filter_register_meta_args_set_last_register_meta_call' ), 10, 4 );
register_term_meta( $taxonomy, $meta_key, $args );
$args['object_subtype'] = $taxonomy;
// Reset global so subsequent data tests do not get polluted.
$GLOBALS['wp_meta_keys'] = array();
$this->assertSame( 'term', $this->last_register_meta_call['object_type'] );
$this->assertSame( $meta_key, $this->last_register_meta_call['meta_key'] );
$this->assertSame( $args, $this->last_register_meta_call['args'] );
}
public function data_register_term_meta() {
return array(
array( 'wptests_tax', 'registered_key1', array( 'single' => true ) ),
array( 'category', 'registered_key2', array() ),
array( '', 'registered_key3', array( 'sanitize_callback' => 'absint' ) ),
);
}
public function filter_register_meta_args_set_last_register_meta_call( $args, $defaults, $object_type, $meta_key ) {
$this->last_register_meta_call['object_type'] = $object_type;
$this->last_register_meta_call['meta_key'] = $meta_key;
$this->last_register_meta_call['args'] = $args;
return $args;
}
/**
* @ticket 38323
* @dataProvider data_unregister_term_meta
*/
public function test_unregister_term_meta( $taxonomy, $meta_key ) {
global $wp_meta_keys;
register_term_meta( $taxonomy, $meta_key, array() );
unregister_term_meta( $taxonomy, $meta_key );
$actual = $wp_meta_keys;
// Reset global so subsequent data tests do not get polluted.
$wp_meta_keys = array();
$this->assertEmpty( $actual );
}
public function data_unregister_term_meta() {
return array(
array( 'wptests_tax', 'registered_key1' ),
array( 'category', 'registered_key2' ),
array( '', 'registered_key3' ),
);
}
/**
* @ticket 44467
*/
public function test_add_metadata_sets_terms_last_changed() {
$term_id = self::factory()->term->create();
wp_cache_delete( 'last_changed', 'terms' );
$this->assertIsInt( add_metadata( 'term', $term_id, 'foo', 'bar' ) );
$this->assertNotFalse( wp_cache_get_last_changed( 'terms' ) );
}
/**
* @ticket 44467
*/
public function test_update_metadata_sets_terms_last_changed() {
$term_id = self::factory()->term->create();
wp_cache_delete( 'last_changed', 'terms' );
$this->assertIsInt( update_metadata( 'term', $term_id, 'foo', 'bar' ) );
$this->assertNotFalse( wp_cache_get_last_changed( 'terms' ) );
}
/**
* @ticket 44467
*/
public function test_delete_metadata_sets_terms_last_changed() {
$term_id = self::factory()->term->create();
update_metadata( 'term', $term_id, 'foo', 'bar' );
wp_cache_delete( 'last_changed', 'terms' );
$this->assertTrue( delete_metadata( 'term', $term_id, 'foo' ) );
$this->assertNotFalse( wp_cache_get_last_changed( 'terms' ) );
}
/**
* @ticket 44467
*/
public function test_metadata_functions_respect_term_meta_support() {
$term_id = self::factory()->term->create();
$meta_id = add_metadata( 'term', $term_id, 'foo', 'bar' );
// Set database version to last version before term meta support.
update_option( 'db_version', 34369 );
$this->assertFalse( get_metadata( 'term', $term_id, 'foo', true ) );
$this->assertFalse( add_metadata( 'term', $term_id, 'foo', 'bar' ) );
$this->assertFalse( update_metadata( 'term', $term_id, 'foo', 'bar' ) );
$this->assertFalse( delete_metadata( 'term', $term_id, 'foo' ) );
$this->assertFalse( get_metadata_by_mid( 'term', $meta_id ) );
$this->assertFalse( update_metadata_by_mid( 'term', $meta_id, 'baz' ) );
$this->assertFalse( delete_metadata_by_mid( 'term', $meta_id ) );
$this->assertFalse( update_meta_cache( 'term', array( $term_id ) ) );
}
}