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

# Conflicts:
#	test/sources/application/Helper/WebResourcesHelperTest.php
#	tests/php-unit-tests/ItopTestCase.php
#	tests/php-unit-tests/composer.lock
#	tests/php-unit-tests/unitary-tests/.make/release/DatamodelsXmlFilesTest.php
#	tests/php-unit-tests/unitary-tests/application/UI/Base/Layout/NavigationMenuTest.php
#	tests/php-unit-tests/unitary-tests/application/query/QueryTest.php
#	tests/php-unit-tests/unitary-tests/core/DBSearchTest.php
#	tests/php-unit-tests/unitary-tests/datamodels/2.x/itop-config/BulkChangeExtKeyTest.inc.php
#	tests/php-unit-tests/unitary-tests/datamodels/2.x/itop-config/CRUD/DBObjectTest.php
#	tests/php-unit-tests/unitary-tests/service/EventTest.php
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/3.0_to_3.1.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/3.0_to_3.1.input.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/3.1_to_3.0.expected.xml
#	tests/php-unit-tests/unitary-tests/setup/iTopDesignFormat/Convert-samples/3.1_to_3.0.input.xml
#	tests/php-unit-tests/unitary-tests/sources/Application/Helper/WebResourcesHelperTest.php
#	tests/php-unit-tests/unitary-tests/sources/Router/RouterTest.php
#	tests/php-unit-tests/unitary-tests/sources/application/Helper/WebResourcesHelperTest.php
#	tests/php-unit-tests/unitary-tests/webservices/ImportTest.inc.php
#	tests/php-unit-tests/unitary-tests/webservices/RestTest.php
This commit is contained in:
Molkobain
2023-01-11 15:55:08 +01:00
253 changed files with 946 additions and 1446 deletions

View File

