Merge remote-tracking branch 'origin/support/2.7' into support/3.0

# Conflicts:
#	tests/manual-visual-tests/Backoffice/RenderAllUiBlocks.php
#	tests/php-unit-tests/ItopDataTestCase.php
#	tests/php-unit-tests/ItopTestCase.php
#	tests/php-unit-tests/integration-tests/dictionaries-test/fr.dictionary.itop.core.KO.wrong_php
#	tests/php-unit-tests/integration-tests/dictionaries-test/fr.dictionary.itop.core.OK.php
#	tests/php-unit-tests/integration-tests/iTopModulesPhpVersionChecklistTest.php
#	tests/php-unit-tests/integration-tests/iTopXmlVersionChecklistTest.php
#	tests/php-unit-tests/phpunit.xml.dist
#	tests/php-unit-tests/unitary-tests/application/SCSSCompilationTest.php
#	tests/php-unit-tests/unitary-tests/application/Session/SessionTest.php
#	tests/php-unit-tests/unitary-tests/application/ThemeHandlerTest.php
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/DO_NOT_CHANGE.css-variables.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/DO_NOT_CHANGE.light-grey.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/README.md
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/_included_file3.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/cross_reference1.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/cross_reference2.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/feature1/_feature1.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/included_file1.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/included_scss/included_file2.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/included_scss/included_file4.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/multi_imports.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/shortcut.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/shortcut2.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/simple_import.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/simple_import2.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/typography.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/css/ui-lightness/DO_NOT_CHANGE.jqueryui.scss
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/css/ui-lightness/images/ui-bg_diagonals-thick_18_b81900_40x40.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/css/ui-lightness/images/ui-bg_diagonals-thick_20_666666_40x40.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/css/ui-lightness/images/ui-icons_1c94c4_256x240.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/css/ui-lightness/images/ui-icons_222222_256x240.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/css/ui-lightness/images/ui-icons_E87C1E_256x240.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/css/ui-lightness/images/ui-icons_F26522_256x240.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/css/ui-lightness/images/ui-icons_ffd27a_256x240.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/css/ui-lightness/images/ui-icons_ffffff_256x240.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/ac-background.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/actions_right.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/bg.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/breadcrumb-separator.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/calendar.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/delete.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/desc.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/error.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/eye-closed-555.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/eye-closed-fff.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/eye-open-555.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/eye-open-fff.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/full-screen.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/green-header.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/green-square.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/indicator.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/info-mini.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/minus.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/ok.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/orange-header.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/plus.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/red-header.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/truncated.png
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/tv-collapsable-last.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/tv-collapsable.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/tv-expandable-last.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/tv-expandable.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/tv-item-last.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/testimages/images/tv-item.gif
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/themes/basque-red/main.css
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/themes/basque-red/main_imagemodified.css
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/themes/basque-red/main_importmodified.css
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/themes/basque-red/main_stylesheet.css
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/themes/basque-red/main_testcompilethemes.css
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/themes/basque-red/main_varchanged.css
#	tests/php-unit-tests/unitary-tests/application/theme-handler/expected/themes/basque-red/theme-parameters.json
#	tests/php-unit-tests/unitary-tests/application/theme-handler/getimages/expected-getimages.json
#	tests/php-unit-tests/unitary-tests/application/theme-handler/getimages/test-getimages.scss
#	tests/php-unit-tests/unitary-tests/core/ActionEmailTest.php
#	tests/php-unit-tests/unitary-tests/core/AttributeDefTest.inc.php
#	tests/php-unit-tests/unitary-tests/core/AttributeURLDefaultPattern.php
#	tests/php-unit-tests/unitary-tests/core/AttributeURLTest.php
#	tests/php-unit-tests/unitary-tests/core/BulkChangeTest.inc.php
#	tests/php-unit-tests/unitary-tests/core/CSVParserTest.php
#	tests/php-unit-tests/unitary-tests/core/DBObjectTest.php
#	tests/php-unit-tests/unitary-tests/core/DBSearchAddConditionPointingTo.php
#	tests/php-unit-tests/unitary-tests/core/ExpressionEvaluateTest.php
#	tests/php-unit-tests/unitary-tests/core/GetSelectFilterTest.php
#	tests/php-unit-tests/unitary-tests/core/InlineImageTest.php
#	tests/php-unit-tests/unitary-tests/core/Log/ExceptionLogTest.php
#	tests/php-unit-tests/unitary-tests/core/Log/ExceptionLogTest/Exceptions.php
#	tests/php-unit-tests/unitary-tests/core/Log/LogAPITest.php
#	tests/php-unit-tests/unitary-tests/core/Log/LogFileNameBuilderTest.php
#	tests/php-unit-tests/unitary-tests/core/LogAPITest.php
#	tests/php-unit-tests/unitary-tests/core/LogFileNameBuilderTest.php
#	tests/php-unit-tests/unitary-tests/core/MetaModelTest.php
#	tests/php-unit-tests/unitary-tests/core/OQLTest.php
#	tests/php-unit-tests/unitary-tests/core/UniquenessConstraintTest.php
#	tests/php-unit-tests/unitary-tests/core/XMLDataLoaderTest.php
#	tests/php-unit-tests/unitary-tests/core/dictApcuTest.php
#	tests/php-unit-tests/unitary-tests/core/dictTest.php
#	tests/php-unit-tests/unitary-tests/core/ormCaseLogTest.php
#	tests/php-unit-tests/unitary-tests/core/ormPasswordTest.php
#	tests/php-unit-tests/unitary-tests/core/ormStyleTest.php
#	tests/php-unit-tests/unitary-tests/setup/MFCompilerTest.php
#	tests/php-unit-tests/unitary-tests/setup/SubMFCompiler.php
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/1.7_to_1.6.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/1.7_to_1.6.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/1.6_to_1.7_2.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/1.6_to_1.7_2.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/1.7.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/1.7_to_1.6.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/1.7_to_1.6.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/1.7_to_1.6_2.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/1.7_to_1.6_2.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/1.7_to_3.0.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/1.7_to_3.0.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/3.0_to_1.7.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/3.0_to_1.7.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/Bug_4569.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/Bug_4569.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_deleted_to_deleted.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_deleted_to_deleted.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_deleted_to_in-definition.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_deleted_to_in-definition.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_deleted_to_not-in-definition.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_deleted_to_not-in-definition.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_in-definition_to_deleted.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_in-definition_to_deleted.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_in-definition_to_in-definition.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_in-definition_to_in-definition.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_in-definition_to_not-in-definition.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_in-definition_to_not-in-definition.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_not-in-definition_to_deleted.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_not-in-definition_to_deleted.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_not-in-definition_to_in-definition.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_not-in-definition_to_in-definition.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_not-in-definition_to_not-in-definition.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/MoveNode-samples/from_not-in-definition_to_not-in-definition.input.xml
#	tests/php-unit-tests/unitary-tests/setup/ressources/datamodels/datamodel-branding.xml
#	tests/php-unit-tests/unitary-tests/sources/application/Helper/WebResourcesHelperTest.php
#	tests/php-unit-tests/unitary-tests/sources/application/status/StatusIncTest.php
#	tests/php-unit-tests/unitary-tests/sources/application/status/status.php
#	tests/php-unit-tests/unitary-tests/synchro/DataSynchroTest.php
This commit is contained in:
Molkobain
2023-01-10 14:05:32 +01:00
242 changed files with 1249 additions and 584 deletions

