MariaDB - Add backupper and restorer (#77)

* noissue - MariaDB - Add backupper and restorer

* noissue - MariaDB - Add backupper and restorer

* remove unwanted modification

* Check backup file can be read

* fix configuration examples

* fix configuration examples

config/packages/db_tools.yaml

@@ -13,13 +13,15 @@ db_tools:
  # Specify here paths to binaries, only if the system can't find them by himself
  # platform are 'mysql', 'postgresql', 'sqlite'
  #backupper_binaries:
- #postgresql: 'usr/bin/pg_dump' # default 'pg_dump'
- #mysql: 'usr/bin/mysqldump' # default 'mysqldump'
- #sqlite: 'usr/bin/sqlite3' # default 'sqlite3'
+ #mariadb: '/usr/bin/mariadb-dump' # default 'mariadb-dump'
+ #mysql: '/usr/bin/mysqldump' # default 'mysqldump'
+ #postgresql: '/usr/bin/pg_dump' # default 'pg_dump'
+ #sqlite: '/usr/bin/sqlite3' # default 'sqlite3'
  #restorer_binaries:
- #postgresql: 'usr/bin/pg_restore' # default 'pg_restore'
- #mysql: 'usr/bin/mysql' # default 'mysql'
- #sqlite3: 'usr/bin/sqlite3' # default 'sqlite3'
+ #mariadb: '/usr/bin/mariadb' # default 'mariadb'
+ #mysql: '/usr/bin/mysql' # default 'mysql'
+ #postgresql: '/usr/bin/pg_restore' # default 'pg_restore'
+ #sqlite: '/usr/bin/sqlite3' # default 'sqlite3'
 
  # Update this configuration if you want to look for anonymizers in a custom folder.
  # These are default paths that will always be registered even if you override the

docs/content/configuration.md

@@ -69,8 +69,9 @@ db_tools:
 
 `db-tools:backup` and `db-tools:restore` need your system/environment to provide some extra binaries
 to be able to work. These binaries depend on the database vendor you use, you will need:
-* for PostgreSQL: `pg_dump` and `pg_restore`
+* for MariaDB: `mariadb-dump` and `mariadb`
 * for MySQL: `mysqldump` and `mysql`
+* for PostgreSQL: `pg_dump` and `pg_restore`
 * for SQLite: `sqlite3`
 
 You can verify that binaries for your DBAL connection(s) are correctly found by the *DbToolsBundle* launching:
@@ -93,13 +94,15 @@ If the `db-tools:check` command returns you some errors:
  # Specify here paths to binaries, only if the system can't find them by himself
  # platform are 'mysql', 'postgresql', 'sqlite'
  backupper_binaries:
- postgresql: 'usr/bin/pg_dump' # default 'pg_dump'
- mysql: 'usr/bin/mysqldump' # default 'mysqldump'
- sqlite: 'usr/bin/sqlite3' # default 'sqlite3'
+ mariadb: '/usr/bin/mariadb-dump' # default 'mariadb-dump'
+ mysql: '/usr/bin/mysqldump' # default 'mysqldump'
+ postgresql: '/usr/bin/pg_dump' # default 'pg_dump'
+ sqlite: '/usr/bin/sqlite3' # default 'sqlite3'
  restorer_binaries:
- postgresql: 'usr/bin/pg_restore' # default 'pg_restore'
- mysql: 'usr/bin/mysql' # default 'mysql'
- sqlite: 'usr/bin/sqlite3' # default 'sqlite3'
+ mariadb: '/usr/bin/mariadb' # default 'mariadb'
+ mysql: '/usr/bin/mysql' # default 'mysql'
+ postgresql: '/usr/bin/pg_restore' # default 'pg_restore'
+ sqlite: '/usr/bin/sqlite3' # default 'sqlite3'
 
  #...
  ```

docs/content/getting-started/database-vendors.md

@@ -27,7 +27,7 @@ Here is a matrix of the current state of support:
 |----------------------------|----------------|---------------|-------------|
 | PostgreSQL | <Badge type="tip" text="✔" title="Working"/> | <Badge type="tip" text="✔" title="Working"/> | <Badge type="tip" text="✔" title="Working"/> |
 | MySQL | <Badge type="tip" text="✔" title="Working"/> | <Badge type="tip" text="✔" title="Working"/> | <Badge type="tip" text="✔" title="Working"/> |
-| MariaDB | <Badge type="danger" text="✘" title="Unsupported"/> | <Badge type="tip" text="✔" title="Working"/> | <Badge type="tip" text="✔" title="Working"/> |
+| MariaDB | <Badge type="tip" text="✔" title="Working"/> | <Badge type="tip" text="✔" title="Working"/> | <Badge type="tip" text="✔" title="Working"/> |
 | SQLite | <Badge type="tip" text="✔" title="Working"/> | <Badge type="warning" text="~" title="Only unit-tested"/> | <Badge type="danger" text="✘" title="Unsupported"/> |
 | SQL Server | <Badge type="danger" text="✘" title="Unsupported"/> | <Badge type="warning" text="~" title="Only unit-tested"/> | <Badge type="danger" text="✘" title="Unsupported"/> |
 

src/Backupper/BackupperFactory.php

@@ -30,8 +30,9 @@ public function create(?string $connectionName = null): AbstractBackupper
  $platform = $queryBuilder->getServerFlavor();
 
  $backupper = match ($platform) {
- Platform::POSTGRESQL => PgSQL\Backupper::class,
+ Platform::MARIADB => MariaDB\Backupper::class,
  Platform::MYSQL => MySQL\Backupper::class,
+ Platform::POSTGRESQL => PgSQL\Backupper::class,
  Platform::SQLITE => SQLite\Backupper::class,
  default => throw new NotImplementedException(\sprintf(
  "Backup is not implemented or configured for platform '%s' while using connection '%s'",

src/Backupper/MariaDB/Backupper.php

@@ -0,0 +1,93 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MakinaCorpus\DbToolsBundle\Backupper\MariaDB;
+
+use MakinaCorpus\DbToolsBundle\Backupper\AbstractBackupper;
+use Symfony\Component\Process\Exception\ProcessFailedException;
+use Symfony\Component\Process\Process;
+
+class Backupper extends AbstractBackupper
+{
+ private ?Process $process = null;
+
+ /**
+ * {@inheritdoc}
+ */
+ public function startBackup(): self
+ {
+ $dbParams = $this->connection->getParams();
+
+ $args = [
+ $this->binary,
+ ];
+
+ if (isset($dbParams['host'])) {
+ $args[] = '-h';
+ $args[] = $dbParams['host'];
+ }
+
+ if (isset($dbParams['user'])) {
+ $args[] = '-u';
+ $args[] = $dbParams['user'];
+ }
+
+ if (isset($dbParams['port'])) {
+ $args[] = '-P';
+ $args[] = $dbParams['port'];
+ }
+
+ if (isset($dbParams['password'])) {
+ $args[] = '-p' . $dbParams['password'];
+ }
+
+ $args[] = '-r';
+ $args[] = $this->destination;
+ $args[] = $dbParams['dbname'];
+ $args[] = '--no-tablespaces';
+
+ foreach ($this->excludedTables as $table) {
+ $args[] = '--ignore-table';
+ $args[] = $dbParams['dbname'] . '.' . $table;
+ }
+
+ if ($this->verbose) {
+ $args[] = '-v';
+ }
+
+ $this->process = new Process(
+ $args,
+ null,
+ null,
+ null,
+ 600
+ );
+
+ $this->process->start();
+
+ return $this;
+ }
+
+ public function checkSuccessful(): void
+ {
+ if (!$this->process->isSuccessful()) {
+ throw new ProcessFailedException($this->process);
+ }
+ }
+
+ public function getExtension(): string
+ {
+ return 'sql';
+ }
+
+ public function getOutput(): string
+ {
+ return $this->process->getOutput();
+ }
+
+ public function getIterator(): \Traversable
+ {
+ return $this->process;
+ }
+}

src/DependencyInjection/DbToolsConfiguration.php

@@ -29,16 +29,18 @@ public function getConfigTreeBuilder(): TreeBuilder
  ->end()
  ->arrayNode('backupper_binaries')
  ->defaultValue([
- 'postgresql' => 'pg_dump',
+ 'mariadb' => 'mariadb-dump',
  'mysql' => 'mysqldump',
+ 'postgresql' => 'pg_dump',
  'sqlite' => 'sqlite3',
  ])
  ->scalarPrototype()->end()
  ->end()
  ->arrayNode('restorer_binaries')
  ->defaultValue([
- 'postgresql' => 'pg_restore',
+ 'mariadb' => 'mariadb',
  'mysql' => 'mysql',
+ 'postgresql' => 'pg_restore',
  'sqlite' => 'sqlite3',
  ])
  ->scalarPrototype()->end()

src/Restorer/MariaDB/Restorer.php

@@ -0,0 +1,96 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MakinaCorpus\DbToolsBundle\Restorer\MariaDB;
+
+use MakinaCorpus\DbToolsBundle\Restorer\AbstractRestorer;
+use Symfony\Component\Process\Exception\ProcessFailedException;
+use Symfony\Component\Process\Process;
+
+class Restorer extends AbstractRestorer
+{
+ private ?Process $process = null;
+ private mixed $backupStream = null;
+ /**
+ * {@inheritdoc}
+ */
+ public function startRestore(): self
+ {
+ $dbParams = $this->connection->getParams();
+
+ $args = [
+ $this->binary,
+ ];
+
+ if (isset($dbParams['host'])) {
+ $args[] = '-h';
+ $args[] = $dbParams['host'];
+ }
+
+ if (isset($dbParams['user'])) {
+ $args[] = '-u';
+ $args[] = $dbParams['user'];
+ }
+
+ if (isset($dbParams['port'])) {
+ $args[] = '-P';
+ $args[] = $dbParams['port'];
+ }
+
+ if (isset($dbParams['password'])) {
+ $args[] = '-p' . $dbParams['password'];
+ }
+
+ $args[] = $dbParams['dbname'];
+
+ if ($this->verbose) {
+ $args[] = '-v';
+ }
+
+ $this->backupStream = \fopen($this->backupFilename, 'r');
+
+ if (false === $this->backupStream) {
+ throw new \InvalidArgumentException(\sprintf(
+ "Backup file '%s' can't be read",
+ $this->backupFilename
+ ));
+ }
+
+ $this->process = new Process(
+ $args,
+ null,
+ null,
+ $this->backupStream,
+ 1800
+ );
+
+ $this->process->start();
+
+ return $this;
+ }
+
+ public function checkSuccessful(): void
+ {
+ if (!$this->process->isSuccessful()) {
+ throw new ProcessFailedException($this->process);
+ }
+
+ \fclose($this->backupStream);
+ }
+
+ public function getExtension(): string
+ {
+ return 'sql';
+ }
+
+ public function getOutput(): string
+ {
+ return $this->process->getOutput();
+ }
+
+ public function getIterator(): \Traversable
+ {
+ return $this->process;
+ }
+}

src/Restorer/MySQL/Restorer.php

@@ -6,7 +6,6 @@
 
 use MakinaCorpus\DbToolsBundle\Restorer\AbstractRestorer;
 use Symfony\Component\Process\Exception\ProcessFailedException;
-use Symfony\Component\Process\InputStream;
 use Symfony\Component\Process\Process;
 
 class Restorer extends AbstractRestorer
@@ -51,6 +50,13 @@ public function startRestore(): self
 
  $this->backupStream = \fopen($this->backupFilename, 'r');
 
+ if (false === $this->backupStream) {
+ throw new \InvalidArgumentException(\sprintf(
+ "Backup file '%s' can't be read",
+ $this->backupFilename
+ ));
+ }
+
  $this->process = new Process(
  $args,
  null,

src/Restorer/RestorerFactory.php

@@ -30,8 +30,9 @@ public function create(?string $connectionName = null): AbstractRestorer
  $platform = $queryBuilder->getServerFlavor();
 
  $restorer = match ($platform) {
- Platform::POSTGRESQL => PgSQL\Restorer::class,
+ Platform::MARIADB => MariaDB\Restorer::class,
  Platform::MYSQL => MySQL\Restorer::class,
+ Platform::POSTGRESQL => PgSQL\Restorer::class,
  Platform::SQLITE => SQLite\Restorer::class,
  default => throw new NotImplementedException(\sprintf(
  "Restore is not implemented or configured for platform '%s' while using connection '%s'",

src/Restorer/SQLite/Restorer.php

@@ -29,6 +29,13 @@ public function startRestore(): self
  $command .= ' < "' . \addcslashes($this->backupFilename, '\\"') . '"';
  $this->backupStream = \fopen($this->backupFilename, 'r');
 
+ if (false === $this->backupStream) {
+ throw new \InvalidArgumentException(\sprintf(
+ "Backup file '%s' can't be read",
+ $this->backupFilename
+ ));
+ }
+
  $this->process = Process::fromShellCommandline(
  $command,
  null,

tests/Functional/BackupperRestorer/BackupperRestorerTest.php

@@ -78,8 +78,9 @@ public function testBackupper(): void
  ;
 
  $backupperFactoy = new BackupperFactory($mockDoctrineRegistry, [
- 'postgresql' => 'pg_dump',
+ 'mariadb' => 'mariadb-dump',
  'mysql' => 'mysqldump',
+ 'postgresql' => 'pg_dump',
  'sqlite' => 'sqlite3',
  ]);
 
@@ -130,8 +131,9 @@ public function testRestorer(): void
  ;
 
  $restorerFactoy = new RestorerFactory($mockDoctrineRegistry, [
- 'postgresql' => 'pg_restore',
+ 'mariadb' => 'mariadb',
  'mysql' => 'mysql',
+ 'postgresql' => 'pg_restore',
  'sqlite' => 'sqlite3',
  ]);