@@ -0,0 +1,344 @@
<?php
namespace Combodo\iTop\Test\UnitTest\Core;
use CMDBSource;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
use MetaModel;
/**
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
* @backupGlobals disabled
*
* created a dedicated test for external keys imports.
*
* Class BulkChangeExtKeyTest
*
* @package Combodo\iTop\Test\UnitTest\Core
*/
class BulkChangeExtKeyTest extends ItopDataTestCase {
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;
private $sUid;
protected function setUp() : void {
parent::setUp();
require_once(APPROOT.'core/bulkchange.class.inc.php');
}
private function deleteAllRacks(){
$oSearch = \DBSearch::FromOQL("SELECT Rack");
$oSet = new \DBObjectSet($oSearch);
$iCount = $oSet->Count();
if ($iCount != 0){
while ($oRack = $oSet->Fetch()){
$oRack->DBDelete();
}
}
}
/**
* @dataProvider ReconciliationKeyProvider
*/
public function testExternalFieldIssueImportFail_NoObjectAtAll($bIsRackReconKey){
$this->deleteAllRacks();
$this->performBulkChangeTest(
'There are no \'Rack\' objects',
"",
null,
$bIsRackReconKey
);
}
public function createRackObjects($aRackDict) {
foreach ($aRackDict as $iOrgId => $aRackNames) {
foreach ($aRackNames as $sRackName) {
$this->createObject('Rack', ['name' => $sRackName, 'description' => "${sRackName}Desc", 'org_id' => $iOrgId]);
}
}
}
private function createAnotherUserInAnotherOrg() {
$oOrg2 = $this->CreateOrganization('UnitTestOrganization2');
$oProfile = \MetaModel::GetObjectFromOQL("SELECT URP_Profiles WHERE name = :name", array('name' => 'Configuration Manager'), true);
$sUid = $this->GetUid();
$oUserProfile = new \URP_UserProfile();
$oUserProfile->Set('profileid', $oProfile->GetKey());
$oUserProfile->Set('reason', 'UNIT Tests');
$oSet = \DBObjectSet::FromObject($oUserProfile);
$oPerson = $this->CreatePerson('666', $oOrg2->GetKey());
$oUser = $this->createObject('UserLocal', array(
'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 */
$oUserOrg = \MetaModel::NewObject('URP_UserOrg', ['allowed_org_id' => $oOrg2->GetKey(),]);
$oAllowedOrgList->AddItem($oUserOrg);
$oUser->Set('allowed_org_list', $oAllowedOrgList);
$oUser->DBWrite();
return [$oOrg2, $oUser];
}
public function ReconciliationKeyProvider(){
return [
'rack_id NOT a reconcilication key' => [ false ],
'rack_id reconcilication key' => [ true ],
];
}
/**
* @dataProvider ReconciliationKeyProvider
*/
public function testExternalFieldIssueImportFail_NoObjectVisibleByCurrentUser($bIsRackReconKey){
$this->deleteAllRacks();
$this->createRackObjects(
[
$this->getTestOrgId() => ['RackTest1', 'RackTest2', 'RackTest3', 'RackTest4']
]
);
list($oOrg2, $oUser) = $this->createAnotherUserInAnotherOrg();
\UserRights::Login($oUser->Get('login'));
$this->performBulkChangeTest(
"There are no 'Rack' objects found with your current profile",
"",
$oOrg2,
$bIsRackReconKey
);
}
/**
* @dataProvider ReconciliationKeyProvider
*/
public function testExternalFieldIssueImportFail_SomeObjectVisibleByCurrentUser($bIsRackReconKey){
$this->deleteAllRacks();
list($oOrg2, $oUser) = $this->createAnotherUserInAnotherOrg();
$this->createRackObjects(
[
$this->getTestOrgId() => ['RackTest1', 'RackTest2'],
$oOrg2->GetKey() => ['RackTest3', 'RackTest4'],
]
);
\UserRights::Login($oUser->Get('login'));
$this->performBulkChangeTest(
"There are some 'Rack' objects not visible with your current profile",
"Some possible 'Rack' value(s): RackTest3, RackTest4",
$oOrg2,
$bIsRackReconKey
);
}
/**
* @dataProvider ReconciliationKeyProvider
*/
public function testExternalFieldIssueImportFail_AllObjectsVisibleByCurrentUser($bIsRackReconKey){
$this->deleteAllRacks();
$this->createRackObjects(
[
$this->getTestOrgId() => ['RackTest1', 'RackTest2', 'RackTest3', 'RackTest4']
]
);
$this->performBulkChangeTest(
"No match for value 'UnexistingRack'",
"Some possible 'Rack' value(s): RackTest1, RackTest2, RackTest3...",
null,
$bIsRackReconKey
);
}
/**
* @dataProvider ReconciliationKeyProvider
*/
public function testExternalFieldIssueImportFail_AllObjectsVisibleByCurrentUser_AmbigousMatch($bIsRackReconKey){
$this->deleteAllRacks();
$this->createRackObjects(
[
$this->getTestOrgId() => ['UnexistingRack', 'UnexistingRack']
]
);
$this->performBulkChangeTest(
"invalid value for attribute",
"Ambiguous: found 2 objects",
null,
$bIsRackReconKey,
null,
null,
null,
'Found 2 matches'
);
}
/**
* @dataProvider ReconciliationKeyProvider
*/
public function testExternalFieldIssueImportFail_AllObjectsVisibleByCurrentUser_FurtherExtKeyForRack($bIsRackReconKey){
$this->deleteAllRacks();
$this->createRackObjects(
[
$this->getTestOrgId() => ['RackTest1', 'RackTest2', 'RackTest3', 'RackTest4']
]
);
$aCsvData = [["UnexistingRackDescription"]];
$aExtKeys = ["org_id" => ["name" => 0], "rack_id" => ["name" => 1, "description" => 3]];
$sSearchLinkUrl = 'UI.php?operation=search&filter=%5B%22SELECT+%60Rack%60+FROM+Rack+AS+%60Rack%60+WHERE+%28%28%60Rack%60.%60name%60+%3D+%3Aname%29+AND+%28%60Rack%60.%60description%60+%3D+%3Adescription%29%29%22%2C%7B%22name%22%3A%22UnexistingRack%22%2C%22description%22%3A%22UnexistingRackDescription%22%7D%2C%5B%5D%5D'
;
$this->performBulkChangeTest(
"No match for value 'UnexistingRack UnexistingRackDescription'",
"Some possible 'Rack' value(s): RackTest1 RackTest1Desc, RackTest2 RackTest2Desc, RackTest3 RackTest3Desc...",
null,
$bIsRackReconKey,
$aCsvData,
$aExtKeys,
$sSearchLinkUrl
);
}
private function GetUid(){
if (is_null($this->sUid)){
$this->sUid = date('dmYHis');
}
return $this->sUid;
}
/** *
* @param $aInitData
* @param $aCsvData
* @param $aAttributes
* @param $aExtKeys
* @param $aReconcilKeys
*/
public function performBulkChangeTest($sExpectedDisplayableValue, $sExpectedDescription, $oOrg, $bIsRackReconKey,
$aAdditionalCsvData=null, $aExtKeys=null, $sSearchLinkUrl=null, $sError="Object not found") {
if ($sSearchLinkUrl===null){
$sSearchLinkUrl = 'UI.php?operation=search&filter=%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)){
$iOrgId = $this->getTestOrgId();
$sOrgName = "UnitTestOrganization";
}else{
$iOrgId = $oOrg->GetKey();
$sOrgName = $oOrg->Get('name');
}
$sUid = $this->GetUid();
$aCsvData = [[$sOrgName, "UnexistingRack", "$sUid"]];
if ($aAdditionalCsvData !== null){
foreach ($aAdditionalCsvData as $i => $aData){
foreach ($aData as $sData){
$aCsvData[$i][] = $sData;
}
}
}
$aAttributes = ["name" => 2];
if ($aExtKeys == null){
$aExtKeys = ["org_id" => ["name" => 0], "rack_id" => ["name" => 1]];
}
$aReconcilKeys = [ "name" ];
$aResult = [
0 => $sOrgName,
"org_id" => $iOrgId,
1 => "UnexistingRack",
2 => "\"$sUid\"",
"rack_id" => [
$sExpectedDisplayableValue,
$sExpectedDescription
],
"__STATUS__" => "Issue: Unexpected attribute value(s)",
"__ERRORS__" => $sError,
];
if ($bIsRackReconKey){
$aReconcilKeys[] = "rack_id";
$aResult[2] = $sUid;
$aResult["__STATUS__"] = "Issue: failed to reconcile";
}
CMDBSource::Query('START TRANSACTION');
//change value during the test
$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));
$oBulk = new \BulkChange(
"Server",
$aCsvData,
$aAttributes,
$aExtKeys,
$aReconcilKeys,
null,
null,
"Y-m-d H:i:s", // date format
true // localize
);
$this->debug("BulkChange:");
$oChange = \CMDBObject::GetCurrentChange();
$this->debug("GetCurrentChange:");
$aRes = $oBulk->Process($oChange);
$this->debug("Process:");
static::assertNotNull($aRes);
$this->debug("assertNotNull:");
var_dump($aRes);
foreach ($aRes as $aRow) {
if (array_key_exists('__STATUS__', $aRow)) {
$sStatus = $aRow['__STATUS__'];
$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('GetDisplayableValue:'.$oCell->GetDisplayableValue());
if (array_key_exists($i,$aResult)) {
$this->debug("aResult:".var_export($aResult[$i]));
if ($oCell instanceof \CellStatus_SearchIssue ||
$oCell instanceof \CellStatus_Ambiguous) {
$this->assertEquals($aResult[$i][0], $oCell->GetDisplayableValue(),
"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__") {
$sErrors = array_key_exists("__ERRORS__", $aResult) ? $aResult["__ERRORS__"] : "";
$this->assertEquals( $sErrors, $oCell->GetDescription());
}
}
$this->assertEquals( $aResult[0], $aRow[0]->GetDisplayableValue());
}
}
MetaModel::GetConfig()->Set('db_core_transactions_enabled',$db_core_transactions_enabled);
}
}

View File

@@ -0,0 +1,221 @@
<?php
/*
* @copyright Copyright (C) 2010-2022 Combodo SARL
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\Test\UnitTest\Core\CRUD;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
use lnkContactToFunctionalCI;
use MetaModel;
/**
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
* @backupGlobals disabled
*/
class DBObjectTest extends ItopDataTestCase
{
const USE_TRANSACTION = true;
const CREATE_TEST_ORG = true;
const DEBUG_UNIT_TEST = true;
public function testReloadNotNecessaryForInsert()
{
$oPerson = $this->CreatePersonInstance();
// Insert without Reload
$oPerson->DBInsert();
// Get initial values
$aValues1 = [];
foreach (MetaModel::GetAttributesList('Person') as $sAttCode) {
if (MetaModel::GetAttributeDef('Person', $sAttCode) instanceof \AttributeLinkedSet) {
continue;
}
$aValues1[$sAttCode] = $oPerson->Get($sAttCode);
}
$sOrgName1 = $oPerson->Get('org_name');
/** @var \ormLinkSet $oCIList1 */
$oCIList1 = $oPerson->Get('cis_list');
$oTeamList1 = $oPerson->Get('team_list');
$sPerson1 = print_r($oPerson, true);
// 1st Reload
$oPerson->Reload(true);
$sPerson2 = print_r($oPerson, true);
$this->assertNotEquals($sPerson1, $sPerson2);
$aValues2 = [];
foreach (MetaModel::GetAttributesList('Person') as $sAttCode) {
if (MetaModel::GetAttributeDef('Person', $sAttCode) instanceof \AttributeLinkedSet) {
continue;
}
$aValues2[$sAttCode] = $oPerson->Get($sAttCode);
}
$sOrgName2 = $oPerson->Get('org_name');
/** @var \ormLinkSet $oCIList2 */
$oCIList2 = $oPerson->Get('cis_list');
$oTeamList2 = $oPerson->Get('team_list');
$this->assertEquals($sOrgName1, $sOrgName2);
$this->assertTrue($oCIList1->Equals($oCIList2));
$this->assertTrue($oTeamList1->Equals($oTeamList2));
$this->assertEquals($aValues1, $aValues2);
// 2nd Reload
$oPerson->Reload(true);
$sPerson3 = print_r($oPerson, true);
$this->assertEquals($sPerson2, $sPerson3);
}
public function testFriendlynameResetOnExtKeyReset()
{
$oPerson = $this->CreatePersonInstance();
$oManager = $this->CreatePersonInstance();
$oManager->DBInsert();
$oPerson->Set('manager_id', $oManager->GetKey());
$this->assertNotEmpty($oPerson->Get('manager_id_friendlyname'));
$oPerson->Set('manager_id', 0);
$this->assertEmpty($oPerson->Get('manager_id_friendlyname'));
}
public function testReloadNotNecessaryForUpdate()
{
$oPerson = $this->CreatePersonInstance();
$oPerson->DBInsert();
$oManager = $this->CreatePersonInstance();
$oManager->DBInsert();
$oPerson->Set('manager_id', $oManager->GetKey());
$oPerson->DBUpdate();
$sManagerFriendlyname1 = $oPerson->Get('manager_id_friendlyname');
$oCIList1 = $oPerson->Get('cis_list');
$oTeamList1 = $oPerson->Get('team_list');
$aValues1 = [];
foreach (MetaModel::GetAttributesList('Person') as $sAttCode) {
if (MetaModel::GetAttributeDef('Person', $sAttCode) instanceof \AttributeLinkedSet) {
continue;
}
$aValues1[$sAttCode] = $oPerson->Get($sAttCode);
}
$sPerson1 = print_r($oPerson, true);
// 1st Reload
$oPerson->Reload(true);
$sPerson2 = print_r($oPerson, true);
$this->assertNotEquals($sPerson1, $sPerson2);
$sManagerFriendlyname2 = $oPerson->Get('manager_id_friendlyname');
$oCIList2 = $oPerson->Get('cis_list');
$oTeamList2 = $oPerson->Get('team_list');
$aValues2 = [];
foreach (MetaModel::GetAttributesList('Person') as $sAttCode) {
if (MetaModel::GetAttributeDef('Person', $sAttCode) instanceof \AttributeLinkedSet) {
continue;
}
$aValues2[$sAttCode] = $oPerson->Get($sAttCode);
}
$this->assertEquals($sManagerFriendlyname1, $sManagerFriendlyname2);
$this->assertTrue($oCIList1->Equals($oCIList2));
$this->assertTrue($oTeamList1->Equals($oTeamList2));
$this->assertEquals($aValues1, $aValues2);
// 2nd Reload
$oPerson->Reload(true);
$sPerson3 = print_r($oPerson, true);
$this->assertEquals($sPerson2, $sPerson3);
}
public function testGetObjectUpdateUnderReentryProtection()
{
$oPerson = $this->CreatePersonInstance();
$oPerson->DBInsert();
$oPerson->Set('email', 'test@combodo.com');
$oPerson->DBUpdate();
$this->assertFalse($oPerson->IsModified());
$oNewPerson = MetaModel::GetObject('Person', $oPerson->GetKey());
$this->assertNotEquals($oPerson->GetObjectUniqId(), $oNewPerson->GetObjectUniqId());
MetaModel::StartReentranceProtection(Metamodel::REENTRANCE_TYPE_UPDATE, $oPerson);
$oPerson->Set('email', 'test1@combodo.com');
$oPerson->DBUpdate();
$this->assertTrue($oPerson->IsModified());
$oNewPerson = MetaModel::GetObject('Person', $oPerson->GetKey());
$this->assertEquals($oPerson->GetObjectUniqId(), $oNewPerson->GetObjectUniqId());
MetaModel::StopReentranceProtection(Metamodel::REENTRANCE_TYPE_UPDATE, $oPerson);
}
public function testObjectIsReadOnly()
{
$oPerson = $this->CreatePersonInstance();
$sMessage = 'Not allowed to write to this object !';
$oPerson->SetReadOnly($sMessage);
try {
$oPerson->Set('email', 'test1@combodo.com');
$this->assertTrue(false, 'Set() should have raised a CoreException');
}
catch (\CoreException $e) {
$this->assertEquals($sMessage, $e->getMessage());
}
$oPerson->SetReadWrite();
$oPerson->Set('email', 'test1@combodo.com');
}
/**
* @throws \ArchivedObjectException
* @throws \CoreException
* @throws \CoreUnexpectedValue
*/
private function CreatePersonInstance()
{
$oServer1 = $this->CreateServer(1);
$oServer2 = $this->CreateServer(2);
$sClass = 'Person';
$aParams = [
'name' => 'Person_'.rand(10000, 99999),
'first_name' => 'Test',
'org_id' => $this->getTestOrgId(),
];
$oPerson = MetaModel::NewObject($sClass);
foreach ($aParams as $sAttCode => $oValue) {
$oPerson->Set($sAttCode, $oValue);
}
$oNewLink1 = new lnkContactToFunctionalCI();
$oNewLink1->Set('functionalci_id', $oServer1->GetKey());
$oNewLink2 = new lnkContactToFunctionalCI();
$oNewLink2->Set('functionalci_id', $oServer2->GetKey());
$oCIs = $oPerson->Get('cis_list');
$oCIs->AddItem($oNewLink1);
$oCIs->AddItem($oNewLink2);
$oPerson->Set('cis_list', $oCIs);
return $oPerson;
}
}

View File

@@ -0,0 +1,171 @@
<?php
/**
* Copyright (C) 2010-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
* along with iTop. If not, see <http: *www.gnu.org/licenses/>
*
*/
namespace Combodo\iTop\Test\UnitTest\Module\iTopConfig;
use Combodo\iTop\Test\UnitTest\ItopTestCase;
use ConfigPlaceholdersResolver;
/**
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
* @backupGlobals disabled
*/
class ConfigPlaceholdersResolverTest extends ItopTestCase
{
protected function setUp(): void
{
parent::setUp();
$this->RequireOnceItopFile('core/config.class.inc.php');
}
/**
* @dataProvider providerResolve
*/
public function testResolve($aEnv, $aServer, $sValue, $sExpected, $sExpectedExceptionClass = null)
{
if ($sExpectedExceptionClass)
{
$this->expectException($sExpectedExceptionClass);
}
$oConfigPlaceholdersResolver = new ConfigPlaceholdersResolver($aEnv, $aServer);
$sResult = $oConfigPlaceholdersResolver->Resolve($sValue);
$this->assertEquals($sExpected, $sResult);
}
public function providerResolve()
{
$stdObj = (object) array('%env(HTTP_PORT)?:8080%', '%server(toto)?:8080%', '%foo(toto)?:8080%');
return array(
'basic behaviour' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, 'HTTP_PORT' => '443'),
'aServer' => array(),
'sValue' => '%env(HTTP_PORT)%',
'sExpected' => '443',
),
'disabled if no ITOP_CONFIG_PLACEHOLDERS' => array(
'aEnv' => array('HTTP_PORT' => '443'),
'aServer' => array(),
'sValue' => '%env(HTTP_PORT)%',
'sExpected' => '%env(HTTP_PORT)%',
),
'basic with default not used' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, 'HTTP_PORT' => '443'),
'aServer' => array(),
'sValue' => '%env(HTTP_PORT)?:foo%',
'sExpected' => '443',
),
'basic with default used' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, ),
'aServer' => array(),
'sValue' => '%env(HTTP_PORT)?:foo%',
'sExpected' => 'foo',
),
'basic with default used and empty' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, ),
'aServer' => array(),
'sValue' => '%env(HTTP_PORT)?:%',
'sExpected' => '',
),
'mixed with static' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, 'HTTP_PORT' => '443'),
'aServer' => array('toto' => 'tutu'),
'sValue' => 'http://localhost:%env(HTTP_PORT)?:8080%/',
'sExpected' => 'http://localhost:443/',
),
'multiple occurrences' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, 'HTTP_PORT' => '443'),
'aServer' => array('SERVER_NAME' => 'localhost'),
'sValue' => 'http://%server(SERVER_NAME)%:%env(HTTP_PORT)%/',
'sExpected' => 'http://localhost:443/',
),
'array as source' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, 'HTTP_PORT' => '443'),
'aServer' => array('toto' => 'tutu'),
'sValue' => array('http://localhost:%env(HTTP_PORT)?:8080%/', '%foo(HTTP_PORT)?:8080%', '%server(toto)?:8080%'),
'sExpected' => array('http://localhost:443/', '%foo(HTTP_PORT)?:8080%', 'tutu'),
),
'invalid source' => array(
'aEnv' => array('toto' => 'tutu'),
'aServer' => array('HTTP_PORT' => '443'),
'sValue' => '%foo(HTTP_PORT)?:8080%',
'sExpected' => '%foo(HTTP_PORT)?:8080%',
),
'ignored source' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, 'HTTP_PORT' => '443'),
'aServer' => array('toto' => 'tutu'),
'sValue' => $stdObj,
'sExpected' => $stdObj,
),
'env matching port' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, 'HTTP_PORT' => '443'),
'aServer' => array('toto' => 'tutu'),
'sValue' => '%env(HTTP_PORT)?:8080%',
'sExpected' => '443',
),
'env no matching port with default ' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, 'foo' => 'bar'),
'aServer' => array('toto' => 'tutu'),
'sValue' => '%env(HTTP_PORT)?:8080%',
'sExpected' => '8080',
),
'env no matching port' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, 'foo' => 'bar'),
'aServer' => array('toto' => 'tutu'),
'sValue' => '%env(HTTP_PORT)%',
'sExpected' => null,
'sExpectedExceptionClass' => 'ConfigException',
),
'server matching port' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, 'toto' => 'tutu'),
'aServer' => array('HTTP_PORT' => '443'),
'sValue' => '%server(HTTP_PORT)?:8080%',
'sExpected' => '443',
),
'server no matching port with default ' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, 'toto' => 'tutu'),
'aServer' => array('foo' => 'bar'),
'sValue' => '%server(HTTP_PORT)?:8080%',
'sExpected' => '8080',
),
'server no matching port' => array(
'aEnv' => array('ITOP_CONFIG_PLACEHOLDERS' => 1, 'toto' => 'tutu'),
'aServer' => array('foo' => 'bar'),
'sValue' => '%server(HTTP_PORT)%',
'sExpected' => null,
'sExpectedExceptionClass' => 'ConfigException',
),
);
}
}

