Skip to content

Report memory-usage while coverage report generation #6421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+39 −6
Open

Report memory-usage while coverage report generation #6421

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 39 additions & 6 deletions src/Runner/CodeCoverage.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
use function sprintf;
use function sys_get_temp_dir;
use PHPUnit\Event\Facade as EventFacade;
use PHPUnit\Event\Telemetry\MemoryMeter;
use PHPUnit\Event\Telemetry\MemoryUsage;
use PHPUnit\Event\Telemetry\SystemMemoryMeter;
use PHPUnit\Framework\TestCase;
use PHPUnit\TextUI\Configuration\CodeCoverageFilterRegistry;
use PHPUnit\TextUI\Configuration\Configuration;
Expand Down Expand Up @@ -52,16 +55,25 @@
*/
final class CodeCoverage
{
/**
* @var array<string,int>
*/
private const array SIZES = [
'GB' => 1073741824,
'MB' => 1048576,
'KB' => 1024,
];
private static ?self $instance = null;
private ?\SebastianBergmann\CodeCoverage\CodeCoverage $codeCoverage = null;

/**
* @phpstan-ignore property.internalClass
*/
private ?Driver $driver = null;
private bool $collecting = false;
private ?TestCase $test = null;
private ?Timer $timer = null;
private ?Driver $driver = null;
private bool $collecting = false;
private ?TestCase $test = null;
private ?Timer $timer = null;
private ?MemoryUsage $memoryStartUsage = null;

public static function instance(): self
{
Expand Down Expand Up @@ -448,6 +460,7 @@ private function codeCoverageGenerationStart(Printer $printer, string $format):
);

$this->timer()->start();
$this->memoryStartUsage = $this->memoryMeter()->memoryUsage();
}

/**
Expand All @@ -457,8 +470,9 @@ private function codeCoverageGenerationSucceeded(Printer $printer): void
{
$printer->print(
sprintf(
"done [%s]\n",
"done [Time: %s, Memory: %s]\n",
$this->timer()->stop()->asString(),
$this->bytesToString($this->memoryMeter()->memoryUsage()->diff($this->memoryStartUsage)->bytes()),
),
);
}
Expand All @@ -470,8 +484,9 @@ private function codeCoverageGenerationFailed(Printer $printer, CodeCoverageExce
{
$printer->print(
sprintf(
"failed [%s]\n%s\n",
"failed [Time: %s, Memory: %s]\n%s\n",
$this->timer()->stop()->asString(),
$this->bytesToString($this->memoryMeter()->memoryUsage()->diff($this->memoryStartUsage)->bytes()),
$e->getMessage(),
),
);
Expand All @@ -485,4 +500,22 @@ private function timer(): Timer

return $this->timer;
}

private function memoryMeter(): MemoryMeter
{
return new SystemMemoryMeter;
}

private function bytesToString(int $bytes): string
{
foreach (self::SIZES as $unit => $value) {
if ($bytes >= $value) {
return sprintf('%.2f %s', $bytes / $value, $unit);
}
}

// @codeCoverageIgnoreStart
return $bytes . ' byte' . ($bytes !== 1 ? 's' : '');
// @codeCoverageIgnoreEnd
}
}