adding an option to not throw an exception if no migration is found

This is mostly usefull for Continuous integration system
doctrine · Aug 27, 2015 · a9ec86f · a9ec86f
1 parent 27edc38
commit a9ec86f
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 1 deletion.
diff --git a/lib/Doctrine/DBAL/Migrations/Migration.php b/lib/Doctrine/DBAL/Migrations/Migration.php
@@ -43,6 +43,11 @@ class Migration
      */
     private $configuration;
 
+    /**
+     * @var boolean
+     */
+    private $noMigrationException;
+
     /**
      * Construct a Migration instance
      *
@@ -52,6 +57,7 @@ public function __construct(Configuration $configuration)
     {
         $this->configuration = $configuration;
         $this->outputWriter = $configuration->getOutputWriter();
+        $this->noMigrationException = false;
     }
 
     /**
@@ -97,6 +103,14 @@ public function writeSqlFile($path, $to = null)
         return $sqlWriter->write($sql, $direction);
     }
 
+    /**
+     * @param boolean $noMigrationException Throw an exception or not if no migration is found. Mostly for Continuous Integration.
+     */
+    public function setNoMigrationException($noMigrationException = false)
+    {
+        $this->noMigrationException = $noMigrationException;
+    }
+
     /**
      * Run a migration to the current version or the given target version.
      *
@@ -151,7 +165,7 @@ public function migrate($to = null, $dryRun = false, $timeAllQueries = false)
         /**
          * If there are no migrations to execute throw an exception.
          */
-        if (empty($migrationsToExecute)) {
+        if (empty($migrationsToExecute) && !$this->noMigrationException) {
             throw MigrationException::noMigrationsToExecute();
         }
 

diff --git a/lib/Doctrine/DBAL/Migrations/Tools/Console/Command/MigrateCommand.php b/lib/Doctrine/DBAL/Migrations/Tools/Console/Command/MigrateCommand.php
@@ -45,6 +45,7 @@ protected function configure()
             ->addOption('write-sql', null, InputOption::VALUE_NONE, 'The path to output the migration SQL file instead of executing it.')
             ->addOption('dry-run', null, InputOption::VALUE_NONE, 'Execute the migration as a dry run.')
             ->addOption('query-time', null, InputOption::VALUE_NONE, 'Time all the queries individually.')
+            ->addOption('allow-no-migration', null, InputOption::VALUE_NONE, 'Don\'t throw an exception if no migration is available (CI).')
             ->setHelp(<<<EOT
 The <info>%command.name%</info> command executes a migration to a specified version or the latest available version:
 
@@ -138,6 +139,7 @@ public function execute(InputInterface $input, OutputInterface $output)
                 }
             }
 
+            $migration->setNoMigrationException($input->getOption('allow-no-migration'));
             $sql = $migration->migrate($version, $dryRun, $timeAllqueries);
 
             if (empty($sql)) {

diff --git a/tests/Doctrine/DBAL/Migrations/Tests/MigrationTest.php b/tests/Doctrine/DBAL/Migrations/Tests/MigrationTest.php
@@ -61,6 +61,14 @@ public function testMigrateWithNoMigrationsThrowsException()
         $migration->migrate();
     }
 
+    public function testMigrateWithNoMigrationsDontThrowsExceptionIfContiniousIntegrationOption()
+    {
+        $migration = new Migration($this->config);
+
+        $migration->setNoMigrationException(true);
+        $migration->migrate();
+    }
+
     /**
      * @param $to
      *