mirror/php-monolog
1
0
Fork 0
mirror of https://github.com/Seldaek/monolog.git synced 2025-08-06 05:07:36 +02:00
Code Issues Releases Wiki Activity

Upgrade phpstan, phpunit (#1923)

Browse Source 
* Upgrade phpstan, phpunit

* Fix phpunit deprecation

* Fix hg tests

* Fix php-console tests

* Fix phpunit on 8.1

* Bump phpconsole
This commit is contained in:
Jordi Boggiano
2024-11-11 15:21:55 +01:00
committed by GitHub
parent 7af6f41cff
commit f43e3d5637
43 changed files with 210 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.github/workflows/continuous-integration.yml vendored
View File

@@ -78,6 +78,11 @@ jobs:
composer-options: "${{ matrix.composer-options }}"
- name: "Run tests"
if: "matrix.php-version >= '8.2'"
run: "composer exec phpunit -- --exclude-group Elasticsearch --exclude-group Elastica"
- name: "Run tests"
if: "matrix.php-version == '8.1'"
run: "composer exec phpunit -- --exclude-group Elasticsearch,Elastica"
tests-es-7:

9
composer.json
View File

@@ -26,10 +26,11 @@
"guzzlehttp/psr7": "^2.2",
"mongodb/mongodb": "^1.8",
"php-amqplib/php-amqplib": "~2.4 || ^3",
"phpstan/phpstan": "^1.9",
"phpstan/phpstan-deprecation-rules": "^1.0",
"phpstan/phpstan-strict-rules": "^1.4",
"phpunit/phpunit": "^10.5.17",
"php-console/php-console": "^3.1.8",
"phpstan/phpstan": "^2",
"phpstan/phpstan-deprecation-rules": "^2",
"phpstan/phpstan-strict-rules": "^2",
"phpunit/phpunit": "^10.5.17 || ^11.0.7",
"predis/predis": "^1.1 || ^2",
"rollbar/rollbar": "^4.0",
"ruflin/elastica": "^7 || ^8",

96
phpstan-baseline.neon
View File

@@ -1,111 +1,163 @@
parameters:
ignoreErrors:
-
message: "#^Property Monolog\\\\ErrorHandler\\:\\:\\$reservedMemory is never read, only written\\.$#"
message: '#^Property Monolog\\ErrorHandler\:\:\$reservedMemory is never read, only written\.$#'
identifier: property.onlyWritten
count: 1
path: src/Monolog/ErrorHandler.php
-
message: "#^Return type \\(array\\<array\\|bool\\|float\\|int\\|object\\|string\\|null\\>\\|bool\\|float\\|int\\|object\\|string\\|null\\) of method Monolog\\\\Formatter\\\\JsonFormatter\\:\\:normalize\\(\\) should be covariant with return type \\(array\\<array\\|bool\\|float\\|int\\|string\\|null\\>\\|bool\\|float\\|int\\|string\\|null\\) of method Monolog\\\\Formatter\\\\NormalizerFormatter\\:\\:normalize\\(\\)$#"
message: '#^Method Monolog\\Formatter\\JsonFormatter\:\:normalizeException\(\) return type has no value type specified in iterable type array\.$#'
identifier: missingType.iterableValue
count: 1
path: src/Monolog/Formatter/JsonFormatter.php
-
message: "#^Cannot access offset 'table' on array\\<array\\|bool\\|float\\|int\\|string\\|null\\>\\|bool\\|float\\|int\\|object\\|string\\.$#"
message: '#^PHPDoc tag @return with type array\<string, array\<array\<string\>\|int\|string\>\|int\|string\>\|string is not subtype of native type array\.$#'
identifier: return.phpDocType
count: 1
path: src/Monolog/Formatter/JsonFormatter.php
-
message: '#^Return type \(array\) of method Monolog\\Formatter\\JsonFormatter\:\:normalizeException\(\) should be covariant with return type \(array\<string, array\<array\<string\>\|int\|string\>\|int\|string\>\|string\) of method Monolog\\Formatter\\NormalizerFormatter\:\:normalizeException\(\)$#'
identifier: method.childReturnType
count: 1
path: src/Monolog/Formatter/JsonFormatter.php
-
message: '#^Return type \(array\<array\<mixed\>\|bool\|float\|int\|object\|string\|null\>\|bool\|float\|int\|object\|string\|null\) of method Monolog\\Formatter\\JsonFormatter\:\:normalize\(\) should be covariant with return type \(array\<array\<mixed\>\|bool\|float\|int\|string\|null\>\|bool\|float\|int\|string\|null\) of method Monolog\\Formatter\\NormalizerFormatter\:\:normalize\(\)$#'
identifier: method.childReturnType
count: 1
path: src/Monolog/Formatter/JsonFormatter.php
-
message: '#^Method Monolog\\Formatter\\NormalizerFormatter\:\:normalizeException\(\) should return array\<string, array\<array\<string\>\|int\|string\>\|int\|string\>\|string but returns array\<int, string\>\.$#'
identifier: return.type
count: 1
path: src/Monolog/Formatter/NormalizerFormatter.php
-
message: '#^Method Monolog\\Formatter\\NormalizerFormatter\:\:normalizeException\(\) should return array\<string, array\<array\<string\>\|int\|string\>\|int\|string\>\|string but returns array\<string, array\<int\<0, max\>\|string, array\<array\<string\>\|int\|string\>\|int\|string\>\|int\|string\>\.$#'
identifier: return.type
count: 1
path: src/Monolog/Formatter/NormalizerFormatter.php
-
message: '#^Cannot access offset ''table'' on array\<array\<mixed\>\|bool\|float\|int\|string\|null\>\|bool\|float\|int\|object\|string\.$#'
identifier: offsetAccess.nonOffsetAccessible
count: 1
path: src/Monolog/Formatter/WildfireFormatter.php
-
message: "#^Return type \\(array\\<array\\|bool\\|float\\|int\\|string\\|null\\>\\|bool\\|float\\|int\\|object\\|string\\|null\\) of method Monolog\\\\Formatter\\\\WildfireFormatter\\:\\:normalize\\(\\) should be covariant with return type \\(array\\<array\\|bool\\|float\\|int\\|string\\|null\\>\\|bool\\|float\\|int\\|string\\|null\\) of method Monolog\\\\Formatter\\\\NormalizerFormatter\\:\\:normalize\\(\\)$#"
message: '#^Return type \(array\<array\<mixed\>\|bool\|float\|int\|string\|null\>\|bool\|float\|int\|object\|string\|null\) of method Monolog\\Formatter\\WildfireFormatter\:\:normalize\(\) should be covariant with return type \(array\<array\<mixed\>\|bool\|float\|int\|string\|null\>\|bool\|float\|int\|string\|null\) of method Monolog\\Formatter\\NormalizerFormatter\:\:normalize\(\)$#'
identifier: method.childReturnType
count: 1
path: src/Monolog/Formatter/WildfireFormatter.php
-
message: "#^Access to constant VERSION on an unknown class Elasticsearch\\\\Client\\.$#"
message: '#^Access to constant VERSION on an unknown class Elasticsearch\\Client\.$#'
identifier: class.notFound
count: 1
path: src/Monolog/Handler/ElasticsearchHandler.php
-
message: "#^Call to method bulk\\(\\) on an unknown class Elasticsearch\\\\Client\\.$#"
message: '#^Call to method bulk\(\) on an unknown class Elasticsearch\\Client\.$#'
identifier: class.notFound
count: 1
path: src/Monolog/Handler/ElasticsearchHandler.php
-
message: "#^Method Monolog\\\\Handler\\\\ElasticsearchHandler\\:\\:createExceptionFromError\\(\\) should return Throwable but returns Elasticsearch\\\\Common\\\\Exceptions\\\\RuntimeException\\.$#"
message: '#^Method Monolog\\Handler\\ElasticsearchHandler\:\:createExceptionFromError\(\) should return Throwable but returns Elasticsearch\\Common\\Exceptions\\RuntimeException\.$#'
identifier: return.type
count: 1
path: src/Monolog/Handler/ElasticsearchHandler.php
-
message: "#^Method Monolog\\\\Handler\\\\ElasticsearchHandler\\:\\:createExceptionFromResponses\\(\\) should return Throwable but returns Elasticsearch\\\\Common\\\\Exceptions\\\\RuntimeException\\.$#"
message: '#^Method Monolog\\Handler\\ElasticsearchHandler\:\:createExceptionFromResponses\(\) should return Throwable but returns Elasticsearch\\Common\\Exceptions\\RuntimeException\.$#'
identifier: return.type
count: 1
path: src/Monolog/Handler/ElasticsearchHandler.php
-
message: "#^Parameter \\$client of method Monolog\\\\Handler\\\\ElasticsearchHandler\\:\\:__construct\\(\\) has invalid type Elasticsearch\\\\Client\\.$#"
message: '#^Parameter \$client of method Monolog\\Handler\\ElasticsearchHandler\:\:__construct\(\) has invalid type Elasticsearch\\Client\.$#'
identifier: class.notFound
count: 2
path: src/Monolog/Handler/ElasticsearchHandler.php
-
message: "#^Property Monolog\\\\Handler\\\\ElasticsearchHandler\\:\\:\\$client has unknown class Elasticsearch\\\\Client as its type\\.$#"
message: '#^Property Monolog\\Handler\\ElasticsearchHandler\:\:\$client has unknown class Elasticsearch\\Client as its type\.$#'
identifier: class.notFound
count: 1
path: src/Monolog/Handler/ElasticsearchHandler.php
-
message: "#^Short ternary operator is not allowed\\. Use null coalesce operator if applicable or consider using long ternary\\.$#"
message: '#^Short ternary operator is not allowed\. Use null coalesce operator if applicable or consider using long ternary\.$#'
identifier: ternary.shortNotAllowed
count: 1
path: src/Monolog/Handler/FingersCrossedHandler.php
-
message: "#^Call to method setBody\\(\\) on an unknown class Swift_Message\\.$#"
message: '#^Call to method setBody\(\) on an unknown class Swift_Message\.$#'
identifier: class.notFound
count: 1
path: src/Monolog/Handler/MandrillHandler.php
-
message: "#^Call to method setDate\\(\\) on an unknown class Swift_Message\\.$#"
message: '#^Call to method setDate\(\) on an unknown class Swift_Message\.$#'
identifier: class.notFound
count: 1
path: src/Monolog/Handler/MandrillHandler.php
-
message: "#^Class Swift_Message not found\\.$#"
message: '#^Class Swift_Message not found\.$#'
identifier: class.notFound
count: 2
path: src/Monolog/Handler/MandrillHandler.php
-
message: "#^Cloning object of an unknown class Swift_Message\\.$#"
message: '#^Cloning object of an unknown class Swift_Message\.$#'
identifier: class.notFound
count: 1
path: src/Monolog/Handler/MandrillHandler.php
-
message: "#^Parameter \\$message of method Monolog\\\\Handler\\\\MandrillHandler\\:\\:__construct\\(\\) has invalid type Swift_Message\\.$#"
message: '#^Parameter \$message of method Monolog\\Handler\\MandrillHandler\:\:__construct\(\) has invalid type Swift_Message\.$#'
identifier: class.notFound
count: 3
path: src/Monolog/Handler/MandrillHandler.php
-
message: "#^Property Monolog\\\\Handler\\\\MandrillHandler\\:\\:\\$message has unknown class Swift_Message as its type\\.$#"
message: '#^Property Monolog\\Handler\\MandrillHandler\:\:\$message has unknown class Swift_Message as its type\.$#'
identifier: class.notFound
count: 1
path: src/Monolog/Handler/MandrillHandler.php
-
message: "#^Variable property access on \\$this\\(Monolog\\\\LogRecord\\)\\.$#"
message: '#^Variable property access on \$this\(Monolog\\LogRecord\)\.$#'
identifier: property.dynamicName
count: 4
path: src/Monolog/LogRecord.php
-
message: "#^Cannot assign offset Fiber to WeakMap\\<Fiber\\<mixed, mixed, mixed, mixed\\>, int\\>\\.$#"
message: '#^Cannot assign offset Fiber to WeakMap\<Fiber\<mixed, mixed, mixed, mixed\>, int\>\.$#'
identifier: offsetAssign.dimType
count: 1
path: src/Monolog/Logger.php
-
message: "#^Parameter \\#1 \\$level \\('alert'\\|'critical'\\|'debug'\\|'emergency'\\|'error'\\|'info'\\|'notice'\\|'warning'\\|Monolog\\\\Level\\) of method Monolog\\\\Logger\\:\\:log\\(\\) should be contravariant with parameter \\$level \\(mixed\\) of method Psr\\\\Log\\\\LoggerInterface\\:\\:log\\(\\)$#"
message: '#^Parameter \#1 \$level \(''alert''\|''critical''\|''debug''\|''emergency''\|''error''\|''info''\|''notice''\|''warning''\|Monolog\\Level\) of method Monolog\\Logger\:\:log\(\) should be contravariant with parameter \$level \(mixed\) of method Psr\\Log\\LoggerInterface\:\:log\(\)$#'
identifier: method.childParameterType
count: 1
path: src/Monolog/Logger.php
-
message: "#^Variable property access on \\$this\\(Monolog\\\\Logger\\)\\.$#"
message: '#^Variable property access on \$this\(Monolog\\Logger\)\.$#'
identifier: property.dynamicName
count: 1
path: src/Monolog/Logger.php
-
message: "#^Parameter \\#1 \\$length of function random_bytes expects int\\<1, max\\>, int given\\.$#"
message: '#^Parameter \#1 \$length of function random_bytes expects int\<1, max\>, int given\.$#'
identifier: argument.type
count: 1
path: src/Monolog/Processor/UidProcessor.php

6
phpstan.neon.dist
View File

@@ -15,13 +15,9 @@ parameters:
- '#zend_monitor_|ZEND_MONITOR_#'
- '#MongoDB\\(Client|Collection)#'
# Cannot resolve this cleanly as different normalizers return different types but it is safe
- message: '#Return type \(string\) of method Monolog\\Formatter\\LineFormatter::normalizeException\(\) should be compatible with return type \(array\) of method Monolog\\Formatter\\NormalizerFormatter::normalizeException\(\)#'
paths:
- src/Monolog/Formatter/LineFormatter.php
includes:
- phpstan-baseline.neon
- phpstan-ignore-by-php-version.neon.php
- phar://phpstan.phar/conf/bleedingEdge.neon
- vendor/phpstan/phpstan-strict-rules/rules.neon
- vendor/phpstan/phpstan-deprecation-rules/rules.neon

3
phpunit.xml.dist
View File

@@ -3,6 +3,9 @@
xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
bootstrap="tests/bootstrap.php"
colors="true"
displayDetailsOnTestsThatTriggerWarnings="true"
displayDetailsOnSkippedTests="true"
displayDetailsOnTestsThatTriggerNotices="true"
beStrictAboutTestsThatDoNotTestAnything="false">
<testsuites>
<testsuite name="Monolog Test Suite">

4
src/Monolog/Formatter/GelfMessageFormatter.php
View File

@@ -88,11 +88,11 @@ class GelfMessageFormatter extends NormalizerFormatter
{
$context = $extra = [];
if (isset($record->context)) {
/** @var mixed[] $context */
/** @var array<array<mixed>|bool|float|int|string|null> $context */
$context = parent::normalize($record->context);
}
if (isset($record->extra)) {
/** @var mixed[] $extra */
/** @var array<array<mixed>|bool|float|int|string|null> $extra */
$extra = parent::normalize($record->extra);
}

2
src/Monolog/Formatter/JsonFormatter.php
View File

@@ -204,7 +204,7 @@ class JsonFormatter extends NormalizerFormatter
* Normalizes given exception with or without its own stack trace based on
* `includeStacktraces` property.
*
* @inheritDoc
* @return array<string, string|int|array<string|int|array<string>>>|string
*/
protected function normalizeException(Throwable $e, int $depth = 0): array
{

6
src/Monolog/Formatter/LineFormatter.php
View File

@@ -175,7 +175,7 @@ class LineFormatter extends NormalizerFormatter
if (null === $output) {
$pcreErrorCode = preg_last_error();
throw new \RuntimeException('Failed to run preg_replace: ' . $pcreErrorCode . ' / ' . Utils::pcreLastErrorMessage($pcreErrorCode));
throw new \RuntimeException('Failed to run preg_replace: ' . $pcreErrorCode . ' / ' . preg_last_error_msg());
}
}
@@ -243,7 +243,7 @@ class LineFormatter extends NormalizerFormatter
if (null === $str) {
$pcreErrorCode = preg_last_error();
throw new \RuntimeException('Failed to run preg_replace: ' . $pcreErrorCode . ' / ' . Utils::pcreLastErrorMessage($pcreErrorCode));
throw new \RuntimeException('Failed to run preg_replace: ' . $pcreErrorCode . ' / ' . preg_last_error_msg());
}
}
@@ -309,6 +309,6 @@ class LineFormatter extends NormalizerFormatter
private function stacktracesParserCustom(string $trace): string
{
return implode("\n", array_filter(array_map($this->stacktracesParser, explode("\n", $trace))));
return implode("\n", array_filter(array_map($this->stacktracesParser, explode("\n", $trace)), fn ($line) => $line !== false && $line !== ''));
}
}