View File

@@ -0,0 +1,98 @@
<?php
/**
* Copyright (C) 2010-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
* along with iTop. If not, see <http: *www.gnu.org/licenses/>
*
*/
namespace Combodo\iTop\Test\UnitTest\Module\iTopConfig;
use Combodo\iTop\Test\UnitTest\ItopTestCase;
use Config;
/**
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
* @backupGlobals disabled
*/
class ConfigTest extends ItopTestCase
{
protected function setUp(): void
{
parent::setUp();
$this->RequireOnceItopFile('core/config.class.inc.php');
}
/**
*
* @dataProvider ProviderPreserveVarOnWriteToFile
*
* @throws \ConfigException
* @throws \CoreException
*
*/
public function testPreserveVarOnWriteToFile($sConfigFile, $sExpectedContains, $aChanges)
{
$sTmpFile = tempnam(sys_get_temp_dir(), "target");
$oConfig = new Config($sConfigFile);
foreach ($aChanges as $key => $val) {
$oConfig->Set($key, $val);
}
$oConfig->WriteToFile($sTmpFile);
$this->assertFileExists($sTmpFile);
$sFileContent = file_get_contents($sTmpFile);
$this->assertStringContainsString($sExpectedContains, $sFileContent, "File content doesn't contain : ".$sExpectedContains);
}
public function ProviderPreserveVarOnWriteToFile()
{
return array(
'preserve var' => array(
'sConfigFile' => __DIR__.'/ConfigTest/config-itop-var.php',
'sExpectedContains' => "'app_root_url' => 'http://' . (isset(\$_SERVER['SERVER_NAME']) ? \$_SERVER['SERVER_NAME'] : 'localhost') . '/itop/iTop/'",
'aChanges' => array(),
),
'preserve joker' => array(
'sConfigFile' => __DIR__.'/ConfigTest/config-itop-joker.php',
'sExpectedContains' => "'app_root_url' => 'http://%server(SERVER_NAME)?:localhost%/itop/iTop/'",
'aChanges' => array(),
),
'preserve set same value' => array(
'sConfigFile' => __DIR__.'/ConfigTest/config-itop-var.php',
'sExpectedContains' => "'app_root_url' => 'http://' . (isset(\$_SERVER['SERVER_NAME']) ? \$_SERVER['SERVER_NAME'] : 'localhost') . '/itop/iTop/'",
'aChanges' => array('app_root_url' => 'http://localhost/itop/iTop/'),
),
'overwrite var' => array(
'sConfigFile' => __DIR__.'/ConfigTest/config-itop-var.php',
'sExpectedContains' => "'app_root_url' => 'foo",
'aChanges' => array('app_root_url' => 'foo'),
),
'overwrite joker' => array(
'sConfigFile' => __DIR__.'/ConfigTest/config-itop-joker.php',
'sExpectedContains' => "'app_root_url' => 'foo",
'aChanges' => array('app_root_url' => 'foo'),
),
);
}
}

