328 lines
9.8 KiB
PHP
328 lines
9.8 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace PhpMyAdmin\Tests;
|
|
|
|
use Exception;
|
|
use PhpMyAdmin\Error;
|
|
use PhpMyAdmin\ErrorHandler;
|
|
|
|
use function array_keys;
|
|
use function array_pop;
|
|
use function count;
|
|
|
|
use const E_RECOVERABLE_ERROR;
|
|
use const E_USER_NOTICE;
|
|
use const E_USER_WARNING;
|
|
use const E_WARNING;
|
|
|
|
/** @covers \PhpMyAdmin\ErrorHandler */
|
|
class ErrorHandlerTest extends AbstractTestCase
|
|
{
|
|
protected ErrorHandler $object;
|
|
|
|
/**
|
|
* Sets up the fixture, for example, opens a network connection.
|
|
* This method is called before a test is executed.
|
|
*/
|
|
protected function setUp(): void
|
|
{
|
|
parent::setUp();
|
|
|
|
$GLOBALS['lang'] = 'en';
|
|
$GLOBALS['dbi'] = $this->createDatabaseInterface();
|
|
$this->object = new ErrorHandler();
|
|
$_SESSION['errors'] = [];
|
|
$GLOBALS['server'] = 0;
|
|
$GLOBALS['cfg']['environment'] = 'production';
|
|
$GLOBALS['cfg']['SendErrorReports'] = 'always';
|
|
}
|
|
|
|
/**
|
|
* Tears down the fixture, for example, closes a network connection.
|
|
* This method is called after a test is executed.
|
|
*/
|
|
protected function tearDown(): void
|
|
{
|
|
parent::tearDown();
|
|
|
|
unset($this->object);
|
|
}
|
|
|
|
/**
|
|
* Data provider for testHandleError
|
|
*
|
|
* @return array<array{int, string, string, int, string, string}>
|
|
*/
|
|
public static function providerForTestHandleError(): array
|
|
{
|
|
return [
|
|
[E_RECOVERABLE_ERROR, 'Compile Error', 'error.txt', 12, 'Compile Error', ''],
|
|
[E_USER_NOTICE, 'User notice', 'error.txt', 12, 'User notice', 'User notice'],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Test for getDispErrors when PHP errors are not shown
|
|
*
|
|
* @param int $errno error number
|
|
* @param string $errstr error string
|
|
* @param string $errfile error file
|
|
* @param int $errline error line
|
|
* @param string $outputShow expected output if showing of errors is enabled
|
|
* @param string $outputHide expected output if showing of errors is
|
|
* disabled and 'sendErrorReports' is set to 'never'
|
|
*
|
|
* @dataProvider providerForTestHandleError
|
|
*/
|
|
public function testGetDispErrorsForDisplayFalse(
|
|
int $errno,
|
|
string $errstr,
|
|
string $errfile,
|
|
int $errline,
|
|
string $outputShow,
|
|
string $outputHide,
|
|
): void {
|
|
// TODO: Add other test cases for all combination of 'sendErrorReports'
|
|
$GLOBALS['cfg']['SendErrorReports'] = 'never';
|
|
|
|
$this->object->handleError($errno, $errstr, $errfile, $errline);
|
|
|
|
$output = $this->object->getDispErrors();
|
|
|
|
if ($outputHide === '') {
|
|
$this->assertEquals('', $output);
|
|
} else {
|
|
$this->assertNotEmpty($outputShow);// Useless check
|
|
$this->assertStringContainsString($outputHide, $output);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Test for getDispErrors when PHP errors are shown
|
|
*
|
|
* @param int $errno error number
|
|
* @param string $errstr error string
|
|
* @param string $errfile error file
|
|
* @param int $errline error line
|
|
* @param string $outputShow expected output if showing of errors is enabled
|
|
* @param string $outputHide expected output if showing of errors is disabled
|
|
*
|
|
* @dataProvider providerForTestHandleError
|
|
*/
|
|
public function testGetDispErrorsForDisplayTrue(
|
|
int $errno,
|
|
string $errstr,
|
|
string $errfile,
|
|
int $errline,
|
|
string $outputShow,
|
|
string $outputHide,
|
|
): void {
|
|
$this->object->handleError($errno, $errstr, $errfile, $errline);
|
|
|
|
$this->assertIsString($outputHide);// Useless check
|
|
$this->assertStringContainsString(
|
|
$outputShow,
|
|
$this->object->getDispErrors(),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Test for checkSavedErrors
|
|
*/
|
|
public function testCheckSavedErrors(): void
|
|
{
|
|
$this->callFunction(
|
|
$this->object,
|
|
ErrorHandler::class,
|
|
'checkSavedErrors',
|
|
[],
|
|
);
|
|
$this->assertArrayNotHasKey('errors', $_SESSION);
|
|
}
|
|
|
|
/**
|
|
* Test for countErrors
|
|
*
|
|
* @group medium
|
|
*/
|
|
public function testCountErrors(): void
|
|
{
|
|
$this->object->addError('Compile Error', E_WARNING, 'error.txt', 15);
|
|
$this->assertEquals(
|
|
1,
|
|
$this->object->countErrors(),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Test for sliceErrors
|
|
*
|
|
* @group medium
|
|
*/
|
|
public function testSliceErrors(): void
|
|
{
|
|
$this->object->addError('Compile Error', E_WARNING, 'error.txt', 15);
|
|
$this->object->addError('Compile Error', E_WARNING, 'error.txt', 16);
|
|
$this->assertEquals(
|
|
2,
|
|
$this->object->countErrors(),
|
|
);
|
|
$this->assertEquals(
|
|
[],
|
|
$this->object->sliceErrors(2),
|
|
);
|
|
$this->assertEquals(
|
|
2,
|
|
$this->object->countErrors(),
|
|
);
|
|
$this->assertCount(
|
|
1,
|
|
$this->object->sliceErrors(1),
|
|
);
|
|
$this->assertEquals(
|
|
1,
|
|
$this->object->countErrors(),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Test for sliceErrors with 10 elements as an example
|
|
*
|
|
* @group medium
|
|
*/
|
|
public function testSliceErrorsOtherExample(): void
|
|
{
|
|
for ($i = 0; $i < 10; $i++) {
|
|
$this->object->addError('Compile Error', E_WARNING, 'error.txt', $i);
|
|
}
|
|
|
|
// 10 initial items
|
|
$this->assertEquals(10, $this->object->countErrors());
|
|
$this->assertEquals(10, count($this->object->getCurrentErrors()));
|
|
|
|
// slice 9 elements, returns one 10 - 9
|
|
$elements = $this->object->sliceErrors(9);
|
|
$firstKey = array_keys($elements)[0];
|
|
|
|
// Gives the last element
|
|
$this->assertEquals(
|
|
[$firstKey => $elements[$firstKey]],
|
|
$elements,
|
|
);
|
|
$this->assertEquals(9, count($this->object->getCurrentErrors()));
|
|
$this->assertEquals(9, $this->object->countErrors());
|
|
|
|
// Slice as much as there is (9), does nothing
|
|
$elements = $this->object->sliceErrors(9);
|
|
$this->assertEquals([], $elements);
|
|
$this->assertEquals(9, count($this->object->getCurrentErrors()));
|
|
$this->assertEquals(9, $this->object->countErrors());
|
|
|
|
// Slice 0, removes everything
|
|
$elements = $this->object->sliceErrors(0);
|
|
$this->assertEquals(9, count($elements));
|
|
$this->assertEquals(0, count($this->object->getCurrentErrors()));
|
|
$this->assertEquals(0, $this->object->countErrors());
|
|
}
|
|
|
|
/**
|
|
* Test for countUserErrors
|
|
*/
|
|
public function testCountUserErrors(): void
|
|
{
|
|
$this->object->addError('Compile Error', E_WARNING, 'error.txt', 15);
|
|
$this->assertEquals(
|
|
0,
|
|
$this->object->countUserErrors(),
|
|
);
|
|
$this->object->addError('Compile Error', E_USER_WARNING, 'error.txt', 15);
|
|
$this->assertEquals(
|
|
1,
|
|
$this->object->countUserErrors(),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Test for hasUserErrors
|
|
*/
|
|
public function testHasUserErrors(): void
|
|
{
|
|
$this->assertFalse($this->object->hasUserErrors());
|
|
}
|
|
|
|
/**
|
|
* Test for hasErrors
|
|
*/
|
|
public function testHasErrors(): void
|
|
{
|
|
$this->assertFalse($this->object->hasErrors());
|
|
}
|
|
|
|
/**
|
|
* Test for countDisplayErrors
|
|
*/
|
|
public function testCountDisplayErrorsForDisplayTrue(): void
|
|
{
|
|
$this->assertEquals(
|
|
0,
|
|
$this->object->countDisplayErrors(),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Test for countDisplayErrors
|
|
*/
|
|
public function testCountDisplayErrorsForDisplayFalse(): void
|
|
{
|
|
$this->assertEquals(
|
|
0,
|
|
$this->object->countDisplayErrors(),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Test for hasDisplayErrors
|
|
*/
|
|
public function testHasDisplayErrors(): void
|
|
{
|
|
$this->assertFalse($this->object->hasDisplayErrors());
|
|
}
|
|
|
|
public function testHandleExceptionForDevEnv(): void
|
|
{
|
|
$GLOBALS['config']->set('environment', 'development');
|
|
$errorHandler = new ErrorHandler();
|
|
$this->assertSame([], $errorHandler->getCurrentErrors());
|
|
$errorHandler->handleException(new Exception('Exception message.'));
|
|
$output = $this->getActualOutputForAssertion();
|
|
$errors = $errorHandler->getCurrentErrors();
|
|
$this->assertCount(1, $errors);
|
|
$error = array_pop($errors);
|
|
$this->assertInstanceOf(Error::class, $error);
|
|
$this->assertSame('Exception: Exception message.', $error->getOnlyMessage());
|
|
$this->assertStringContainsString($error->getDisplay(), $output);
|
|
$this->assertStringContainsString('Internal error', $output);
|
|
$this->assertStringContainsString('ErrorHandlerTest.php#' . $error->getLine(), $output);
|
|
$this->assertStringContainsString('Exception: Exception message.', $output);
|
|
}
|
|
|
|
public function testHandleExceptionForProdEnv(): void
|
|
{
|
|
$GLOBALS['config']->set('environment', 'production');
|
|
$errorHandler = new ErrorHandler();
|
|
$this->assertSame([], $errorHandler->getCurrentErrors());
|
|
$errorHandler->handleException(new Exception('Exception message.'));
|
|
$output = $this->getActualOutputForAssertion();
|
|
$errors = $errorHandler->getCurrentErrors();
|
|
$this->assertCount(1, $errors);
|
|
$error = array_pop($errors);
|
|
$this->assertInstanceOf(Error::class, $error);
|
|
$this->assertSame('Exception: Exception message.', $error->getOnlyMessage());
|
|
$this->assertStringContainsString($error->getDisplay(), $output);
|
|
$this->assertStringContainsString('Exception: Exception message.', $output);
|
|
$this->assertStringNotContainsString('ErrorHandlerTest.php#' . $error->getLine(), $output);
|
|
}
|
|
}
|
