Fix SyslogLogger and tests

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

View File

@ -23,9 +23,9 @@ namespace Friendica\Core\Logger\Factory;
use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\Logger\Exception\LoggerException; use Friendica\Core\Logger\Exception\LoggerException;
use Friendica\Core\Logger\Exception\LogLevelException;
use Friendica\Core\Logger\Type\SyslogLogger as SyslogLoggerClass; use Friendica\Core\Logger\Type\SyslogLogger as SyslogLoggerClass;
use Psr\Log\LoggerInterface; use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
/** /**
* The logger factory for the SyslogLogger instance * The logger factory for the SyslogLogger instance
@ -49,10 +49,10 @@ class SyslogLogger extends AbstractLoggerTypeFactory
$logFacility = $config->get('system', 'syslog_facility') ?? SyslogLoggerClass::DEFAULT_FACILITY; $logFacility = $config->get('system', 'syslog_facility') ?? SyslogLoggerClass::DEFAULT_FACILITY;
$loglevel = SyslogLogger::mapLegacyConfigDebugLevel($config->get('system', 'loglevel')); $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]; $loglevel = SyslogLoggerClass::logLevels[$loglevel];
} else { } 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); return new SyslogLoggerClass($this->channel, $this->introspection, $loglevel, $logOpts, $logFacility);

View File

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

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);
}
}

View File

@ -21,8 +21,6 @@
namespace Friendica\Test\src\Core\Logger; 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\Exception\LogLevelException;
use Friendica\Core\Logger\Type\SyslogLogger; use Friendica\Core\Logger\Type\SyslogLogger;
use Psr\Log\LogLevel; use Psr\Log\LogLevel;
@ -58,7 +56,10 @@ class SyslogLoggerTest extends AbstractLoggerTest
*/ */
protected function getInstance($level = LogLevel::DEBUG) 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; return $this->logger;
} }
@ -72,7 +73,7 @@ class SyslogLoggerTest extends AbstractLoggerTest
$this->expectException(LogLevelException::class); $this->expectException(LogLevelException::class);
$this->expectExceptionMessageMatches("/The level \".*\" is not valid./"); $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->expectException(LogLevelException::class);
$this->expectExceptionMessageMatches("/The level \".*\" is not valid./"); $this->expectExceptionMessageMatches("/The level \".*\" is not valid./");
$logger = new SyslogLoggerWrapper('test', $this->config, $this->introspection); $logger = $this->getInstance();
$logger->log('NOPE', 'a test'); $logger->log('NOPE', 'a test');
} }
@ -94,7 +95,7 @@ class SyslogLoggerTest extends AbstractLoggerTest
*/ */
public function testClose() public function testClose()
{ {
$logger = new SyslogLoggerWrapper('test', $this->config, $this->introspection); $logger = $this->getInstance();
$logger->emergency('test'); $logger->emergency('test');
$logger->close(); $logger->close();
// Reopened itself // Reopened itself

View File

@ -21,10 +21,8 @@
namespace Friendica\Test\src\Core\Logger; 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\Type\SyslogLogger;
use Friendica\Core\Logger\Util\Introspection;
use Psr\Log\LogLevel;
/** /**
* Wraps the SyslogLogger for replacing the syslog call with a string field. * Wraps the SyslogLogger for replacing the syslog call with a string field.
@ -33,9 +31,9 @@ class SyslogLoggerWrapper extends SyslogLogger
{ {
private $content; 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 = ''; $this->content = '';
} }