* @copyright 2013 Akeneo SAS (http://www.akeneo.com)
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
*/
class DatabaseCommand extends Command
{
protected static $defaultName = 'pim:installer:db';
protected static $defaultDescription = 'Prepare database and load fixtures';
const LOAD_ALL = 'all';
const LOAD_BASE = 'base';
protected ?CommandExecutor $commandExecutor;
public function __construct(
private readonly EntityManagerInterface $entityManager,
private readonly ClientRegistry $clientRegistry,
protected readonly Connection $connection,
private readonly FixtureJobLoader $fixtureJobLoader,
private readonly EventDispatcherInterface $eventDispatcher,
private readonly InstallData $installTimeQuery,
) {
parent::__construct();
}
/**
* {@inheritdoc}
*/
protected function configure()
{
$this
->addOption(
'fixtures',
null,
InputOption::VALUE_REQUIRED,
'Determines fixtures to load (can be just OroPlatform or all)',
self::LOAD_ALL
)
->addOption(
'withoutIndexes',
null,
InputOption::VALUE_OPTIONAL,
'Should the command setup the elastic search indexes',
false
)
->addOption(
'withoutFixtures',
null,
InputOption::VALUE_OPTIONAL,
'Should the command install any fixtures',
false
)
->addOption(
'catalog',
null,
InputOption::VALUE_OPTIONAL,
'Directory of the fixtures to install',
'src/Akeneo/Platform/Bundle/InstallerBundle/Resources/fixtures/minimal'
)
->addOption(
'doNotDropDatabase',
null,
InputOption::VALUE_NONE,
'Try to use an existing database if it already exists. Beware, the database data will still be deleted'
)
;
}
/**
* {@inheritdoc}
*/
protected function initialize(InputInterface $input, OutputInterface $output)
{
$this->commandExecutor = new CommandExecutor(
$input,
$output,
$this->getApplication()
);
}
/**
* {@inheritdoc}
*/
protected function execute(InputInterface $input, OutputInterface $output): int
{
$output->writeln('Prepare database schema');
// Needs to try if database already exists or not
try {
if (!$this->connection->isConnected()) {
$this->connection->connect();
}
if ($input->getOption('doNotDropDatabase')) {
$this->commandExecutor->runCommand('doctrine:schema:drop', ['--force' => true, '--full-database' => true]);
} else {
$this->commandExecutor->runCommand('doctrine:database:drop', ['--force' => true]);
}
} catch (ConnectionException $e) {
$output->writeln('Database does not exist yet');
}
$this->commandExecutor->runCommand('doctrine:database:create', ['--if-not-exists' => true]);
// Needs to close connection if always open
if ($this->connection->isConnected()) {
$this->connection->close();
}
$this->commandExecutor
->runCommand('doctrine:schema:create')
->runCommand(
'doctrine:schema:update',
['--force' => true, '--no-interaction' => true]
);
if (false === $input->getOption('withoutIndexes')) {
$this->resetElasticsearchIndex($output);
}
$entityManager = $this->entityManager;
$entityManager->clear();
$this->eventDispatcher->dispatch(
new InstallerEvent($this->commandExecutor, null, [
'catalog' => $input->getOption('catalog')
]),
InstallerEvents::POST_DB_CREATE
);
$this->setLatestKnownMigration($input);
if (false === $input->getOption('withoutFixtures')) {
$this->eventDispatcher->dispatch(
new InstallerEvent($this->commandExecutor, null, [
'catalog' => $input->getOption('catalog')
]),
InstallerEvents::PRE_LOAD_FIXTURES
);
$this->loadFixturesStep($input, $output);
$this->eventDispatcher->dispatch(
new InstallerEvent($this->commandExecutor, null, [
'catalog' => $input->getOption('catalog')
]),
InstallerEvents::POST_LOAD_FIXTURES
);
}
$this->installTimeQuery->withDatetime(new \DateTimeImmutable());
return Command::SUCCESS;
}
/**
* TODO: TIP-613: This should be done with a command.
* TODO: TIP-613: This command should be able to drop/create indexes, and/or re-index products.
*/
protected function resetElasticsearchIndex(OutputInterface $output)
{
$output->writeln('Reset elasticsearch indexes');
$clients = $this->clientRegistry->getClients();
foreach ($clients as $client) {
$client->resetIndex();
}
}
protected function loadFixturesStep(InputInterface $input, OutputInterface $output): DatabaseCommand
{
$catalog = $input->getOption('catalog');
if ($input->getOption('env') === 'behat') {
$input->setOption('fixtures', self::LOAD_BASE);
}
$output->writeln(
sprintf(
'Load jobs for fixtures. (data set: %s)',
$catalog
)
);
$this->fixtureJobLoader->loadJobInstances($input->getOption('catalog'));
$jobInstances = $this->fixtureJobLoader->getLoadedJobInstances();
foreach ($jobInstances as $jobInstance) {
$params = [
'code' => $jobInstance->getCode(),
'--no-debug' => true,
'--no-log' => true,
'-v' => true,
];
$this->eventDispatcher->dispatch(
new InstallerEvent($this->commandExecutor, $jobInstance->getCode(), [
'catalog' => $catalog
]),
InstallerEvents::PRE_LOAD_FIXTURE
);
if ($input->getOption('verbose')) {
$output->writeln(
sprintf(
'Please wait, the %s are processing...',
$jobInstance->getCode()
)
);
}
$this->commandExecutor->runCommand('akeneo:batch:job', $params);
$this->eventDispatcher->dispatch(
new InstallerEvent($this->commandExecutor, $jobInstance->getCode(), [
'job_name' => $jobInstance->getJobName(),
'catalog' => $catalog,
]),
InstallerEvents::POST_LOAD_FIXTURE
);
}
$output->writeln('');
$output->writeln('Delete jobs for fixtures.');
$this->fixtureJobLoader->deleteJobInstances();
return $this;
}
private function setLatestKnownMigration(InputInterface $input): void
{
$latestMigration = $this->getLatestMigration($input);
$this->commandExecutor->runCommand('doctrine:migrations:sync-metadata-storage', ['-q' => true]);
$this->commandExecutor->runCommand(
'doctrine:migrations:version',
['version' => $latestMigration, '--add' => true, '--all' => true, '-q' => true]
);
}
private function getLatestMigration(InputInterface $input): string
{
$params = ['bin/console', 'doctrine:migrations:latest'];
$params[] = '--no-debug';
if ($input->hasOption('env')) {
$params[] = '--env';
$params[] = $input->getOption('env');
}
if ($input->hasOption('verbose') && $input->getOption('verbose') === true) {
$params[] = '--verbose';
}
$latestMigrationProcess = new Process($params);
$latestMigrationProcess->run();
if ($latestMigrationProcess->getExitCode() !== 0) {
throw new \RuntimeException("Impossible to get the latest migration {$latestMigrationProcess->getErrorOutput()}");
}
return $latestMigrationProcess->getOutput();
}
}