Merge pull request #4891 from Ragazzo/faker_console_controller_adjustments

Faker console controller adjustments

composer.json

@@ -84,7 +84,8 @@
 		"smarty/smarty": "*",
 		"imagine/imagine": "v0.5.0",
 		"swiftmailer/swiftmailer": "*",
-		"cebe/indent": "*"
+		"cebe/indent": "*",
+		"fzaninotto/faker": "*"
 	},
 	"suggest": {
 		"phpdocumentor/reflection": "required by yii2-apidoc extension",

extensions/faker/FixtureController.php

@@ -55,21 +55,18 @@ use yii\helpers\VarDumper;
  * After you prepared needed templates for tables you can simply generate your fixtures via command
  *
  * ~~~
- * yii fixture/generate users
+ * yii fixture/generate user
  *
- * //also a short version of this command (generate action is default)
- * yii fixture users
- *
- * //to generate fixtures for several tables, use "," as a separator, for example:
- * yii fixture users,profile
+ * //generate fixtures from several templates, for example:
+ * yii fixture/generate user profile team
  * ~~~
  *
  * In the code above "users" is template name, after this command run, new file named same as template
  * will be created under the `$fixtureDataPath` folder.
- * You can generate fixtures for all templates by specifying keyword "all"
+ * You can generate fixtures for all templates, for example:
  *
  * ~~~
- * yii fixture/generate all
+ * yii fixture/generate-all
  * ~~~
  *
  * This command will generate fixtures for all template files that are stored under $templatePath and
@@ -79,38 +76,45 @@ use yii\helpers\VarDumper;
  * all fixtures and in each file there will be 3 rows (fixtures).
  *
  * ~~~
- * yii fixture/generate all 3
+ * yii fixture/generate-all --count=3
  * ~~~
  *
  * You can specify different options of this command:
  *
  * ~~~
  * //generate fixtures in russian language
- * yii fixture/generate users 5 --language=ru_RU
+ * yii fixture/generate user --count=5 --language=ru_RU
  *
  * //read templates from the other path
- * yii fixture/generate all --templatePath=@app/path/to/my/custom/templates
+ * yii fixture/generate-all --templatePath=@app/path/to/my/custom/templates
  *
  * //generate fixtures into other folders
- * yii fixture/generate all --fixtureDataPath=@tests/unit/fixtures/subfolder1/subfolder2/subfolder3
+ * yii fixture/generate-all --fixtureDataPath=@tests/unit/fixtures/subfolder1/subfolder2/subfolder3
  * ~~~
  *
+ * 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'
+ * ~~~
+ * 
  * 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:
  *
  * ~~~
  * class Book extends \Faker\Provider\Base
  * {
+ * 
  *     public function title($nbWords = 5)
  *     {
  *         $sentence = $this->generator->sentence($nbWords);
  *         return mb_substr($sentence, 0, mb_strlen($sentence) - 1);
  *     }
- *
- *     public function ISBN()
- *     {
- *         return $this->generator->randomNumber(13);
- *     }
+ * 
  * }
  * ~~~
  *
@@ -132,15 +136,7 @@ use yii\helpers\VarDumper;
  */
 class FixtureController extends \yii\console\controllers\FixtureController
 {
-    /**
-     * type of fixture generating
-     */
-    const GENERATE_ALL = 'all';
 
-    /**
-     * @var string controller default action ID.
-     */
-    public $defaultAction = 'generate';
     /**
      * @var string Alias to the template path, where all tables templates are stored.
      */
@@ -153,6 +149,10 @@ class FixtureController extends \yii\console\controllers\FixtureController
      * @var string Language to use when generating fixtures data.
      */
     public $language;
+    /**
+     * @var integer total count of data per fixture. Defaults to 2.
+     */
+    public $count = 2;
     /**
      * @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.
@@ -180,61 +180,192 @@ class FixtureController extends \yii\console\controllers\FixtureController
         if (parent::beforeAction($action)) {
             $this->checkPaths();
             $this->addProviders();
-
             return true;
         } else {
             return false;
         }
     }
 
+    /**
+     * Lists all available fixtures template files.
+     */
+    public function actionTemplates()
+    {
+        $foundTemplates = $this->findTemplatesFiles();
+
+        if (!$foundTemplates) {
+            $this->notifyNoTemplatesFound();
+        } else {
+            $this->notifyTemplatesCanBeGenerated($foundTemplates);
+        }
+    }
+
     /**
      * Generates fixtures and fill them with Faker data.
+     * For example,
+     * 
+     * ~~~
+     * //generate fixtures in russian language
+     * yii fixture/generate user --count=5 --language=ru_RU
      *
-     * @param array|string $file filename for the table template.
-     * You can generate all fixtures for all tables by specifying keyword "all" as filename.
-     * @param integer $times how much fixtures do you want per table
+     * //generate several fixtures
+     * yii fixture/generate user profile team
+     * ~~~
+     * 
      * @throws \yii\base\InvalidParamException
      * @throws \yii\console\Exception
      */
-    public function actionGenerate(array $file, $times = 2)
+    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);
 
-        if ($this->needToGenerateAll($file[0])) {
-            $files = FileHelper::findFiles($templatePath, ['only' => ['*.php']]);
+        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()
+    {
+        $foundTemplates = $this->findTemplatesFiles();
+
+        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);
+    }
+
+    /**
+     * 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);
+        }
+
+        $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);
+        }
+
+        $this->stdout("\n");
+    }
+
+    /**
+     * Returns array containg fixtures templates file names. You can specify what files to find
+     * 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 = [];
-            foreach ($file as $fileName) {
+
+            foreach ($templatesNames as $fileName) {
                 $filesToSearch[] = $fileName . '.php';
             }
-            $files = FileHelper::findFiles($templatePath, ['only' => $filesToSearch]);
+
+            $files = FileHelper::findFiles(Yii::getAlias($this->templatePath), ['only' => $filesToSearch]);
         }
 
-        if (empty($files)) {
-            throw new Exception("No files were found by name: \"" . implode(', ', $file) . "\".\n"
-                . "Check that template with these name exists, under template path: \n\"{$templatePath}\"."
-            );
+        $foundTemplates = [];
+
+        foreach ($files as $fileName) {
+            $foundTemplates[] = basename($fileName, '.php');
         }
 
-        if (!$this->confirmGeneration($files)) {
-            return;
-        }
-
-        foreach ($files as $templateFile) {
-            $fixtureFileName = basename($templateFile);
-            $fixtures = [];
-
-            for ($i = 0; $i < $times; $i++) {
-                $fixtures[$i] = $this->generateFixture($templateFile, $i);
-            }
-
-            $content = $this->exportFixtures($fixtures);
-            FileHelper::createDirectory($fixtureDataPath);
-            file_put_contents($fixtureDataPath . '/'. $fixtureFileName, $content);
-
-            $this->stdout("Fixture file was generated under: $fixtureDataPath\n", Console::FG_GREEN);
-        }
+        return $foundTemplates;
     }
 
     /**
@@ -255,9 +386,9 @@ class FixtureController extends \yii\console\controllers\FixtureController
      */
     public function checkPaths()
     {
-        $path = Yii::getAlias($this->templatePath);
+        $path = Yii::getAlias($this->templatePath, false);
 
-        if (!is_dir($path)) {
+        if (!$path || !is_dir($path)) {
             throw new Exception("The template path \"{$this->templatePath}\" does not exist");
         }
     }
@@ -272,16 +403,6 @@ class FixtureController extends \yii\console\controllers\FixtureController
         }
     }
 
