CodeIgniter4/tests/system/Log/Handlers/FileHandlerTest.php at 15fc6753b29b23aed8e8d8b5fd2d509c507507be · michalsn/CodeIgniter4 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <[email protected]>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Log\Handlers;

use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\Mock\MockFileLogger;
use CodeIgniter\Test\Mock\MockLogger as LoggerConfig;
use org\bovigo\vfs\vfsStream;
use PHPUnit\Framework\Attributes\Group;
use Tests\Support\Log\Handlers\TestHandler;

/**
 * @internal
 */
#[Group('Others')]
final class FileHandlerTest extends CIUnitTestCase
{
    private string $start;

    protected function setUp(): void
    {
        parent::setUp();
        $root        = vfsStream::setup('root');
        $this->start = $root->url() . '/';
    }

    public function testHandle(): void
    {
        $config = new LoggerConfig();

        $config->handlers[TestHandler::class]['handles'] = ['critical'];

        $logger = new MockFileLogger($config->handlers[TestHandler::class]);
        $logger->setDateFormat('Y-m-d H:i:s:u');
        $this->assertTrue($logger->handle('warning', 'This is a test log'));
    }

    public function testBasicHandle(): void
    {
        $config                                          = new LoggerConfig();
        $config->handlers[TestHandler::class]['path']    = $this->start . 'charlie/';
        $config->handlers[TestHandler::class]['handles'] = ['critical'];

        $logger = new MockFileLogger($config->handlers[TestHandler::class]);
        $logger->setDateFormat('Y-m-d H:i:s:u');
        $expected = 'log-' . date('Y-m-d') . '.log';
        vfsStream::newFile($expected)->at(vfsStream::setup('root/charlie'))->withContent('This is a test log');
        $this->assertTrue($logger->handle('warning', 'This is a test log'));
    }

    public function testHandleCreateFile(): void
    {
        $config                                       = new LoggerConfig();
        $config->handlers[TestHandler::class]['path'] = $this->start;
        $logger                                       = new MockFileLogger($config->handlers[TestHandler::class]);

        $logger->setDateFormat('Y-m-d H:i:s:u');
        $expected = 'log-' . date('Y-m-d') . '.log';
        vfsStream::newFile($expected)->at(vfsStream::setup('root'))->withContent('This is a test log');
        $logger->handle('warning', 'This is a test log');

        $fp   = fopen($config->handlers[TestHandler::class]['path'] . $expected, 'rb');
        $line = fgets($fp);
        fclose($fp);

        // did the log file get created?
        $expectedResult = 'This is a test log';
        $this->assertStringContainsString($expectedResult, (string) $line);
    }

    public function testHandleAppendsContextAsJson(): void
    {
        $config                                       = new LoggerConfig();
        $config->handlers[TestHandler::class]['path'] = $this->start;
        $logger                                       = new MockFileLogger($config->handlers[TestHandler::class]);

        $logger->setDateFormat('Y-m-d');
        $expected = 'log-' . date('Y-m-d') . '.log';
        vfsStream::newFile($expected)->at(vfsStream::setup('root'))->withContent('');
        $logger->handle('debug', 'Test message', [HandlerInterface::GLOBAL_CONTEXT_KEY => ['foo' => 'bar']]);

        $fp   = fopen($config->handlers[TestHandler::class]['path'] . $expected, 'rb');
        $line = fgets($fp);
        fclose($fp);

        $this->assertStringContainsString('Test message {"_ci_context":{"foo":"bar"}}', (string) $line);
    }

    public function testHandleDateTimeCorrectly(): void
    {
        $config                                       = new LoggerConfig();
        $config->handlers[TestHandler::class]['path'] = $this->start;
        $logger                                       = new MockFileLogger($config->handlers[TestHandler::class]);

        $logger->setDateFormat('Y-m-d');
        $expected = 'log-' . date('Y-m-d') . '.log';
        vfsStream::newFile($expected)->at(vfsStream::setup('root'))->withContent('Test message');
        $logger->handle('debug', 'Test message');
        $fp   = fopen($config->handlers[TestHandler::class]['path'] . $expected, 'rb');
        $line = fgets($fp); // and get the second line
        fclose($fp);

        $expectedResult = 'Test message';
        $this->assertStringContainsString($expectedResult, (string) $line);
    }
}