composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-25 11:38:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

N°7130 - Allows to ignore existing column field in setup's data migration method (#597)

Browse Source 
* Allows to ignore existing column field in setup's data migration method

* Update setup/moduleinstaller.class.inc.php

* N°7130 - Fix typo in variable extraction

* N°7130 - Add unit tests

* Update setup/moduleinstaller.class.inc.php

---------

Co-authored-by: Molkobain <lajarige.guillaume@free.fr>
This commit is contained in:
Stephen Abello
2024-01-09 09:43:22 +01:00
committed by GitHub
parent bfb05d331e
commit 73c989ee67
2 changed files with 148 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
setup/moduleinstaller.class.inc.php
View File

@@ -242,11 +242,15 @@ abstract class ModuleInstallerAPI
* @param $sOrigColumn
* @param $sDstTable
* @param $sDstColumn
* @param bool $bIgnoreExistingDstColumn
*
* @throws \MySQLException
* @throws \CoreException
* @throws \MySQLException
* @throws \MySQLHasGoneAwayException
*
* @since 3.2.0 N°7130 Add parameter $bIgnoreExistingDstColumn
*/
public static function MoveColumnInDB($sOrigTable, $sOrigColumn, $sDstTable, $sDstColumn)
public static function MoveColumnInDB($sOrigTable, $sOrigColumn, $sDstTable, $sDstColumn, $bIgnoreExistingDstColumn = false)
{
if (!MetaModel::DBExists(false))
{
@@ -260,16 +264,19 @@ abstract class ModuleInstallerAPI
return;
}
if (!CMDBSource::IsTable($sDstTable) || CMDBSource::IsField($sDstTable, $sDstColumn))
$bDstTableFieldExists = CMDBSource::IsField($sDstTable, $sDstColumn);
if (!CMDBSource::IsTable($sDstTable) || ($bDstTableFieldExists && !$bIgnoreExistingDstColumn))
{
// Destination field is already created
// Destination field is already created, and we are not ignoring it
return;
}
// Create the destination field
// Create the destination field if necessary
if($bDstTableFieldExists === false){
$sSpec = CMDBSource::GetFieldSpec($sOrigTable, $sOrigColumn);
$sQueryAdd = "ALTER TABLE `{$sDstTable}` ADD `{$sDstColumn}` {$sSpec}";
CMDBSource::Query($sQueryAdd);
}
// Copy the data
$sQueryUpdate = "UPDATE `{$sDstTable}` AS d LEFT JOIN `{$sOrigTable}` AS o ON d.id = o.id SET d.`{$sDstColumn}` = o.`{$sOrigColumn}` WHERE 1";

132
tests/php-unit-tests/unitary-tests/setup/ModuleInstallerAPITest.php Normal file
View File

@@ -0,0 +1,132 @@
<?php
namespace Combodo\iTop\Test\UnitTest\Setup;
use CMDBSource;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
use MetaModel;
use ModuleInstallerAPI;
/**
* Class ModuleInstallerAPITest
*
* @covers ModuleInstallerAPI
*
*/
class ModuleInstallerAPITest extends ItopDataTestCase
{
protected static string $sWorkTable = "unit_tests_work_table";
protected function setUp(): void
{
parent::setUp();
$this->RequireOnceItopFile('setup/moduleinstaller.class.inc.php');
}
public function tearDown(): void
{
if (CMDBSource::IsTable(static::$sWorkTable)) {
CMDBSource::DropTable(static::$sWorkTable);
}
parent::tearDown();
}
/**
* Test that the new $bIgnoreExistingDstColumn parameter works as expected and doesn't break the previous behavior
*
* @covers \ModuleInstallerAPI::MoveColumnInDB
* @dataProvider MoveColumnInDB_IgnoreExistingDstColumnParamProvider
*
* @param bool $bDstColAlreadyExists
* @param bool $bIgnoreExistingDstColumn
* @param bool $bShouldWork
*
* @return void
* @throws \CoreException
* @throws \MySQLException
* @throws \MySQLHasGoneAwayException
*/
public function testMoveColumnInDB_IgnoreExistingDstColumnParam(bool $bDstColAlreadyExists, bool $bIgnoreExistingDstColumn, bool $bShouldWork): void
{
// Info from the original table
$sOrigClass = "Person";
$sOrigTable = MetaModel::DBGetTable($sOrigClass);
$sOrigAttCode = "first_name";
$oOrigAttDef = MetaModel::GetAttributeDef($sOrigClass, $sOrigAttCode);
$sOrigColName = array_key_first($oOrigAttDef->GetSQLColumns());
// Info for the destination table
$sDstTable = static::$sWorkTable;
$sDstNonExistingColName = "non_existing_column";
$sDstExistingColName = "existing_column";
// Create work table with an empty $sDstExistingColName column
// Data will then either be moved to the $sDstExistingColName or $sDstNonExistingColName column depending on the test case
CMDBSource::Query(
<<<SQL
CREATE TABLE `{$sDstTable}` AS
SELECT id
FROM {$sOrigTable}
LIMIT 3
SQL
);
CMDBSource::Query(
<<<SQL
ALTER TABLE `{$sDstTable}`
ADD `{$sDstExistingColName}` VARCHAR(255)
SQL
);
CMDBSource::CacheReset($sDstTable);
// Save value from original table as a reference
$oPerson = MetaModel::GetObject($sOrigClass, 1);
$sOrigValue = $oPerson->Get($sOrigAttCode);
// Try to move data
$sDstColName = $bDstColAlreadyExists ? $sDstExistingColName : $sDstNonExistingColName;
ModuleInstallerAPI::MoveColumnInDB($sOrigTable, $sOrigColName, $sDstTable, $sDstColName, $bIgnoreExistingDstColumn);
// Check if data was actually moved
// - Either way, the column should exist
$sDstValue = CMDBSource::QueryToScalar(
<<<SQL
SELECT `{$sDstColName}` FROM `{$sDstTable}` WHERE `id` = 1
LIMIT 1
SQL
);
// Put data back in the original table
ModuleInstallerAPI::MoveColumnInDB($sDstTable, $sDstColName, $sOrigTable, $sOrigColName);
if ($bShouldWork) {
$this->assertEquals($sOrigValue, $sDstValue, "Data was not moved as expected");
} else {
$this->assertEquals(null, $sDstValue, "Data should NOT have moved");
}
}
public function MoveColumnInDB_IgnoreExistingDstColumnParamProvider(): array
{
return [
"Nominal use case, move data to a non-existing column" => [
"Dest. col. already exists?" => false,
"bIgnoreExistingDstColumn param" => false,
"Should work" => true,
],
"Move data to non-existing table fails if not explicitly wanted" => [
"Dest. col. already exists?" => true,
"bIgnoreExistingDstColumn param" => false,
"Should work" => false,
],
"Move data to non-existing table on purpose" => [
"Dest. col. already exists?" => true,
"bIgnoreExistingDstColumn param" => true,
"Should work" => true,
],
];
}
}