FixtureController.php 14.4 KB
Newer Older
Mark committed
1 2 3 4 5 6 7 8 9 10 11 12
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\faker;

use Yii;
use yii\console\Exception;
use yii\helpers\Console;
Qiang Xue committed
13
use yii\helpers\FileHelper;
Qiang Xue committed
14
use yii\helpers\VarDumper;
Mark committed
15 16 17 18 19

/**
 * This command manage fixtures creations based on given template.
 *
 * Fixtures are one of the important paths in unit testing. To speed up developers
Mark committed
20
 * work these fixtures can be generated automatically, based on prepared template.
Mark committed
21
 * This command is a simple wrapper for the fixtures library [Faker](https://github.com/fzaninotto/Faker).
Qiang Xue committed
22 23 24
 *
 * You should configure this command as follows (you can use any alias, not only "fixture"):
 *
Mark committed
25
 * ~~~
Qiang Xue committed
26 27 28 29 30
 * 'controllerMap' => [
 *     'fixture' => [
 *         'class' => 'yii\faker\FixtureController',
 *     ],
 * ],
Mark committed
31
 * ~~~
Qiang Xue committed
32
 *
Mark committed
33 34
 * To start using this command you need to be familiar (read guide) for the Faker library and
 * generate fixtures template files, according to the given format:
Qiang Xue committed
35
 *
Qiang Xue committed
36 37
 * ```php
 * // users.php file under template path (by default @tests/unit/templates/fixtures)
Mark committed
38
 * return [
Qiang Xue committed
39 40 41 42 43 44
 *     'name' => $faker->firstName,
 *     'phone' => $faker->phoneNumber,
 *     'city' => $faker->city,
 *     'password' => Yii::$app->getSecurity()->generatePasswordHash('password_' . $index),
 *     'auth_key' => Yii::$app->getSecurity()->generateRandomString(),
 *     'intro' => $faker->sentence(7, true),  // generate a sentence with 7 words
Mark committed
45
 * ];
Qiang Xue committed
46
 * ```
Qiang Xue committed
47
 *
Mark committed
48
 * If you use callback as a attribute value, then it will be called as shown with three parameters:
Qiang Xue committed
49
 *
Qiang Xue committed
50 51
 * - `$faker`: the Faker generator instance
 * - `$index`: the current fixture index. For example if user need to generate 3 fixtures for user table, it will be 0..2.
Qiang Xue committed
52
 *
Mark committed
53
 * After you set all needed fields in callback, you need to return $fixture array back from the callback.
Qiang Xue committed
54
 *
Mark committed
55
 * After you prepared needed templates for tables you can simply generate your fixtures via command
Qiang Xue committed
56
 *
Mark committed
57
 * ~~~
Mark committed
58
 * yii fixture/generate user
Qiang Xue committed
59
 *
Mark committed
60
 * //generate fixtures from several templates, for example:
Mark committed
61
 * yii fixture/generate user profile team
Mark committed
62
 * ~~~
Qiang Xue committed
63
 *
Mark committed
64
 * In the code above "users" is template name, after this command run, new file named same as template
Mark committed
65
 * will be created under the `$fixtureDataPath` folder.
Mark committed
66
 * You can generate fixtures for all templates, for example:
Qiang Xue committed
67
 *
Mark committed
68
 * ~~~
Mark committed
69
 * yii fixture/generate-all
Mark committed
70
 * ~~~
Qiang Xue committed
71 72
 *
 * This command will generate fixtures for all template files that are stored under $templatePath and
Mark committed
73
 * store fixtures under `$fixtureDataPath` with file names same as templates names.
Qiang Xue committed
74
 *
Mark committed
75 76
 * You can specify how many fixtures per file you need by the second parameter. In the code below we generate
 * all fixtures and in each file there will be 3 rows (fixtures).
Qiang Xue committed
77
 *
Mark committed
78
 * ~~~
Mark committed
79
 * yii fixture/generate-all --count=3
Mark committed
80
 * ~~~
Qiang Xue committed
81
 *
Mark committed
82
 * You can specify different options of this command:
Qiang Xue committed
83
 *
Mark committed
84
 * ~~~
Qiang Xue committed
85
 * //generate fixtures in russian language
Mark committed
86
 * yii fixture/generate user --count=5 --language=ru_RU
Qiang Xue committed
87
 *
88
 * //read templates from the other path
Mark committed
89
 * yii fixture/generate-all --templatePath=@app/path/to/my/custom/templates
Qiang Xue committed
90
 *
Mark committed
91
 * //generate fixtures into other folders
Mark committed
92
 * yii fixture/generate-all --fixtureDataPath=@tests/unit/fixtures/subfolder1/subfolder2/subfolder3
Mark committed
93
 * ~~~
Qiang Xue committed
94
 *
Mark committed
95 96 97 98 99 100 101 102 103 104
 * You can see all available templates by running command:
 *
 * ~~~
 * //list all templates under default template path (i.e. '@tests/unit/templates/fixtures')
 * yii fixture/templates
 *
 * //list all templates under specified template path
 * yii fixture/templates --templatePath='@app/path/to/my/custom/templates'
 * ~~~
 * 
Mark committed
105 106
 * You also can create your own data providers for custom tables fields, see Faker library guide for more info (https://github.com/fzaninotto/Faker);
 * After you created custom provider, for example:
Qiang Xue committed
107
 *
Mark committed
108
 * ~~~
Qiang Xue committed
109 110
 * class Book extends \Faker\Provider\Base
 * {
Mark committed
111
 * 
Qiang Xue committed
112 113 114 115 116
 *     public function title($nbWords = 5)
 *     {
 *         $sentence = $this->generator->sentence($nbWords);
 *         return mb_substr($sentence, 0, mb_strlen($sentence) - 1);
 *     }
Mark committed
117
 * 
Qiang Xue committed
118
 * }
Mark committed
119
 * ~~~
Qiang Xue committed
120
 *
Mark committed
121
 * you can use it by adding it to the $providers property of the current command. In your console.php config:
Qiang Xue committed
122
 *
Mark committed
123
 * ~~~
Qiang Xue committed
124 125 126 127 128 129 130 131
 *    'controllerMap' => [
 *        'fixture' => [
 *            'class' => 'yii\faker\FixtureController',
 *            'providers' => [
 *                'app\tests\unit\faker\providers\Book',
 *            ],
 *        ],
 *    ],
Mark committed
132
 * ~~~
Qiang Xue committed
133 134
 *
 * @author Mark Jebri <mark.github@yandex.ru>
Mark committed
135 136 137 138
 * @since 2.0.0
 */
