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

Fix SyslogLogger and tests

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

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

@ -23,9 +23,9 @@ namespace Friendica\Core\Logger\Factory;
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\Logger\Exception\LoggerException;
use Friendica\Core\Logger\Exception\LogLevelException;
use Friendica\Core\Logger\Type\SyslogLogger as SyslogLoggerClass;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
/**
* The logger factory for the SyslogLogger instance
@ -49,10 +49,10 @@ class SyslogLogger extends AbstractLoggerTypeFactory
$logFacility = $config->get('system', 'syslog_facility') ?? SyslogLoggerClass::DEFAULT_FACILITY;
$loglevel = SyslogLogger::mapLegacyConfigDebugLevel($config->get('system', 'loglevel'));
if (!array_key_exists($loglevel, SyslogLoggerClass::logLevels)) {
if (array_key_exists($loglevel, SyslogLoggerClass::logLevels)) {
$loglevel = SyslogLoggerClass::logLevels[$loglevel];
} else {
$loglevel = SyslogLoggerClass::logLevels[LogLevel::NOTICE];
throw new LogLevelException(sprintf('The level "%s" is not valid.', $loglevel));
}
return new SyslogLoggerClass($this->channel, $this->introspection, $loglevel, $logOpts, $logFacility);

2
tests/functional/DependencyCheckTest.php
View file

@ -145,7 +145,7 @@ class DependencyCheckTest extends FixtureTest
$config->set('system', 'dlogfile', $this->root->url() . '/friendica.log');
/** @var LoggerInterface $logger */
$logger = $this->dice->create('$devLogger', [['$channel' => 'dev']]);
$logger = $this->dice->create('$devLogger', ['dev']);
self::assertInstanceOf(LoggerInterface::class, $logger);
}

47
tests/src/Core/Logger/SyslogLoggerFactoryWrapper.php Normal file
View file

@ -0,0 +1,47 @@
<?php
/**
* @copyright Copyright (C) 2010-2023, the Friendica project
*
* @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/>.
*
*/
namespace Friendica\Test\src\Core\Logger;
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\Logger\Exception\LogLevelException;
use Friendica\Core\Logger\Factory\SyslogLogger;
use Friendica\Core\Logger\Type\SyslogLogger as SyslogLoggerClass;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
class SyslogLoggerFactoryWrapper extends SyslogLogger
{
public function create(IManageConfigValues $config): LoggerInterface
{
$logOpts = $config->get('system', 'syslog_flags') ?? SyslogLoggerClass::DEFAULT_FLAGS;
$logFacility = $config->get('system', 'syslog_facility') ?? SyslogLoggerClass::DEFAULT_FACILITY;
$loglevel = SyslogLogger::mapLegacyConfigDebugLevel($config->get('system', 'loglevel'));
if (array_key_exists($loglevel, SyslogLoggerClass::logLevels)) {
$loglevel = SyslogLoggerClass::logLevels[$loglevel];
} else {
throw new LogLevelException(sprintf('The level "%s" is not valid.', $loglevel));
}
return new SyslogLoggerWrapper($this->channel, $this->introspection, $loglevel, $logOpts, $logFacility);
}
}

15
tests/src/Core/Logger/SyslogLoggerTest.php
View file

@ -21,8 +21,6 @@
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\Type\SyslogLogger;
use Psr\Log\LogLevel;
@ -58,7 +56,10 @@ class SyslogLoggerTest extends AbstractLoggerTest
*/
protected function getInstance($level = LogLevel::DEBUG)
{
$this->logger = new SyslogLoggerWrapper('test', $this->config, $this->introspection, $level);
$this->config->shouldReceive('get')->with('system', 'loglevel')->andReturn($level);
$loggerFactory = new SyslogLoggerFactoryWrapper($this->introspection, 'test');
$this->logger = $loggerFactory->create($this->config);
return $this->logger;
}
@ -71,8 +72,8 @@ class SyslogLoggerTest extends AbstractLoggerTest
{
$this->expectException(LogLevelException::class);
$this->expectExceptionMessageMatches("/The level \".*\" is not valid./");
$logger = new SyslogLoggerWrapper('test', $this->config, $this->introspection, 'NOPE');
$logger = $this->getInstance('NOPE');
}
/**
@ -83,7 +84,7 @@ class SyslogLoggerTest extends AbstractLoggerTest
$this->expectException(LogLevelException::class);
$this->expectExceptionMessageMatches("/The level \".*\" is not valid./");
$logger = new SyslogLoggerWrapper('test', $this->config, $this->introspection);
$logger = $this->getInstance();
$logger->log('NOPE', 'a test');
}
@ -94,7 +95,7 @@ class SyslogLoggerTest extends AbstractLoggerTest
*/
public function testClose()
{
$logger = new SyslogLoggerWrapper('test', $this->config, $this->introspection);
$logger = $this->getInstance();
$logger->emergency('test');
$logger->close();
// Reopened itself

8
tests/src/Core/Logger/SyslogLoggerWrapper.php
View file

@ -21,10 +21,8 @@
namespace Friendica\Test\src\Core\Logger;
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\Logger\Capabilities\IHaveCallIntrospections;
use Friendica\Core\Logger\Type\SyslogLogger;
use Friendica\Core\Logger\Util\Introspection;
use Psr\Log\LogLevel;
/**
* Wraps the SyslogLogger for replacing the syslog call with a string field.
@ -33,9 +31,9 @@ class SyslogLoggerWrapper extends SyslogLogger
{
private $content;
public function __construct($channel, IManageConfigValues $config, Introspection $introspection, $level = LogLevel::NOTICE)
public function __construct(string $channel, IHaveCallIntrospections $introspection, string $logLevel, string $logOptions, string $logFacility)
{
parent::__construct($channel, $config, $introspection, $level);
parent::__construct($channel, $introspection, $logLevel, $logOptions, $logFacility);
$this->content = '';
}