Merge pull request #182 from cakephp/migrations-class-seed

Update the Migrations class to support the seeding feature
cakephp · Jan 10, 2016 · dc814e3 · dc814e3
2 parents 04f969b + 580665b
commit dc814e3
Show file tree

Hide file tree

Showing 8 changed files with 240 additions and 4 deletions.
diff --git a/src/CakeManager.php b/src/CakeManager.php
@@ -30,6 +30,16 @@ public function resetMigrations()
         $this->migrations = null;
     }
 
+    /**
+     * Reset the seeds stored in the object
+     *
+     * @return void
+     */
+    public function resetSeeds()
+    {
+        $this->seeds = null;
+    }
+
     /**
      * Prints the specified environment's migration status.
      *

diff --git a/src/ConfigurationTrait.php b/src/ConfigurationTrait.php
@@ -61,7 +61,7 @@ public function getConfig($forceRefresh = false)
 
         $source = $this->input->getOption('source');
         if ($source) {
-            if ($this instanceof Seed) {
+            if ($this instanceof Seed || ($this instanceof Migrations && $this->getCommand() === 'seed')) {
                 $seedsFolder = $source;
             } else {
                 $migrationsFolder = $source;

diff --git a/src/Migrations.php b/src/Migrations.php
@@ -48,6 +48,15 @@ class Migrations
      */
     protected $default = [];
 
