composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-20 17:18:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

N°8796 - Add PHP code style validation in iTop and extensions - format whole code base

Browse Source
This commit is contained in:
odain
2025-11-07 15:39:53 +01:00
parent 12f23113f5
commit 890a2568c8
2110 changed files with 53099 additions and 63885 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
tests/php-unit-tests/unitary-tests/core/DBObject/CMDBObjectTest.php
View File

@@ -2,21 +2,18 @@
namespace Combodo\iTop\Test\UnitTest\Core;
use CMDBObject;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
use CoreException;
use Exception;
use MetaModel;
/**
* @since 2.7.7 3.0.2 3.1.0 N°3717 tests history objects creation
*
* @package Combodo\iTop\Test\UnitTest\Core
*/
class CMDBObjectTest extends ItopDataTestCase
{
private $sAdminLogin;
@@ -51,8 +48,11 @@ class CMDBObjectTest extends ItopDataTestCase
$oTestObject->Set('url', 'https://www.combodo.com');
$oTestObject->DBWrite();
self::assertFalse(CMDBObject::GetCurrentChange()->IsNew(), 'TrackInfo : Current change persisted');
self::assertEquals($sTrackInfo, CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : current change created with expected trackinfo');
self::assertEquals(
$sTrackInfo,
CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : current change created with expected trackinfo'
);
//-- new object with non persisted current change
$sTrackInfo2 = $sTrackInfo.'_2';
@@ -64,8 +64,11 @@ class CMDBObjectTest extends ItopDataTestCase
$oTestObject->Set('url', 'https://fr.wikipedia.org');
$oTestObject->DBUpdate();
self::assertFalse(CMDBObject::GetCurrentChange()->IsNew(), 'SetCurrentChange : Current change persisted');
self::assertEquals($sTrackInfo2, CMDBObject::GetCurrentChange()->Get('userinfo'),
'SetCurrentChange : current change created with expected trackinfo');
self::assertEquals(
$sTrackInfo2,
CMDBObject::GetCurrentChange()->Get('userinfo'),
'SetCurrentChange : current change created with expected trackinfo'
);
//-- new object with current change init using helper method
$sTrackInfo3 = $sTrackInfo.'_3';
@@ -73,8 +76,11 @@ class CMDBObjectTest extends ItopDataTestCase
$oTestObject->Set('url', 'https://en.wikipedia.org');
$oTestObject->DBUpdate();
self::assertFalse(CMDBObject::GetCurrentChange()->IsNew(), 'SetCurrentChangeFromParams : Current change persisted');
self::assertEquals($sTrackInfo3, CMDBObject::GetCurrentChange()->Get('userinfo'),
'SetCurrentChangeFromParams : current change created with expected trackinfo');
self::assertEquals(
$sTrackInfo3,
CMDBObject::GetCurrentChange()->Get('userinfo'),
'SetCurrentChangeFromParams : current change created with expected trackinfo'
);
// restore initial conditions
$oTestObject->DBDelete();
@@ -82,7 +88,8 @@ class CMDBObjectTest extends ItopDataTestCase
CMDBObject::SetTrackInfo($sInitialTrackInfo);
}
public function CurrentChangeUnderImpersonationProvider(){
public function CurrentChangeUnderImpersonationProvider()
{
return [
'no track info' => [ 'sTrackInfo' => null ],
'track info from approvalbase' => [
@@ -99,7 +106,8 @@ class CMDBObjectTest extends ItopDataTestCase
* @runInSeparateProcess
* @dataProvider CurrentChangeUnderImpersonationProvider
*/
public function testCurrentChangeUnderImpersonation($sTrackInfo=null, $sExpectedChangeLogWhenImpersonation=null) {
public function testCurrentChangeUnderImpersonation($sTrackInfo = null, $sExpectedChangeLogWhenImpersonation = null)
{
$this->CreateTestOrganization();
$sUid = date('dmYHis');
@@ -119,7 +127,7 @@ class CMDBObjectTest extends ItopDataTestCase
// reset current change
CMDBObject::SetCurrentChange(null);
if (is_null($sTrackInfo)){
if (is_null($sTrackInfo)) {
CMDBObject::SetTrackInfo(null);
} else {
$sTrackInfo = $this->ReplaceByFriendlyNames($sTrackInfo, $oAdminUser, $oImpersonatedUser);
@@ -127,43 +135,70 @@ class CMDBObjectTest extends ItopDataTestCase
}
$this->CreateSimpleObject();
if (is_null($sTrackInfo)){
self::assertEquals($oAdminUser->GetFriendlyName(), CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : no impersonation');
if (is_null($sTrackInfo)) {
self::assertEquals(
$oAdminUser->GetFriendlyName(),
CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : no impersonation'
);
} else {
self::assertEquals($sTrackInfo, CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : no impersonation');
self::assertEquals(
$sTrackInfo,
CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : no impersonation'
);
}
self::assertEquals($oAdminUser->GetKey(), CMDBObject::GetCurrentChange()->Get('user_id'),
'TrackInfo : admin userid');
self::assertEquals(
$oAdminUser->GetKey(),
CMDBObject::GetCurrentChange()->Get('user_id'),
'TrackInfo : admin userid'
);
\UserRights::Impersonate($sImpersonatedLogin);
$this->CreateSimpleObject();
if (is_null($sExpectedChangeLogWhenImpersonation)){
if (is_null($sExpectedChangeLogWhenImpersonation)) {
$sExpectedMsg = $this->ReplaceByFriendlyNames("AdminSurName AdminName on behalf of ImpersonatedSurName ImpersonatedName", $oAdminUser, $oImpersonatedUser);
self::assertEquals($sExpectedMsg, CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : impersonation');
self::assertEquals(
$sExpectedMsg,
CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : impersonation'
);
} else {
$sExpectedMsg = $this->ReplaceByFriendlyNames($sExpectedChangeLogWhenImpersonation, $oAdminUser, $oImpersonatedUser);
self::assertEquals($sExpectedMsg, CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : impersonation');
self::assertEquals(
$sExpectedMsg,
CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : impersonation'
);
}
self::assertEquals(null, CMDBObject::GetCurrentChange()->Get('user_id'),
'TrackInfo : no userid to force userinfo being displayed on UI caselog side');
self::assertEquals(
null,
CMDBObject::GetCurrentChange()->Get('user_id'),
'TrackInfo : no userid to force userinfo being displayed on UI caselog side'
);
\UserRights::Deimpersonate();
$this->CreateSimpleObject();
if (is_null($sTrackInfo)){
self::assertEquals($oAdminUser->GetFriendlyName(), CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : no impersonation');
if (is_null($sTrackInfo)) {
self::assertEquals(
$oAdminUser->GetFriendlyName(),
CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : no impersonation'
);
} else {
self::assertEquals($sTrackInfo, CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : no impersonation');
self::assertEquals(
$sTrackInfo,
CMDBObject::GetCurrentChange()->Get('userinfo'),
'TrackInfo : no impersonation'
);
}
self::assertEquals($oAdminUser->GetKey(), CMDBObject::GetCurrentChange()->Get('user_id'),
'TrackInfo : admin userid');
self::assertEquals(
$oAdminUser->GetKey(),
CMDBObject::GetCurrentChange()->Get('user_id'),
'TrackInfo : admin userid'
);
// restore initial conditions
CMDBObject::SetCurrentChange($oInitialCurrentChange);
@@ -196,7 +231,7 @@ class CMDBObjectTest extends ItopDataTestCase
* @dataProvider RecordObjDeletionProvider
*
*/
public function testRecordObjDeletion( string $sFirstName, string $sName)
public function testRecordObjDeletion(string $sFirstName, string $sName)
{
$oPerson = MetaModel::NewObject('Person', [
'first_name' => $sFirstName,
@@ -208,39 +243,40 @@ class CMDBObjectTest extends ItopDataTestCase
$bDeletionOK = true;
try {
$oDeletionPlan = $this->InvokeNonPublicMethod(CMDBObject::class, 'RecordObjDeletion', $oPerson, [$oPerson->GetKey()]);
}
catch (CoreException $e) {
} catch (CoreException $e) {
$bDeletionOK = false;
}
// We don't need to test the result (truncated string), it's already done in \DBObject::SetTrim() with N°3448
$this->assertTrue($bDeletionOK);
}
private function ReplaceByFriendlyNames($sMessage, $oAdminUser, $oImpersonatedUser) : string {
private function ReplaceByFriendlyNames($sMessage, $oAdminUser, $oImpersonatedUser): string
{
$sNewMessage = str_replace('AdminSurName AdminName', $oAdminUser->GetFriendlyName(), $sMessage);
$sNewMessage = str_replace('ImpersonatedSurName ImpersonatedName', $oImpersonatedUser->GetFriendlyName(), $sNewMessage);
return $sNewMessage;
}
private function CreateSimpleObject(){
private function CreateSimpleObject()
{
/** @var \DocumentWeb $oTestObject */
$oTestObject = MetaModel::NewObject('DocumentWeb');
$oTestObject->Set('name', 'PHPUnit test');
$oTestObject->Set('org_id', $this->getTestOrgId() );
$oTestObject->Set('org_id', $this->getTestOrgId());
$oTestObject->Set('url', 'https://www.combodo.com');
$oTestObject->DBWrite();
}
private function CreateUserForImpersonation($sLogin, $sProfileName, $sName, $sSurname): \UserLocal {
private function CreateUserForImpersonation($sLogin, $sProfileName, $sName, $sSurname): \UserLocal
{
/** @var \Person $oPerson */
$oPerson = $this->createObject('Person', array(
$oPerson = $this->createObject('Person', [
'name' => $sName,
'first_name' => $sSurname,
'org_id' => $this->getTestOrgId(),
));
]);
$oProfile = \MetaModel::GetObjectFromOQL("SELECT URP_Profiles WHERE name = :name", array('name' => $sProfileName), true);
$oProfile = \MetaModel::GetObjectFromOQL("SELECT URP_Profiles WHERE name = :name", ['name' => $sProfileName], true);
/** @var \UserLocal $oUser */
$oUser = $this->CreateUser($sLogin, $oProfile->GetKey(), "1234567Azert@", $oPerson->GetKey());