cakephp/tests/TestCase/Log/Engine/SyslogLogTest.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.4.0
 * @license       https://opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Test\TestCase\Log\Engine;

use Cake\Log\Engine\SyslogLog;
use Cake\TestSuite\TestCase;

/**
 * SyslogLogTest class
 */
class SyslogLogTest extends TestCase
{
    /**
     * Tests that the connection to the logger is open with the right arguments
     */
    public function testOpenLog(): void
    {
        /** @var \Cake\Log\Engine\SyslogLog|\PHPUnit\Framework\MockObject\MockObject $log */
        $log = $this->getMockBuilder(SyslogLog::class)
            ->onlyMethods(['_open', '_write'])
            ->getMock();
        $log->expects($this->once())->method('_open')->with('', LOG_ODELAY, LOG_USER);
        $log->log('debug', 'message');

        $log = $this->getMockBuilder(SyslogLog::class)
            ->onlyMethods(['_open', '_write'])
            ->getMock();
        $log->setConfig([
            'prefix' => 'thing',
            'flag' => LOG_NDELAY,
            'facility' => LOG_MAIL,
            'format' => '%s: %s',
        ]);
        $log->expects($this->once())->method('_open')
            ->with('thing', LOG_NDELAY, LOG_MAIL);
        $log->log('debug', 'message');
    }

    /**
     * Tests that single lines are written to syslog
     *
     * @dataProvider typesProvider
     */
    public function testWriteOneLine(string $type, int $expected): void
    {
        /** @var \Cake\Log\Engine\SyslogLog|\PHPUnit\Framework\MockObject\MockObject $log */
        $log = $this->getMockBuilder(SyslogLog::class)
            ->onlyMethods(['_open', '_write'])
            ->getMock();
        $log->expects($this->once())->method('_write')->with($expected, $type . ': Foo');
        $log->log($type, 'Foo');
    }

    /**
     * Tests that multiple lines are split and logged separately
     */
    public function testWriteMultiLine(): void
    {
        /** @var \Cake\Log\Engine\SyslogLog|\PHPUnit\Framework\MockObject\MockObject $log */
        $log = $this->getMockBuilder(SyslogLog::class)
            ->onlyMethods(['_open', '_write'])
            ->getMock();
        $log->expects($this->exactly(2))
            ->method('_write')
            ->withConsecutive(
                [LOG_DEBUG, 'debug: Foo'],
                [LOG_DEBUG, 'debug: Bar']
            );
        $log->log('debug', "Foo\nBar");
    }

    /**
     * Test deprecated format option
     */
    public function testDeprecatedFormat(): void
    {
        $this->deprecated(function (): void {
            $log = $this->getMockBuilder(SyslogLog::class)
                ->setConstructorArgs(['config' => ['format' => 'custom %s: %s']])
                ->onlyMethods(['_open', '_write'])
                ->getMock();
            $log->expects($this->exactly(2))
                ->method('_write')
                ->withConsecutive(
                    [LOG_DEBUG, 'custom debug: Foo'],
                    [LOG_DEBUG, 'custom debug: Bar']
                );
            $log->log('debug', "Foo\nBar");
        });
    }

    /**
     * Test deprecated format option
     */
    public function testDeprecatedFormatMessage(): void
    {
        $this->expectDeprecation();
        $this->expectDeprecationMessage('`format` option is now deprecated in favor of custom formatters');
        $this->expectDeprecationMessage('SyslogLog.php');
        new SyslogLog(['format' => 'custom %s: %s']);
    }

    /**
     * Data provider for the write function test
     *
     * @return array
     */
    public function typesProvider(): array
    {
        return [
            ['emergency', LOG_EMERG],
            ['alert', LOG_ALERT],
            ['critical', LOG_CRIT],
            ['error', LOG_ERR],
            ['warning', LOG_WARNING],
            ['notice', LOG_NOTICE],
            ['info', LOG_INFO],
            ['debug', LOG_DEBUG],
        ];
    }
}