Extend WP_Ajax_UnitTestCase instead of WP_UnitTestCase

Author: aristath

tests/phpunit/traits/test-class-ajax-security-aioseo.php

@@ -14,7 +14,7 @@
  *
  * @covers \Progress_Planner\Suggested_Tasks\Providers\Traits\Ajax_Security_AIOSEO
  */
-class Ajax_Security_AIOSEO_Test extends \WP_UnitTestCase {
+class Ajax_Security_AIOSEO_Test extends \WP_Ajax_UnitTestCase {
 
 	/**
 	 * Mock class that uses the trait.
@@ -61,15 +61,26 @@ public function public_verify_aioseo_ajax_security( $capability = 'manage_option
 	/**
 	 * Test verify_aioseo_active_or_fail when AIOSEO is not active.
 	 *
+	 * @covers \Progress_Planner\Suggested_Tasks\Providers\Traits\Ajax_Security_AIOSEO::verify_aioseo_active_or_fail
+	 *
 	 * @return void
 	 */
 	public function test_verify_aioseo_active_or_fail_not_active() {
 		// Verify aioseo function doesn't exist.
 		$this->assertFalse( \function_exists( 'aioseo' ) );
 
-		// We can't easily test wp_send_json_error because it exits,
-		// but we can verify the function check.
-		$this->assertTrue( true );
+		// WP_Ajax_UnitTestCase allows us to test AJAX methods that call wp_send_json_error().
+		try {
+			$this->mock_class->public_verify_aioseo_active_or_fail();
+			$this->fail( 'Expected WPAjaxDieStopException was not thrown' );
+		} catch ( \WPAjaxDieStopException $e ) {
+			// Get the response.
+			$response = json_decode( $this->_last_response, true );
+			$this->assertFalse( $response['success'] );
+			$this->assertArrayHasKey( 'data', $response );
+			$this->assertArrayHasKey( 'message', $response['data'] );
+			$this->assertStringContainsString( 'AIOSEO', $response['data']['message'] );
+		}
 	}
 
 	/**

tests/phpunit/traits/test-class-ajax-security-base.php

@@ -14,7 +14,7 @@
  *
  * @covers \Progress_Planner\Suggested_Tasks\Providers\Traits\Ajax_Security_Base
  */
-class Ajax_Security_Base_Test extends \WP_UnitTestCase {
+class Ajax_Security_Base_Test extends \WP_Ajax_UnitTestCase {
 
 	/**
 	 * Mock class that uses the trait.
@@ -102,10 +102,17 @@ public function test_verify_nonce_or_fail_valid() {
 	public function test_verify_nonce_or_fail_invalid() {
 		$_REQUEST['nonce'] = 'invalid_nonce';
 
-		// We can't easily test wp_send_json_error because it exits,
-		// but we can verify the check_ajax_referer behavior.
-		$result = \check_ajax_referer( 'progress_planner', 'nonce', false );
-		$this->assertFalse( $result );
+		// WP_Ajax_UnitTestCase allows us to test AJAX methods that call wp_send_json_error().
+		try {
+			$this->mock_class->public_verify_nonce_or_fail();
+			$this->fail( 'Expected WPAjaxDieStopException was not thrown' );
+		} catch ( \WPAjaxDieStopException $e ) {
+			// Get the response.
+			$response = json_decode( $this->_last_response, true );
+			$this->assertFalse( $response['success'] );
+			$this->assertArrayHasKey( 'data', $response );
+			$this->assertArrayHasKey( 'message', $response['data'] );
+		}
 
 		// Clean up.
 		unset( $_REQUEST['nonce'] );
@@ -141,8 +148,18 @@ public function test_verify_capability_or_fail_non_admin() {
 		$user_id = $this->factory->user->create( [ 'role' => 'subscriber' ] );
 		\wp_set_current_user( $user_id );
 
-		// Verify user cannot manage options.
-		$this->assertFalse( \current_user_can( 'manage_options' ) );
+		// WP_Ajax_UnitTestCase allows us to test AJAX methods that call wp_send_json_error().
+		try {
+			$this->mock_class->public_verify_capability_or_fail();
+			$this->fail( 'Expected WPAjaxDieStopException was not thrown' );
+		} catch ( \WPAjaxDieStopException $e ) {
+			// Get the response.
+			$response = json_decode( $this->_last_response, true );
+			$this->assertFalse( $response['success'] );
+			$this->assertArrayHasKey( 'data', $response );
+			$this->assertArrayHasKey( 'message', $response['data'] );
+			$this->assertStringContainsString( 'permission', $response['data']['message'] );
+		}
 	}
 
 	/**

tests/phpunit/traits/test-class-ajax-security-yoast.php

@@ -14,7 +14,7 @@
  *
  * @covers \Progress_Planner\Suggested_Tasks\Providers\Traits\Ajax_Security_Yoast
  */
-class Ajax_Security_Yoast_Test extends \WP_UnitTestCase {
+class Ajax_Security_Yoast_Test extends \WP_Ajax_UnitTestCase {
 
 	/**
 	 * Mock class that uses the trait.
@@ -61,15 +61,26 @@ public function public_verify_yoast_ajax_security( $capability = 'manage_options
 	/**
 	 * Test verify_yoast_active_or_fail when Yoast is not active.
 	 *
+	 * @covers \Progress_Planner\Suggested_Tasks\Providers\Traits\Ajax_Security_Yoast::verify_yoast_active_or_fail
+	 *
 	 * @return void
 	 */
 	public function test_verify_yoast_active_or_fail_not_active() {
 		// Verify WPSEO_Options class doesn't exist.
 		$this->assertFalse( \class_exists( 'WPSEO_Options' ) );
 
-		// We can't easily test wp_send_json_error because it exits,
-		// but we can verify the class check.
-		$this->assertTrue( true );
+		// WP_Ajax_UnitTestCase allows us to test AJAX methods that call wp_send_json_error().
+		try {
+			$this->mock_class->public_verify_yoast_active_or_fail();
+			$this->fail( 'Expected WPAjaxDieStopException was not thrown' );
+		} catch ( \WPAjaxDieStopException $e ) {
+			// Get the response.
+			$response = json_decode( $this->_last_response, true );
+			$this->assertFalse( $response['success'] );
+			$this->assertArrayHasKey( 'data', $response );
+			$this->assertArrayHasKey( 'message', $response['data'] );
+			$this->assertStringContainsString( 'Yoast', $response['data']['message'] );
+		}
 	}
 
 	/**