2019-03-04 22:39:14 +00:00
|
|
|
<?php
|
2020-02-09 14:45:36 +00:00
|
|
|
/**
|
2023-01-01 14:36:24 +00:00
|
|
|
* @copyright Copyright (C) 2010-2023, the Friendica project
|
2020-02-09 14:45:36 +00:00
|
|
|
*
|
|
|
|
* @license GNU AGPL version 3 or any later version
|
|
|
|
*
|
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Affero General Public License as
|
|
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
|
|
* License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
*
|
|
|
|
*/
|
2019-03-04 22:39:14 +00:00
|
|
|
|
2021-10-23 10:22:27 +00:00
|
|
|
namespace Friendica\Test\src\Core\Logger;
|
2019-03-04 22:39:14 +00:00
|
|
|
|
|
|
|
use Friendica\Test\MockedTest;
|
2021-10-29 10:36:14 +00:00
|
|
|
use Friendica\Core\Logger\Util\Introspection;
|
2019-03-04 22:39:14 +00:00
|
|
|
use Mockery\MockInterface;
|
|
|
|
use Psr\Log\LoggerInterface;
|
|
|
|
use Psr\Log\LogLevel;
|
|
|
|
|
|
|
|
abstract class AbstractLoggerTest extends MockedTest
|
|
|
|
{
|
|
|
|
use LoggerDataTrait;
|
|
|
|
|
2021-12-12 19:19:52 +00:00
|
|
|
const LOGLINE = '/.* \[.*]: .* {.*\"file\":\".*\".*,.*\"line\":\d*,.*\"function\":\".*\".*,.*\"uid\":\".*\".*}/';
|
2019-03-04 22:39:14 +00:00
|
|
|
|
|
|
|
const FILE = 'test';
|
|
|
|
const LINE = 666;
|
|
|
|
const FUNC = 'myfunction';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var Introspection|MockInterface
|
|
|
|
*/
|
|
|
|
protected $introspection;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the content of the current logger instance
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
abstract protected function getContent();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the current logger instance
|
|
|
|
*
|
|
|
|
* @param string $level the default loglevel
|
|
|
|
*
|
|
|
|
* @return LoggerInterface
|
|
|
|
*/
|
|
|
|
abstract protected function getInstance($level = LogLevel::DEBUG);
|
|
|
|
|
2021-04-01 21:04:30 +00:00
|
|
|
protected function setUp(): void
|
2019-03-04 22:39:14 +00:00
|
|
|
{
|
|
|
|
parent::setUp();
|
|
|
|
|
|
|
|
$this->introspection = \Mockery::mock(Introspection::class);
|
|
|
|
$this->introspection->shouldReceive('getRecord')->andReturn([
|
|
|
|
'file' => self::FILE,
|
|
|
|
'line' => self::LINE,
|
|
|
|
'function' => self::FUNC
|
|
|
|
]);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function assertLogline($string)
|
|
|
|
{
|
2021-12-12 19:19:52 +00:00
|
|
|
self::assertMatchesRegularExpression(self::LOGLINE, $string);
|
2019-03-04 22:39:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
public function assertLoglineNums($assertNum, $string)
|
|
|
|
{
|
2020-10-17 12:19:57 +00:00
|
|
|
self::assertEquals($assertNum, preg_match_all(self::LOGLINE, $string));
|
2019-03-04 22:39:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Test if the logger works correctly
|
|
|
|
*/
|
|
|
|
public function testNormal()
|
|
|
|
{
|
|
|
|
$logger = $this->getInstance();
|
|
|
|
$logger->emergency('working!');
|
|
|
|
$logger->alert('working too!');
|
|
|
|
$logger->debug('and now?');
|
|
|
|
$logger->notice('message', ['an' => 'context']);
|
|
|
|
|
|
|
|
$text = $this->getContent();
|
2020-10-17 12:19:57 +00:00
|
|
|
self::assertLogline($text);
|
|
|
|
self::assertLoglineNums(4, $text);
|
2019-03-04 22:39:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Test if a log entry is correctly interpolated
|
|
|
|
*/
|
|
|
|
public function testPsrInterpolate()
|
|
|
|
{
|
|
|
|
$logger = $this->getInstance();
|
|
|
|
|
|
|
|
$logger->emergency('A {psr} test', ['psr' => 'working']);
|
|
|
|
$logger->alert('An {array} test', ['array' => ['it', 'is', 'working']]);
|
|
|
|
$text = $this->getContent();
|
2021-05-23 21:16:33 +00:00
|
|
|
self::assertStringContainsString('A working test', $text);
|
|
|
|
self::assertStringContainsString('An ["it","is","working"] test', $text);
|
2019-03-04 22:39:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Test if a log entry contains all necessary information
|
|
|
|
*/
|
|
|
|
public function testContainsInformation()
|
|
|
|
{
|
|
|
|
$logger = $this->getInstance();
|
|
|
|
$logger->emergency('A test');
|
|
|
|
|
|
|
|
$text = $this->getContent();
|
2021-05-23 21:16:33 +00:00
|
|
|
self::assertStringContainsString('"file":"' . self::FILE . '"', $text);
|
|
|
|
self::assertStringContainsString('"line":' . self::LINE, $text);
|
|
|
|
self::assertStringContainsString('"function":"' . self::FUNC . '"', $text);
|
2019-03-04 22:39:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Test if the minimum level is working
|
|
|
|
*/
|
|
|
|
public function testMinimumLevel()
|
|
|
|
{
|
|
|
|
$logger = $this->getInstance(LogLevel::NOTICE);
|
|
|
|
|
|
|
|
$logger->emergency('working');
|
|
|
|
$logger->alert('working');
|
|
|
|
$logger->error('working');
|
|
|
|
$logger->warning('working');
|
|
|
|
$logger->notice('working');
|
|
|
|
$logger->info('not working');
|
|
|
|
$logger->debug('not working');
|
|
|
|
|
|
|
|
$text = $this->getContent();
|
|
|
|
|
2020-10-17 12:19:57 +00:00
|
|
|
self::assertLoglineNums(5, $text);
|
2019-03-04 22:39:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Test with different logging data
|
|
|
|
* @dataProvider dataTests
|
|
|
|
*/
|
|
|
|
public function testDifferentTypes($function, $message, array $context)
|
|
|
|
{
|
|
|
|
$logger = $this->getInstance();
|
|
|
|
$logger->$function($message, $context);
|
|
|
|
|
|
|
|
$text = $this->getContent();
|
|
|
|
|
2020-10-17 12:19:57 +00:00
|
|
|
self::assertLogline($text);
|
2019-03-04 22:39:14 +00:00
|
|
|
|
2021-11-02 19:11:29 +00:00
|
|
|
self::assertStringContainsString(@json_encode($context, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE), $text);
|
2019-03-04 22:39:14 +00:00
|
|
|
}
|
2021-03-28 19:50:32 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Test a message with an exception
|
|
|
|
*/
|
|
|
|
public function testExceptionHandling()
|
|
|
|
{
|
|
|
|
$e = new \Exception("Test String", 123);
|
|
|
|
$eFollowUp = new \Exception("FollowUp", 456, $e);
|
|
|
|
|
|
|
|
$assertion = $eFollowUp->__toString();
|
|
|
|
|
|
|
|
$logger = $this->getInstance();
|
|
|
|
$logger->alert('test', ['e' => $eFollowUp]);
|
|
|
|
$text = $this->getContent();
|
|
|
|
|
|
|
|
self::assertLogline($text);
|
|
|
|
|
2021-11-02 19:11:29 +00:00
|
|
|
self::assertStringContainsString(@json_encode($assertion, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE), $this->getContent());
|
2021-03-28 19:50:32 +00:00
|
|
|
}
|
2021-04-01 18:55:25 +00:00
|
|
|
|
|
|
|
public function testNoObjectHandling()
|
|
|
|
{
|
|
|
|
$logger = $this->getInstance();
|
|
|
|
$logger->alert('test', ['e' => ['test' => 'test']]);
|
|
|
|
$text = $this->getContent();
|
|
|
|
|
|
|
|
self::assertLogline($text);
|
|
|
|
|
2021-05-23 21:16:33 +00:00
|
|
|
self::assertStringContainsString('test', $this->getContent());
|
2021-04-01 18:55:25 +00:00
|
|
|
}
|
2019-03-04 22:39:14 +00:00
|
|
|
}
|