class FixtureController extends \yii\console\controllers\FixtureController
{
139 140 141 142 143 144 145 146 147 148 149 150 151

    /**
     * @var string Alias to the template path, where all tables templates are stored.
     */
    public $templatePath = '@tests/unit/templates/fixtures';
    /**
     * @var string Alias to the fixture data path, where data files should be written.
     */
    public $fixtureDataPath = '@tests/unit/fixtures/data';
    /**
     * @var string Language to use when generating fixtures data.
     */
    public $language;
Mark committed
152 153 154 155
    /**
     * @var integer total count of data per fixture. Defaults to 2.
     */
    public $count = 2;
156 157 158 159 160
    /**
     * @var array Additional data providers that can be created by user and will be added to the Faker generator.
     * More info in [Faker](https://github.com/fzaninotto/Faker.) library docs.
     */
    public $providers = [];
161

162 163 164 165 166 167 168
    /**
     * @var \Faker\Generator Faker generator instance
     */
    private $_generator;


    /**
169
     * @inheritdoc
170
     */
Alexander Makarov committed
171
    public function options($actionID)
172
    {
Alexander Makarov committed
173
        return array_merge(parent::options($actionID), [
Qiang Xue committed
174
            'templatePath', 'language', 'fixtureDataPath', 'count'
175 176 177 178 179 180 181 182 183 184 185 186 187 188
        ]);
    }

