You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
375 lines
10 KiB
375 lines
10 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\console\controllers; |
|
|
|
use Yii; |
|
use yii\console\Controller; |
|
use yii\console\Exception; |
|
use yii\helpers\Console; |
|
use yii\helpers\FileHelper; |
|
use yii\test\FixtureTrait; |
|
|
|
/** |
|
* This command manages loading and unloading fixtures. |
|
* You can specify different options of this command to point fixture manager |
|
* to the specific tables of the different database connections. |
|
* |
|
* To use this command simply configure your console.php config like this: |
|
* |
|
* ~~~ |
|
* 'db' => [ |
|
* 'class' => 'yii\db\Connection', |
|
* 'dsn' => 'mysql:host=localhost;dbname={your_database}', |
|
* 'username' => '{your_db_user}', |
|
* 'password' => '', |
|
* 'charset' => 'utf8', |
|
* ], |
|
* ~~~ |
|
* |
|
* ~~~ |
|
* #load fixtures under $fixturePath from UsersFixture class with default namespace "tests\unit\fixtures" |
|
* yii fixture/load User |
|
* |
|
* #also a short version of this command (generate action is default) |
|
* yii fixture User |
|
* |
|
* #load fixtures under $fixturePath with the different database connection |
|
* yii fixture/load User --db=someOtherDbConnection |
|
* |
|
* #load fixtures under different $fixturePath. |
|
* yii fixture/load User --namespace=alias\my\custom\namespace\goes\here |
|
* ~~~ |
|
* |
|
* @author Mark Jebri <mark.github@yandex.ru> |
|
* @since 2.0 |
|
*/ |
|
class FixtureController extends Controller |
|
{ |
|
|
|
use FixtureTrait; |
|
|
|
/** |
|
* type of fixture apply to database |
|
*/ |
|
const APPLY_ALL = 'all'; |
|
|
|
/** |
|
* @var string controller default action ID. |
|
*/ |
|
public $defaultAction = 'apply'; |
|
/** |
|
* @var string id of the database connection component of the application. |
|
*/ |
|
public $db = 'db'; |
|
/** |
|
* @var string default namespace to search fixtures in |
|
*/ |
|
public $namespace = 'tests\unit\fixtures'; |
|
/** |
|
* @var array global fixtures that should be applied when loading and unloading. By default it is set to `InitDbFixture` |
|
* that disables and enables integrity check, so your data can be safely loaded. |
|
*/ |
|
public $globalFixtures = [ |
|
'yii\test\InitDb', |
|
]; |
|
|
|
/** |
|
* Returns the names of the global options for this command. |
|
* @return array the names of the global options for this command. |
|
*/ |
|
public function globalOptions() |
|
{ |
|
return array_merge(parent::globalOptions(), [ |
|
'db', 'namespace','globalFixtures' |
|
]); |
|
} |
|
|
|
/** |
|
* Loads given fixture. You can load several fixtures specifying |
|
* their names separated with commas, like: User,UserProfile,MyCustom. Be sure there is no |
|
* whitespace between names. Note that if you are loading fixtures to storage, for example: database or nosql, |
|
* storage will not be cleared, data will be appended to already existed. |
|
* @param array $fixtures |
|
* @throws \yii\console\Exception |
|
*/ |
|
public function actionLoad(array $fixtures, array $except = []) |
|
{ |
|
$foundFixtures = $this->findFixtures($fixtures); |
|
|
|
if (!$this->needToApplyAll($fixtures[0])) { |
|
$notFoundFixtures = array_diff($fixtures, $foundFixtures); |
|
|
|
if ($notFoundFixtures) { |
|
$this->notifyNotFound($notFoundFixtures); |
|
} |
|
} |
|
|
|
if (!$foundFixtures) { |
|
throw new Exception("No files were found by name: \"" . implode(', ', $fixtures) . "\".\n" |
|
. "Check that files with these name exists, under fixtures path: \n\"" . $this->getFixturePath() . "\"." |
|
); |
|
} |
|
|
|
if (!$this->confirmLoad($foundFixtures, $except)) { |
|
return; |
|
} |
|
|
|
$filtered = array_diff($foundFixtures, $except); |
|
$fixtures = $this->getFixturesConfig(array_merge($this->globalFixtures ,$filtered)); |
|
|
|
if (!$fixtures) { |
|
throw new Exception('No fixtures were found in namespace: "' . $this->namespace . '"' . ''); |
|
} |
|
|
|
$transaction = $this->getDbConnection()->beginTransaction(); |
|
|
|
try { |
|
$this->loadFixtures($this->createFixtures($fixtures)); |
|
$transaction->commit(); |
|
} catch (\Exception $e) { |
|
$transaction->rollback(); |
|
$this->stdout("Exception occurred, transaction rollback. Tables will be in same state.\n", Console::BG_RED); |
|
throw $e; |
|
} |
|
$this->notifyLoaded($fixtures); |
|
} |
|
|
|
/** |
|
* Unloads given fixtures. You can clear environment and unload multiple fixtures by specifying |
|
* their names separated with commas, like: User,UserProfile,MyCustom. Be sure there is no |
|
* whitespace between tables names. |
|
* @param array|string $fixtures |
|
* @param array|string $except |
|
*/ |
|
public function actionUnload(array $fixtures, array $except = []) |
|
{ |
|
$foundFixtures = $this->findFixtures($fixtures); |
|
|
|
if (!$this->needToApplyAll($fixtures[0])) { |
|
$notFoundFixtures = array_diff($fixtures, $foundFixtures); |
|
|
|
if ($notFoundFixtures) { |
|
$this->notifyNotFound($notFoundFixtures); |
|
} |
|
} |
|
|
|
if (!$foundFixtures) { |
|
throw new Exception("No files were found by name: \"" . implode(', ', $fixtures) . "\".\n" |
|
. "Check that fixtures with these name exists, under fixtures path: \n\"" . $this->getFixturePath() . "\"." |
|
); |
|
} |
|
|
|
if (!$this->confirmUnload($foundFixtures, $except)) { |
|
return; |
|
} |
|
|
|
$filtered = array_diff($foundFixtures, $except); |
|
$fixtures = $this->getFixturesConfig(array_merge($this->globalFixtures ,$filtered)); |
|
|
|
if (!$fixtures) { |
|
throw new Exception('No fixtures were found in namespace: ' . $this->namespace . '".'); |
|
} |
|
|
|
$transaction = $this->getDbConnection()->beginTransaction(); |
|
|
|
try { |
|
$this->unloadFixtures($this->createFixtures($fixtures)); |
|
$transaction->commit(); |
|
|
|
} catch (\Exception $e) { |
|
$transaction->rollback(); |
|
$this->stdout("Exception occurred, transaction rollback. Tables will be in same state.\n", Console::BG_RED); |
|
throw $e; |
|
} |
|
$this->notifyUnloaded($fixtures); |
|
} |
|
|
|
/** |
|
* Returns database connection component |
|
* @return \yii\db\Connection |
|
* @throws \yii\console\Exception if [[db]] is invalid. |
|
*/ |
|
public function getDbConnection() |
|
{ |
|
$db = Yii::$app->getComponent($this->db); |
|
|
|
if ($db === null) { |
|
throw new Exception("There is no database connection component with id \"{$this->db}\"."); |
|
} |
|
|
|
return $db; |
|
} |
|
|
|
/** |
|
* Notifies user that fixtures were successfully loaded. |
|
* @param array $fixtures |
|
*/ |
|
private function notifyLoaded($fixtures) |
|
{ |
|
$this->stdout("Fixtures were successfully loaded from namespace:\n", Console::FG_YELLOW); |
|
$this->stdout("\t\"" . Yii::getAlias($this->namespace) . "\"\n\n", Console::FG_GREEN); |
|
$this->outputList($fixtures); |
|
} |
|
|
|
/** |
|
* Notifies user that fixtures were successfully unloaded. |
|
* @param array $fixtures |
|
*/ |
|
private function notifyUnloaded($fixtures) |
|
{ |
|
$this->stdout("Fixtures were successfully loaded from namespace:\n", Console::FG_YELLOW); |
|
$this->stdout("\t\"" . Yii::getAlias($this->namespace) . "\"\n\n", Console::FG_GREEN); |
|
$this->outputList($fixtures); |
|
} |
|
|
|
/** |
|
* Notifies user that fixtures were not found under fixtures path. |
|
* @param array $fixtures |
|
*/ |
|
private function notifyNotFound($fixtures) |
|
{ |
|
$this->stdout("Some fixtures were not found under path:\n", Console::BG_RED); |
|
$this->stdout("\t" . $this->getFixturePath() . "\n\n", Console::FG_GREEN); |
|
$this->stdout("Check that they have correct namespace \"{$this->namespace}\" \n", Console::BG_RED); |
|
$this->outputList($fixtures); |
|
$this->stdout("\n"); |
|
} |
|
|
|
/** |
|
* Prompts user with confirmation if fixtures should be loaded. |
|
* @param array $fixtures |
|
* @param array $except |
|
* @return boolean |
|
*/ |
|
private function confirmLoad($fixtures, $except) |
|
{ |
|
$this->stdout("Fixtures namespace is: \n", Console::FG_YELLOW); |
|
$this->stdout("\t" . $this->namespace . "\n\n", Console::FG_GREEN); |
|
|
|
if (count($this->globalFixtures)) { |
|
$this->stdout("Global fixtures will be loaded:\n\n", Console::FG_YELLOW); |
|
$this->outputList($this->globalFixtures); |
|
} |
|
|
|
$this->stdout("\nFixtures below will be loaded:\n\n", Console::FG_YELLOW); |
|
$this->outputList($fixtures); |
|
|
|
if (count($except)) { |
|
$this->stdout("\nFixtures that will NOT be loaded: \n\n", Console::FG_YELLOW); |
|
$this->outputList($except); |
|
} |
|
|
|
return $this->confirm("\nLoad above fixtures?"); |
|
} |
|
|
|
/** |
|
* Prompts user with confirmation for fixtures that should be unloaded. |
|
* @param array $fixtures |
|
* @param array $except |
|
* @return boolean |
|
*/ |
|
private function confirmUnload($fixtures, $except) |
|
{ |
|
$this->stdout("Fixtures namespace is: \n", Console::FG_YELLOW); |
|
$this->stdout("\t" . $this->namespace . "\n\n", Console::FG_GREEN); |
|
|
|
if (count($this->globalFixtures)) { |
|
$this->stdout("Global fixtures will be unloaded:\n\n", Console::FG_YELLOW); |
|
$this->outputList($this->globalFixtures); |
|
} |
|
|
|
$this->stdout("\nFixtures below will be unloaded:\n\n", Console::FG_YELLOW); |
|
$this->outputList($fixtures); |
|
|
|
if (count($except)) { |
|
$this->stdout("\nFixtures that will NOT be unloaded:\n\n", Console::FG_YELLOW); |
|
$this->outputList($except); |
|
} |
|
|
|
return $this->confirm("\nUnload fixtures?"); |
|
} |
|
|
|
/** |
|
* Outputs data to the console as a list. |
|
* @param array $data |
|
*/ |
|
private function outputList($data) |
|
{ |
|
foreach ($data as $index => $item) { |
|
$this->stdout("\t" . ($index + 1) . ". {$item}\n", Console::FG_GREEN); |
|
} |
|
} |
|
|
|
/** |
|
* Checks if needed to apply all fixtures. |
|
* @param string $fixture |
|
* @return bool |
|
*/ |
|
public function needToApplyAll($fixture) |
|
{ |
|
return $fixture == self::APPLY_ALL; |
|
} |
|
|
|
/** |
|
* @param array $fixtures |
|
* @return array Array of found fixtures. These may differ from input parameter as not all fixtures may exists. |
|
*/ |
|
private function findFixtures(array $fixtures) |
|
{ |
|
$fixturesPath = $this->getFixturePath(); |
|
|
|
$filesToSearch = ['*Fixture.php']; |
|
if (!$this->needToApplyAll($fixtures[0])) { |
|
$filesToSearch = []; |
|
foreach ($fixtures as $fileName) { |
|
$filesToSearch[] = $fileName . 'Fixture.php'; |
|
} |
|
} |
|
|
|
$files = FileHelper::findFiles($fixturesPath, ['only' => $filesToSearch]); |
|
$foundFixtures = []; |
|
|
|
foreach ($files as $fixture) { |
|
$foundFixtures[] = basename($fixture, 'Fixture.php'); |
|
} |
|
|
|
return $foundFixtures; |
|
} |
|
|
|
/** |
|
* Returns valid fixtures config that can be used to load them. |
|
* @param array $fixtures fixtures to configure |
|
* @return array |
|
*/ |
|
private function getFixturesConfig($fixtures) |
|
{ |
|
$config = []; |
|
|
|
foreach ($fixtures as $fixture) { |
|
|
|
$isNamespaced = (strpos($fixture, '\\') !== false); |
|
$fullClassName = $isNamespaced ? $fixture . 'Fixture' : $this->namespace . '\\' . $fixture . 'Fixture'; |
|
|
|
if (class_exists($fullClassName)) { |
|
$config[] = $fullClassName; |
|
} |
|
} |
|
|
|
return $config; |
|
} |
|
|
|
/** |
|
* Returns fixture path that determined on fixtures namespace. |
|
* @return string fixture path |
|
*/ |
|
private function getFixturePath() |
|
{ |
|
return Yii::getAlias('@' . str_replace('\\', '/', $this->namespace)); |
|
} |
|
|
|
}
|
|
|