keith/friendica
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix logger classes and tests

Browse source
This commit is contained in:
Philipp 2023-07-17 01:06:11 +02:00
parent 903ecc2a76
commit bca6abf4ab
No known key found for this signature in database
GPG key ID: 24A7501396EB5432
5 changed files with 28 additions and 72 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/Core/Logger/Factory/StreamLogger.php
View file

@ -25,10 +25,10 @@ use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\Logger\Capabilities\LogChannel;
use Friendica\Core\Logger\Exception\LoggerArgumentException;
use Friendica\Core\Logger\Exception\LoggerException;
use Friendica\Core\Logger\Exception\LogLevelException;
use Friendica\Core\Logger\Type\StreamLogger as StreamLoggerClass;
use Friendica\Core\Logger\Util\FileSystem;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
use Psr\Log\NullLogger;
/**
@ -55,7 +55,7 @@ class StreamLogger extends AbstractLoggerTypeFactory
$fileSystem = new FileSystem();
$logfile = $logfile ?? $config->get('system', 'logfile');
if ((@file_exists($logfile) && !@is_writable($logfile)) && !@is_writable(basename($logfile))) {
if (!@file_exists($logfile) || !@is_writable($logfile)) {
throw new LoggerArgumentException(sprintf('%s is not a valid logfile', $logfile));
}
@ -64,7 +64,7 @@ class StreamLogger extends AbstractLoggerTypeFactory
if (array_key_exists($loglevel, StreamLoggerClass::levelToInt)) {
$loglevel = StreamLoggerClass::levelToInt[$loglevel];
} else {
$loglevel = StreamLoggerClass::levelToInt[LogLevel::NOTICE];
throw new LogLevelException(sprintf('The level "%s" is not valid.', $loglevel));
}
$stream = $fileSystem->createStream($logfile);

10
src/Core/Logger/Util/FileSystem.php
View file

@ -21,6 +21,8 @@
namespace Friendica\Core\Logger\Util;
use Friendica\Core\Logger\Exception\LoggerUnusableException;
/**
* Util class for filesystem manipulation for Logger classes
*/
@ -37,6 +39,8 @@ class FileSystem
* @param string $file The file
*
* @return string The directory name (empty if no directory is found, like urls)
*
* @throws LoggerUnusableException
*/
public function createDir(string $file): string
{
@ -57,7 +61,7 @@ class FileSystem
restore_error_handler();
if (!$status && !is_dir($dirname)) {
throw new \UnexpectedValueException(sprintf('Directory "%s" cannot get created: ' . $this->errorMessage, $dirname));
throw new LoggerUnusableException(sprintf('Directory "%s" cannot get created: ' . $this->errorMessage, $dirname));
}
return $dirname;
@ -75,7 +79,7 @@ class FileSystem
*
* @return resource the open stream resource
*
* @throws \UnexpectedValueException
* @throws LoggerUnusableException
*/
public function createStream(string $url)
{
@ -89,7 +93,7 @@ class FileSystem
restore_error_handler();
if (!is_resource($stream)) {
throw new \UnexpectedValueException(sprintf('The stream or file "%s" could not be opened: ' . $this->errorMessage, $url));
throw new LoggerUnusableException(sprintf('The stream or file "%s" could not be opened: ' . $this->errorMessage, $url));
}
return $stream;

24
tests/src/Core/Hooks/Util/HookFileManagerTest.php
View file

@ -55,20 +55,12 @@ return [
\Psr\Log\NullLogger::class => [''],
],
],
\Friendica\Core\Hooks\Capabilities\BehavioralHookType::DECORATOR => [
\Psr\Log\LoggerInterface::class => [
\Psr\Log\NullLogger::class,
],
],
];
EOF,
'addonsArray' => [],
'assertStrategies' => [
[LoggerInterface::class, NullLogger::class, ''],
],
'assertDecorators' => [
[LoggerInterface::class, NullLogger::class],
],
],
'normalWithString' => [
'content' => <<<EOF
@ -80,18 +72,12 @@ return [
\Psr\Log\NullLogger::class => '',
],
],
\Friendica\Core\Hooks\Capabilities\BehavioralHookType::DECORATOR => [
\Psr\Log\LoggerInterface::class => \Psr\Log\NullLogger::class,
],
];
EOF,
'addonsArray' => [],
'assertStrategies' => [
[LoggerInterface::class, NullLogger::class, ''],
],
'assertDecorators' => [
[LoggerInterface::class, NullLogger::class],
],
],
'withAddons' => [
'content' => <<<EOF
@ -116,7 +102,6 @@ EOF,
[LoggerInterface::class, NullLogger::class, ''],
[LoggerInterface::class, NullLogger::class, 'null'],
],
'assertDecorators' => [],
],
'withAddonsWithString' => [
'content' => <<<EOF
@ -141,7 +126,6 @@ EOF,
[LoggerInterface::class, NullLogger::class, ''],
[LoggerInterface::class, NullLogger::class, 'null'],
],
'assertDecorators' => [],
],
// This should work because unique name convention is part of the instance manager logic, not of the file-infrastructure layer
'withAddonsDoubleNamed' => [
@ -167,7 +151,6 @@ EOF,
[LoggerInterface::class, NullLogger::class, ''],
[LoggerInterface::class, NullLogger::class, ''],
],
'assertDecorators' => [],
],
'withWrongContentButAddons' => [
'content' => <<<EOF
@ -191,7 +174,6 @@ EOF,
'assertStrategies' => [
[LoggerInterface::class, NullLogger::class, ''],
],
'assertDecorators' => [],
],
];
}
@ -199,7 +181,7 @@ EOF,
/**
* @dataProvider dataHooks
*/
public function testSetupHooks(string $content, array $addonsArray, array $assertStrategies, array $assertDecorators)
public function testSetupHooks(string $content, array $addonsArray, array $assertStrategies)
{
vfsStream::newFile('static/hooks.config.php')
->withContent($content)
@ -215,10 +197,6 @@ EOF,
$instanceManager->shouldReceive('registerStrategy')->withArgs($assertStrategy)->once();
}
foreach ($assertDecorators as $assertDecorator) {
$instanceManager->shouldReceive('registerDecorator')->withArgs($assertDecorator)->once();
}
$hookFileManager->setupHooks($instanceManager);
self::expectNotToPerformAssertions();