-    /**
-     * Checks if needed to generate all fixtures.
-     * @param string $file
-     * @return bool
-     */
-    public function needToGenerateAll($file)
-    {
-        return $file == self::GENERATE_ALL;
-    }
-
     /**
      * Returns exported to the string representation of given fixtures array.
      * @param array $fixtures
@@ -305,6 +426,25 @@ class FixtureController extends \yii\console\controllers\FixtureController
         return require($_template_);
     }
 
+    /**
+     * Generates fixture file by the given fixture template file.
+     * @param type $templateName template file name
+     * @param type $templatePath path where templates are stored
+     * @param type $fixtureDataPath fixture data path where generated file should be written
+     */
+    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);
+    }
+
     /**
      * Prompts user with message if he confirm generation with given fixture templates files.
      * @param array $files
@@ -317,10 +457,11 @@ class FixtureController extends \yii\console\controllers\FixtureController
         $this->stdout("Templates will be taken from path: \n", Console::FG_YELLOW);
         $this->stdout("\t" . Yii::getAlias($this->templatePath) . "\n\n", Console::FG_GREEN);
 
-        foreach ($files as $index => $fileName) {
-            $this->stdout("    " . ($index + 1) . ". " . basename($fileName) . "\n", Console::FG_GREEN);
+        foreach ($files as $fileName) {
+            $this->stdout("\t* " . $fileName . "\n", Console::FG_GREEN);
         }
 
         return $this->confirm('Generate above fixtures?');
     }
+
 }

extensions/faker/README.md

@@ -69,14 +69,11 @@ In this script, you can use the following two predefined variables:
 With such a template file, you can generate your fixtures using the commands like the following:
 
 ```
-# generate fixtures for the users table based on users fixture template
-php yii fixture/generate User
-
-# also a short version of this command ("generate" action is default)
-php yii fixture User
+# generate fixtures from user fixture template
+php yii fixture/generate user
 
 # to generate several fixture data files
-php yii fixture User Profile Team
+php yii fixture/generate user profile team
 ```
 
 In the code above `users` is template name. After running this command, a new file with the same template name
@@ -107,23 +104,29 @@ php yii fixture/generate-all --templatePath='@app/path/to/my/custom/templates'
 php yii fixture/generate-all --fixtureDataPath='@tests/acceptance/fixtures/data'
 ```
 
+You can see all available templates by running command:
+
+```
+# list all templates under default template path (i.e. '@tests/unit/templates/fixtures')
+php yii fixture/templates
+
+# list all templates under specified template path
+php yii fixture/templates --templatePath='@app/path/to/my/custom/templates'
+```
+
 You also can create your own data providers for custom tables fields, see [Faker](https://github.com/fzaninotto/Faker) library guide for more info;
 After you created custom provider, for example:
 
 ```php
 class Book extends \Faker\Provider\Base
 {
+
     public function title($nbWords = 5)
     {
         $sentence = $this->generator->sentence($nbWords);
         return mb_substr($sentence, 0, mb_strlen($sentence) - 1);
     }
 
-    public function ISBN()
-    {
-        return $this->generator->randomNumber(13);
-    }
-
  }
 ```
 

tests/unit/data/extensions/faker/providers/Book.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace yiiunit\data\extensions\faker\providers;
+
+use \Faker\Provider\Base;
+
+class Book extends Base
+{
+
+    public function title($nbWords = 5)
+    {
+        $sentence = $this->generator->sentence($nbWords);
+        return mb_substr($sentence, 0, mb_strlen($sentence) - 1);
+    }
+
+}

tests/unit/data/extensions/faker/templates/book.php

@@ -0,0 +1,9 @@
+<?php
+/**
+ * @var $faker \Faker\Generator
+ * @var $index integer
+ */
+
+return [
+    'title' => $faker->title,
+];