View File

@@ -0,0 +1,290 @@
<?php
/*
* Copyright (C) 2013-2021 Combodo SARL
* This file is part of iTop.
* iTop 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.
* iTop 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
*/
namespace Combodo\iTop\Test\UnitTest\Core\Log;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
use ExceptionLog;
require_once(__DIR__.'/ExceptionLogTest/Exceptions.php');
/**
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
* @backupGlobals disabled
*/
class ExceptionLogTest extends ItopDataTestCase
{
protected function setUp(): void
{
require_once(__DIR__.'/ExceptionLogTest/Exceptions.php');
parent::setUp();
}
/**
* @dataProvider logProvider
*/
public function testLogInFile($aLevels, $aExceptions, $sChannel, $aExpectedWriteNumber, $logLevelMin, $aExpectedDbWriteNumber, $logLevelMinWriteInDb)
{
$mockFileLog = $this->createMock('FileLog');
$oMockConfig = $this->createMock('Config');
$oMockConfig
->method("Get")
->willReturnCallback(function ($code) use ($logLevelMin, $logLevelMinWriteInDb) {
switch ($code) {
case 'log_level_min':
if (is_null($logLevelMin))
{
$logLevelMin = '';//this should be the default value, if it did change, please fix it here
}
return $logLevelMin;
case 'log_level_min.write_in_db':
if (is_null($logLevelMinWriteInDb))
{
$logLevelMinWriteInDb = [ 'Exception' => 'Error', ];//this should be the default value, if it did change, please fix it here
}
return $logLevelMinWriteInDb;
}
return '';
});
$aContext = ['contextKey1' => 'value'];
foreach ($aLevels as $i => $sLevel) {
$sExpectedFile = __FILE__;
// @formatter:off
$oException = new $aExceptions[$i]("Iteration number $i"); $sExpectedLine = __LINE__; //Both should remain on the same line
// @formatter:on
$iExpectedWriteNumber = $aExpectedWriteNumber[$i];
$iExpectedDbWriteNumber = $aExpectedDbWriteNumber[$i];
$aExpectedFileContext = array_merge($aContext, [
'exception class' => get_class($oException),
'file' => $sExpectedFile,
'line' => $sExpectedLine,
]
); //The context is preserved, and, if the key 'exception class' is not yet in the array, it is added
$mockFileLog->expects($this->exactly($iExpectedWriteNumber))
->method($sLevel)
->with($oException->GetMessage(), $sChannel, $aExpectedFileContext);
ExceptionLog::MockStaticObjects($mockFileLog, $oMockConfig);
ExceptionLog::LogException($oException, $aContext, $sLevel);
$oExpectedLastEventIssue = $this->InvokeNonPublicStaticMethod('ExceptionLog', 'GetLastEventIssue', []);
if (0 == $iExpectedDbWriteNumber) {
$this->assertNull($oExpectedLastEventIssue);
} else {
$this->assertInstanceOf(\EventIssue::class, $oExpectedLastEventIssue);
$this->assertEquals($aExpectedFileContext, $oExpectedLastEventIssue->Get('data'));
}
}
}
public function logProvider()
{
return [
'use parent' => [
'aLevels' => ['Debug'],
'aExceptions' => [\GrandChildException::class],
'sChannel' => 'Exception',
'aExpectedWriteNumber' => [1],
'logLevelMin' => ['Exception' => 'Debug'],
'iExpectedDbWriteNumber' => [1],
'logLevelMinWriteInDb' => ['Exception' => 'Debug'],
],
'flat configuration' => [
'aLevels' => ['Debug'],
'aExceptions' => [\GrandChildException::class],
'sChannel' => 'GrandChildException',
'aExpectedWriteNumber' => [1],
'logLevelMin' => 'Debug',
'iExpectedDbWriteNumber' => [1],
'logLevelMinWriteInDb' => 'Debug',
],
'Default conf has expected levels' => [
'aLevels' => ['Debug', 'Warning'],
'aExceptions' => [\GrandChildException::class, \GrandChildException::class],
'sChannel' => 'GrandChildException',
'aExpectedWriteNumber' => [0, 1],
'logLevelMin' => null,
'iExpectedDbWriteNumber' => [0, 0],
'logLevelMinWriteInDb' => null,
],
'use correct order in inheritance tree' => [
'aLevels' => ['Trace', 'Debug', 'Info', 'Error'],
'aExceptions' => [\GrandChildException::class, \GrandChildException::class, \GrandChildException::class, \GrandChildException::class],
'sChannel' => 'GrandChildException',
'aExpectedWriteNumber' => [0, 1, 1, 1],
'logLevelMin' => ['ChildException' => 'Error', 'GrandChildException' => 'Debug', ],
'iExpectedDbWriteNumber' => [0, 1, 1, 1],
'logLevelMinWriteInDb' => ['ChildException' => 'Error', 'GrandChildException' => 'Debug', ],
],
'handle namespaced classes' => [
'aLevels' => ['Debug'],
'aExceptions' => [\Namespaced\Exception\ExceptionInNamespace::class],
'sChannel' => 'Namespaced\Exception\ExceptionInNamespace',
'aExpectedWriteNumber' => [1],
'logLevelMin' => ['Namespaced\Exception\ExceptionInNamespace' => 'Debug'],
'iExpectedDbWriteNumber' => [1],
'logLevelMinWriteInDb' => ['Namespaced\Exception\ExceptionInNamespace' => 'Debug'],
],
'not enabled by default' => [
'aLevels' => ['Debug'],
'aExceptions' => [\Exception::class],
'sChannel' => 'Exception',
'aExpectedWriteNumber' => [0],
'logLevelMin' => null,
'iExpectedDbWriteNumber' => [0],
'logLevelMinWriteInDb' => null,
],
'explicitly disabled' => [
'aLevels' => ['Info'],
'aExceptions' => [\Exception::class],
'sChannel' => 'Exception',
'aExpectedWriteNumber' => [0],
'logLevelMin' => ['Exception' => false],
'iExpectedDbWriteNumber' => [0],
'logLevelMinWriteInDb' => ['Exception' => false],
],
'default channel, default conf' => [
'aLevels' => ['Warning'],
'aExceptions' => [\Exception::class],
'sChannel' => 'Exception',
'aExpectedWriteNumber' => [1],
'logLevelMin' => null,
'iExpectedDbWriteNumber' => [0],
'logLevelMinWriteInDb' => null,
],
'enabled' => [
'aLevels' => ['Debug'],
'aExceptions' => [\Exception::class],
'sChannel' => 'Exception',
'aExpectedWriteNumber' => [1],
'logLevelMin' => ['Exception' => 'Debug'],
'iExpectedDbWriteNumber' => [1],
'logLevelMinWriteInDb' => ['Exception' => 'Debug'],
],
'file: 2 enabled, 2 filtered, db: 1 enabled, 3 filtered' => [
'aLevels' => ['Debug', 'Trace', 'Warning', 'Error'],
'aExceptions' => [\Exception::class, \Exception::class, \Exception::class, \Exception::class],
'sChannel' => 'Exception',
'aExpectedWriteNumber' => [0, 0, 1, 1],
'logLevelMin' => null,
'iExpectedDbWriteNumber' => [0, 0, 0, 1],
'logLevelMinWriteInDb' => null,
],
'Simple Error (testing Throwable signature)' => [
'aLevels' => ['Debug'],
'aExceptions' => [\Error::class],
'sChannel' => 'Error',
'aExpectedWriteNumber' => [1],
'logLevelMin' => 'Debug',
'iExpectedDbWriteNumber' => [1],
'logLevelMinWriteInDb' => 'Debug',
],
"use '' to enable all" => [
'aLevels' => ['Debug'],
'aExceptions' => [\GrandChildException::class, \Exception::class],
'sChannel' => 'GrandChildException',
'aExpectedWriteNumber' => [1, 1],
'logLevelMin' => ['' => 'Debug'],
'iExpectedDbWriteNumber' => [1, 1],
'logLevelMinWriteInDb' => ['' => 'Debug'],
],
];
}
/**
* @dataProvider exceptionClassProvider
*/
public function testExceptionClassFromHierarchy($aLogConfig, $sActualExceptionClass, $sExpectedExceptionClass)
{
$oMockConfig = $this->createMock('Config');
$oMockConfig
->method('Get')
->willReturn($aLogConfig);
ExceptionLog::MockStaticObjects(null, $oMockConfig);
$sReturnedExceptionClass = $this->InvokeNonPublicStaticMethod(ExceptionLog::class, 'ExceptionClassFromHierarchy', [$sActualExceptionClass]);
static::assertEquals($sExpectedExceptionClass, $sReturnedExceptionClass, 'Not getting correct exception in hierarchy !');
}
public function exceptionClassProvider()
{
// WARNING : cannot use Exception::class or LogAPI constants for levels :/
return [
'Exception, defined in config' => [
'aLogConfig' => ['Exception' => 'Debug'],
'sActualExceptionClass' => 'Exception',
'sExpectedExceptionClass' => 'Exception',
],
'Child of Exception, Exception defined in config' => [
'aLogConfig' => ['Exception' => 'Debug'],
'sActualExceptionClass' => 'ChildException',
'sExpectedExceptionClass' => 'Exception',
],
'Grand child of Exception, Exception defined in config' => [
'aLogConfig' => ['Exception' => 'Debug'],
'sActualExceptionClass' => 'GrandChildException',
'sExpectedExceptionClass' => 'Exception',
],
'Exception, just a default level defined in config' => [
'aLogConfig' => 'Debug',
'sActualExceptionClass' => 'Exception',
'sExpectedExceptionClass' => null,
],
'Exception, no exception class defined in config' => [
'aLogConfig' => ['IssueLog' => 'Debug'],
'sActualExceptionClass' => 'Exception',
'sExpectedExceptionClass' => null,
],
'Exception, just the child defined in config' => [
'aLogConfig' => ['ChildException' => 'Debug'],
'sActualExceptionClass' => 'Exception',
'sExpectedExceptionClass' => null,
],
'Exception, Exception and the child defined in config' => [
'aLogConfig' => ['Exception' => 'Debug', 'ChildException' => 'Debug'],
'sActualExceptionClass' => 'Exception',
'sExpectedExceptionClass' => 'Exception',
],
];
}
public function testGetLevelDefault()
{
$resultDb = $this->InvokeNonPublicStaticMethod(\ExceptionLog::class, 'GetLevelDefault', [\ExceptionLog::ENUM_CONFIG_PARAM_DB]);
$resultFile = $this->InvokeNonPublicStaticMethod(\ExceptionLog::class, 'GetLevelDefault', [\ExceptionLog::ENUM_CONFIG_PARAM_FILE]);
$resultFilePerDefaultWhenKeyNotFound = $this->InvokeNonPublicStaticMethod(\ExceptionLog::class, 'GetLevelDefault', ['foo']);
$this->assertEquals(false, $resultDb);
$this->assertEquals('Ok', $resultFile);
$this->assertEquals('Ok', $resultFilePerDefaultWhenKeyNotFound);
}
}

