Skip to content

Build/Test Tools: Always reset the mock PHPMailer instance in tests #13887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zakariabinsaifullah wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Build/Test Tools: Always reset the mock PHPMailer instance in tests #13887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions tests/phpunit/includes/mock-mailer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,21 +102,22 @@ function tests_retrieve_phpmailer_instance() {
/**
* Helper method to reset the phpmailer instance.
*
* Always replaces the global instance with a fresh MockPHPMailer, so that a test
* which unsets or replaces the global cannot cause later tests to send email
* through a real PHPMailer instance.
*
* @since 4.6.0
* @since 7.2.0 The instance is now reset even if the global is unset or empty.
*
* @return bool
* @return true Always true.
*/
function reset_phpmailer_instance() {
$mailer = tests_retrieve_phpmailer_instance();
if ( $mailer ) {
$mailer = new MockPHPMailer( true );
$mailer::$validator = static function ( $email ) {
return (bool) is_email( $email );
};
$mailer = new MockPHPMailer( true );
$mailer::$validator = static function ( $email ) {
return (bool) is_email( $email );
};

$GLOBALS['phpmailer'] = $mailer;
return true;
}
$GLOBALS['phpmailer'] = $mailer;

return false;
return true;
}
69 changes: 69 additions & 0 deletions tests/phpunit/tests/pluggable/wpMail.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -758,4 +758,73 @@ public function test_wp_mail_plain_and_html_workaround() {
'The text/html Content-Type header is not present.'
);
}

/**
* Tests that reset_phpmailer_instance() restores the mock mailer when the global is unset.
*
* @ticket 28618
*/
public function test_reset_phpmailer_instance_restores_mock_when_global_is_unset() {
unset( $GLOBALS['phpmailer'] );

$this->assertTrue( reset_phpmailer_instance(), 'reset_phpmailer_instance() should return true.' );
$this->assertInstanceOf( 'MockPHPMailer', $GLOBALS['phpmailer'] );
}

/**
* Tests that reset_phpmailer_instance() replaces any non-mock value of the global.
*
* @ticket 28618
*
* @dataProvider data_reset_phpmailer_instance_replaces_non_mock_global
*
* @param string $type The type of value to set the global to.
*/
public function test_reset_phpmailer_instance_replaces_non_mock_global( $type ) {
switch ( $type ) {
case 'real mailer':
$GLOBALS['phpmailer'] = new WP_PHPMailer( true );
break;
case 'null':
$GLOBALS['phpmailer'] = null;
break;
case 'false':
$GLOBALS['phpmailer'] = false;
break;
}

reset_phpmailer_instance();

$this->assertInstanceOf( 'MockPHPMailer', $GLOBALS['phpmailer'] );
}

/**
* Data provider for test_reset_phpmailer_instance_replaces_non_mock_global().
*
* @return array<string, array{0: string}>
*/
public static function data_reset_phpmailer_instance_replaces_non_mock_global() {
return array(
'real mailer' => array( 'real mailer' ),
'null' => array( 'null' ),
'false' => array( 'false' ),
);
}

/**
* Tests that wp_mail() sends through the mock mailer after the global was unset and reset.
*
* @ticket 28618
*/
public function test_wp_mail_uses_mock_mailer_after_global_is_unset_and_reset() {
unset( $GLOBALS['phpmailer'] );
reset_phpmailer_instance();

$this->assertTrue( wp_mail( 'user@example.com', 'Test subject', 'Test message' ), 'wp_mail() should succeed.' );

$mailer = tests_retrieve_phpmailer_instance();

$this->assertInstanceOf( 'MockPHPMailer', $mailer, 'wp_mail() should use the mock mailer.' );
$this->assertSame( 'Test subject', $mailer->get_sent()->subject, 'The email should be captured by the mock mailer.' );
}
}
Loading