Skip to content

Fix #23031: Check data\schema patch aliases #25265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 26, 2019
Merged

Fix #23031: Check data\schema patch aliases #25265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions lib/internal/Magento/Framework/Setup/Patch/PatchApplier.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,9 @@ public function applyDataPatch($moduleName = null)
$this->moduleDataSetup->getConnection()->beginTransaction();
$dataPatch->apply();
$this->patchHistory->fixPatch(get_class($dataPatch));
foreach ($dataPatch->getAliases() as $patchAlias) {
$this->patchHistory->fixPatch($patchAlias);
}
$this->moduleDataSetup->getConnection()->commit();
} catch (\Exception $e) {
$this->moduleDataSetup->getConnection()->rollBack();
Expand Down Expand Up @@ -237,6 +240,9 @@ public function applySchemaPatch($moduleName = null)
$schemaPatch = $this->patchFactory->create($schemaPatch, ['schemaSetup' => $this->schemaSetup]);
$schemaPatch->apply();
$this->patchHistory->fixPatch(get_class($schemaPatch));
foreach ($schemaPatch->getAliases() as $patchAlias) {
$this->patchHistory->fixPatch($patchAlias);
}
} catch (\Exception $e) {
throw new SetupException(
new Phrase(
Expand Down
156 changes: 139 additions & 17 deletions lib/internal/Magento/Framework/Setup/Test/Unit/Patch/PatchApplierTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,11 @@
use Magento\Framework\DB\Adapter\AdapterInterface;
use Magento\Framework\Module\ModuleResource;
use Magento\Framework\ObjectManagerInterface;
use Magento\Framework\Setup\Exception;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Framework\Setup\Patch\DataPatchInterface;
use Magento\Framework\Setup\Patch\PatchBackwardCompatability;
use Magento\Framework\Setup\Patch\PatchInterface;
use Magento\Framework\Setup\SchemaSetupInterface;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
use Magento\Framework\Setup\Patch\PatchApplier;
Expand Down Expand Up @@ -169,8 +172,10 @@ public function testApplyDataPatchForNewlyInstalledModule($moduleName, $dataPatc

$patch1 = $this->createMock(\SomeDataPatch::class);
$patch1->expects($this->once())->method('apply');
$patch1->expects($this->once())->method('getAliases')->willReturn([]);
$patch2 = $this->createMock(\OtherDataPatch::class);
$patch2->expects($this->once())->method('apply');
$patch2->expects($this->once())->method('getAliases')->willReturn([]);
$this->objectManagerMock->expects($this->any())->method('create')->willReturnMap(
[
['\\' . \SomeDataPatch::class, ['moduleDataSetup' => $this->moduleDataSetupMock], $patch1],
Expand All @@ -188,6 +193,60 @@ public function testApplyDataPatchForNewlyInstalledModule($moduleName, $dataPatc
$this->patchApllier->applyDataPatch($moduleName);
}

/**
* @param $moduleName
* @param $dataPatches
* @param $moduleVersionInDb
*
* @dataProvider applyDataPatchDataNewModuleProvider()
*
* @expectedException Exception
* @expectedExceptionMessageRegExp "Unable to apply data patch .+ cannot be applied twice"
*/
public function testApplyDataPatchForAlias($moduleName, $dataPatches, $moduleVersionInDb)
{
$this->dataPatchReaderMock->expects($this->once())
->method('read')
->with($moduleName)
->willReturn($dataPatches);

$this->moduleResourceMock->expects($this->any())->method('getDataVersion')->willReturnMap(
[
[$moduleName, $moduleVersionInDb]
]
);

$patch1 = $this->createMock(DataPatchInterface::class);
$patch1->expects($this->once())->method('getAliases')->willReturn(['PatchAlias']);
$patchClass = get_class($patch1);

$patchRegistryMock = $this->createAggregateIteratorMock(PatchRegistry::class, [$patchClass], ['registerPatch']);
$patchRegistryMock->expects($this->any())
->method('registerPatch');

$this->patchRegistryFactoryMock->expects($this->any())
->method('create')
->willReturn($patchRegistryMock);

$this->objectManagerMock->expects($this->any())->method('create')->willReturnMap(
[
['\\' . $patchClass, ['moduleDataSetup' => $this->moduleDataSetupMock], $patch1],
]
);
$this->connectionMock->expects($this->exactly(1))->method('beginTransaction');
$this->connectionMock->expects($this->never())->method('commit');
$this->patchHistoryMock->expects($this->any())->method('fixPatch')->will(
$this->returnCallback(
function ($param1) {
if ($param1 == 'PatchAlias') {
throw new \LogicException(sprintf("Patch %s cannot be applied twice", $param1));
}
}
)
);
$this->patchApllier->applyDataPatch($moduleName);
}

/**
* @return array
*/
Expand Down Expand Up @@ -243,8 +302,10 @@ public function testApplyDataPatchForInstalledModule($moduleName, $dataPatches,

$patch1 = $this->createMock(\SomeDataPatch::class);
$patch1->expects(self::never())->method('apply');
$patch1->expects(self::any())->method('getAliases')->willReturn([]);
$patch2 = $this->createMock(\OtherDataPatch::class);
$patch2->expects(self::once())->method('apply');
$patch2->expects(self::any())->method('getAliases')->willReturn([]);
$this->objectManagerMock->expects(self::any())->method('create')->willReturnMap(
[
['\\' . \SomeDataPatch::class, ['moduleDataSetup' => $this->moduleDataSetupMock], $patch1],
Expand Down Expand Up @@ -279,7 +340,7 @@ public function applyDataPatchDataInstalledModuleProvider()
* @param $dataPatches
* @param $moduleVersionInDb
*
* @expectedException \Magento\Framework\Setup\Exception
* @expectedException Exception
* @expectedExceptionMessage Patch Apply Error
*
* @dataProvider applyDataPatchDataInstalledModuleProvider()
Expand Down Expand Up @@ -328,7 +389,7 @@ public function testApplyDataPatchRollback($moduleName, $dataPatches, $moduleVer
}

/**
* @expectedException \Magento\Framework\Setup\Exception
* @expectedException Exception
* @expectedExceptionMessageRegExp "Patch [a-zA-Z0-9\_]+ should implement DataPatchInterface"
*/
public function testNonDataPatchApply()
Expand Down Expand Up @@ -434,8 +495,10 @@ public function testSchemaPatchAplly($moduleName, $schemaPatches, $moduleVersion

$patch1 = $this->createMock(\SomeSchemaPatch::class);
$patch1->expects($this->never())->method('apply');
$patch1->expects($this->any())->method('getAliases')->willReturn([]);
$patch2 = $this->createMock(\OtherSchemaPatch::class);
$patch2->expects($this->once())->method('apply');
$patch2->expects($this->any())->method('getAliases')->willReturn([]);
$this->patchFactoryMock->expects($this->any())->method('create')->willReturnMap(
[
[\SomeSchemaPatch::class, ['schemaSetup' => $this->schemaSetupMock], $patch1],
Expand All @@ -448,6 +511,55 @@ public function testSchemaPatchAplly($moduleName, $schemaPatches, $moduleVersion
$this->patchApllier->applySchemaPatch($moduleName);
}

/**
* @param $moduleName
* @param $schemaPatches
* @param $moduleVersionInDb
*
* @dataProvider schemaPatchDataProvider()
*
* @expectedException Exception
* @expectedExceptionMessageRegExp "Unable to apply patch .+ cannot be applied twice"
*/
public function testSchemaPatchApplyForPatchAlias($moduleName, $schemaPatches, $moduleVersionInDb)
{
$this->schemaPatchReaderMock->expects($this->once())
->method('read')
->with($moduleName)
->willReturn($schemaPatches);

$this->moduleResourceMock->expects($this->any())->method('getDbVersion')->willReturnMap(
[
[$moduleName, $moduleVersionInDb]
]
);

$patch1 = $this->createMock(PatchInterface::class);
$patch1->expects($this->once())->method('getAliases')->willReturn(['PatchAlias']);
$patchClass = get_class($patch1);

$patchRegistryMock = $this->createAggregateIteratorMock(PatchRegistry::class, [$patchClass], ['registerPatch']);
$patchRegistryMock->expects($this->any())
->method('registerPatch');

$this->patchRegistryFactoryMock->expects($this->any())
->method('create')
->willReturn($patchRegistryMock);

$this->patchFactoryMock->expects($this->any())->method('create')->willReturn($patch1);
$this->patchHistoryMock->expects($this->any())->method('fixPatch')->will(
$this->returnCallback(
function ($param1) {
if ($param1 == 'PatchAlias') {
throw new \LogicException(sprintf("Patch %s cannot be applied twice", $param1));
}
}
)
);

$this->patchApllier->applySchemaPatch($moduleName);
}

public function testRevertDataPatches()
{
$patches = [\RevertableDataPatch::class];
Expand Down Expand Up @@ -534,33 +646,43 @@ private function createAggregateIteratorMock($className, array $items = [], arra

$someIterator->expects($this->any())
->method('rewind')
->willReturnCallback(function () use ($iterator) {
$iterator->rewind();
});
->willReturnCallback(
function () use ($iterator) {
$iterator->rewind();
}
);

$someIterator->expects($this->any())
->method('current')
->willReturnCallback(function () use ($iterator) {
return $iterator->current();
});
->willReturnCallback(
function () use ($iterator) {
return $iterator->current();
}
);

$someIterator->expects($this->any())
->method('key')
->willReturnCallback(function () use ($iterator) {
return $iterator->key();
});
->willReturnCallback(
function () use ($iterator) {
return $iterator->key();
}
);

$someIterator->expects($this->any())
->method('next')
->willReturnCallback(function () use ($iterator) {
$iterator->next();
});
->willReturnCallback(
function () use ($iterator) {
$iterator->next();
}
);

$someIterator->expects($this->any())
->method('valid')
->willReturnCallback(function () use ($iterator) {
return $iterator->valid();
});
->willReturnCallback(
function () use ($iterator) {
return $iterator->valid();
}
);

return $mockIteratorAggregate;
}
Expand Down