Adding console commands (#22)

* Adding console commands

* Adding restore command.

Author: Nyholm

Command/BackupCommand.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace BM\BackupManagerBundle\Command;
+
+
+use BackupManager\Config\Config;
+use BackupManager\Filesystems\Destination;
+use BackupManager\Filesystems\FilesystemProvider;
+use BackupManager\Manager;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Backup database.
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class BackupCommand extends Command
+{
+    protected static $defaultName = 'backup-manager:backup';
+
+    /**
+     * @var Manager
+     */
+    private $manager;
+
+    /**
+     * @var string
+     */
+    private $filePrefix;
+
+    /**
+     *
+     * @param Manager $manager
+     * @param string $filePrefix
+     */
+    public function __construct(Manager $manager, $filePrefix)
+    {
+        $this->manager = $manager;
+        $this->filePrefix = $filePrefix;
+        parent::__construct();
+    }
+
+
+    protected function configure()
+    {
+        $this
+            ->setDescription('Starts a new backup.')
+            ->addArgument('database', InputArgument::REQUIRED, 'What database configuration do you want to backup?')
+            ->addArgument('destinations', InputArgument::IS_ARRAY, 'What storages do you want to upload the backup to?')
+            ->addOption('compression', 'c', InputOption::VALUE_OPTIONAL, 'How do you want to compress the file?', 'null')
+            ->addOption('filename', 'name', InputOption::VALUE_OPTIONAL, 'A customized filename', null)
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        if (null === $filename = $input->getOption('filename')) {
+            $filename = $this->filePrefix.(new \DateTime())->format('Y-m-d_H-i-s');
+        }
+
+        $destinations = [];
+        foreach ($input->getArgument('destinations') as $name) {
+            $destinations[] = new Destination($name, $filename);
+        }
+
+        $this->manager->makeBackup()->run($input->getArgument('database'), $destinations, $input->getOption('compression'));
+    }
+}

Command/RestoreCommand.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace BM\BackupManagerBundle\Command;
+
+
+use BackupManager\Config\Config;
+use BackupManager\Filesystems\Destination;
+use BackupManager\Filesystems\FilesystemProvider;
+use BackupManager\Manager;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Restore from backup.
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class RestoreCommand extends Command
+{
+    protected static $defaultName = 'backup-manager:restore';
+
+    /**
+     * @var Manager
+     */
+    private $manager;
+
+    /**
+     *
+     * @param Manager $manager
+     */
+    public function __construct(Manager $manager)
+    {
+        $this->manager = $manager;
+        parent::__construct();
+    }
+
+
+    protected function configure()
+    {
+        $this
+            ->setDescription('Restore form backup.')
+            ->addArgument('database', InputArgument::REQUIRED, 'What database configuration do you want to backup?')
+            ->addArgument('destination', InputArgument::REQUIRED, 'What storage do you want to restore from?')
+            ->addArgument('file_path', InputArgument::REQUIRED, 'Where on the storage is the file?')
+            ->addOption('compression', 'c', InputOption::VALUE_OPTIONAL, 'What file compression is used?', 'null')
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $this->manager->makeRestore()->run(
+            $input->getArgument('destination'),
+            $input->getArgument('file_path'),
+            $input->getArgument('database'),
+            $input->getOption('compression')
+        );
+    }
+
+}

DependencyInjection/BMBackupManagerExtension.php

@@ -47,6 +47,11 @@ public function load(array $configs, ContainerBuilder $container)
 
         $container->getDefinition('backup_manager.config_database')
             ->replaceArgument(0, $config['database']);
+
+        if (isset($config['output_file_prefix'])) {
+            $container->getDefinition('backup_manager.command.backup')
+                ->replaceArgument(1, $config['output_file_prefix']);
+        }
     }
 
     /**

DependencyInjection/Configuration.php

@@ -71,6 +71,7 @@ public function getConfigTreeBuilder()
                         ->end()
                     ->end()
                 ->end()
+                ->scalarNode('output_file_prefix')->info('Use as a prefix for default backup filename')->end()
             ->end()
         ;
 

README.md

@@ -131,7 +131,11 @@ Backup to / restore from any configured database.
 Backup the development database to `Amazon S3`. The S3 backup path will be `test/backup.sql.gz` in the end, when `gzip` is done with it.
 
 ```php
-$this->container->get('backup_manager')->makeBackup()->run('development', 's3', 'test/backup.sql', 'gzip');
+$this->container->get('backup_manager')->makeBackup()->run('development', [new Destination('s3', 'test/backup.sql')], 'gzip');
+```
+
+```bash
+php bin/console backup-manager:backup development s3 -c gzip --filename test/backup.sql
 ```
 
 Backup to / restore from any configured filesystem.
@@ -143,6 +147,10 @@ Restore the database file `test/backup.sql.gz` from `Amazon S3` to the `developm
 $this->container->get('backup_manager')->makeRestore()->run('s3', 'test/backup.sql.gz', 'development', 'gzip');
 ```
 
+```bash
+php bin/console backup-manager:backup development s3 test/backup.sql.gz -c gzip 
+```
+
 > This package does not allow you to backup from one database type and restore to another. A MySQL dump is not compatible with PostgreSQL.
 
 Requirements

Resources/config/services.yml

@@ -1,4 +1,19 @@
 services:
+    # Commands
+    backup_manager.command.backup:
+        class: BM\BackupManagerBundle\Command\BackupCommand
+        public: false
+        arguments: ['@backup_manager', '']
+        tags:
+            - { name: 'console.command' }
+
+    backup_manager.command.restore:
+        class: BM\BackupManagerBundle\Command\RestoreCommand
+        public: false
+        arguments: ['@backup_manager']
+        tags:
+            - { name: 'console.command' }
+
     # Storage
     backup_manager.config_storage:
         class:  BackupManager\Config\Config

composer.json

@@ -14,6 +14,7 @@
         "php": "^5.5 || ^7.0",
         "backup-manager/backup-manager": "^1.2",
         "symfony/config": "^2.7 || ^3.1 || ^4.0",
+        "symfony/console": "^2.7 || ^3.1 || ^4.0",
         "symfony/dependency-injection": "^2.7 || ^3.1 || ^4.0",
         "symfony/filesystem": "^2.7 || ^3.1 || ^4.0",
         "symfony/framework-bundle": "^2.7 || ^3.0 || ^4.0",