tests/unit/data/extensions/faker/templates/profile.php

@@ -0,0 +1,13 @@
+<?php
+/**
+ * @var $faker \Faker\Generator
+ * @var $index integer
+ */
+
+$security = Yii::$app->getSecurity();
+
+return [
+    'address' => $faker->address,
+    'phone' => $faker->phoneNumber,
+    'first_name' => $faker->firstName,
+];

tests/unit/data/extensions/faker/templates/user.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * @var $faker \Faker\Generator
+ * @var $index integer
+ */
+
+$security = Yii::$app->getSecurity();
+
+return [
+    'username' => $faker->userName,
+    'email' => $faker->email,
+    'auth_key' => $security->generateRandomString(),
+    'created_at' => time(),
+    'updated_at' => time(),
+];

tests/unit/extensions/faker/FixtureControllerTest.php

@@ -0,0 +1,166 @@
+<?php
+
+namespace yiiunit\extensions\faker;
+
+use Yii;
+use yiiunit\TestCase;
+use yii\faker\FixtureController;
+
+/**
+ * Unit test for [[\yii\faker\FixtureController]].
+ * @see FixtureController
+ *
+ * @group console
+ */
+class FixtureControllerTest extends TestCase
+{
+
+    /**
+     * @var \yiiunit\extensions\faker\FixtureConsoledController
+     */
+    private $_fixtureController;
+
+    protected function setUp()
+    {
+        parent::setUp();
+
+        $this->mockApplication();
+
+        $this->_fixtureController = Yii::createObject([
+            'class' => 'yiiunit\extensions\faker\FixtureConsoledController',
+            'interactive' => false,
+            'fixtureDataPath' => '@runtime/faker',
+            'templatePath' => '@yiiunit/data/extensions/faker/templates'
+        ],['fixture-faker', Yii::$app]);
+    }
+
+    public function tearDown()
+    {
+        @unlink(Yii::getAlias('@runtime/faker/user.php'));
+        @unlink(Yii::getAlias('@runtime/faker/profile.php'));
+        @unlink(Yii::getAlias('@runtime/faker/book.php'));
+        parent::tearDown();
+    }
+
+    public function testGenerateOne()
+    {
+        $filename = Yii::getAlias('@runtime/faker/user.php');
+        $this->assertFileNotExists($filename, 'file to be generated should not exist before');
+
+        $this->_fixtureController->actionGenerate('user');
+        $this->assertFileExists($filename, 'fixture template file should be generated');
+
+        $generatedData = require Yii::getAlias('@runtime/faker/user.php');
+        $this->assertCount(2, $generatedData, 'by default only 2 fixtures should be generated');
+        
+        foreach ($generatedData as $fixtureData) {
+            $this->assertNotNull($fixtureData['username'],  'generated "username" should not be empty');
+            $this->assertNotNull($fixtureData['email'],     'generated "email" should not be empty');
+            $this->assertNotNull($fixtureData['auth_key'],  'generated "auth_key" should not be empty');
+            $this->assertNotNull($fixtureData['created_at'],'generated "created_at" should not be empty');
+            $this->assertNotNull($fixtureData['updated_at'],'generated "updated_at" should not be empty');
+        }
+    }
+
+    public function testGenerateBoth()
+    {
+        $userFilename = Yii::getAlias('@runtime/faker/user.php');
+        $this->assertFileNotExists($userFilename, 'file to be generated should not exist before');
+
+        $profileFilename = Yii::getAlias('@runtime/faker/profile.php');
+        $this->assertFileNotExists($profileFilename, 'file to be generated should not exist before');
+
+        $this->_fixtureController->actionGenerate('user', 'profile');
+        $this->assertFileExists($userFilename, 'fixture template file should be generated');
+        $this->assertFileExists($profileFilename, 'fixture template file should be generated');
+    }
+
+    public function testGenerateNotFound()
+    {
+        $fileName = Yii::getAlias('@runtime/faker/not_existing_template.php');
+        $this->_fixtureController->actionGenerate('not_existing_template');
+        $this->assertFileNotExists($fileName, 'not existing template should not be generated');
+    }
+
+    public function testGenerateProvider()
+    {
+        $bookFilename = Yii::getAlias('@runtime/faker/book.php');
+        $this->assertFileNotExists($bookFilename, 'file to be generated should not exist before');
+
+        $this->_fixtureController->providers[] = 'yiiunit\data\extensions\faker\providers\Book';
+        $this->_fixtureController->run('generate',['book']);
+        $this->assertFileExists($bookFilename, 'fixture template file should be generated');
+    }
+
+    /**
+     * @expectedException yii\console\Exception
+     */
+    public function testNothingToGenerateException()
+    {
+        $this->_fixtureController->actionGenerate();
+    }
+
+    /**
+     * @expectedException yii\console\Exception
+     */
+    public function testWrongTemplatePathException()
+    {
+        $this->_fixtureController->templatePath = '@not/existing/fixtures/templates/path';
+        $this->_fixtureController->run('generate',['user']);
+    }
+
+    public function testGenerateParticularTimes()
+    {
+        $filename = Yii::getAlias('@runtime/faker/user.php');
+        $this->assertFileNotExists($filename, 'file to be generated should not exist before');
+
+        $this->_fixtureController->count = 5;
+        $this->_fixtureController->actionGenerate('user');
+        $this->assertFileExists($filename, 'fixture template file should be generated');
+
+        $generatedData = require Yii::getAlias('@runtime/faker/user.php');
+        $this->assertCount(5, $generatedData, 'exactly 5 fixtures should be generated for the given template');
+    }
+
+    public function testGenerateParticlularLanguage()
+    {
+        $filename = Yii::getAlias('@runtime/faker/profile.php');
+        $this->assertFileNotExists($filename, 'file to be generated should not exist before');
+
+        $this->_fixtureController->language = 'ru_RU';
+        $this->_fixtureController->actionGenerate('profile');
+        $this->assertFileExists($filename, 'fixture template file should be generated');
+
+        $generatedData = require Yii::getAlias('@runtime/faker/profile.php');
+        $this->assertEquals(1, preg_match('/^[а-я]*$/iu', $generatedData[0]['first_name']), 'generated value should be in ru-RU language');
+    }
+
+    public function testGenerateAll()
+    {
+        $userFilename = Yii::getAlias('@runtime/faker/user.php');
+        $this->assertFileNotExists($userFilename, 'file to be generated should not exist before');
+
+        $profileFilename = Yii::getAlias('@runtime/faker/profile.php');
+        $this->assertFileNotExists($profileFilename, 'file to be generated should not exist before');
+
+        $bookFilename = Yii::getAlias('@runtime/faker/book.php');
+        $this->assertFileNotExists($bookFilename, 'file to be generated should not exist before');
+
+        $this->_fixtureController->providers[] = 'yiiunit\data\extensions\faker\providers\Book';
+        $this->_fixtureController->run('generate-all');
+
+        $this->assertFileExists($userFilename, 'fixture template file should be generated');
+        $this->assertFileExists($profileFilename, 'fixture template file should be generated');
+        $this->assertFileExists($bookFilename, 'fixture template file should be generated');
+    }
+
+}
+
+class FixtureConsoledController extends FixtureController
+{
+
+    public function stdout($string)
+    {
+    }
+
+}

tests/unit/framework/console/controllers/CacheControllerTest.php

@@ -6,6 +6,12 @@ use Yii;
 use yiiunit\TestCase;
 use yii\console\controllers\CacheController;
 
+/**
+ * Unit test for [[\yii\console\controllers\CacheController]].
+ * @see CacheController
+ *
+ * @group console
+ */
 class CacheControllerTest extends TestCase
 {
 
@@ -83,7 +89,6 @@ class CacheControllerTest extends TestCase
 
         $this->assertFalse(Yii::$app->firstCache->get('firstKey'),'first cache data should be flushed');
         $this->assertFalse(Yii::$app->secondCache->get('thirdKey'), 'second cache data should be flushed');
-
     }
 
 }