mirror
/
PHPMailer
mirror of https://github.com/PHPMailer/PHPMailer.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SendTestCase: error out when the testbootstrap file cannot be found 

The `PHPMailerTest` class contained a `testBootstrap()` method to verify that the `testbootstrap.php` file exists as the first test in the class.
As the order in which tests are run is not predefined, this is not reliable.

Additionally, the check for the `testbootstrap.php` file is checking a pre-requisite for tests using the `PHPMailer::send()` method, so it would be better to verify via a condition in the `set_up()`.

Now, using such a condition, there is choice: the test can either be marked as "skipped" when the `testbootstrap.php` file can not be found, or be marked as an "error".

As the tests _should_ run, skipping them would hide an error in the dev-user test setup, so showing these tests as errors seems more appropriate.

To that end, the `testBootstrap()` method has been removed and a check for the `testbootstrap.php` file has been added to the `SendTestCase::set_up()` which will now throw an appropriate `Exception` when the file is not found.

Oops... also removes a stray `parent::set_up()` at the start of the local `set_up()` which should have been removed in 218fd13c88
This commit is contained in:
jrfnl 2021-07-03 05:44:52 +02:00
parent e372a5e85b
commit ef35c0daa5
2 changed files with 13 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
test/PHPMailer/PHPMailerTest.php
View File

@ -23,18 +23,6 @@ use PHPMailer\Test\SendTestCase;
*/
final class PHPMailerTest extends SendTestCase
{
/**
* Check that we have loaded default test params.
* Pretty much everything will fail due to unset recipient if this is not done.
*/
public function testBootstrap()
{
self::assertFileExists(
\PHPMAILER_INCLUDE_DIR . '/test/testbootstrap.php',
'Test config params missing - copy testbootstrap.php to testbootstrap-dist.php and change as appropriate'
);
}
/**
* Word-wrap an ASCII message.
*/

17
test/SendTestCase.php
View File

@ -13,6 +13,7 @@
namespace PHPMailer\Test;
use Exception;
use PHPMailer\Test\PreSendTestCase;
/**
@ -43,12 +44,20 @@ abstract class SendTestCase extends PreSendTestCase
*/
protected function set_up()
{
parent::set_up();
if (file_exists(\PHPMAILER_INCLUDE_DIR . '/test/testbootstrap.php')) {
include \PHPMAILER_INCLUDE_DIR . '/test/testbootstrap.php'; // Overrides go in here.
/*
* Make sure the testbootstrap.php file is available.
* Pretty much everything will fail due to unset recipient if this is not done, so error
* the tests out before they run if the file does not exist.
*/
if (file_exists(\PHPMAILER_INCLUDE_DIR . '/test/testbootstrap.php') === false) {
throw new Exception(
'Test config params missing - copy testbootstrap-dist.php to testbootstrap.php and change'
. ' as appropriate for your own test environment setup.'
);
}
include \PHPMAILER_INCLUDE_DIR . '/test/testbootstrap.php'; // Overrides go in here.
/*
* Process the $REQUEST values and add them to the list of properties
* to change at class initialization.