Merge pull request #1865 from atishamte/migration

MigrationRunner issue with definition resolved

Author: lonnieezell

system/Database/MigrationRunner.php

@@ -196,7 +196,7 @@ public function __construct(BaseConfig $config, $db = null)
 	 * @param string|null $namespace
 	 * @param string|null $group
 	 *
-	 * @return mixed TRUE if no migrations are found, current version string on success, FALSE on failure
+	 * @return mixed Current version string on success, FALSE on failure or no migrations are found
 	 * @throws ConfigException
 	 */
 	public function version(string $targetVersion, string $namespace = null, string $group = null)
@@ -253,12 +253,14 @@ public function version(string $targetVersion, string $namespace = null, string
 		$this->checkMigrations($migrations, $method, $targetVersion);
 
 		// loop migration for each namespace (module)
+
+		$migrationStatus = false;
 		foreach ($migrations as $version => $migration)
 		{
 			// Only include migrations within the scoop
-			if (($method === 'up' && $version > $currentVersion && $version <= $targetVersion) || ( $method === 'down' && $version <= $currentVersion && $version > $targetVersion)
-			)
+			if (($method === 'up' && $version > $currentVersion && $version <= $targetVersion) || ( $method === 'down' && $version <= $currentVersion && $version > $targetVersion))
 			{
+				$migrationStatus = false;
 				include_once $migration->path;
 				// Get namespaced class name
 				$class = $this->namespace . '\Database\Migrations\Migration_' . ($migration->name);
@@ -288,10 +290,12 @@ public function version(string $targetVersion, string $namespace = null, string
 				{
 					$this->removeHistory($migration->version);
 				}
+
+				$migrationStatus = true;
 			}
 		}
 
-		return true;
+		return ($migrationStatus) ? $targetVersion : false;
 	}
 
 	//--------------------------------------------------------------------

tests/system/Database/Migrations/MigrationRunnerTest.php

@@ -231,10 +231,10 @@ public function testVersionThrowsMigrationGapException()
 
 		$version = $runner->version(0);
 
-		$this->assertEquals($version, '002');
+		$this->assertFalse($version);
 	}
 
-	public function testVersionReturnsTrueWhenNothingToDo()
+	public function testVersionReturnsFalseWhenNothingToDo()
 	{
 		$config       = $this->config;
 		$config->type = 'sequential';
@@ -246,7 +246,7 @@ public function testVersionReturnsTrueWhenNothingToDo()
 
 		$version = $runner->version(0);
 
-		$this->assertTrue($version);
+		$this->assertFalse($version);
 	}
 
 	/**
@@ -266,7 +266,7 @@ public function testVersionWithNoClassInFile()
 
 		$version = $runner->version(1);
 
-		$this->assertEquals('001', $version);
+		$this->assertFalse($version);
 	}
 
 	public function testVersionReturnsUpDownSuccess()
@@ -290,7 +290,7 @@ public function testVersionReturnsUpDownSuccess()
 
 		$version = $runner->version(0);
 
-		$this->assertTrue($version);
+		$this->assertEquals('000', $version);
 		$this->assertFalse(db_connect()->tableExists('foo'));
 	}
 
@@ -314,6 +314,26 @@ public function testLatestSuccess()
 		$this->assertTrue(db_connect()->tableExists('foo'));
 	}
 
+	public function testVersionReturnsDownSuccess()
+	{
+		$config       = $this->config;
+		$config->type = 'sequential';
+		$runner       = new MigrationRunner($config);
+		$runner->setSilent(false);
+
+		$runner = $runner->setPath($this->start);
+
+		vfsStream::copyFromFileSystem(
+			TESTPATH . '_support/Database/SupportMigrations',
+			$this->root
+		);
+
+		$version = $runner->version(0);
+
+		$this->assertEquals('000', $version);
+		$this->assertFalse(db_connect()->tableExists('foo'));
+	}
+
 	public function testCurrentSuccess()
 	{
 		$config                 = $this->config;

user_guide_src/source/dbmgmt/migration.rst

@@ -344,7 +344,7 @@ Class Reference
 		:param	mixed	$namespace: application namespace, if null (App) namespace will be used.
 		:param	mixed	$group: database group name, if null default database group will be used.
 		:param	mixed	$target_version: Migration version to process
-		:returns:	TRUE if no migrations are found, current version string on success, FALSE on failure
+		:returns:	Current version string on success, FALSE on failure or no migrations are found
 		:rtype:	mixed
 
 		Version can be used to roll back changes or step forwards programmatically to