View File

@@ -0,0 +1,37 @@
<?php
/**
*
* Configuration file, generated for the unit tests
*
*
*
*/
$MySettings = array(
// app_root_url: Root URL used for navigating within the application, or from an email to the application (you can put $SERVER_NAME$ as a placeholder for the server's name)
// default: ''
'app_root_url' => 'http://%server(SERVER_NAME)?:localhost%/itop/iTop/',
);
/**
*
* Modules specific settings
*
*/
$MyModuleSettings = array(
);
/**
*
* Data model modules to be loaded. Names are specified as relative paths
*
*/
$MyModules = array(
'addons' => array('user rights' => 'addons/userrights/userrightsprofile.class.inc.php'),
);
?>

View File

@@ -0,0 +1,37 @@
<?php
/**
*
* Configuration file, generated for the unit tests
*
*
*
*/
$MySettings = array(
// app_root_url: Root URL used for navigating within the application, or from an email to the application (you can put $SERVER_NAME$ as a placeholder for the server's name)
// default: ''
'app_root_url' => 'http://' . (isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : 'localhost') . '/itop/iTop/',
);
/**
*
* Modules specific settings
*
*/
$MyModuleSettings = array(
);
/**
*
* Data model modules to be loaded. Names are specified as relative paths
*
*/
$MyModules = array(
'addons' => array('user rights' => 'addons/userrights/userrightsprofile.class.inc.php'),
);
?>

