Changeset 43050 for trunk/tests/phpunit/tests/cron.php

Timestamp:

05/01/2018 02:04:25 AM (6 years ago)

Author:

peterwilsoncc

Message:

Cron API: Return meaningful values from cron functions.

Return values added to Cron API functions to indicate outcome:

• wp_schedule_single_event(), wp_schedule_event(), wp_reschedule_event() and wp_unschedule_event(): boolean indicating success or failure,
• wp_clear_scheduled_hook(): integer indicating number of jobs cleared (zero or more), false if one or more jobs fail to clear,
• wp_unschedule_hook(): integer indicating number of jobs cleared (zero or more), false if the jobs fail to clear,
• spawn_cron(): boolean indicating whether job spawned,
• wp_cron(): integer indicating number of jobs spawned (zero or more), false if one or more jobs fail to spawned,
• _set_cron_array(): boolean outcome of update_option().

Props evansolomon, jrf, peterwilsoncc, pento for code review.
Fixes #21072.

File:

• trunk/tests/phpunit/tests/cron.php (modified) (11 diffs)

trunk/tests/phpunit/tests/cron.php

@@ -30 +30 @@
         $timestamp = strtotime( '+1 hour' );
 
-        wp_schedule_single_event( $timestamp, $hook );
+        $scheduled = wp_schedule_single_event( $timestamp, $hook );
+        $this->assertTrue( $scheduled );
         $this->assertEquals( $timestamp, wp_next_scheduled( $hook ) );
 
@@ -44 +45 @@
         $args      = array( 'foo' );
 
-        wp_schedule_single_event( $timestamp, $hook, $args );
+        $scheduled = wp_schedule_single_event( $timestamp, $hook, $args );
+        $this->assertTrue( $scheduled );
         // this returns the timestamp only if we provide matching args
         $this->assertEquals( $timestamp, wp_next_scheduled( $hook, $args ) );
@@ -61 +63 @@
         $timestamp = strtotime( '+1 hour' );
 
-        wp_schedule_event( $timestamp, $recur, $hook );
+        $scheduled = wp_schedule_event( $timestamp, $recur, $hook );
+        $this->assertTrue( $scheduled );
         // it's scheduled for the right time
         $this->assertEquals( $timestamp, wp_next_scheduled( $hook ) );
@@ -75 +78 @@
         $args      = array( 'foo' );
 
-        wp_schedule_event( $timestamp, 'hourly', $hook, $args );
+        $scheduled = wp_schedule_event( $timestamp, 'hourly', $hook, $args );
+        $this->assertTrue( $scheduled );
         // this returns the timestamp only if we provide matching args
         $this->assertEquals( $timestamp, wp_next_scheduled( $hook, $args ) );
@@ -95 +99 @@
 
         // now unschedule it and make sure it's gone
-        wp_unschedule_event( $timestamp, $hook );
+        $unscheduled = wp_unschedule_event( $timestamp, $hook );
+        $this->assertTrue( $unscheduled );
         $this->assertEquals( false, wp_next_scheduled( $hook ) );
     }
@@ -114 +119 @@
 
         // clear the schedule for the no args events and make sure it's gone
-        wp_clear_scheduled_hook( $hook );
+        $hook_unscheduled = wp_clear_scheduled_hook( $hook );
+        $this->assertSame( 2, $hook_unscheduled );
         $this->assertFalse( wp_next_scheduled( $hook ) );
         // the args events should still be there
@@ -123 +129 @@
         wp_clear_scheduled_hook( $hook, $args );
         $this->assertFalse( wp_next_scheduled( $hook, $args ) );
+    }
+
+    function test_clear_undefined_schedule() {
+        $hook = __FUNCTION__;
+        $args = array( 'arg1' );
+
+        wp_schedule_single_event( strtotime( '+1 hour' ), $hook, $args );
+        wp_schedule_single_event( strtotime( '+2 hour' ), $hook, $args );
+
+        // clear the schedule for no args events and ensure no events are cleared.
+        $hook_unscheduled = wp_clear_scheduled_hook( $hook );
+        $this->assertSame( 0, $hook_unscheduled );
     }
 
@@ -207 +225 @@
 
         // clear the schedule and make sure it's gone.
-        wp_unschedule_hook( $hook );
+        $unschedule_hook = wp_unschedule_hook( $hook );
+        $this->assertSame( 4, $unschedule_hook );
+        $this->assertFalse( wp_next_scheduled( $hook ) );
+    }
+
+    function test_unschedule_undefined_hook() {
+        $hook           = __FUNCTION__;
+        $unrelated_hook = __FUNCTION__ . '_two';
+
+        // Attempt to clear schedule on non-existant hook.
+        $unschedule_hook = wp_unschedule_hook( $hook );
+        $this->assertSame( 0, $unschedule_hook );
+        $this->assertFalse( wp_next_scheduled( $hook ) );
+
+        // Repeat tests with populated cron array.
+        wp_schedule_single_event( strtotime( '+1 hour' ), $unrelated_hook );
+        wp_schedule_single_event( strtotime( '+2 hour' ), $unrelated_hook );
+
+        $unschedule_hook = wp_unschedule_hook( $hook );
+        $this->assertSame( 0, $unschedule_hook );
         $this->assertFalse( wp_next_scheduled( $hook ) );
     }
@@ -222 +259 @@
 
         // first one works
-        wp_schedule_single_event( $ts1, $hook, $args );
+        $this->assertTrue( wp_schedule_single_event( $ts1, $hook, $args ) );
         // second one is ignored
-        wp_schedule_single_event( $ts2, $hook, $args );
+        $this->assertFalse( wp_schedule_single_event( $ts2, $hook, $args ) );
 
         // the next event should be at +5 minutes, not +3
@@ -241 +278 @@
 
         // first one works
-        wp_schedule_single_event( $ts1, $hook, $args );
+        $this->assertTrue( wp_schedule_single_event( $ts1, $hook, $args ) );
         // second works too
-        wp_schedule_single_event( $ts2, $hook, $args );
+        $this->assertTrue( wp_schedule_single_event( $ts2, $hook, $args ) );
 
         // the next event should be at +3 minutes, even though that one was scheduled second
@@ -260 +297 @@
 
         // first one works
-        wp_schedule_single_event( $ts1, $hook, $args );
+        $this->assertTrue( wp_schedule_single_event( $ts1, $hook, $args ) );
         // second works too
-        wp_schedule_single_event( $ts2, $hook, $args );
+        $this->assertTrue( wp_schedule_single_event( $ts2, $hook, $args ) );
 
         // the next event should be at +3 minutes