54
tests/src/Core/Logger/StreamLoggerTest.php
View file

@ -22,9 +22,7 @@
namespace Friendica\Test\src\Core\Logger;
use Friendica\Core\Logger\Exception\LoggerArgumentException;
use Friendica\Core\Logger\Exception\LoggerException;
use Friendica\Core\Logger\Exception\LogLevelException;
use Friendica\Core\Logger\Util\FileSystem;
use Friendica\Test\Util\VFSTrait;
use Friendica\Core\Logger\Type\StreamLogger;
use org\bovigo\vfs\vfsStream;
@ -40,33 +38,26 @@ class StreamLoggerTest extends AbstractLoggerTest
*/
private $logfile;
/**
* @var \Friendica\Core\Logger\Util\Filesystem
*/
private $fileSystem;
protected function setUp(): void
{
parent::setUp();
$this->setUpVfsDir();
$this->fileSystem = new FileSystem();
}
/**
* {@@inheritdoc}
*/
protected function getInstance($level = LogLevel::DEBUG)
protected function getInstance($level = LogLevel::DEBUG, $logfile = 'friendica.log')
{
$this->logfile = vfsStream::newFile('friendica.log')
$this->logfile = vfsStream::newFile($logfile)
->at($this->root);
$this->config->shouldReceive('get')->with('system', 'logfile')->andReturn($this->logfile->url())->once();
$this->config->shouldReceive('get')->with('system', 'loglevel')->andReturn($level)->once();
$logger = new StreamLogger('test', $this->config, $this->introspection, $this->fileSystem, $level);
return $logger;
$loggerFactory = new \Friendica\Core\Logger\Factory\StreamLogger($this->introspection, 'test');
return $loggerFactory->create($this->config);
}
/**
@ -83,11 +74,12 @@ class StreamLoggerTest extends AbstractLoggerTest
public function testNoUrl()
{
$this->expectException(LoggerArgumentException::class);
$this->expectExceptionMessage("Missing stream URL.");
$this->expectExceptionMessage(' is not a valid logfile');
$this->config->shouldReceive('get')->with('system', 'logfile')->andReturn('')->once();
$logger = new StreamLogger('test', $this->config, $this->introspection, $this->fileSystem);
$loggerFactory = new \Friendica\Core\Logger\Factory\StreamLogger($this->introspection, 'test');
$logger = $loggerFactory->create($this->config);
$logger->emergency('not working');
}
@ -104,7 +96,8 @@ class StreamLoggerTest extends AbstractLoggerTest
$this->config->shouldReceive('get')->with('system', 'logfile')->andReturn($logfile->url())->once();
$logger = new StreamLogger('test', $this->config, $this->introspection, $this->fileSystem);
$loggerFactory = new \Friendica\Core\Logger\Factory\StreamLogger($this->introspection, 'test');
$logger = $loggerFactory->create($this->config);
$logger->emergency('not working');
}
@ -119,7 +112,8 @@ class StreamLoggerTest extends AbstractLoggerTest
static::markTestIncomplete('We need a platform independent way to set directory to readonly');
$logger = new StreamLogger('test', '/$%/wrong/directory/file.txt', $this->introspection, $this->fileSystem);
$loggerFactory = new \Friendica\Core\Logger\Factory\StreamLogger($this->introspection, 'test');
$logger = $loggerFactory->create($this->config);
$logger->emergency('not working');
}
@ -132,9 +126,7 @@ class StreamLoggerTest extends AbstractLoggerTest
$this->expectException(LogLevelException::class);
$this->expectExceptionMessageMatches("/The level \".*\" is not valid./");
$this->config->shouldReceive('get')->with('system', 'logfile')->andReturn('file.text')->once();
$logger = new StreamLogger('test', $this->config, $this->introspection, $this->fileSystem, 'NOPE');
$logger = $this->getInstance('NOPE');
}
/**
@ -145,29 +137,11 @@ class StreamLoggerTest extends AbstractLoggerTest
$this->expectException(LogLevelException::class);
$this->expectExceptionMessageMatches("/The level \".*\" is not valid./");
$logfile = vfsStream::newFile('friendica.log')
->at($this->root);
$this->config->shouldReceive('get')->with('system', 'logfile')->andReturn($logfile->url())->once();
$logger = new StreamLogger('test', $this->config, $this->introspection, $this->fileSystem);
$logger = $this->getInstance('NOPE');
$logger->log('NOPE', 'a test');
}
/**
* Test when the file is null
*/
public function testWrongFile()
{
$this->expectException(LoggerArgumentException::class);
$this->expectExceptionMessage("A stream must either be a resource or a string.");
$this->config->shouldReceive('get')->with('system', 'logfile')->andReturn(null)->once();
$logger = new StreamLogger('test', $this->config, $this->introspection, $this->fileSystem);
}
/**
* Test a relative path
* @doesNotPerformAssertions