+    /**
+     * Current command being run.
+     * Useful if some logic needs to be applied in the ConfigurationTrait depending
+     * on the command
+     *
+     * @var array
+     */
+    protected $command;
+
     /**
      * Constructor
      * @param array $default Default option to be used when calling a method.
@@ -65,6 +74,28 @@ public function __construct(array $default = [])
         }
     }
 
+    /**
+     * Sets the command
+     *
+     * @param string $command Command name to store.
+     * @return self
+     */
+    public function setCommand($command)
+    {
+        $this->command = $command;
+        return $this;
+    }
+
+    /**
+     * Gets the command
+     *
+     * @return string Command name
+     */
+    public function getCommand()
+    {
+        return $this->command;
+    }
+
     /**
      * Returns the status of each migrations based on the options passed
      *
@@ -80,6 +111,7 @@ public function __construct(array $default = [])
      */
     public function status($options = [])
     {
+        $this->setCommand('status');
         $input = $this->getInput('Status', [], $options);
         $params = ['default', $input->getOption('format')];
 
@@ -103,6 +135,7 @@ public function status($options = [])
      */
     public function migrate($options = [])
     {
+        $this->setCommand('migrate');
         $input = $this->getInput('Migrate', [], $options);
         $method = 'migrate';
         $params = ['default', $input->getOption('target')];
@@ -133,6 +166,7 @@ public function migrate($options = [])
      */
     public function rollback($options = [])
     {
+        $this->setCommand('rollback');
         $input = $this->getInput('Rollback', [], $options);
         $method = 'rollback';
         $params = ['default', $input->getOption('target')];
@@ -161,6 +195,7 @@ public function rollback($options = [])
      */
     public function markMigrated($version, $options = [])
     {
+        $this->setCommand('mark_migrated');
         $input = $this->getInput('MarkMigrated', ['version' => $version], $options);
         $params = [$version];
 
@@ -175,6 +210,29 @@ public function markMigrated($version, $options = [])
         return true;
     }
 
+
+    /**
+     * Seed the database using a seed file
+     *
+     * @param array $options Options to pass to the command
+     * Available options are :
+     *
+     * - `connection` The datasource connection to use
+     * - `source` The folder where migrations are in
+     * - `plugin` The plugin containing the migrations
+     * - `seed` The seed file to use
+     *
+     * @return bool Success
+     */
+    public function seed($options = [])
+    {
+        $this->setCommand('seed');
+        $input = $this->getInput('Seed', [], $options);
+        $params = ['default', $input->getOption('seed')];
+        $this->run('Seed', $params, $input);
+        return true;
+    }
+
     /**
      * Runs the method needed to execute and return
      *
@@ -189,6 +247,7 @@ protected function run($method, $params, $input)
     {
         if ($this->configuration instanceof Config) {
             $migrationPath = $this->getConfig()->getMigrationPath();
+            $seedPath = $this->getConfig()->getSeedPath();
         }
 
         $this->setInput($input);
@@ -198,6 +257,9 @@ protected function run($method, $params, $input)
         if (isset($migrationPath) && $newConfig->getMigrationPath() !== $migrationPath) {
             $manager->resetMigrations();
         }
+        if (isset($seedPath) && $newConfig->getSeedPath() !== $seedPath) {
+            $manager->resetSeeds();
+        }
 
         return call_user_func_array([$manager, $method], $params);
     }

diff --git a/tests/TestCase/Command/SeedTest.php b/tests/TestCase/Command/SeedTest.php
@@ -155,7 +155,7 @@ public function testExecuteCustomParams()
             ->execute()->fetchAll('assoc');
         $expected = [
             [
-                'id' => '1',
+                'id' => '2',
                 'number' => '5',
                 'radix' => '10'
             ]

diff --git a/tests/TestCase/MigrationsTest.php b/tests/TestCase/MigrationsTest.php
@@ -426,6 +426,143 @@ public function testMigrateDateOption()
         $this->assertEquals($expectedStatus, $this->migrations->status());
     }
 
+    /**
+     * Tests seeding the database
+     *
+     * @return void
+     */
+    public function testSeed()
+    {
+        $this->migrations->migrate();
+        $seed = $this->migrations->seed(['source' => 'Seeds']);
+        $this->assertTrue($seed);
+
+        $result = $this->Connection->newQuery()
+            ->select(['*'])
+            ->from('numbers')
+            ->execute()->fetchAll('assoc');
+        $expected = [
+            [
+                'id' => '1',
+                'number' => '10',
+                'radix' => '10'
+            ]
+        ];
+        $this->assertEquals($expected, $result);
+
+        $seed = $this->migrations->seed(['source' => 'Seeds']);
+        $this->assertTrue($seed);
+        $result = $this->Connection->newQuery()
+            ->select(['*'])
+            ->from('numbers')
+            ->execute()->fetchAll('assoc');
+        $expected = [
+            [
+                'id' => '1',
+                'number' => '10',
+                'radix' => '10'
+            ],
+            [
+                'id' => '2',
+                'number' => '10',
+                'radix' => '10'
+            ]
+        ];
+        $this->assertEquals($expected, $result);
+
+        $seed = $this->migrations->seed(['source' => 'AltSeeds']);
+        $this->assertTrue($seed);
+        $result = $this->Connection->newQuery()
+            ->select(['*'])
+            ->from('numbers')
+            ->execute()->fetchAll('assoc');
+        $expected = [
+            [
+                'id' => '1',
+                'number' => '10',
+                'radix' => '10'
+            ],
+            [
+                'id' => '2',
+                'number' => '10',
+                'radix' => '10'
+            ],
+            [
+                'id' => '3',
+                'number' => '2',
+                'radix' => '10'
+            ],
+            [
+                'id' => '4',
+                'number' => '5',
+                'radix' => '10'
+            ]
+        ];
+        $this->assertEquals($expected, $result);
+        $this->migrations->rollback(['target' => 0]);
+    }
+
+    /**
+     * Tests seeding the database with seeder
+     *
+     * @return void
+     */
+    public function testSeedOneSeeder()
+    {
+        $this->migrations->migrate();
+
+        $seed = $this->migrations->seed(['source' => 'AltSeeds', 'seed' => 'AnotherNumbersSeed']);
+        $this->assertTrue($seed);
+        $result = $this->Connection->newQuery()
+            ->select(['*'])
+            ->from('numbers')
+            ->execute()->fetchAll('assoc');
+
+        $expected = [
+            [
+                'id' => '1',
+                'number' => '2',
+                'radix' => '10'
+            ]
+        ];
+        $this->assertEquals($expected, $result);
+
+        $seed = $this->migrations->seed(['source' => 'AltSeeds', 'seed' => 'NumbersAltSeed']);
+        $this->assertTrue($seed);
+        $result = $this->Connection->newQuery()
+            ->select(['*'])
+            ->from('numbers')
+            ->execute()->fetchAll('assoc');
+
+        $expected = [
+            [
+                'id' => '1',
+                'number' => '2',
+                'radix' => '10'
+            ],
+            [
+                'id' => '2',
+                'number' => '5',
+                'radix' => '10'
+            ]
+        ];
+        $this->assertEquals($expected, $result);
+
+        $this->migrations->rollback(['target' => 0]);
+    }
+
+    /**
+     * Tests that requesting a unexistant seed throws an exception
+     *
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage The seed class "DerpSeed" does not exist
+     * @return void
+     */
+    public function testSeedWrongSeed()
+    {
+        $this->migrations->seed(['source' => 'AltSeeds', 'seed' => 'DerpSeed']);
+    }
+
     /**
      * Tests migrating the baked snapshots
      *

diff --git a/tests/test_app/config/AltSeeds/AnotherNumbersSeed.php b/tests/test_app/config/AltSeeds/AnotherNumbersSeed.php
@@ -0,0 +1,29 @@
+<?php
+use Phinx\Seed\AbstractSeed;
+
+/**
+ * NumbersSeed seed.
+ */
+class AnotherNumbersSeed extends AbstractSeed
+{
+    /**
+     * Run Method.
+     *
+     * Write your database seeder using this method.
+     *
+     * More information on writing seeders is available here:
+     * http://docs.phinx.org/en/latest/seeding.html
+     */
+    public function run()
+    {
+        $data = [
+            [
+                'number' => '2',
+                'radix' => '10'
+            ]
+        ];
+
+        $table = $this->table('numbers');
+        $table->insert($data)->save();
+    }
+}
diff --git a/tests/test_app/config/AltSeeds/NumbersAltSeed.php b/tests/test_app/config/AltSeeds/NumbersAltSeed.php
@@ -18,7 +18,6 @@ public function run()
     {
         $data = [
             [
-                'id' => '1',
                 'number' => '5',
                 'radix' => '10'
             ]

diff --git a/tests/test_app/config/Seeds/NumbersSeed.php b/tests/test_app/config/Seeds/NumbersSeed.php
@@ -18,7 +18,6 @@ public function run()
     {
         $data = [
             [
-                'id' => '1',
                 'number' => '10',
                 'radix' => '10'
             ]