View File

@@ -0,0 +1,97 @@
<?php
/**
* Created by Bruno DA SILVA, working for Combodo
* Date: 31/12/2019
* Time: 12:31
*/
namespace Combodo\iTop\Test\UnitTest\Module\iTopConfig\Validator;
use Combodo\iTop\Config\Validator\iTopConfigAstValidator;
use Combodo\iTop\Test\UnitTest\ItopTestCase;
use PhpParser\Node;
use PhpParser\PrettyPrinter\Standard;
class iTopConfigAstValidatorTest extends ItopTestCase
{
public function setUp(): void
{
parent::setUp();
$this->RequireOnceItopFile('env-production/itop-config/src/Validator/ConfigNodesVisitor.php');
$this->RequireOnceItopFile('env-production/itop-config/src/Validator/iTopConfigAstValidator.php');
}
/**
* @dataProvider InvalidDataProvider
* @param $sConf
*
* @throws \Exception
*/
public function testInvalid($sConf)
{
$oiTopConfigValidator = new iTopConfigAstValidator();
$this->expectException(\Exception::class);
try{
$oiTopConfigValidator->Validate($sConf);
}catch (\Exception $e)
{
$this->assertStringStartsWith('Invalid configuration:', $e->getMessage());
throw $e;
}
}
public function InvalidDataProvider()
{
return array(
'invalid PHP' => array(
'sConf' => '<?php fiction Method(){}'
),
'function call' => array(
'sConf' => '<?php FunctionCall();'
),
'function declaration' => array(
'sConf' => '<?php function foo() {};'
),
'class instantiation' => array(
'sConf' => '<?php new Class {};'
),
'Class declaration' => array(
'sConf' => '<?php class foo {};'
),
'echo' => array(
'sConf' => '<?php echo "toto"; ?>'
),
);
}
/**
* @dataProvider ValidDataProvider
* @doesNotPerformAssertions
*
* @param $sConf
*
* @throws \Exception
*/
public function testValid($sConf)
{
$oiTopConfigValidator = new iTopConfigAstValidator();
$oiTopConfigValidator->Validate($sConf);
}
public function ValidDataProvider()
{
return array(
'simple code' => array(
'sConf' => '<?php $var = array("toto"); ?>'
),
'class constant' => array(
'sConf' => '<?php $var = array(foo::bar);'
),
);
}
}

