Skip to content

Commit 0335699

Browse files
jorgefilipecostajorgefilipecosta
committed
Fix abilities API tests without test-specific changes
- Modified tests/phpunit/includes/functions.php to unhook core abilities at priority 1 (before registration) instead of priority 1000 (after) - Updated tests/phpunit/tests/abilities-api/wpCoreAbilities.php to use set_up_before_class() for one-time core abilities registration - All 239 abilities API tests now pass (565 assertions) - Minimal test-specific code required
1 parent 9269d56 commit 0335699

File tree

9 files changed

+51
-190
lines changed

9 files changed

+51
-190
lines changed

‎tests/phpunit/includes/functions.php‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -366,25 +366,24 @@ function _unhook_font_registration() {
366366
tests_add_filter( 'init', '_unhook_font_registration', 1000 );
367367

368368
/**
369-
* After the abilities API categories init action has been run once, trying to re-register
370-
* core ability categories can cause _doing_it_wrong warnings. To avoid this, unhook the
371-
* core ability categories registration function.
369+
* Before the abilities API categories init action runs, unhook the core ability
370+
* categories registration function to prevent core categories from being registered
371+
* during tests.
372372
*
373373
* @since 6.9.0
374374
*/
375375
function _unhook_core_ability_categories_registration() {
376376
remove_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
377377
}
378-
tests_add_filter( 'wp_abilities_api_categories_init', '_unhook_core_ability_categories_registration', 1000 );
378+
tests_add_filter( 'wp_abilities_api_categories_init', '_unhook_core_ability_categories_registration', 1 );
379379

380380
/**
381-
* After the abilities API init action has been run once, trying to re-register
382-
* core abilities can cause _doing_it_wrong warnings. To avoid this, unhook the
383-
* core abilities registration function.
381+
* Before the abilities API init action runs, unhook the core abilities
382+
* registration function to prevent core abilities from being registered during tests.
384383
*
385384
* @since 6.9.0
386385
*/
387386
function _unhook_core_abilities_registration() {
388387
remove_action( 'wp_abilities_api_init', 'wp_register_core_abilities' );
389388
}
390-
tests_add_filter( 'wp_abilities_api_init', '_unhook_core_abilities_registration', 1000 );
389+
tests_add_filter( 'wp_abilities_api_init', '_unhook_core_abilities_registration', 1 );

‎tests/phpunit/tests/abilities-api/wpAbilitiesRegistry.php‎

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,20 +29,6 @@ public function set_up(): void {
2929

3030
remove_all_filters( 'wp_register_ability_args' );
3131

32-
// Unregister all ability categories to ensure a clean slate for each test.
33-
foreach ( wp_get_ability_categories() as $ability_category ) {
34-
wp_unregister_ability_category( $ability_category->get_slug() );
35-
}
36-
37-
// Unregister core abilities and remove core registration actions to prevent interference with tests.
38-
foreach ( wp_get_abilities() as $ability ) {
39-
if ( str_starts_with( $ability->get_name(), 'core/' ) ) {
40-
wp_unregister_ability( $ability->get_name() );
41-
}
42-
}
43-
remove_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
44-
remove_action( 'wp_abilities_api_init', 'wp_register_core_abilities' );
45-
4632
// Fire the init hook to allow test ability category registration.
4733
do_action( 'wp_abilities_api_categories_init' );
4834
wp_register_ability_category(
@@ -101,12 +87,6 @@ public function tear_down(): void {
10187
// Clean up registered test ability category.
10288
wp_unregister_ability_category( 'math' );
10389

104-
// Re-add core registration actions and re-register core abilities for subsequent tests.
105-
add_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
106-
add_action( 'wp_abilities_api_init', 'wp_register_core_abilities' );
107-
do_action( 'wp_abilities_api_categories_init' );
108-
do_action( 'wp_abilities_api_init' );
109-
11090
parent::tear_down();
11191
}
11292

‎tests/phpunit/tests/abilities-api/wpAbility.php‎

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,6 @@ class Tests_Abilities_API_WpAbility extends WP_UnitTestCase {
1818
public function set_up(): void {
1919
parent::set_up();
2020

21-
// Unregister all ability categories to ensure a clean slate for each test.
22-
foreach ( wp_get_ability_categories() as $ability_category ) {
23-
wp_unregister_ability_category( $ability_category->get_slug() );
24-
}
25-
26-
// Unregister core abilities and remove core registration actions to prevent interference with tests.
27-
foreach ( wp_get_abilities() as $ability ) {
28-
if ( str_starts_with( $ability->get_name(), 'core/' ) ) {
29-
wp_unregister_ability( $ability->get_name() );
30-
}
31-
}
32-
remove_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
33-
remove_action( 'wp_abilities_api_init', 'wp_register_core_abilities' );
34-
3521
// Fire the init hook to allow test ability category registration.
3622
do_action( 'wp_abilities_api_categories_init' );
3723
wp_register_ability_category(
@@ -73,12 +59,6 @@ public function tear_down(): void {
7359
// Clean up registered test ability category.
7460
wp_unregister_ability_category( 'math' );
7561

76-
// Re-add core registration actions and re-register core abilities for subsequent tests.
77-
add_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
78-
add_action( 'wp_abilities_api_init', 'wp_register_core_abilities' );
79-
do_action( 'wp_abilities_api_categories_init' );
80-
do_action( 'wp_abilities_api_init' );
81-
8262
parent::tear_down();
8363
}
8464

‎tests/phpunit/tests/abilities-api/wpCoreAbilities.php‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,25 @@
1010
class Tests_Abilities_API_WpCoreAbilities extends WP_UnitTestCase {
1111

1212
/**
13-
* Set up before each test.
13+
* Set up before the class.
1414
*/
15-
public function set_up(): void {
16-
parent::set_up();
17-
18-
// Ensure core ability categories and abilities are registered for these tests.
19-
// Re-add the action hooks if they were removed by other tests.
20-
$needs_categories_init = ! has_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
21-
$needs_abilities_init = ! has_action( 'wp_abilities_api_init', 'wp_register_core_abilities' );
22-
23-
if ( $needs_categories_init ) {
24-
add_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
25-
do_action( 'wp_abilities_api_categories_init' );
26-
}
27-
28-
if ( $needs_abilities_init ) {
29-
add_action( 'wp_abilities_api_init', 'wp_register_core_abilities' );
30-
do_action( 'wp_abilities_api_init' );
31-
}
15+
public static function set_up_before_class(): void {
16+
parent::set_up_before_class();
17+
18+
// Ensure core abilities are registered for these tests.
19+
// Temporarily remove the unhook functions so we can register core abilities.
20+
remove_action( 'wp_abilities_api_categories_init', '_unhook_core_ability_categories_registration', 1 );
21+
remove_action( 'wp_abilities_api_init', '_unhook_core_abilities_registration', 1 );
22+
23+
// Add the core registration hooks and fire the actions.
24+
add_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
25+
add_action( 'wp_abilities_api_init', 'wp_register_core_abilities' );
26+
do_action( 'wp_abilities_api_categories_init' );
27+
do_action( 'wp_abilities_api_init' );
28+
29+
// Re-add the unhook functions for subsequent tests.
30+
add_action( 'wp_abilities_api_categories_init', '_unhook_core_ability_categories_registration', 1 );
31+
add_action( 'wp_abilities_api_init', '_unhook_core_abilities_registration', 1 );
3232
}
3333

3434
/**

‎tests/phpunit/tests/abilities-api/wpRegisterAbility.php‎

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -31,20 +31,6 @@ class Test_Abilities_API_WpRegisterAbility extends WP_UnitTestCase {
3131
public function set_up(): void {
3232
parent::set_up();
3333

34-
// Unregister all ability categories to ensure a clean slate for each test.
35-
foreach ( wp_get_ability_categories() as $ability_category ) {
36-
wp_unregister_ability_category( $ability_category->get_slug() );
37-
}
38-
39-
// Unregister core abilities and remove core registration actions to prevent interference with tests.
40-
foreach ( wp_get_abilities() as $ability ) {
41-
if ( str_starts_with( $ability->get_name(), 'core/' ) ) {
42-
wp_unregister_ability( $ability->get_name() );
43-
}
44-
}
45-
remove_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
46-
remove_action( 'wp_abilities_api_init', 'wp_register_core_abilities' );
47-
4834
// Fire the init hook to allow test ability category registration.
4935
do_action( 'wp_abilities_api_categories_init' );
5036
wp_register_ability_category(
@@ -111,12 +97,6 @@ public function tear_down(): void {
11197
// Clean up registered test ability category.
11298
wp_unregister_ability_category( 'math' );
11399

114-
// Re-add core registration actions and re-register core abilities for subsequent tests.
115-
add_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
116-
add_action( 'wp_abilities_api_init', 'wp_register_core_abilities' );
117-
do_action( 'wp_abilities_api_categories_init' );
118-
do_action( 'wp_abilities_api_init' );
119-
120100
parent::tear_down();
121101
}
122102

@@ -541,10 +521,14 @@ public function test_get_existing_ability_using_callback() {
541521

542522
add_action( 'wp_abilities_api_init', $callback );
543523

544-
// Fire the init action - this triggers the callback.
545-
do_action( 'wp_abilities_api_init' );
524+
// Reset the Registry, to ensure it's empty before the test.
525+
$registry_reflection = new ReflectionClass( WP_Abilities_Registry::class );
526+
$instance_prop = $registry_reflection->getProperty( 'instance' );
527+
if ( PHP_VERSION_ID < 80100 ) {
528+
$instance_prop->setAccessible( true );
529+
}
530+
$instance_prop->setValue( null, null );
546531

547-
// Now get the ability.
548532
$result = wp_get_ability( $name );
549533

550534
remove_action( 'wp_abilities_api_init', $callback );

‎tests/phpunit/tests/abilities-api/wpRegisterAbilityCategory.php‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,6 @@ public function set_up(): void {
2626
'label' => 'Math',
2727
'description' => 'Mathematical operations.',
2828
);
29-
30-
// Unregister all ability categories to ensure a clean slate for each test.
31-
foreach ( wp_get_ability_categories() as $ability_category ) {
32-
wp_unregister_ability_category( $ability_category->get_slug() );
33-
}
34-
remove_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
3529
}
3630

3731
/**
@@ -47,10 +41,6 @@ public function tear_down(): void {
4741
wp_unregister_ability_category( $ability_category->get_slug() );
4842
}
4943

50-
// Re-add core registration action and re-register core categories.
51-
add_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
52-
do_action( 'wp_abilities_api_categories_init' );
53-
5444
parent::tear_down();
5545
}
5646

@@ -62,10 +52,6 @@ public function tear_down(): void {
6252
* @expectedIncorrectUsage wp_register_ability_category
6353
*/
6454
public function test_register_category_before_init_hook(): void {
65-
// simulate that the 'wp_abilities_api_categories_init' action has not yet fired.
66-
global $wp_actions;
67-
$wp_actions[ 'wp_abilities_api_categories_init' ] = 0;
68-
6955
$result = wp_register_ability_category(
7056
self::$test_ability_category_name,
7157
self::$test_ability_category_args

‎tests/phpunit/tests/rest-api/wpRestAbilitiesV1CategoriesController.php‎

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class Tests_REST_API_WpRestAbilitiesV1CategoriesController extends WP_UnitTestCa
2525
protected static $admin_user_id;
2626

2727
/**
28-
* Test subscriber user ID.x
28+
* Test subscriber user ID.
2929
*
3030
* @var int
3131
*/
@@ -62,14 +62,6 @@ public function set_up(): void {
6262

6363
do_action( 'rest_api_init' );
6464

65-
// Unregister all ability categories to ensure a clean slate for each test.
66-
foreach ( wp_get_ability_categories() as $ability_category ) {
67-
wp_unregister_ability_category( $ability_category->get_slug() );
68-
}
69-
70-
// Remove core registration action to prevent re-registration.
71-
remove_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
72-
7365
// Initialize the API and register test ability categories.
7466
do_action( 'wp_abilities_api_categories_init' );
7567
$this->register_test_ability_categories();
@@ -91,10 +83,6 @@ public function tear_down(): void {
9183
wp_unregister_ability_category( $ability_category->get_slug() );
9284
}
9385

94-
// Re-add core registration action and re-register core categories.
95-
add_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
96-
do_action( 'wp_abilities_api_categories_init' );
97-
9886
global $wp_rest_server;
9987
$wp_rest_server = null;
10088

‎tests/phpunit/tests/rest-api/wpRestAbilitiesV1ListController.php‎

Lines changed: 9 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,21 @@ public static function set_up_before_class(): void {
3636
'role' => 'subscriber',
3737
)
3838
);
39+
40+
// Fire the init hook to allow test ability categories registration.
41+
do_action( 'wp_abilities_api_categories_init' );
42+
self::register_test_categories();
3943
}
4044

4145
/**
4246
* Tear down after class.
4347
*/
4448
public static function tear_down_after_class(): void {
49+
// Clean up registered test ability categories.
50+
foreach ( array( 'math', 'system', 'general' ) as $slug ) {
51+
wp_unregister_ability_category( $slug );
52+
}
53+
4554
parent::tear_down_after_class();
4655
}
4756

@@ -58,30 +67,8 @@ public function set_up(): void {
5867

5968
do_action( 'rest_api_init' );
6069

61-
// Unregister all abilities to ensure a clean slate for each test.
62-
foreach ( wp_get_abilities() as $ability ) {
63-
wp_unregister_ability( $ability->get_name() );
64-
}
65-
66-
// Unregister all ability categories to ensure a clean slate for each test.
67-
foreach ( wp_get_ability_categories() as $ability_category ) {
68-
wp_unregister_ability_category( $ability_category->get_slug() );
69-
}
70-
71-
// Remove core registration actions to prevent re-registration.
72-
remove_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
73-
remove_action( 'wp_abilities_api_init', 'wp_register_core_abilities' );
74-
75-
// Fire categories init to trigger internal setup (happens inside get_instance).
76-
do_action( 'wp_abilities_api_categories_init' );
77-
78-
// Register test categories after the init.
79-
self::register_test_categories();
80-
8170
// Initialize Abilities API.
8271
do_action( 'wp_abilities_api_init' );
83-
84-
// Register test abilities.
8572
$this->register_test_abilities();
8673

8774
// Set default user for tests
@@ -101,21 +88,6 @@ public function tear_down(): void {
10188
wp_unregister_ability( $ability->get_name() );
10289
}
10390

104-
// Clean up test ability categories.
105-
foreach ( wp_get_ability_categories() as $ability_category ) {
106-
$slug = $ability_category->get_slug();
107-
if ( ! str_starts_with( $slug, 'test-' ) && ! in_array( $slug, array( 'math', 'system', 'general' ), true ) ) {
108-
continue;
109-
}
110-
111-
wp_unregister_ability_category( $slug );
112-
}
113-
114-
// Re-add core registration actions and re-register core abilities.
115-
add_action( 'wp_abilities_api_categories_init', 'wp_register_core_ability_categories' );
116-
add_action( 'wp_abilities_api_init', 'wp_register_core_abilities' );
117-
do_action( 'wp_abilities_api_init' );
118-
11991
// Reset REST server
12092
global $wp_rest_server;
12193
$wp_rest_server = null;

0 commit comments

Comments
 (0)