composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-25 03:28:45 +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 20:39:38 +01:00
parent 7681c157ec
commit b0a792afab
369 changed files with 22041 additions and 26866 deletions
Download Patch File Download Diff File Expand all files Collapse all files

133
tests/php-unit-tests/unitary-tests/datamodels/2.x/itop-config/BulkChangeExtKeyTest.php
View File

@@ -6,7 +6,6 @@ use CMDBSource;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
use MetaModel;
/**
* created a dedicated test for external keys imports.
*
@@ -14,28 +13,31 @@ use MetaModel;
*
* @package Combodo\iTop\Test\UnitTest\Core
*/
class BulkChangeExtKeyTest extends ItopDataTestCase {
const CREATE_TEST_ORG = true;
class BulkChangeExtKeyTest extends ItopDataTestCase
{
public const CREATE_TEST_ORG = true;
/**
* this test may delete Person objects to cover all usecases
* DO NOT CHANGE USE_TRANSACTION value to avoid any DB loss!
*/
const USE_TRANSACTION = true;
public const USE_TRANSACTION = true;
private $sUid;
protected function setUp() : void {
protected function setUp(): void
{
parent::setUp();
require_once(APPROOT.'core/bulkchange.class.inc.php');
}
private function deleteAllRacks(){
private function deleteAllRacks()
{
$oSearch = \DBSearch::FromOQL("SELECT Rack");
$oSet = new \DBObjectSet($oSearch);
$iCount = $oSet->Count();
if ($iCount != 0){
while ($oRack = $oSet->Fetch()){
if ($iCount != 0) {
while ($oRack = $oSet->Fetch()) {
$oRack->DBDelete();
}
}
@@ -44,7 +46,8 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
/**
* @dataProvider ReconciliationKeyProvider
*/
public function testExternalFieldIssueImportFail_NoObjectAtAll($bIsRackReconKey){
public function testExternalFieldIssueImportFail_NoObjectAtAll($bIsRackReconKey)
{
$this->deleteAllRacks();
$this->performBulkChangeTest(
@@ -55,7 +58,8 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
);
}
public function createRackObjects($aRackDict) {
public function createRackObjects($aRackDict)
{
foreach ($aRackDict as $iOrgId => $aRackNames) {
foreach ($aRackNames as $sRackName) {
$this->createObject('Rack', ['name' => $sRackName, 'description' => "{$sRackName}Desc", 'org_id' => $iOrgId]);
@@ -63,9 +67,10 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
}
}
private function createAnotherUserInAnotherOrg() {
private function createAnotherUserInAnotherOrg()
{
$oOrg2 = $this->CreateOrganization('UnitTestOrganization2');
$oProfile = \MetaModel::GetObjectFromOQL("SELECT URP_Profiles WHERE name = :name", array('name' => 'Configuration Manager'), true);
$oProfile = \MetaModel::GetObjectFromOQL("SELECT URP_Profiles WHERE name = :name", ['name' => 'Configuration Manager'], true);
$sUid = $this->GetUid();
@@ -73,13 +78,13 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
$oSet->AddItem(MetaModel::NewObject('URP_UserProfile', ['profileid' => $oProfile->GetKey(), 'reason' => 'UNIT Tests']));
$oPerson = $this->CreatePerson('666', $oOrg2->GetKey());
$oUser = $this->createObject('UserLocal', array(
$oUser = $this->createObject('UserLocal', [
'contactid' => $oPerson->GetKey(),
'login' => $sUid,
'password' => "ABCdef$sUid@12345",
'language' => 'EN US',
'profile_list' => $oSet,
));
]);
$oAllowedOrgList = $oUser->Get('allowed_org_list');
/** @var \URP_UserOrg $oUserOrg */
@@ -90,22 +95,23 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
return [$oOrg2, $oUser];
}
public function ReconciliationKeyProvider(){
public function ReconciliationKeyProvider()
{
return [
'rack_id NOT a reconcilication key' => [ false ],
'rack_id reconcilication key' => [ true ],
];
}
/**
* @dataProvider ReconciliationKeyProvider
*/
public function testExternalFieldIssueImportFail_NoObjectVisibleByCurrentUser($bIsRackReconKey){
public function testExternalFieldIssueImportFail_NoObjectVisibleByCurrentUser($bIsRackReconKey)
{
$this->deleteAllRacks();
$this->createRackObjects(
[
$this->getTestOrgId() => ['RackTest1', 'RackTest2', 'RackTest3', 'RackTest4']
$this->getTestOrgId() => ['RackTest1', 'RackTest2', 'RackTest3', 'RackTest4'],
]
);
@@ -123,7 +129,8 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
/**
* @dataProvider ReconciliationKeyProvider
*/
public function testExternalFieldIssueImportFail_SomeObjectVisibleByCurrentUser($bIsRackReconKey){
public function testExternalFieldIssueImportFail_SomeObjectVisibleByCurrentUser($bIsRackReconKey)
{
$this->deleteAllRacks();
[$oOrg2, $oUser] = $this->createAnotherUserInAnotherOrg();
$this->createRackObjects(
@@ -146,11 +153,12 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
/**
* @dataProvider ReconciliationKeyProvider
*/
public function testExternalFieldIssueImportFail_AllObjectsVisibleByCurrentUser($bIsRackReconKey){
public function testExternalFieldIssueImportFail_AllObjectsVisibleByCurrentUser($bIsRackReconKey)
{
$this->deleteAllRacks();
$this->createRackObjects(
[
$this->getTestOrgId() => ['RackTest1', 'RackTest2', 'RackTest3', 'RackTest4']
$this->getTestOrgId() => ['RackTest1', 'RackTest2', 'RackTest3', 'RackTest4'],
]
);
@@ -165,11 +173,12 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
/**
* @dataProvider ReconciliationKeyProvider
*/
public function testExternalFieldIssueImportFail_AllObjectsVisibleByCurrentUser_AmbigousMatch($bIsRackReconKey){
public function testExternalFieldIssueImportFail_AllObjectsVisibleByCurrentUser_AmbigousMatch($bIsRackReconKey)
{
$this->deleteAllRacks();
$this->createRackObjects(
[
$this->getTestOrgId() => ['UnexistingRack', 'UnexistingRack']
$this->getTestOrgId() => ['UnexistingRack', 'UnexistingRack'],
]
);
@@ -189,11 +198,12 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
/**
* @dataProvider ReconciliationKeyProvider
*/
public function testExternalFieldIssueImportFail_AllObjectsVisibleByCurrentUser_FurtherExtKeyForRack($bIsRackReconKey){
public function testExternalFieldIssueImportFail_AllObjectsVisibleByCurrentUser_FurtherExtKeyForRack($bIsRackReconKey)
{
$this->deleteAllRacks();
$this->createRackObjects(
[
$this->getTestOrgId() => ['RackTest1', 'RackTest2', 'RackTest3', 'RackTest4']
$this->getTestOrgId() => ['RackTest1', 'RackTest2', 'RackTest3', 'RackTest4'],
]
);
@@ -213,24 +223,33 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
);
}
private function GetUid(){
if (is_null($this->sUid)){
private function GetUid()
{
if (is_null($this->sUid)) {
$this->sUid = uniqid('test');
}
return $this->sUid;
}
public function performBulkChangeTest($sExpectedDisplayableValue, $sExpectedDescription, $oOrg, $bIsRackReconKey,
$aAdditionalCsvData=null, $aAdditionalAttributes=null, $aExtKeys=null, $sSearchLinkUrl=null, $sError="Object not found") {
if ($sSearchLinkUrl===null){
public function performBulkChangeTest(
$sExpectedDisplayableValue,
$sExpectedDescription,
$oOrg,
$bIsRackReconKey,
$aAdditionalCsvData = null,
$aAdditionalAttributes = null,
$aExtKeys = null,
$sSearchLinkUrl = null,
$sError = "Object not found"
) {
if ($sSearchLinkUrl === null) {
$sSearchLinkUrl = 'UI.php?operation=search&filter='.rawurlencode('%5B%22SELECT+%60Rack%60+FROM+Rack+AS+%60Rack%60+WHERE+%28%60Rack%60.%60name%60+%3D+%3Aname%29%22%2C%7B%22name%22%3A%22UnexistingRack%22%7D%2C%5B%5D%5D');
}
if (is_null($oOrg)){
if (is_null($oOrg)) {
$iOrgId = $this->getTestOrgId();
$sOrgName = "UnitTestOrganization";
}else{
} else {
$iOrgId = $oOrg->GetKey();
$sOrgName = $oOrg->Get('name');
}
@@ -238,18 +257,18 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
$sUid = $this->GetUid();
$aCsvData = [[$sOrgName, "UnexistingRack", "$sUid"]];
if ($aAdditionalCsvData !== null){
foreach ($aAdditionalCsvData as $i => $aData){
foreach ($aData as $sData){
if ($aAdditionalCsvData !== null) {
foreach ($aAdditionalCsvData as $i => $aData) {
foreach ($aData as $sData) {
$aCsvData[$i][] = $sData;
}
}
}
$aAttributes = ["name" => 2];
if ($aAdditionalAttributes !== null){
if ($aAdditionalAttributes !== null) {
$aAttributes = array_merge($aAttributes, $aAdditionalAttributes);
}
if ($aExtKeys == null){
if ($aExtKeys == null) {
$aExtKeys = ["org_id" => ["name" => 0], "rack_id" => ["name" => 1]];
}
$aReconcilKeys = [ "name" ];
@@ -261,19 +280,18 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
2 => "\"$sUid\"",
"rack_id" => [
$sExpectedDisplayableValue,
$sExpectedDescription
$sExpectedDescription,
],
"__STATUS__" => "Issue: Unexpected attribute value(s)",
"__ERRORS__" => $sError,
];
if ($bIsRackReconKey){
if ($bIsRackReconKey) {
$aReconcilKeys[] = "rack_id";
$aResult[2] = $sUid;
$aResult["__STATUS__"] = "Issue: failed to reconcile";
}
CMDBSource::Query('START TRANSACTION');
try {
@@ -281,8 +299,8 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
$db_core_transactions_enabled = MetaModel::GetConfig()->Get('db_core_transactions_enabled');
MetaModel::GetConfig()->Set('db_core_transactions_enabled', false);
$this->debug("aCsvData:" . json_encode($aCsvData[0]));
$this->debug("aReconcilKeys:" . var_export($aReconcilKeys));
$this->debug("aCsvData:".json_encode($aCsvData[0]));
$this->debug("aReconcilKeys:".var_export($aReconcilKeys));
$oBulk = new \BulkChange(
"Server",
$aCsvData,
@@ -304,24 +322,33 @@ class BulkChangeExtKeyTest extends ItopDataTestCase {
foreach ($aRes as $aRow) {
if (array_key_exists('__STATUS__', $aRow)) {
$sStatus = $aRow['__STATUS__'];
$this->debug("sStatus:" . $sStatus->GetDescription());
$this->debug("sStatus:".$sStatus->GetDescription());
$this->assertEquals($aResult["__STATUS__"], $sStatus->GetDescription());
foreach ($aRow as $i => $oCell) {
if ($i != "finalclass" && $i != "__STATUS__" && $i != "__ERRORS__") {
$this->debug("i:" . $i);
$this->debug("i:".$i);
if (array_key_exists($i, $aResult)) {
$this->debug("aResult:" . var_export($aResult[$i]));
$this->debug("aResult:".var_export($aResult[$i]));
if ($oCell instanceof \CellStatus_SearchIssue ||
$oCell instanceof \CellStatus_Ambiguous) {
$this->assertEquals($aResult[$i][0], $oCell->GetCLIValue(),
"failure on " . get_class($oCell) . ' cell type');
$this->assertEquals($sSearchLinkUrl, $oCell->GetSearchLinkUrl(),
"failure on " . get_class($oCell) . ' cell type');
$this->assertEquals($aResult[$i][1], $oCell->GetDescription(),
"failure on " . get_class($oCell) . ' cell type');
$this->assertEquals(
$aResult[$i][0],
$oCell->GetCLIValue(),
"failure on ".get_class($oCell).' cell type'
);
$this->assertEquals(
$sSearchLinkUrl,
$oCell->GetSearchLinkUrl(),
"failure on ".get_class($oCell).' cell type'
);
$this->assertEquals(
$aResult[$i][1],
$oCell->GetDescription(),
"failure on ".get_class($oCell).' cell type'
);
}
}
} else if ($i === "__ERRORS__") {
} elseif ($i === "__ERRORS__") {
$sErrors = array_key_exists("__ERRORS__", $aResult) ? $aResult["__ERRORS__"] : "";
$this->assertEquals($sErrors, $oCell->GetDescription());
}