    public function beforeAction($action)
    {
        if (parent::beforeAction($action)) {
            $this->checkPaths();
            $this->addProviders();
            return true;
        } else {
            return false;
        }
    }

Mark committed
189 190 191
    /**
     * Lists all available fixtures template files.
     */
Mark committed
192
    public function actionTemplates()
Mark committed
193 194 195 196 197 198 199 200 201 202
    {
        $foundTemplates = $this->findTemplatesFiles();

        if (!$foundTemplates) {
            $this->notifyNoTemplatesFound();
        } else {
            $this->notifyTemplatesCanBeGenerated($foundTemplates);
        }
    }

203 204
    /**
     * Generates fixtures and fill them with Faker data.
Mark committed
205 206 207 208
     * For example,
     * 
     * ~~~
     * //generate fixtures in russian language
Mark committed
209
     * yii fixture/generate user --count=5 --language=ru_RU
210
     *
Mark committed
211 212
     * //generate several fixtures
     * yii fixture/generate user profile team
Mark committed
213 214
     * ~~~
     * 
215 216
     * @throws \yii\base\InvalidParamException
     * @throws \yii\console\Exception
217
     */
Mark committed
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
    public function actionGenerate()
    {
        $templatesInput = func_get_args();

        if (empty($templatesInput)) {
            throw new Exception('You should specify input fixtures template files');
        }

        $foundTemplates = $this->findTemplatesFiles($templatesInput);

        $notFoundTemplates = array_diff($templatesInput, $foundTemplates);

        if ($notFoundTemplates) {
            $this->notifyNotFoundTemplates($notFoundTemplates);
        }

        if (!$foundTemplates) {
            $this->notifyNoTemplatesFound();
            return static::EXIT_CODE_NORMAL;
        }

        if (!$this->confirmGeneration($foundTemplates)) {
            return static::EXIT_CODE_NORMAL;
        }

        $templatePath = Yii::getAlias($this->templatePath);
        $fixtureDataPath = Yii::getAlias($this->fixtureDataPath);

        FileHelper::createDirectory($fixtureDataPath);

        $generatedTemplates = [];

        foreach ($foundTemplates as $templateName) {
            $this->generateFixtureFile($templateName, $templatePath, $fixtureDataPath);
            $generatedTemplates[] = $templateName;
        }

        $this->notifyTemplatesGenerated($generatedTemplates);
    }

    /**
     * Generates all fixtures template path that can be found.
     */
    public function actionGenerateAll()
262
    {
Mark committed
263 264 265 266 267 268 269 270 271 272 273
        $foundTemplates = $this->findTemplatesFiles();

        if (!$foundTemplates) {
            $this->notifyNoTemplatesFound();
            return static::EXIT_CODE_NORMAL;
        }

        if (!$this->confirmGeneration($foundTemplates)) {
            return static::EXIT_CODE_NORMAL;
        }

274 275 276
        $templatePath = Yii::getAlias($this->templatePath);
        $fixtureDataPath = Yii::getAlias($this->fixtureDataPath);

Mark committed
277 278 279 280 281 282 283
        FileHelper::createDirectory($fixtureDataPath);

        $generatedTemplates = [];

        foreach ($foundTemplates as $templateName) {
            $this->generateFixtureFile($templateName, $templatePath, $fixtureDataPath);            
            $generatedTemplates[] = $templateName;
284 285
        }

Mark committed
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
        $this->notifyTemplatesGenerated($generatedTemplates);
    }

    /**
     * Notifies user that given fixtures template files were not found.
     * @param array $templatesNames
     */
    private function notifyNotFoundTemplates($templatesNames)
    {
        $this->stdout("The following fixtures templates were NOT found:\n\n", Console::FG_RED);

        foreach ($templatesNames as $name) {
            $this->stdout("\t * $name \n", Console::FG_GREEN);
        }

        $this->stdout("\n");
    }

    /**
     * Notifies user that there was not found any files matching given input conditions.
     */
    private function notifyNoTemplatesFound()
    {
        $this->stdout("No fixtures template files matching input conditions were found under the path:\n\n", Console::FG_RED);
        $this->stdout("\t " . Yii::getAlias($this->templatePath) . " \n\n", Console::FG_GREEN);
    }

    /**
     * Notifies user that given fixtures template files were generated.
     * @param array $templatesNames
     */
    private function notifyTemplatesGenerated($templatesNames)
    {
        $this->stdout("The following fixtures template files were generated:\n\n", Console::FG_YELLOW);

        foreach ($templatesNames as $name) {
            $this->stdout("\t* " . $name . "\n", Console::FG_GREEN);
323 324
        }

Mark committed
325 326 327 328 329 330 331 332 333 334
        $this->stdout("\n");
    }

    private function notifyTemplatesCanBeGenerated($templatesNames)
    {
        $this->stdout("Template files path: ", Console::FG_YELLOW);
        $this->stdout(Yii::getAlias($this->templatePath) . "\n\n", Console::FG_GREEN);

        foreach ($templatesNames as $name) {
            $this->stdout("\t* " . $name . "\n", Console::FG_GREEN);
335 336
        }

Mark committed
337 338 339 340
        $this->stdout("\n");
    }

