Support options batch for migrate:rollback. (#7531)

Author: albertcht

src/Commands/Migrations/RollbackCommand.php

@@ -45,6 +45,7 @@ public function handle()
             [
                 'pretend' => $this->input->getOption('pretend'),
                 'step' => (int) $this->input->getOption('step'),
+                'batch' => (int) $this->input->getOption('batch'),
             ]
         );
     }
@@ -63,6 +64,7 @@ protected function getOptions()
             ['realpath', null, InputOption::VALUE_NONE, 'Indicate any provided migration file paths are pre-resolved absolute paths'],
             ['pretend', null, InputOption::VALUE_NONE, 'Dump the SQL queries that would be run'],
             ['step', null, InputOption::VALUE_OPTIONAL, 'The number of migrations to be reverted'],
+            ['batch', null, InputOption::VALUE_OPTIONAL, 'The batch of migrations (identified by their batch number) to be reverted'],
         ];
     }
 }

src/Migrations/DatabaseMigrationRepository.php

@@ -88,6 +88,21 @@ public function getMigrationBatches()
             ->pluck('batch', 'migration')->all();
     }
 
+    /**
+     * Get the list of the migrations by batch number.
+     *
+     * @param int $batch
+     * @return array
+     */
+    public function getMigrationsByBatch($batch)
+    {
+        return $this->table()
+            ->where('batch', $batch)
+            ->orderBy('migration', 'desc')
+            ->get()
+            ->all();
+    }
+
     /**
      * Log that a migration was run.
      *

src/Migrations/MigrationRepositoryInterface.php

@@ -43,6 +43,14 @@ public function getLast();
      */
     public function getMigrationBatches();
 
+    /**
+     * Get the list of the migrations by batch number.
+     *
+     * @param int $batch
+     * @return array
+     */
+    public function getMigrationsByBatch($batch);
+
     /**
      * Log that a migration was run.
      *

src/Migrations/Migrator.php

@@ -355,6 +355,10 @@ protected function getMigrationsForRollback(array $options): array
             return $this->repository->getMigrations($steps);
         }
 
+        if (($batch = $options['batch'] ?? 0) > 0) {
+            return $this->repository->getMigrationsByBatch($batch);
+        }
+
         return $this->repository->getLast();
     }
 

tests/DatabaseMigrationRepositoryTest.php

@@ -139,6 +139,21 @@ public function testCreateRepositoryCreatesProperDatabaseTable()
         $repo->createRepository();
     }
 
+    public function testGetMigrationsByBatchReturnsCorrectMigrations()
+    {
+        $repo = $this->getRepository();
+        $query = Mockery::mock(Builder::class);
+        $connectionMock = Mockery::mock(Connection::class);
+        $repo->getConnectionResolver()->shouldReceive('connection')->with(null)->andReturn($connectionMock);
+        $repo->getConnection()->shouldReceive('table')->once()->with('migrations')->andReturn($query);
+        $query->shouldReceive('where')->once()->with('batch', '5')->andReturn($query);
+        $query->shouldReceive('orderBy')->once()->with('migration', 'desc')->andReturn($query);
+        $query->shouldReceive('get')->once()->andReturn(new Collection(['migration2', 'migration1']));
+        $query->shouldReceive('useWritePdo')->once()->andReturn($query);
+
+        $this->assertEquals(['migration2', 'migration1'], $repo->getMigrationsByBatch('5'));
+    }
+
     protected function getRepository()
     {
         return new DatabaseMigrationRepository(Mockery::mock(ConnectionResolverInterface::class), 'migrations');

tests/DatabaseMigrationRollbackCommandTest.php

@@ -49,7 +49,7 @@ public function testRollbackCommandCallsMigratorWithProperArguments()
         $migrator->shouldReceive('paths')->once()->andReturn([]);
         $migrator->shouldReceive('setConnection')->once()->with('default');
         $migrator->shouldReceive('setOutput')->once()->andReturn($migrator);
-        $migrator->shouldReceive('rollback')->once()->with([BASE_PATH . DIRECTORY_SEPARATOR . 'migrations'], ['pretend' => false, 'step' => 0]);
+        $migrator->shouldReceive('rollback')->once()->with([BASE_PATH . DIRECTORY_SEPARATOR . 'migrations'], ['pretend' => false, 'step' => 0, 'batch' => 0]);
 
         $this->runCommand($command);
     }
@@ -60,11 +60,22 @@ public function testRollbackCommandCallsMigratorWithStepOption()
         $migrator->shouldReceive('paths')->once()->andReturn([]);
         $migrator->shouldReceive('setConnection')->once()->with('default');
         $migrator->shouldReceive('setOutput')->once()->andReturn($migrator);
-        $migrator->shouldReceive('rollback')->once()->with([BASE_PATH . DIRECTORY_SEPARATOR . 'migrations'], ['pretend' => false, 'step' => 2]);
+        $migrator->shouldReceive('rollback')->once()->with([BASE_PATH . DIRECTORY_SEPARATOR . 'migrations'], ['pretend' => false, 'step' => 2, 'batch' => 0]);
 
         $this->runCommand($command, ['--step' => 2]);
     }
 
+    public function testRollbackCommandCallsMigratorWithBatchOption()
+    {
+        $command = new RollbackCommand($migrator = Mockery::mock(Migrator::class));
+        $migrator->shouldReceive('paths')->once()->andReturn([]);
+        $migrator->shouldReceive('setConnection')->once()->with('default');
+        $migrator->shouldReceive('setOutput')->once()->andReturn($migrator);
+        $migrator->shouldReceive('rollback')->once()->with([BASE_PATH . DIRECTORY_SEPARATOR . 'migrations'], ['pretend' => false, 'step' => 0, 'batch' => 2]);
+
+        $this->runCommand($command, ['--batch' => 2]);
+    }
+
     public function testRollbackCommandCanBePretended()
     {
         $command = new RollbackCommand($migrator = Mockery::mock(Migrator::class));
@@ -82,7 +93,7 @@ public function testRollbackCommandCanBePretendedWithStepOption()
         $migrator->shouldReceive('paths')->once()->andReturn([]);
         $migrator->shouldReceive('setConnection')->once()->with('foo');
         $migrator->shouldReceive('setOutput')->once()->andReturn($migrator);
-        $migrator->shouldReceive('rollback')->once()->with([BASE_PATH . DIRECTORY_SEPARATOR . 'migrations'], ['pretend' => true, 'step' => 2]);
+        $migrator->shouldReceive('rollback')->once()->with([BASE_PATH . DIRECTORY_SEPARATOR . 'migrations'], ['pretend' => true, 'step' => 2, 'batch' => 0]);
 
         $this->runCommand($command, ['--pretend' => true, '--database' => 'foo', '--step' => 2]);
     }