View File

@@ -0,0 +1,23 @@
<?php
/*
* Copyright (C) 2013-2021 Combodo SARL
* This file is part of iTop.
* iTop 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.
* iTop 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
*/
namespace {
class ChildException extends Exception {};
class GrandChildException extends ChildException {};
}
namespace Namespaced\Exception {
class ExceptionInNamespace extends \ChildException {}
}

View File

@@ -0,0 +1,192 @@
<?php
/*
* @copyright Copyright (C) 2010-2021 Combodo SARL
* @license http://opensource.org/licenses/AGPL-3.0
*/
/**
* Created by PhpStorm.
* User: Eric
* Date: 31/08/2018
* Time: 17:03
*/
namespace Combodo\iTop\Test\UnitTest\Core\Log;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
/**
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
* @backupGlobals disabled
*/
class LogAPITest extends ItopDataTestCase
{
private $mockFileLog;
private $oMetaModelConfig;
protected function setUp():void
{
parent::setUp();
$this->mockFileLog = $this->createMock('FileLog');
$this->oMetaModelConfig = $this->createMock('Config');
}
/**
* @dataProvider LogApiProvider
* @test
* @backupGlobals disabled
*/
public function TestLogApi($oConfigObject, $sMessage, $Channel, $sExpectedLevel, $sExpectedMessage, $sExpectedChannel = '')
{
\IssueLog::MockStaticObjects($this->mockFileLog, $oConfigObject);
$this->mockFileLog->expects($this->exactly(1))
->method($sExpectedLevel)
->with($sExpectedMessage, $sExpectedChannel);
\IssueLog::Error($sMessage, $Channel);
}
public function LogApiProvider()
{
return [
[$this->oMetaModelConfig, "log msg", '', "Error", "log msg"],
[$this->oMetaModelConfig, "log msg", 'PoudlardChannel', "Error", "log msg", 'PoudlardChannel'],
[null, "log msg", '', "Error", "log msg"],
];
}
/**
* @dataProvider LogWarningWithASpecificChannelProvider
* @test
* @backupGlobals disabled
*/
public function TestLogWarningWithASpecificChannel($expectedCallNb, $sExpectedLevel, $ConfigReturnedObject, $bExceptionRaised=false)
{
$this->oMetaModelConfig
->method("Get")
->willReturnMap([
[\LogAPI::ENUM_CONFIG_PARAM_FILE, $ConfigReturnedObject],
[\LogAPI::ENUM_CONFIG_PARAM_DB, $ConfigReturnedObject],
]);
\IssueLog::MockStaticObjects($this->mockFileLog, $this->oMetaModelConfig);
$this->mockFileLog->expects($this->exactly($expectedCallNb))
->method($sExpectedLevel)
->with("log msg", "GaBuZoMeuChannel");
try{
\IssueLog::Warning("log msg", "GaBuZoMeuChannel");
if ($bExceptionRaised) {
$this->fail("raised should have been raised");
}
}
catch(\Exception $e) {
if (!$bExceptionRaised) {
$this->fail("raised should NOT have been raised");
}
}
}
public function LogWarningWithASpecificChannelProvider()
{
return [
"empty config" => [ 0, "Ok", ''],
"Default Unknown Level" => [ 0, "Ok", 'TotoLevel', true],
"Info as Default Level" => [ 1 , "Warning", 'Info'],
"Error as Default Level" => [ 0, "Warning", 'Error'],
"Empty array" => [ 0, "Ok", array()],
"Channel configured on an undefined level" => [ 0, "Ok", ["GaBuZoMeuChannel" => "TotoLevel"], true],
"Channel defined with Error" => [ 0, "Warning", ["GaBuZoMeuChannel" => "Error"]],
"Channel defined with Info" => [ 1, "Warning", ["GaBuZoMeuChannel" => "Info"]],
];
}
/**
* @dataProvider LogOkWithASpecificChannel
* @test
* @backupGlobals disabled
*/
public function TestLogOkWithASpecificChannel($expectedCallNb, $sExpectedLevel, $ConfigReturnedObject, $bExceptionRaised=false)
{
$this->oMetaModelConfig
->method("Get")
->willReturnMap([
[\LogAPI::ENUM_CONFIG_PARAM_FILE, $ConfigReturnedObject],
[\LogAPI::ENUM_CONFIG_PARAM_DB, $ConfigReturnedObject],
]);
\IssueLog::MockStaticObjects($this->mockFileLog, $this->oMetaModelConfig);
$this->mockFileLog->expects($this->exactly($expectedCallNb))
->method($sExpectedLevel)
->with("log msg", "GaBuZoMeuChannel");
try {
\IssueLog::Ok("log msg", "GaBuZoMeuChannel");
if ($bExceptionRaised) {
$this->fail("raised should have been raised");
}
}
catch (\Exception $e) {
if (!$bExceptionRaised) {
$this->fail("raised should NOT have been raised");
}
}
}
public function LogOkWithASpecificChannel()
{
return [
"empty config" => [1, "Ok", ''],
"Empty array" => [1, "Ok", array()],
];
}
/**
* Tests that we are creating a valid object, with all its mandatory fields set !
*
* @throws \CoreException
*/
public function testGetEventIssue(): void
{
$oEventIssue = $this->InvokeNonPublicStaticMethod(\LogAPI::class, 'GetEventIssue', [
'My message',
\LogChannels::CORE,
['context' => 'hop'],
]);
// Finding mandatory fields in EventIssue class
$aEventIssueAllAttributes = \MetaModel::ListAttributeDefs(\EventIssue::class);
$aEventIssueMandatoryAttributes = array_filter($aEventIssueAllAttributes, static function ($oAttDef, $sAttCode) {
if (false === $oAttDef->IsNullAllowed()) {
return $oAttDef;
}
}, ARRAY_FILTER_USE_BOTH);
// remove fields set in the OnInsert method
unset($aEventIssueMandatoryAttributes['page']);
foreach ($aEventIssueMandatoryAttributes as $sAttCode => $oAttDef) {
$this->assertNotEmpty($oEventIssue->Get($sAttCode), "In the EventIssue instance returned by LogAPI the '$sAttCode' mandatory attr is empty :(");
}
}
public function testGetLevelDefault()
{
$resultDb = $this->InvokeNonPublicStaticMethod(\LogAPI::class, 'GetLevelDefault', [\LogAPI::ENUM_CONFIG_PARAM_DB]);
$resultFile = $this->InvokeNonPublicStaticMethod(\LogAPI::class, 'GetLevelDefault', [\LogAPI::ENUM_CONFIG_PARAM_FILE]);
$resultFilePerDefaultWhenKeyNotFound = $this->InvokeNonPublicStaticMethod(\LogAPI::class, 'GetLevelDefault', ['foo']);
$this->assertEquals(false, $resultDb);
$this->assertEquals('Ok', $resultFile);
$this->assertEquals('Ok', $resultFilePerDefaultWhenKeyNotFound);
}
}