View File

@@ -0,0 +1,54 @@
<?php
/**
* Created by Bruno DA SILVA, working for Combodo
* Date: 31/12/2019
* Time: 12:31
*/
namespace Combodo\iTop\Test\UnitTest\Module\iTopConfig\Validator;
use Combodo\iTop\Config\Validator\iTopConfigAstValidator;
use Combodo\iTop\Config\Validator\iTopConfigSyntaxValidator;
use Combodo\iTop\Test\UnitTest\ItopTestCase;
use PhpParser\Node;
use PhpParser\PrettyPrinter\Standard;
class iTopConfigSyntaxValidatorTest extends ItopTestCase
{
public function setUp(): void
{
parent::setUp();
$this->RequireOnceItopFile('env-production/itop-config/src/Validator/ConfigNodesVisitor.php');
$this->RequireOnceItopFile('env-production/itop-config/src/Validator/iTopConfigSyntaxValidator.php');
}
/**
* @throws \Exception
* @doesNotPerformAssertions
*/
public function testValidCode()
{
$oiTopConfigValidator = new iTopConfigSyntaxValidator();
$oiTopConfigValidator->Validate("<?php \n echo 'foo'; ");
}
public function testThrowOnInvalidCode()
{
$oiTopConfigValidator = new iTopConfigSyntaxValidator();
$this->expectException(\Exception::class);
try{
$oiTopConfigValidator->Validate("<?php \n zef;zefzef \n zdadz = azdazd \n zerfgzaezerfgzef>");
} catch (\Exception $e) {
if (version_compare(phpversion(), '8.0.0', '<')) {
$this->assertStringStartsWith('Error in configuration: syntax error, unexpected \'zdadz\' (T_STRING)', $e->getMessage());
} else {
$this->assertStringStartsWith('Error in configuration: syntax error, unexpected identifier "zdadz" at line 2', $e->getMessage());
}
throw $e;
}
}
}