    /**
341
     * Returns array containing fixtures templates file names. You can specify what files to find
Mark committed
342 343 344 345 346 347 348 349 350 351 352 353
     * by the given parameter.
     * @param array $templatesNames template file names to search. If empty then all files will be searched.
     * @return array
     */
    private function findTemplatesFiles(array $templatesNames = [])
    {
        $findAll = ($templatesNames == []);

        if ($findAll) {
            $files = FileHelper::findFiles(Yii::getAlias($this->templatePath), ['only' => ['*.php']]);
        } else {
            $filesToSearch = [];
354

Mark committed
355 356
            foreach ($templatesNames as $fileName) {
                $filesToSearch[] = $fileName . '.php';
357 358
            }

Mark committed
359 360 361 362
            $files = FileHelper::findFiles(Yii::getAlias($this->templatePath), ['only' => $filesToSearch]);
        }

        $foundTemplates = [];
363

Mark committed
364 365
        foreach ($files as $fileName) {
            $foundTemplates[] = basename($fileName, '.php');
366
        }
Mark committed
367 368

        return $foundTemplates;
369 370 371 372 373 374 375 376
    }

    /**
     * Returns Faker generator instance. Getter for private property.
     * @return \Faker\Generator
     */
    public function getGenerator()
    {
Qiang Xue committed
377 378 379
        if ($this->_generator === null) {
            $language = $this->language === null ? Yii::$app->language : $this->language;
            $this->_generator = \Faker\Factory::create(str_replace('-', '_', $language));
380 381 382 383 384 385 386 387 388
        }
        return $this->_generator;
    }

    /**
     * Check if the template path and migrations path exists and writable.
     */
    public function checkPaths()
    {
Mark committed
389
        $path = Yii::getAlias($this->templatePath, false);
390

Mark committed
391
        if (!$path || !is_dir($path)) {
Alexander Makarov committed
392
            throw new Exception("The template path \"{$this->templatePath}\" does not exist");
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
        }
    }

    /**
     * Adds users providers to the faker generator.
     */
    public function addProviders()
    {
        foreach ($this->providers as $provider) {
            $this->generator->addProvider(new $provider($this->generator));
        }
    }

    /**
     * Returns exported to the string representation of given fixtures array.
408
     * @param array $fixtures
409 410 411 412
     * @return string exported fixtures format
     */
    public function exportFixtures($fixtures)
    {
Qiang Xue committed
413
        return "<?php\n\nreturn " . VarDumper::export($fixtures) . ";\n";
414 415 416 417
    }

    /**
     * Generates fixture from given template
418 419
     * @param string $_template_ the fixture template file
     * @param integer $index the current fixture index
420
     * @return array fixture
421
     */
422
    public function generateFixture($_template_, $index)
423
    {
424
        // $faker and $index are exposed to the template file
Qiang Xue committed
425
        $faker = $this->getGenerator();
426
        return require($_template_);
427 428
    }

Mark committed
429 430
    /**
     * Generates fixture file by the given fixture template file.
431 432 433
     * @param string $templateName template file name
     * @param string $templatePath path where templates are stored
     * @param string $fixtureDataPath fixture data path where generated file should be written
Mark committed
434 435 436 437 438 439 440 441 442 443 444 445 446 447
     */
    public function generateFixtureFile($templateName, $templatePath, $fixtureDataPath)
    {
        $fixtures = [];

        for ($i = 0; $i < $this->count; $i++) {
            $fixtures[$i] = $this->generateFixture($templatePath . '/' . $templateName . '.php', $i);
        }

        $content = $this->exportFixtures($fixtures);

        file_put_contents($fixtureDataPath . '/'. $templateName . '.php', $content);
    }

448 449
    /**
     * Prompts user with message if he confirm generation with given fixture templates files.
450
     * @param array $files
451 452 453 454 455 456 457 458 459
     * @return boolean
     */
    public function confirmGeneration($files)
    {
        $this->stdout("Fixtures will be generated under the path: \n", Console::FG_YELLOW);
        $this->stdout("\t" . Yii::getAlias($this->fixtureDataPath) . "\n\n", Console::FG_GREEN);
        $this->stdout("Templates will be taken from path: \n", Console::FG_YELLOW);
        $this->stdout("\t" . Yii::getAlias($this->templatePath) . "\n\n", Console::FG_GREEN);

Mark committed
460 461
        foreach ($files as $fileName) {
            $this->stdout("\t* " . $fileName . "\n", Console::FG_GREEN);
462 463 464 465
        }

        return $this->confirm('Generate above fixtures?');
    }
Mark committed
466

Mark committed
467
}