2
src/Monolog/Formatter/MongoDBFormatter.php
View File

@@ -150,7 +150,7 @@ class MongoDBFormatter implements FormatterInterface
{
$milliseconds = floor(((float) $value->format('U.u')) * 1000);
$milliseconds = (PHP_INT_SIZE == 8) //64-bit OS?
$milliseconds = (PHP_INT_SIZE === 8) //64-bit OS?
? (int) $milliseconds
: (string) $milliseconds;

4
src/Monolog/Formatter/NormalizerFormatter.php
View File

@@ -163,7 +163,7 @@ class NormalizerFormatter implements FormatterInterface
*/
protected function normalizeRecord(LogRecord $record): array
{
/** @var array<mixed> $normalized */
/** @var array<mixed[]|scalar|null> $normalized */
$normalized = $this->normalize($record->toArray());
return $normalized;
@@ -248,7 +248,7 @@ class NormalizerFormatter implements FormatterInterface
}
/**
* @return mixed[]
* @return array<string, string|int|array<string|int|array<string>>>|string
*/
protected function normalizeException(Throwable $e, int $depth = 0)
{

4
src/Monolog/Handler/BrowserConsoleHandler.php
View File

@@ -243,7 +243,7 @@ class BrowserConsoleHandler extends AbstractProcessingHandler
if (null === $style) {
$pcreErrorCode = preg_last_error();
throw new \RuntimeException('Failed to run preg_replace_callback: ' . $pcreErrorCode . ' / ' . Utils::pcreLastErrorMessage($pcreErrorCode));
throw new \RuntimeException('Failed to run preg_replace_callback: ' . $pcreErrorCode . ' / ' . preg_last_error_msg());
}
return $style;
@@ -256,7 +256,7 @@ class BrowserConsoleHandler extends AbstractProcessingHandler
private static function dump(string $title, array $dict): array
{
$script = [];
$dict = array_filter($dict);
$dict = array_filter($dict, fn ($value) => $value !== null);
if (\count($dict) === 0) {
return $script;
}

5
src/Monolog/Handler/ErrorLogHandler.php
View File

@@ -27,11 +27,12 @@ class ErrorLogHandler extends AbstractProcessingHandler
public const OPERATING_SYSTEM = 0;
public const SAPI = 4;
/** @var 0|1|3|4 */
protected int $messageType;
protected bool $expandNewlines;
/**
* @param int $messageType Says where the error should go.
* @param 0|1|3|4 $messageType Says where the error should go.
* @param bool $expandNewlines If set to true, newlines in the message will be expanded to be take multiple log entries
*
* @throws \InvalidArgumentException If an unsupported message type is set
@@ -84,7 +85,7 @@ class ErrorLogHandler extends AbstractProcessingHandler
if ($lines === false) {
$pcreErrorCode = preg_last_error();
throw new \RuntimeException('Failed to preg_split formatted string: ' . $pcreErrorCode . ' / '. Utils::pcreLastErrorMessage($pcreErrorCode));
throw new \RuntimeException('Failed to preg_split formatted string: ' . $pcreErrorCode . ' / '. preg_last_error_msg());
}
foreach ($lines as $line) {
error_log($line, $this->messageType);

4
src/Monolog/Handler/MandrillHandler.php
View File

@@ -70,8 +70,8 @@ class MandrillHandler extends MailHandler
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://mandrillapp.com/api/1.0/messages/send-raw.json');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
'key' => $this->apiKey,
'raw_message' => (string) $message,

2
src/Monolog/Handler/OverflowHandler.php
View File

@@ -97,7 +97,7 @@ class OverflowHandler extends AbstractHandler implements FormattableHandlerInter
return false === $this->bubble;
}
if ($this->thresholdMap[$level] == 0) {
if ($this->thresholdMap[$level] === 0) {
// This current message is breaking the threshold. Flush the buffer and continue handling the current record
foreach ($this->buffer[$level] ?? [] as $buffered) {
$this->handler->handle($buffered);

4
src/Monolog/Handler/SendGridHandler.php
View File

@@ -92,8 +92,8 @@ class SendGridHandler extends MailHandler
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.sendgrid.com/api/mail.send.json');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($message));
Curl\Util::execute($ch, 2);
}

4
src/Monolog/Handler/Slack/SlackRecord.php
View File

@@ -206,7 +206,7 @@ class SlackRecord
*/
public function stringify(array $fields): string
{
/** @var array<mixed> $normalized */
/** @var array<array<mixed>|bool|float|int|string|null> $normalized */
$normalized = $this->normalizerFormatter->normalizeValue($fields);
$hasSecondDimension = \count(array_filter($normalized, 'is_array')) > 0;
@@ -341,7 +341,7 @@ class SlackRecord
*/
private function generateAttachmentFields(array $data): array
{
/** @var array<mixed> $normalized */
/** @var array<array<mixed>|string> $normalized */
$normalized = $this->normalizerFormatter->normalizeValue($data);
$fields = [];

4
src/Monolog/Handler/SocketHandler.php
View File

@@ -386,7 +386,7 @@ class SocketHandler extends AbstractProcessingHandler
$sent = 0;
$this->lastSentBytes = $sent;
while ($this->isConnected() && $sent < $length) {
if (0 == $sent) {
if (0 === $sent) {
$chunk = $this->fwrite($data);
} else {
$chunk = $this->fwrite(substr($data, $sent));
@@ -412,7 +412,7 @@ class SocketHandler extends AbstractProcessingHandler
private function writingIsTimedOut(int $sent): bool
{
// convert to ms
if (0.0 == $this->writingTimeout) {
if (0.0 === $this->writingTimeout) {
return false;
}

2
src/Monolog/Handler/SyslogUdpHandler.php
View File

@@ -96,7 +96,7 @@ class SyslogUdpHandler extends AbstractSyslogHandler
if (false === $lines) {
$pcreErrorCode = preg_last_error();
throw new \RuntimeException('Could not preg_split: ' . $pcreErrorCode . ' / ' . Utils::pcreLastErrorMessage($pcreErrorCode));
throw new \RuntimeException('Could not preg_split: ' . $pcreErrorCode . ' / ' . preg_last_error_msg());
}
return $lines;

16
src/Monolog/Handler/TestHandler.php
View File

@@ -23,14 +23,14 @@ use Monolog\LogRecord;
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*
* @method bool hasEmergency(string|array $recordAssertions)
* @method bool hasAlert(string|array $recordAssertions)
* @method bool hasCritical(string|array $recordAssertions)
* @method bool hasError(string|array $recordAssertions)
* @method bool hasWarning(string|array $recordAssertions)
* @method bool hasNotice(string|array $recordAssertions)
* @method bool hasInfo(string|array $recordAssertions)
* @method bool hasDebug(string|array $recordAssertions)
* @method bool hasEmergency(array{message: string, context?: mixed[]}|string $recordAssertions)
* @method bool hasAlert(array{message: string, context?: mixed[]}|string $recordAssertions)
* @method bool hasCritical(array{message: string, context?: mixed[]}|string $recordAssertions)
* @method bool hasError(array{message: string, context?: mixed[]}|string $recordAssertions)
* @method bool hasWarning(array{message: string, context?: mixed[]}|string $recordAssertions)
* @method bool hasNotice(array{message: string, context?: mixed[]}|string $recordAssertions)
* @method bool hasInfo(array{message: string, context?: mixed[]}|string $recordAssertions)
* @method bool hasDebug(array{message: string, context?: mixed[]}|string $recordAssertions)
*
* @method bool hasEmergencyRecords()
* @method bool hasAlertRecords()

2
src/Monolog/Logger.php
View File

@@ -166,7 +166,7 @@ class Logger implements LoggerInterface, ResettableInterface
/**
* @param string $name The logging channel, a simple descriptive name that is attached to all log records
* @param HandlerInterface[] $handlers Optional stack of handlers, the first one in the array is called first, etc.
* @param list<HandlerInterface> $handlers Optional stack of handlers, the first one in the array is called first, etc.
* @param callable[] $processors Optional array of processors
* @param DateTimeZone|null $timezone Optional timezone, if not provided date_default_timezone_get() will be used
*

7
src/Monolog/Processor/MercurialProcessor.php
View File

@@ -62,13 +62,18 @@ class MercurialProcessor implements ProcessorInterface
}
$result = explode(' ', trim((string) shell_exec('hg id -nb')));
if (\count($result) >= 3) {
return self::$cache = [
'branch' => $result[1],
'revision' => $result[2],
];
}
if (\count($result) === 2) {
return self::$cache = [
'branch' => $result[1],
'revision' => $result[0],
];
}
return self::$cache = [];
}

10
src/Monolog/Test/TestCase.php
View File

@@ -17,6 +17,7 @@ use Monolog\LogRecord;
use Monolog\DateTimeImmutable;
use Monolog\Formatter\FormatterInterface;
use Psr\Log\LogLevel;
use ReflectionProperty;
/**
* Lets you easily generate log records and a dummy formatter for testing purposes
@@ -27,15 +28,6 @@ use Psr\Log\LogLevel;
*/
class TestCase extends \PHPUnit\Framework\TestCase
{
public function tearDown(): void
{
parent::tearDown();
if (isset($this->handler)) {
unset($this->handler);
}
}
/**
* @param array<mixed> $context
* @param array<mixed> $extra

21
src/Monolog/Utils.php
View File

@@ -140,25 +140,6 @@ final class Utils
return $json;
}
/**
* @internal
*/
public static function pcreLastErrorMessage(int $code): string
{
if (PHP_VERSION_ID >= 80000) {
return preg_last_error_msg();
}
$constants = (get_defined_constants(true))['pcre'];
$constants = array_filter($constants, function ($key) {
return substr($key, -6) == '_ERROR';
}, ARRAY_FILTER_USE_KEY);
$constants = array_flip($constants);
return $constants[$code] ?? 'UNDEFINED_ERROR';
}
/**
* Throws an exception according to a given code with a customized message
*
@@ -209,7 +190,7 @@ final class Utils
if (!\is_string($data)) {
$pcreErrorCode = preg_last_error();
throw new \RuntimeException('Failed to preg_replace_callback: ' . $pcreErrorCode . ' / ' . self::pcreLastErrorMessage($pcreErrorCode));
throw new \RuntimeException('Failed to preg_replace_callback: ' . $pcreErrorCode . ' / ' . preg_last_error_msg());
}
$data = str_replace(
['¤', '¦', '¨', '´', '¸', '¼', '½', '¾'],

6
tests/Monolog/ErrorHandlerTest.php
View File

@@ -68,7 +68,6 @@ class ErrorHandlerTest extends \PHPUnit\Framework\TestCase
{
$ref = new \ReflectionClass(\get_class($instance));
$prop = $ref->getProperty($property);
$prop->setAccessible(true);
return $prop->getValue($instance);
}
@@ -91,6 +90,7 @@ class ErrorHandlerTest extends \PHPUnit\Framework\TestCase
$this->assertEquals($expectedFatalLevel, $this->getPrivatePropertyValue($errHandler, 'fatalLevel'));
}
#[WithoutErrorHandler]
public function testHandleException()
{
$logger = new Logger('test', [$handler = new TestHandler]);
@@ -106,12 +106,14 @@ class ErrorHandlerTest extends \PHPUnit\Framework\TestCase
$errHandler->registerExceptionHandler([], true);
$prop = $this->getPrivatePropertyValue($errHandler, 'previousExceptionHandler');
$this->assertTrue(\is_callable($prop));
restore_exception_handler();
restore_exception_handler();
}
public function testCodeToString()
{
$method = new \ReflectionMethod(ErrorHandler::class, 'codeToString');
$method->setAccessible(true);
$this->assertEquals('E_ERROR', $method->invokeArgs(null, [E_ERROR]));
$this->assertEquals('E_WARNING', $method->invokeArgs(null, [E_WARNING]));

2
tests/Monolog/Formatter/MongoDBFormatterTest.php
View File

@@ -44,11 +44,9 @@ class MongoDBFormatterTest extends TestCase
$formatter = new MongoDBFormatter($traceDepth, $traceAsString);
$reflTrace = new \ReflectionProperty($formatter, 'exceptionTraceAsString');
$reflTrace->setAccessible(true);
$this->assertEquals($expectedTraceAsString, $reflTrace->getValue($formatter));
$reflDepth = new \ReflectionProperty($formatter, 'maxNestingLevel');
$reflDepth->setAccessible(true);
$this->assertEquals($expectedTraceDepth, $reflDepth->getValue($formatter));
}

4
tests/Monolog/Formatter/NormalizerFormatterTest.php
View File

@@ -220,7 +220,6 @@ class NormalizerFormatterTest extends TestCase
$formatter = new NormalizerFormatter();
$reflMethod = new \ReflectionMethod($formatter, 'toJson');
$reflMethod->setAccessible(true);
$res = $reflMethod->invoke($formatter, [$foo, $bar], true);
restore_error_handler();
@@ -255,7 +254,6 @@ class NormalizerFormatterTest extends TestCase
$formatter = new NormalizerFormatter();
$reflMethod = new \ReflectionMethod($formatter, 'toJson');
$reflMethod->setAccessible(true);
$res = $reflMethod->invoke($formatter, [$resource], true);
restore_error_handler();
@@ -299,7 +297,6 @@ class NormalizerFormatterTest extends TestCase
{
$formatter = new NormalizerFormatter();
$reflMethod = new \ReflectionMethod($formatter, 'toJson');
$reflMethod->setAccessible(true);
// send an invalid unicode sequence as a object that can't be cleaned
$record = new \stdClass;
@@ -312,7 +309,6 @@ class NormalizerFormatterTest extends TestCase
{
$formatter = new NormalizerFormatter();
$reflMethod = new \ReflectionMethod($formatter, 'toJson');
$reflMethod->setAccessible(true);
$res = $reflMethod->invoke($formatter, ['message' => "\xA4\xA6\xA8\xB4\xB8\xBC\xBD\xBE"]);

1
tests/Monolog/Handler/BrowserConsoleHandlerTest.php
View File

@@ -27,7 +27,6 @@ class BrowserConsoleHandlerTest extends TestCase
protected function generateScript()
{
$reflMethod = new \ReflectionMethod('Monolog\Handler\BrowserConsoleHandler', 'generateScript');
$reflMethod->setAccessible(true);
return $reflMethod->invoke(null);
}

7
tests/Monolog/Handler/FleepHookHandlerTest.php
View File

@@ -39,6 +39,13 @@ class FleepHookHandlerTest extends TestCase
$this->handler = new FleepHookHandler(self::TOKEN);
}
public function tearDown(): void
{
parent::tearDown();
unset($this->handler);
}
/**
* @covers ::__construct
*/

2
tests/Monolog/Handler/FlowdockHandlerTest.php
View File

@@ -40,6 +40,7 @@ class FlowdockHandlerTest extends TestCase
parent::tearDown();
unset($this->res);
unset($this->handler);
}
public function testWriteHeader()
@@ -73,7 +74,6 @@ class FlowdockHandlerTest extends TestCase
->getMock();
$reflectionProperty = new \ReflectionProperty('Monolog\Handler\SocketHandler', 'connectionString');
$reflectionProperty->setAccessible(true);
$reflectionProperty->setValue($this->handler, 'localhost:1234');
$this->handler->expects($this->any())

1
tests/Monolog/Handler/HandlerWrapperTest.php
View File

@@ -36,6 +36,7 @@ class HandlerWrapperTest extends TestCase
parent::tearDown();
unset($this->wrapper);
unset($this->handler);
}
public static function trueFalseDataProvider(): array

2
tests/Monolog/Handler/InsightOpsHandlerTest.php
View File

@@ -33,6 +33,7 @@ class InsightOpsHandlerTest extends TestCase
parent::tearDown();
unset($this->resource);
unset($this->handler);
}
public function testWriteContent()
@@ -68,7 +69,6 @@ class InsightOpsHandlerTest extends TestCase
->getMock();
$reflectionProperty = new \ReflectionProperty('\Monolog\Handler\SocketHandler', 'connectionString');
$reflectionProperty->setAccessible(true);
$reflectionProperty->setValue($this->handler, 'localhost:1234');
$this->handler->expects($this->any())

2
tests/Monolog/Handler/LogEntriesHandlerTest.php
View File

@@ -32,6 +32,7 @@ class LogEntriesHandlerTest extends TestCase
parent::tearDown();
unset($this->res);
unset($this->handler);
}
public function testWriteContent()
@@ -72,7 +73,6 @@ class LogEntriesHandlerTest extends TestCase
->getMock();
$reflectionProperty = new \ReflectionProperty('Monolog\Handler\SocketHandler', 'connectionString');
$reflectionProperty->setAccessible(true);
$reflectionProperty->setValue($this->handler, 'localhost:1234');
$this->handler->expects($this->any())

2
tests/Monolog/Handler/LogmaticHandlerTest.php
View File

@@ -32,6 +32,7 @@ class LogmaticHandlerTest extends TestCase
parent::tearDown();
unset($this->res);
unset($this->handler);
}
public function testWriteContent()
@@ -72,7 +73,6 @@ class LogmaticHandlerTest extends TestCase
->getMock();
$reflectionProperty = new \ReflectionProperty('Monolog\Handler\SocketHandler', 'connectionString');
$reflectionProperty->setAccessible(true);
$reflectionProperty->setValue($this->handler, 'localhost:1234');
$this->handler->expects($this->any())

16
tests/Monolog/Handler/PHPConsoleHandlerTest.php
View File

@@ -21,6 +21,7 @@ use PhpConsole\Dispatcher\Debug as DebugDispatcher;
use PhpConsole\Dispatcher\Errors as ErrorDispatcher;
use PhpConsole\Handler as VendorPhpConsoleHandler;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\WithoutErrorHandler;
use PHPUnit\Framework\MockObject\MockObject;
/**
@@ -169,6 +170,7 @@ class PHPConsoleHandlerTest extends TestCase
}
}
#[WithoutErrorHandler]
public function testError($classesPartialsTraceIgnore = null)
{
$code = E_USER_NOTICE;
@@ -182,10 +184,12 @@ class PHPConsoleHandlerTest extends TestCase
$this->equalTo($line),
$classesPartialsTraceIgnore ?: $this->equalTo($this->getHandlerDefaultOption('classesPartialsTraceIgnore'))
);
$errorHandler = ErrorHandler::register($this->initLogger($classesPartialsTraceIgnore ? ['classesPartialsTraceIgnore' => $classesPartialsTraceIgnore] : []), false);
$errorHandler = ErrorHandler::register($this->initLogger($classesPartialsTraceIgnore ? ['classesPartialsTraceIgnore' => $classesPartialsTraceIgnore] : []), false, false);
$errorHandler->registerErrorHandler([], false, E_USER_WARNING);
$reflMethod = new \ReflectionMethod($errorHandler, 'handleError');
$reflMethod->invoke($errorHandler, $code, $message, $file, $line);
restore_error_handler();
}
public function testException()
@@ -215,11 +219,6 @@ class PHPConsoleHandlerTest extends TestCase
$this->initLogger(['enabled' => false])->debug('test');
}
public function testOptionClassesPartialsTraceIgnore()
{
$this->testError(['Class', 'Namespace\\']);
}
public function testOptionDebugTagsKeysInContext()
{
$this->testDebugTags(['key1', 'key2']);
@@ -232,6 +231,11 @@ class PHPConsoleHandlerTest extends TestCase
}));
$this->assertEquals([VendorPhpConsoleHandler::getInstance(), 'handleException'], set_exception_handler(function () {
}));
restore_exception_handler();
restore_error_handler();
restore_exception_handler();
restore_error_handler();
}
public static function provideConnectorMethodsOptionsSets()

5
tests/Monolog/Handler/ProcessHandlerTest.php
View File

@@ -22,7 +22,7 @@ class ProcessHandlerTest extends TestCase
*
* @var string
*/
const DUMMY_COMMAND = 'echo';
const DUMMY_COMMAND = 'php -r "echo fgets(STDIN);"';
/**
* @covers Monolog\Handler\ProcessHandler::__construct
@@ -42,7 +42,6 @@ class ProcessHandlerTest extends TestCase
$mockBuilder = $this->getMockBuilder('Monolog\Handler\ProcessHandler');
$mockBuilder->onlyMethods(['writeProcessInput']);
// using echo as command, as it is most probably available
$mockBuilder->setConstructorArgs([self::DUMMY_COMMAND]);
$handler = $mockBuilder->getMock();
@@ -163,7 +162,6 @@ class ProcessHandlerTest extends TestCase
{
$mockBuilder = $this->getMockBuilder('Monolog\Handler\ProcessHandler');
$mockBuilder->onlyMethods(['readProcessErrors']);
// using echo as command, as it is most probably available
$mockBuilder->setConstructorArgs([self::DUMMY_COMMAND]);
$handler = $mockBuilder->getMock();
@@ -184,7 +182,6 @@ class ProcessHandlerTest extends TestCase
{
$class = new \ReflectionClass('Monolog\Handler\ProcessHandler');
$property = $class->getProperty('process');
$property->setAccessible(true);
$handler = new ProcessHandler(self::DUMMY_COMMAND);
$handler->handle($this->getRecord(Level::Warning, '21 is only the half truth'));

2
tests/Monolog/Handler/PushoverHandlerTest.php
View File

@@ -32,6 +32,7 @@ class PushoverHandlerTest extends TestCase
parent::tearDown();
unset($this->res);
unset($this->handler);
}
public function testWriteHeader()
@@ -131,7 +132,6 @@ class PushoverHandlerTest extends TestCase
->getMock();
$reflectionProperty = new \ReflectionProperty('Monolog\Handler\SocketHandler', 'connectionString');
$reflectionProperty->setAccessible(true);
$reflectionProperty->setValue($this->handler, 'localhost:1234');
$this->handler->expects($this->any())

2
tests/Monolog/Handler/SlackHandlerTest.php
View File

@@ -42,6 +42,7 @@ class SlackHandlerTest extends TestCase
parent::tearDown();
unset($this->res);
unset($this->handler);
}
public function testWriteHeader()
@@ -139,7 +140,6 @@ class SlackHandlerTest extends TestCase
->getMock();
$reflectionProperty = new \ReflectionProperty('Monolog\Handler\SocketHandler', 'connectionString');
$reflectionProperty->setAccessible(true);
$reflectionProperty->setValue($this->handler, 'localhost:1234');
$this->handler->expects($this->any())

1
tests/Monolog/Handler/SocketHandlerTest.php
View File

@@ -32,6 +32,7 @@ class SocketHandlerTest extends TestCase
parent::tearDown();
unset($this->res);
unset($this->handler);
}
public function testInvalidHostname()

2
tests/Monolog/Handler/StreamHandlerTest.php
View File

@@ -263,7 +263,7 @@ STRING;
#[DataProvider('provideMemoryValues')]
public function testPreventOOMError($phpMemory, $expectedChunkSize): void
{
$previousValue = ini_set('memory_limit', $phpMemory);
$previousValue = @ini_set('memory_limit', $phpMemory);
if ($previousValue === false) {
$this->markTestSkipped('We could not set a memory limit that would trigger the error.');

7
tests/Monolog/Handler/TelegramBotHandlerTest.php
View File

@@ -23,6 +23,13 @@ class TelegramBotHandlerTest extends TestCase
{
private TelegramBotHandler&MockObject $handler;
public function tearDown(): void
{
parent::tearDown();
unset($this->handler);
}
public function testSendTelegramRequest(): void
{
$this->createHandler();

1
tests/Monolog/LoggerTest.php
View File

@@ -743,7 +743,6 @@ class LoggerTest extends TestCase
$getProperty = function ($object, $property) {
$reflectionProperty = new \ReflectionProperty(\get_class($object), $property);
$reflectionProperty->setAccessible(true);
return $reflectionProperty->getValue($object);
};

46
tests/Monolog/Processor/MercurialProcessorTest.php
View File

@@ -15,6 +15,41 @@ use Monolog\Test\TestCase;
class MercurialProcessorTest extends TestCase
{
private string $oldCwd;
private string $testDir;
protected function setUp(): void
{
parent::setUp();
$this->oldCwd = getcwd();
$this->testDir = sys_get_temp_dir().'/monolog-processor-mercurial-test';
mkdir($this->testDir, recursive: true);
chdir($this->testDir);
}
protected function tearDown(): void
{
parent::tearDown();
chdir($this->oldCwd);
if (!file_exists($this->testDir)) {
return;
}
$items = new \RecursiveIteratorIterator(
new \RecursiveDirectoryIterator($this->testDir, \RecursiveDirectoryIterator::SKIP_DOTS),
\RecursiveIteratorIterator::CHILD_FIRST
);
foreach ($items as $item) {
$item->isDir() ? rmdir((string) $item) : unlink((string) $item);
}
rmdir($this->testDir);
}
/**
* @covers Monolog\Processor\MercurialProcessor::__invoke
*/
@@ -31,12 +66,17 @@ class MercurialProcessorTest extends TestCase
return;
}
`hg init`;
exec('hg init');
exec('hg branch default');
touch('test.txt');
exec('hg add test.txt');
exec('hg commit -u foo -m "initial commit"');
$processor = new MercurialProcessor();
$record = $processor($this->getRecord());
$this->assertArrayHasKey('hg', $record->extra);
$this->assertTrue(!\is_array($record->extra['hg']['branch']));
$this->assertTrue(!\is_array($record->extra['hg']['revision']));
$this->assertSame('default', $record->extra['hg']['branch']);
$this->assertSame('0', $record->extra['hg']['revision']);
}
}

30
tests/Monolog/UtilsTest.php
View File

@@ -77,7 +77,6 @@ class UtilsTest extends \PHPUnit_Framework_TestCase
public function testDetectAndCleanUtf8($in, $expect)
{
$reflMethod = new \ReflectionMethod(Utils::class, 'detectAndCleanUtf8');
$reflMethod->setAccessible(true);
$args = [&$in];
$reflMethod->invokeArgs(null, $args);
$this->assertSame($expect, $in);
@@ -102,35 +101,6 @@ class UtilsTest extends \PHPUnit_Framework_TestCase
];
}
#[DataProvider('providesPcreLastErrorMessage')]
public function testPcreLastErrorMessage(int $code, string $msg)
{
if (PHP_VERSION_ID >= 80000) {
$this->assertSame('No error', Utils::pcreLastErrorMessage($code));
return;
}
$this->assertEquals($msg, Utils::pcreLastErrorMessage($code));
}
/**
* @return array[]
*/
public static function providesPcreLastErrorMessage(): array
{
return [
[0, 'PREG_NO_ERROR'],
[1, 'PREG_INTERNAL_ERROR'],
[2, 'PREG_BACKTRACK_LIMIT_ERROR'],
[3, 'PREG_RECURSION_LIMIT_ERROR'],
[4, 'PREG_BAD_UTF8_ERROR'],
[5, 'PREG_BAD_UTF8_OFFSET_ERROR'],
[6, 'PREG_JIT_STACKLIMIT_ERROR'],
[-1, 'UNDEFINED_ERROR'],
];
}
public static function provideIniValuesToConvertToBytes()
{
return [