cakephp/tests/TestCase/Error/ConsoleErrorHandlerTest.php

<?php
declare(strict_types=1);

/**
 * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 * @link          https://cakephp.org CakePHP(tm) Project
 * @since         2.0.0
 * @license       https://opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Test\TestCase\Error;

use Cake\Console\Exception\ConsoleException;
use Cake\Controller\Exception\MissingActionException;
use Cake\Log\Log;
use Cake\TestSuite\Stub\ConsoleOutput;
use Cake\TestSuite\TestCase;
use InvalidArgumentException;

/**
 * ConsoleErrorHandler Test case.
 */
class ConsoleErrorHandlerTest extends TestCase
{
    /**
     * @var \Cake\Error\ConsoleErrorHandler|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $Error;

    /**
     * @var \Cake\TestSuite\Stub\ConsoleOutput
     */
    protected $stderr;

    /**
     * setup, create mocks
     */
    public function setUp(): void
    {
        parent::setUp();
        $this->stderr = new ConsoleOutput();
        $this->Error = $this->getMockBuilder('Cake\Error\ConsoleErrorHandler')
            ->onlyMethods(['_stop'])
            ->setConstructorArgs([['stderr' => $this->stderr]])
            ->getMock();
        Log::drop('stdout');
        Log::drop('stderr');
    }

    /**
     * tearDown
     */
    public function tearDown(): void
    {
        unset($this->Error);
        parent::tearDown();
    }

    /**
     * test that the console error handler can deal with Exceptions.
     */
    public function testHandleError(): void
    {
        $content = "<error>Notice Error:</error> This is a notice error\nIn [/some/file, line 275]\n";
        $this->Error->expects($this->never())
            ->method('_stop');

        $this->Error->handleError(E_NOTICE, 'This is a notice error', '/some/file', 275);
        $this->assertSame($content, $this->stderr->messages()[0]);
    }

    /**
     * test that the console error handler can deal with fatal errors.
     */
    public function testHandleFatalError(): void
    {
        ob_start();
        $content = "<error>Fatal Error:</error> This is a fatal error\nIn [/some/file, line 275]\n";

        $this->Error->handleError(E_USER_ERROR, 'This is a fatal error', '/some/file', 275);
        $this->assertCount(1, $this->stderr->messages());
        $this->assertSame($content, $this->stderr->messages()[0]);
        ob_end_clean();
    }

    /**
     * test that the console error handler can deal with CakeExceptions.
     */
    public function testCakeErrors(): void
    {
        $exception = new MissingActionException('Missing action');
        $message = sprintf("<error>Exception:</error> Missing action\nIn [%s, line %s]\n", $exception->getFile(), $exception->getLine());

        $this->Error->expects($this->once())
            ->method('_stop')
            ->with(1);

        $this->Error->handleException($exception);

        $this->assertCount(1, $this->stderr->messages());
        $this->assertSame($message, $this->stderr->messages()[0]);
    }

    /**
     * test a non Cake Exception exception.
     */
    public function testNonCakeExceptions(): void
    {
        $exception = new InvalidArgumentException('Too many parameters.');

        $this->Error->expects($this->once())
            ->method('_stop')
            ->with(1);

        $this->Error->handleException($exception);
        $this->assertStringContainsString('Too many parameters', $this->stderr->messages()[0]);
    }

    /**
     * Test error code is used as exit code for ConsoleException.
     */
    public function testConsoleExceptions(): void
    {
        $exception = new ConsoleException('Test ConsoleException', 2);

        $this->Error->expects($this->once())
            ->method('_stop')
            ->with(2);

        $this->Error->handleException($exception);
        $this->assertStringContainsString('Test ConsoleException', $this->stderr->messages()[0]);
    }
}