Adding support for ignoreTables (#25)

* Adding support for ignoreTables

* Added tests

* Remove config key if it was not set

* Added docs

* Fixed typo

Author: Nyholm

DependencyInjection/Configuration.php

@@ -20,8 +20,7 @@ public function getConfigTreeBuilder()
             ->children()
                 ->variableNode('storage')
                     ->validate()
-                        ->always()
-                        ->then(function ($storageConfig) {
+                        ->always(function ($storageConfig) {
                             foreach ($storageConfig as $name => $config) {
                                 if (!isset($config['type'])) {
                                     throw new InvalidConfigurationException(sprintf('You must define a "type" for storage "%s"', $name));
@@ -60,6 +59,27 @@ public function getConfigTreeBuilder()
                 ->end() // End storage
 
                 ->arrayNode('database')->isRequired()
+                    ->validate()
+                        ->ifTrue(function ($databases) {
+                            $valid = true;
+                            foreach ($databases as $database) {
+                                $valid = $valid && (empty($database['ignoreTables']) || $database['type'] === 'mysql');
+                            }
+
+                            return !$valid;
+                        })
+                        ->thenInvalid('Key "ignoreTables" is only valid on MySQL databases.')
+                    ->end()
+                    ->validate()
+                        ->always(function ($databases) {
+                            foreach ($databases as &$database) {
+                                if (empty($database['ignoreTables'])) {
+                                    unset($database['ignoreTables']);
+                                }
+                            }
+                            return $databases;
+                        })
+                    ->end()
                     ->prototype('array')
                         ->children()
                             ->scalarNode('type')->end()
@@ -68,6 +88,9 @@ public function getConfigTreeBuilder()
                             ->scalarNode('user')->end()
                             ->scalarNode('pass')->end()
                             ->scalarNode('database')->end()
+                            ->arrayNode('ignoreTables')
+                                ->scalarPrototype()->end()
+                            ->end()
                         ->end()
                     ->end()
                 ->end()

README.md

@@ -70,6 +70,7 @@ bm_backup_manager:
             user: root
             pass: password
             database: test
+            ignoreTables: ['foo', 'bar']
         production:
             type: postgresql
             host: localhost

Tests/Unit/DependencyInjection/BMBackupManagerExtensionTest.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace BM\BackupManagerBundle\Tests\Unit\DependencyInjection;
 
 use BM\BackupManagerBundle\DependencyInjection\BMBackupManagerExtension;
@@ -22,7 +21,7 @@ protected function getContainerExtensions()
 
     public function testReplacementOfConfig()
     {
-        $storageConfig = ['local'=>['type'=>'local', 'root'=>'/foo']];
+        $storageConfig = ['local'=>['type'=>'Local', 'root'=>'/foo']];
         $dbConfig = ['dev'=>['type'=>'mysql']];
 
         $this->load([

Tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace BM\BackupManagerBundle\Tests\Unit\DependencyInjection;
+
+use BM\BackupManagerBundle\DependencyInjection\Configuration;
+use Matthias\SymfonyConfigTest\PhpUnit\ConfigurationTestCaseTrait;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @author Tobias Nyholm <[email protected]>
+ */
+class ConfigurationTest extends TestCase
+{
+    use ConfigurationTestCaseTrait;
+
+    protected function getConfiguration()
+    {
+        return new Configuration();
+    }
+
+    public function testIgnoreTablesGeneratesErrorWhenNotUsingMySQL()
+    {
+        $this->assertConfigurationIsInvalid(array(
+                [
+                    'database'=>[
+                        'dev'=>[
+                            'type' => 'foo',
+                            'ignoreTables'=>['xx', 'yy']
+                        ],
+                        'prod'=>[
+                            'type' => 'mysql',
+                        ],
+                    ],
+                ]
+            ),
+            'Key "ignoreTables" is only valid on MySQL databases.'
+        );
+    }
+
+    public function testIgnoreTablesDoesNothingWhenOmitted()
+    {
+        $this->assertConfigurationIsValid(array(
+                [
+                    'database'=>[
+                        'dev'=>[
+                            'type' => 'foo',
+                        ],
+                        'prod'=>[
+                            'type' => 'mysql',
+                        ],
+                    ],
+                ]
+            )
+        );
+    }
+}