View File

@@ -0,0 +1,163 @@
<?php
/*
* @copyright Copyright (C) 2010-2021 Combodo SARL
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\Test\UnitTest\Core\Log;
use Combodo\iTop\Test\UnitTest\ItopTestCase;
use DailyRotatingLogFileNameBuilder;
use DateTime;
class LogFileNameBuilderTest extends ItopTestCase
{
const TEST_LOGFILE_PREFIX = 'fileNameBuilder.test';
const TEST_LOGFILE_EXTENSION = 'log';
/**
* @param $sLogFile
* @param \DateTime $oNewModificationDate
*
* @uses \clearstatcache() if not called, the next filemtime() call will return the PHP cached date instead of the real one
*/
private function ChangeFileModificationDate($sLogFile, DateTime $oNewModificationDate)
{
touch($sLogFile, $oNewModificationDate->getTimestamp());
clearstatcache(true, $sLogFile);
}
protected function setUp(): void
{
parent::setUp();
require_once APPROOT.'core/log.class.inc.php';
}
protected function tearDown(): void
{
parent::tearDown();
// remove log files created in the test
$aTestLogFiles = glob(__DIR__.DIRECTORY_SEPARATOR.self::TEST_LOGFILE_PREFIX.'*.'.self::TEST_LOGFILE_EXTENSION);
foreach ($aTestLogFiles as $sLogFile) {
unlink($sLogFile);
}
}
public function testCheckAndRotateLogFile()
{
$sLogFile = __DIR__.DIRECTORY_SEPARATOR.self::TEST_LOGFILE_PREFIX.'.'.self::TEST_LOGFILE_EXTENSION;
$oFileBuilder = new DailyRotatingLogFileNameBuilder($sLogFile);
if (file_exists($sLogFile))
{
unlink($sLogFile);
}
$bIsFileExists = $oFileBuilder->IsLogFileExists();
$this->assertFalse($bIsFileExists, 'Test log file does not exist');
$hLogFile = fopen($sLogFile, 'a');
$sDate = date('Y-m-d H:i:s');
$sTestClassName = self::class;
fwrite($hLogFile, "$sDate | This is a line generated by $sTestClassName\n");
fclose($hLogFile);
$iLogDateLastModifiedTimeStamp = filemtime($sLogFile);
$oLogFileLastModified = DateTime::createFromFormat('U', $iLogDateLastModifiedTimeStamp);
$sRotatedLogFile = $oFileBuilder->GetRotatedFileName($oLogFileLastModified);
$oFileBuilder->CheckAndRotateLogFile();
$this->assertFileExists($sLogFile, 'Test log file modification date is today, original file still exists after rotation call');
$this->assertFileNotExists($sRotatedLogFile, 'No rotation occurred yet');
$oTimeYesterday = new DateTime('yesterday');
$sRotatedLogFile = $oFileBuilder->GetRotatedFileName($oTimeYesterday);
$this->ChangeFileModificationDate($sLogFile, $oTimeYesterday);
// changing modification date, but do not reset cached filebuilder date => no change
$oFileBuilder->CheckAndRotateLogFile();
$this->assertFileExists($sLogFile, 'Test log file modification date is yesterday but filebuilder use its cache, original file still exists after rotation call');
$this->assertFileNotExists($sRotatedLogFile, 'No rotation occurred yet');
// changing modification date AND resetting filebuilder date cache
$oFileBuilder->ResetLastModifiedDateForFile();
$oFileBuilder->CheckAndRotateLogFile();
$this->assertFileNotExists($sLogFile, 'Test log file modification date is yesterday, file rotated !');
$this->assertFileExists($sRotatedLogFile, 'Rotation was not done');
// file cleanup will be done in tearDown !
}
public function ShouldRotateProvider()
{
return array(
'DAILY Same day' => array('DailyRotatingLogFileNameBuilder', '2020-02-01 00:00', '2020-02-01 15:42', false),
'DAILY Same week, different day less 24h diff' => array('DailyRotatingLogFileNameBuilder', '2020-02-01 12:00', '2020-02-02 09:00', true),
'DAILY Same week, different day' => array('DailyRotatingLogFileNameBuilder', '2020-02-01 00:00', '2020-02-02 00:00', true),
'DAILY 1 week diff' => array('DailyRotatingLogFileNameBuilder', '2020-02-01 00:00', '2020-02-08 00:00', true),
'WEEKLY Same week' => array('WeeklyRotatingLogFileNameBuilder', '2020-02-01 00:00', '2020-02-01 00:00', false),
'WEEKLY 1 week diff, same month' => array('WeeklyRotatingLogFileNameBuilder', '2020-02-01 00:00', '2020-02-08 00:00', true),
'WEEKLY 2 weeks diff, same month' => array('WeeklyRotatingLogFileNameBuilder', '2020-02-01 00:00', '2020-02-15 00:00', true),
'WEEKLY 1 week diff, different month' => array('WeeklyRotatingLogFileNameBuilder', '2020-01-27 00:00', '2020-02-03 00:00', true),
'WEEKLY same week, different month' => array('WeeklyRotatingLogFileNameBuilder', '2020-01-27 00:00', '2020-02-02 00:00', false),
'WEEKLY 1 week diff, different year' => array('WeeklyRotatingLogFileNameBuilder', '2019-12-30 00:00', '2020-01-06 00:00', true),
'WEEKLY same week, different year' => array('WeeklyRotatingLogFileNameBuilder', '2019-12-30 00:00', '2020-01-05 00:00', true),
'MONTHLY same month' => array('MonthlyRotatingLogFileNameBuilder', '2020-02-10 00:00', '2020-02-14 00:00', false),
'MONTHLY on first day which is a sunday' => array('MonthlyRotatingLogFileNameBuilder', '2020-01-30 00:00', '2020-02-01 00:00', true),
);
}
/**
* @param string $sFileNameBuilderClass RotatingLogFileNameBuilder impl
* @param string $sDateModified format Y-m-d H:i
* @param string $sDateNow format Y-m-d H:i
* @param bool $bExpected
*
* @dataProvider ShouldRotateProvider
*/
public function testShouldRotate($sFileNameBuilderClass, $sDateModified, $sDateNow, $bExpected)
{
$oDateModified = DateTime::createFromFormat('Y-m-d H:i', $sDateModified);
$oDateNow = DateTime::createFromFormat('Y-m-d H:i', $sDateNow);
/** @var \RotatingLogFileNameBuilder $oFileBuilder */
$oFileBuilder = new $sFileNameBuilderClass();
$bShouldRotate = $oFileBuilder->ShouldRotate($oDateModified, $oDateNow);
$this->assertEquals($bExpected, $bShouldRotate);
}
public function CronNextOccurrenceProvider()
{
return array(
'DAILY morning' => array('DailyRotatingLogFileNameBuilder', '2020-02-01 05:00', '2020-02-02 00:00'),
'DAILY midnight' => array('DailyRotatingLogFileNameBuilder', '2020-02-01 00:00', '2020-02-02 00:00'),
'WEEKLY monday 12:42' => array('WeeklyRotatingLogFileNameBuilder', '2020-02-03 12:42', '2020-02-10 00:00'),
'WEEKLY monday 00:00' => array('WeeklyRotatingLogFileNameBuilder', '2020-02-03 00:00', '2020-02-10 00:00'),
'WEEKLY tuesday 12:42' => array('WeeklyRotatingLogFileNameBuilder', '2020-02-04 12:42', '2020-02-10 00:00'),
'WEEKLY sunday 12:42' => array('WeeklyRotatingLogFileNameBuilder', '2020-02-02 12:42', '2020-02-03 00:00'),
'MONTHLY 12/02 12:42' => array('MonthlyRotatingLogFileNameBuilder', '2020-02-12 12:42', '2020-03-01 00:00'),
);
}
/**
* @param string $sFileNameBuilderClass RotatingLogFileNameBuilder impl
* @param string $sDateNow format Y-m-d H:i
* @param string $sExpectedOccurrence format Y-m-d H:i
*
* @dataProvider CronNextOccurrenceProvider
*/
public function testCronNextOccurrence($sFileNameBuilderClass, $sDateNow, $sExpectedOccurrence)
{
$oDateNow = DateTime::createFromFormat('Y-m-d H:i', $sDateNow);
/** @var \RotatingLogFileNameBuilder $oFileBuilder */
$oFileBuilder = new $sFileNameBuilderClass();
$oActualOccurrence = $oFileBuilder->GetCronProcessNextOccurrence($oDateNow);
$sActualOccurrence = $oActualOccurrence->format('Y-m-d H:i');
$this->assertEquals($sExpectedOccurrence, $sActualOccurrence);
}
}