Wavyzz/dolibarr-fork
2
0
Fork 0
forked from Wavyzz/dolibarr
Code Pull Requests Activity

Qual: Improve logging on phpunit error by limiting to new log lines (#28575)

Browse Source 
# Qual: Improve logging on phpunit error by limiting to new log lines

Log only the new files since the start of the failed test within the limit
of the number of requested lines.

To do this, the log file size is recorded in setUp() to show only the data
beyond this limit on error.
This commit is contained in:
MDW
2024-03-02 12:42:20 +01:00
committed by GitHub
parent b131013c82
commit 2a52a35dc1
1 changed files with 38 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
test/phpunit/CommonClassTest.class.php
View File

@@ -60,6 +60,16 @@ abstract class CommonClassTest extends TestCase
*/
public $nbLinesToShow = 100;
/**
* Log file from which to extract lines in case of failing test
*/
public $logfile = DOL_DATA_ROOT.'/dolibarr.log';
/**
* Log file size before a test started (=in setUp() call)
*/
public $logSizeAtSetup = 0;
/**
* Constructor
* We save global variables into local variables
@@ -108,15 +118,25 @@ abstract class CommonClassTest extends TestCase
*/
protected function onNotSuccessfulTest(Throwable $t): void
{
$logfile = DOL_DATA_ROOT.'/dolibarr.log';
$lines = file($logfile);
// Get the lines that were added since the start of the test
$filecontent = (string) @file_get_contents($this->logfile);
$currentSize = strlen($filecontent);
if ($currentSize >= $this->logSizeAtSetup) {
$filecontent = substr($filecontent, $this->logSizeAtSetup);
}
$lines = preg_split("/\r?\n/", $filecontent, -1, PREG_SPLIT_NO_EMPTY);
// Determine the number of lines to show
$nbLinesToShow = $this->nbLinesToShow;
if ($t instanceof PHPUnit\Framework\Error\Notice) {
$nbLinesToShow = 3;
}
// Determine test information to show
$failedTestMethod = $this->getName(false);
$className = get_called_class();
@@ -132,18 +152,26 @@ abstract class CommonClassTest extends TestCase
// Get the last line of the log
$last_lines = array_slice($lines, $first_line, $nbLinesToShow);
// Show log information
print PHP_EOL;
// Use GitHub Action compatible group output (:warning: arguments not encoded)
print "##[group]$className::$failedTestMethod failed - $argsText.".PHP_EOL;
print "## Exception: {$t->getMessage()}".PHP_EOL;
if ($nbLinesToShow) {
// Show partial log file contents when requested.
print "## Show last ".$nbLinesToShow." lines of dolibarr.log file -----".PHP_EOL;
foreach ($last_lines as $line) {
print $line.PHP_EOL;
$newLines = count($last_lines);
if ($newLines > 0) {
// Show partial log file contents when requested.
print "## Show last ".count($last_lines)." lines of dolibarr.log file -----".PHP_EOL;
foreach ($last_lines as $line) {
print $line.PHP_EOL;
}
print "## end of dolibarr.log for $className::$failedTestMethod".PHP_EOL;
} else {
print "## No new lines in 'dolibarr.log' since start of this test.".PHP_EOL;
}
print "## end of dolibarr.log for $className::$failedTestMethod".PHP_EOL;
}
print "##[endgroup]".PHP_EOL;
@@ -164,6 +192,9 @@ abstract class CommonClassTest extends TestCase
$langs = $this->savlangs;
$db = $this->savdb;
// Record the filesize to determine which part of the log to show on error
$this->logSizeAtSetup = (int) filesize($this->logfile);
if ((int) getenv('PHPUNIT_DEBUG') > 0) {
print get_called_class().'::'.$this->getName(false)."::".__FUNCTION__.PHP_EOL;
}