This commit is contained in:
2026-09-15 10:26:34 +08:00
commit ecf36afa56
10493 changed files with 1404888 additions and 0 deletions
@@ -0,0 +1,283 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\TestFramework\Deploy;
use Magento\Framework\App\DeploymentConfig;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Shell;
use Magento\Framework\Shell\CommandRenderer;
use Magento\Setup\Console\Command\InstallCommand;
/**
* The purpose of this class is enable/disable module and upgrade commands execution.
*
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
class CliCommand
{
/**
* @var Shell
*/
private $shell;
/**
* @var TestModuleManager
*/
private $testEnv;
/**
* @var ParametersHolder
*/
private $parametersHolder;
/**
* @var DeploymentConfig
*/
private $deploymentConfig;
/**
* @param TestModuleManager $testEnv
* @internal param Shell $shell
*/
public function __construct(
\Magento\TestFramework\Deploy\TestModuleManager $testEnv
) {
$this->shell = new Shell(new CommandRenderer());
$this->testEnv = $testEnv;
$this->parametersHolder = new ParametersHolder();
}
/**
* Copy Test module files and execute enable module command.
*
* @param string $moduleName
* @return string
* @throws LocalizedException
*/
public function introduceModule($moduleName)
{
$this->testEnv->addModuleFiles($moduleName);
return $this->enableModule($moduleName);
}
/**
* Execute enable module command.
*
* @param string $moduleName
* @return string
* @throws LocalizedException
*/
public function enableModule($moduleName)
{
$initParams = $this->parametersHolder->getInitParams();
$enableModuleCommand = $this->getCliScriptCommand() . ' module:enable ' . $moduleName
. ' -n -vvv --magento-init-params="' . $initParams['magento-init-params'] . '"';
return $this->shell->execute($enableModuleCommand);
}
/**
* Execute upgrade magento command.
*
* @param array $installParams
* @return string
* @throws LocalizedException
*/
public function upgrade($installParams = [])
{
$initParams = $this->parametersHolder->getInitParams();
$upgradeCommand = $this->getCliScriptCommandWithDI() . 'setup:upgrade -vvv -n --magento-init-params="'
. $initParams['magento-init-params'] . '"';
$installParams = $this->toCliArguments($installParams);
$upgradeCommand .= ' ' . implode(" ", array_keys($installParams));
return $this->shell->execute($upgradeCommand, array_values($installParams));
}
/**
* Execute disable module command.
*
* @param string $moduleName
* @return string
* @throws LocalizedException
*/
public function disableModule($moduleName)
{
$initParams = $this->parametersHolder->getInitParams();
$disableModuleCommand = $this->getCliScriptCommand() . ' module:disable ' . $moduleName
. ' -vvv --magento-init-params="' . $initParams['magento-init-params'] . '"';
return $this->shell->execute($disableModuleCommand);
}
/**
* Split quote db configuration.
*
* @return void
* @throws LocalizedException
* @deprecated split database solution is deprecated and will be removed
*/
public function splitQuote()
{
//phpcs:ignore Magento2.Functions.DiscouragedFunction
trigger_error('Method is deprecated', E_USER_DEPRECATED);
$initParams = $this->parametersHolder->getInitParams();
$installParams = $this->toCliArguments(
$this->parametersHolder->getDbData('checkout')
);
$command = $this->getCliScriptCommand() . ' setup:db-schema:split-quote ' .
implode(" ", array_keys($installParams)) .
' -vvv --no-interaction --magento-init-params="' .
$initParams['magento-init-params'] . '"';
$this->shell->execute($command, array_values($installParams));
}
/**
* Split sales db configuration.
*
* @return void
* @throws LocalizedException
* @deprecated split database solution is deprecated and will be removed
*/
public function splitSales()
{
//phpcs:ignore Magento2.Functions.DiscouragedFunction
trigger_error('Method is deprecated', E_USER_DEPRECATED);
$initParams = $this->parametersHolder->getInitParams();
$installParams = $this->toCliArguments(
$this->parametersHolder->getDbData('sales')
);
$command = $this->getCliScriptCommand() . ' setup:db-schema:split-sales ' .
implode(" ", array_keys($installParams)) .
' -vvv --magento-init-params="' .
$initParams['magento-init-params'] . '"';
$this->shell->execute($command, array_values($installParams));
}
/**
* Clean all types of cache
*/
public function cacheClean()
{
$initParams = $this->parametersHolder->getInitParams();
$command = $this->getCliScriptCommand() . ' cache:clean ' .
' -vvv --magento-init-params=' .
$initParams['magento-init-params'];
$this->shell->execute($command);
}
/**
* Uninstall module
*
* @param string $moduleName
* @throws LocalizedException
*/
public function uninstallModule($moduleName)
{
$initParams = $this->parametersHolder->getInitParams();
$command = $this->getCliScriptCommand() . ' module:uninstall ' . $moduleName . ' --remove-data ' .
' -vvv --non-composer --magento-init-params="' .
$initParams['magento-init-params'] . '"';
$this->shell->execute($command);
}
/**
* Convert from raw params to CLI arguments, like --admin-username.
*
* @param array $params
* @return array
*/
private function toCliArguments(array $params)
{
$result = [];
foreach ($params as $key => $value) {
if (!empty($value)) {
$result["--{$key}=%s"] = $value;
}
}
return $result;
}
/**
* Execute install command.
*
* @param array $modules
* @param array $installParams
* @return string
* @throws \Exception
*/
public function install(array $modules, array $installParams = [])
{
if (empty($modules)) {
throw new \Exception("Cannot install Magento without modules");
}
$params = $this->parametersHolder->getInitParams();
$installParams += [
InstallCommand::INPUT_KEY_ENABLE_MODULES => implode(",", $modules),
InstallCommand::INPUT_KEY_DISABLE_MODULES => 'all'
];
$installParams = $this->toCliArguments(
array_merge(
$params,
$this->parametersHolder->getDbData('default'),
$installParams
)
);
// run install script
$exitCode = $this->shell->execute(
PHP_BINARY . ' -f %s setup:install -vvv ' . implode(' ', array_keys($installParams)),
array_merge([BP . '/bin/magento'], array_values($installParams))
);
$this->afterInstall();
return $exitCode;
}
/**
* You can decorate this function in order to add your own events here
*
* @return void
*/
public function afterInstall()
{
//Take current deployment config in order to flush it cache after installation
//Before installation usually we do not have any connections - so we need to add them
$this->deploymentConfig = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
->get(DeploymentConfig::class);
$this->deploymentConfig->resetData();
}
/**
* Get custom magento-cli command with additional DI configuration
*
* @return string
*/
private function getCliScriptCommandWithDI(): string
{
$params['MAGE_DIRS']['base']['path'] = BP;
$params['INTEGRATION_TESTS_CLI_AUTOLOADER'] = TESTS_BASE_DIR . '/framework/autoload.php';
$params['TESTS_BASE_DIR'] = TESTS_BASE_DIR;
return 'INTEGRATION_TEST_PARAMS="' . urldecode(http_build_query($params)) . '"'
. ' ' . PHP_BINARY . ' -f ' . INTEGRATION_TESTS_BASE_DIR
. '/bin/magento ';
}
/**
* Get basic magento-cli command
*
* @return string
*/
private function getCliScriptCommand()
{
return PHP_BINARY . ' -f ' . BP . '/bin/magento ';
}
}
@@ -0,0 +1,60 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\TestFramework\Deploy;
use Magento\Framework\Setup\Declaration\Schema\Db\MySQL\DbSchemaReader;
/**
* The purpose of this class is adding test modules files to Magento code base.
*/
class DescribeTable
{
/**
* Schema reader.
*
* @var DbSchemaReader
*/
private $dbSchemaReader;
/**
* This registry is used to ignore some tables, during comparison
*
* @var array
*/
private static $ignoredSystemTables = ['cache', 'cache_tag', 'flag', 'session', 'setup_module', 'patch_list'];
/**
* Constructor.
*
* @param DbSchemaReader $dbSchemaReader
*/
public function __construct(DbSchemaReader $dbSchemaReader)
{
$this->dbSchemaReader = $dbSchemaReader;
}
/**
* Describe shards.
*
* @param string $shardName
* @return array
*/
public function describeShard($shardName)
{
$data = [];
$tables = $this->dbSchemaReader->readTables($shardName);
foreach ($tables as $table) {
if (in_array($table, self::$ignoredSystemTables)) {
continue;
}
$data[$table] = $this->dbSchemaReader->getCreateTableSql($table, $shardName)['Create Table'];
}
return $data;
}
}
@@ -0,0 +1,73 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\TestFramework\Deploy;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\Shell;
use Magento\Setup\Console\Command\InstallCommand;
/**
* The purpose of this class is enable/disable module and upgrade commands execution.
*/
class ParametersHolder
{
/**
* Initialize params.
*
* @var array
*/
private $initParams;
/**
* Return application initialization parameters.
*
* @return array
*/
public function getInitParams()
{
if (!isset($this->initParams)) {
$customDirs = $this->getCustomDirs();
$initParams = [
\Magento\Framework\App\Bootstrap::INIT_PARAM_FILESYSTEM_DIR_PATHS => $customDirs,
];
$this->initParams = ['magento-init-params' => urldecode(http_build_query($initParams))];
}
return $this->initParams;
}
/**
* Include data from config file and convert it to db format:
* -db-name
* -db-user-name
* -db-password
* -db-host
*
* @param string $resource can be default, checkout, sales
* @return array
*/
public function getDbData($resource)
{
$dbData = include TESTS_INSTALLATION_DB_CONFIG_FILE;
return $dbData[$resource];
}
/**
* Get customized directory paths.
*
* @return array
*/
private function getCustomDirs()
{
$installDir = TESTS_TEMP_DIR;
$path = DirectoryList::PATH;
$var = "{$installDir}/var";
$customDirs = [
DirectoryList::CONFIG => [$path => "{$installDir}/etc"],
DirectoryList::VAR_DIR => [$path => $var],
];
return $customDirs;
}
}
@@ -0,0 +1,64 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\TestFramework\Deploy;
use Magento\Framework\App\DeploymentConfig\Reader as ConfigReader;
use Magento\Framework\App\DeploymentConfig\Writer as ConfigWriter;
use Magento\Framework\Config\File\ConfigFilePool;
/**
* The purpose of this class is add sharding db connections to env file.
*/
class ShardingConfig
{
/**
* @var ConfigWriter
*/
private $configWriter;
/**
* @var ConfigReader
*/
private $configReader;
/**
* @param ConfigWriter $configWriter
* @param ConfigReader $configReader
*/
public function __construct(ConfigWriter $configWriter, ConfigReader $configReader)
{
$this->configWriter = $configWriter;
$this->configReader = $configReader;
}
/**
* Apply sharding database connection to env file
*/
public function applyConfiguration()
{
$allDbData = include TESTS_INSTALLATION_DB_CONFIG_FILE;
$config = $this->configReader->load(ConfigFilePool::APP_ENV);
foreach ($allDbData as $connectionName => $dbData) {
if (!isset($config['db']['connection'][$connectionName]) && $connectionName !== 'default') {
$config['db']['connection'][$connectionName] = [
'host' => $dbData['host'],
'username' => $dbData['username'],
'password' => $dbData['password'],
'dbname' => $dbData['dbname'],
'model' => 'mysql4',
'engine' => 'innodb',
'initStatements' => 'SET NAMES utf8;',
'active' => '1'
];
$config['resource'][$connectionName] = [
'connection' => $connectionName
];
$this->configWriter->saveConfig([ConfigFilePool::APP_ENV => $config], true);
}
}
}
}
@@ -0,0 +1,43 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\TestFramework\Deploy;
use Magento\Framework\App\ResourceConnection;
/**
* The purpose of this class is to describe what data is in table
*/
class TableData
{
/**
* @var ResourceConnection
*/
private $resourceConnection;
/**
* TableData constructor.
* @param ResourceConnection $resourceConnection
*/
public function __construct(ResourceConnection $resourceConnection)
{
$this->resourceConnection = $resourceConnection;
}
/**
* @param string $tableName
* @param string $columnName
* @return array
*/
public function describeTableData($tableName, $columnName = null)
{
$adapter = $this->resourceConnection->getConnection();
$cols = $columnName ?: '*';
$select = $adapter
->select()
->from($tableName, $cols);
return $columnName ? $adapter->fetchCol($select) : $adapter->fetchAll($select);
}
}
@@ -0,0 +1,182 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\TestFramework\Deploy;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\Module\ModuleList;
use Magento\Framework\Module\ModuleListInterface;
/**
* The purpose of this class is adding test modules files to Magento code base.
*/
class TestModuleManager
{
/**
* Name of file of DB XML declaration.
*/
const DECLARATIVE_FILE_NAME = "db_schema.xml";
/**
* Add test module files to Magento code base.
*
* @param string $moduleName
* @return void
* @throws \RuntimeException
*/
public function addModuleFiles($moduleName)
{
$moduleName = str_replace("Magento_", "", $moduleName);
$pathToCommittedTestModules = TESTS_MODULES_PATH . '/Magento/' . $moduleName;
$pathToInstalledMagentoInstanceModules = MAGENTO_MODULES_PATH . $moduleName;
$iterator = new \RecursiveIteratorIterator(
new \RecursiveDirectoryIterator(
$pathToCommittedTestModules,
\RecursiveDirectoryIterator::FOLLOW_SYMLINKS
)
);
/** @var \SplFileInfo $file */
foreach ($iterator as $file) {
if (!$file->isDir()) {
$source = $file->getPathname();
$relativePath = substr($source, strlen($pathToCommittedTestModules));
$destination = $pathToInstalledMagentoInstanceModules . $relativePath;
$targetDir = dirname($destination);
if (!is_dir($targetDir)) {
mkdir($targetDir, 0755, true);
}
copy($source, $destination);
}
}
unset($iterator, $file);
// Register the modules under '_files/'
$pathPattern = $pathToInstalledMagentoInstanceModules . '/Test*/registration.php';
$files = glob($pathPattern, GLOB_NOSORT);
if ($files === false) {
throw new \RuntimeException('glob() returned error while searching in \'' . $pathPattern . '\'');
}
foreach ($files as $file) {
include $file;
}
}
/**
* Copy revision folder to main module
*
* @param string $moduleName
* @param string $revisionName
* @param string $dir
* @return void
*/
public function addRevision($moduleName, $revisionName, $dir)
{
$modulePath = str_replace("Magento_", "", $moduleName);
$folder = MAGENTO_MODULES_PATH . $modulePath;
$desiredPath = $folder . '/' . $dir;
$revisionPath = $folder . '/revisions/' . $revisionName . '/';
if (!is_dir($desiredPath)) {
mkdir($desiredPath, 0777, true);
}
rename($revisionPath, $desiredPath);
}
/**
* Update module version.
*
* @param string $moduleName Like Magento_TestSetupModule
* @param string $revisionName Folder name, like reviisions/revision_1/db_schema.xml
* @param string $fileName For example db_schema.xml
* @param string $fileDir For example etc or Setup
*/
public function updateRevision($moduleName, $revisionName, $fileName, $fileDir)
{
$modulePath = str_replace("Magento_", "", $moduleName);
$folder = MAGENTO_MODULES_PATH . $modulePath;
$oldFile = $folder . DIRECTORY_SEPARATOR . $fileDir . "/" . $fileName;
$revisionFile = MAGENTO_MODULES_PATH . $modulePath . "/revisions/" .
$revisionName . DIRECTORY_SEPARATOR . $fileName;
if (!file_exists($oldFile)) {
$dir = dirname($oldFile);
if (!is_dir($dir)) {
mkdir($dir, 0777, true);
}
touch($oldFile);
}
if (file_exists($revisionFile)) {
unlink($oldFile);
copy($revisionFile, $oldFile);
} else {
throw new \InvalidArgumentException("Old File or revision files paths are invalid");
}
}
/**
* Remove test module files to Magento code base.
*
* @param string $moduleName
* @return void
*/
public function removeModuleFiles($moduleName)
{
$modulePath = str_replace("Magento_", "", $moduleName);
$folder = MAGENTO_MODULES_PATH . $modulePath;
//remove test modules from magento codebase
if (is_dir($folder)) {
\Magento\Framework\Filesystem\Io\File::rmdirRecursive($folder);
}
}
/**
* There can be situation when config version of module can be cached
* So proposed to clean shared instance of
* @see ModuleList in order to achieve clean installation
*/
public function cleanModuleList()
{
/**
* @var \Magento\TestFramework\ObjectManager $objectManager
*/
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
$objectManager->removeSharedInstance(ModuleList::class);
$objectManager->removeSharedInstance(ModuleListInterface::class);
}
/**
* Update module files.
*
* @param string $moduleName
* @return void
*/
public function updateModuleFiles($moduleName)
{
$pathToCommittedTestModules = TESTS_MODULES_PATH . '/UpgradeScripts/' . $moduleName;
$pathToInstalledMagentoInstanceModules = MAGENTO_MODULES_PATH . $moduleName;
$iterator = new \RecursiveIteratorIterator(
new \RecursiveDirectoryIterator(
$pathToCommittedTestModules,
\RecursiveDirectoryIterator::FOLLOW_SYMLINKS
)
);
/** @var \SplFileInfo $file */
foreach ($iterator as $file) {
if (!$file->isDir()) {
$source = $file->getPathname();
$relativePath = substr($source, strlen($pathToCommittedTestModules));
$destination = $pathToInstalledMagentoInstanceModules . $relativePath;
$targetDir = dirname($destination);
if (!is_dir($targetDir)) {
mkdir($targetDir, 0755, true);
}
copy($source, $destination);
}
}
}
}