ModelTaskTest.php

<?php
/**
 * CakePHP : Rapid Development Framework (http://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 * @link          http://cakephp.org CakePHP Project
 * @since         0.1.0
 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 */
namespace Bake\Test\TestCase\Shell\Task;

use Bake\Shell\Task\BakeTemplateTask;
use Bake\Test\TestCase\TestCase;
use Cake\Core\Configure;
use Cake\Core\Plugin;
use Cake\Model\Model;
use Cake\ORM\TableRegistry;
use Cake\Utility\ClassRegistry;

/**
 * ModelTaskTest class
 */
class ModelTaskTest extends TestCase
{
    /**
     * fixtures
     *
     * Don't sort this list alphabetically - otherwise there are table constraints
     * which fail when using postgres
     *
     * @var array
     */
    public $fixtures = [
        'plugin.bake.bake_articles',
        'plugin.bake.bake_comments',
        'plugin.bake.bake_articles_bake_tags',
        'plugin.bake.bake_tags',
        'plugin.bake.category_threads',
        'core.users',
        'core.number_trees',
        'core.counter_cache_users',
        'core.counter_cache_posts',
        'core.tags',
        'core.articles_tags'
    ];

    /**
     * setUp method
     *
     * @return void
     */
    public function setUp()
    {
        parent::setUp();
        $this->_compareBasePath = Plugin::path('Bake') . 'tests' . DS . 'comparisons' . DS . 'Model' . DS;
        $io = $this->getMock('Cake\Console\ConsoleIo', [], [], '', false);

        $this->Task = $this->getMock(
            'Bake\Shell\Task\ModelTask',
            ['in', 'err', 'createFile', '_stop', '_checkUnitTest'],
            [$io]
        );
        $this->Task->connection = 'test';
        $this->_setupOtherMocks();
        TableRegistry::clear();
    }

    /**
     * Setup a mock that has out mocked. Normally this is not used as it makes $this->at() really tricky.
     *
     * @return void
     */
    protected function _useMockedOut()
    {
        $io = $this->getMock('Cake\Console\ConsoleIo', [], [], '', false);

        $this->Task = $this->getMock(
            'Bake\Shell\Task\ModelTask',
            ['in', 'out', 'err', 'hr', 'createFile', '_stop', '_checkUnitTest'],
            [$io]
        );
        $this->_setupOtherMocks();
    }

    /**
     * sets up the rest of the dependencies for Model Task
     *
     * @return void
     */
    protected function _setupOtherMocks()
    {
        $io = $this->getMock('Cake\Console\ConsoleIo', [], [], '', false);

        $this->Task->Fixture = $this->getMock('Bake\Shell\Task\FixtureTask', [], [$io]);
        $this->Task->Test = $this->getMock('Bake\Shell\Task\FixtureTask', [], [$io]);
        $this->Task->BakeTemplate = new BakeTemplateTask($io);
        $this->Task->BakeTemplate->interactive = false;

        $this->Task->name = 'Model';
    }

    /**
     * tearDown method
     *
     * @return void
     */
    public function tearDown()
    {
        parent::tearDown();
        unset($this->Task);
        $this->fixtureManager->shutDown();
    }

    /**
     * Test that listAll uses the connection property
     *
     * @return void
     */
    public function testListAllConnection()
    {
        $this->_useMockedOut();
        $this->Task->connection = 'test';

        $result = $this->Task->listAll();
        $this->assertContains('bake_articles', $result);
        $this->assertContains('bake_articles_bake_tags', $result);
        $this->assertContains('bake_tags', $result);
        $this->assertContains('bake_comments', $result);
        $this->assertContains('category_threads', $result);
    }

    /**
     * Test getName() method.
     *
     * @return void
     */
    public function testGetTable()
    {
        $result = $this->Task->getTable('BakeArticles');
        $this->assertEquals('bake_articles', $result);

        $this->Task->params['table'] = 'bake_articles';
        $result = $this->Task->getTable('Article');
        $this->assertEquals('bake_articles', $result);
    }

    /**
     * Test getting the a table class.
     *
     * @return void
     */
    public function testGetTableObject()
    {
        $result = $this->Task->getTableObject('Article', 'bake_articles');
        $this->assertInstanceOf('Cake\ORM\Table', $result);
        $this->assertEquals('bake_articles', $result->table());
        $this->assertEquals('Article', $result->alias());
    }

    /**
     * Test getAssociations with off flag.
     *
     * @return void
     */
    public function testGetAssociationsNoFlag()
    {
        $this->Task->params['no-associations'] = true;
        $articles = TableRegistry::get('BakeArticle');
        $this->assertEquals([], $this->Task->getAssociations($articles));
    }

    /**
     * Test applying associations.
     *
     * @return void
     */
    public function testApplyAssociations()
    {
        $articles = TableRegistry::get('BakeArticles');
        $assocs = [
            'belongsTo' => [
                [
                    'alias' => 'BakeUsers',
                    'foreignKey' => 'bake_user_id',
                ],
            ],
            'hasMany' => [
                [
                    'alias' => 'BakeComments',
                    'foreignKey' => 'bake_article_id',
                ],
            ],
            'belongsToMany' => [
                [
                    'alias' => 'BakeTags',
                    'foreignKey' => 'bake_article_id',
                    'joinTable' => 'bake_articles_bake_tags',
                    'targetForeignKey' => 'bake_tag_id',
                ],
            ],
        ];
        $original = $articles->associations()->keys();
        $this->assertEquals([], $original);

        $this->Task->applyAssociations($articles, $assocs);
        $new = $articles->associations()->keys();
        $expected = ['bakeusers', 'bakecomments', 'baketags'];
        $this->assertEquals($expected, $new);
    }

    /**
     * Test applying associations does nothing on a concrete class
     *
     * @return void
     */
    public function testApplyAssociationsConcreteClass()
    {
        Configure::write('App.namespace', 'Bake\Test\App');
        $articles = TableRegistry::get('Articles');
        $assocs = [
            'belongsTo' => [
                [
                    'alias' => 'BakeUsers',
                    'foreignKey' => 'bake_user_id',
                ],
            ],
            'hasMany' => [
                [
                    'alias' => 'BakeComments',
                    'foreignKey' => 'bake_article_id',
                ],
            ],
            'belongsToMany' => [
                [
                    'alias' => 'BakeTags',
                    'foreignKey' => 'bake_article_id',
                    'joinTable' => 'bake_articles_bake_tags',
                    'targetForeignKey' => 'bake_tag_id',
                ],
            ],
        ];
        $original = $articles->associations()->keys();
        $this->Task->applyAssociations($articles, $assocs);
        $new = $articles->associations()->keys();
        $this->assertEquals($original, $new);
    }

    /**
     * Test getAssociations
     *
     * @return void
     */
    public function testGetAssociations()
    {
        $articles = TableRegistry::get('BakeArticles');
        $result = $this->Task->getAssociations($articles);
        $expected = [
            'belongsTo' => [
                [
                    'alias' => 'BakeUsers',
                    'foreignKey' => 'bake_user_id'
                ],
            ],
            'hasMany' => [
                [
                    'alias' => 'BakeComments',
                    'foreignKey' => 'bake_article_id',
                ],
            ],
            'belongsToMany' => [
                [
                    'alias' => 'BakeTags',
                    'foreignKey' => 'bake_article_id',
                    'joinTable' => 'bake_articles_bake_tags',
                    'targetForeignKey' => 'bake_tag_id',
                ],
            ],
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * Test getAssociations in a plugin
     *
     * @return void
     */
    public function testGetAssociationsPlugin()
    {
        $articles = TableRegistry::get('BakeArticles');
        $this->Task->plugin = 'TestBake';

        $result = $this->Task->getAssociations($articles);
        $expected = [
            'belongsTo' => [
                [
                    'alias' => 'BakeUsers',
                    'className' => 'TestBake.BakeUsers',
                    'foreignKey' => 'bake_user_id'
                ],
            ],
            'hasMany' => [
                [
                    'alias' => 'BakeComments',
                    'className' => 'TestBake.BakeComments',
                    'foreignKey' => 'bake_article_id',
                ],
            ],
            'belongsToMany' => [
                [
                    'alias' => 'BakeTags',
                    'className' => 'TestBake.BakeTags',
                    'foreignKey' => 'bake_article_id',
                    'joinTable' => 'bake_articles_bake_tags',
                    'targetForeignKey' => 'bake_tag_id',
                ],
            ],
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * test that belongsTo generation works.
     *
     * @return void
     */
    public function testBelongsToGeneration()
    {
        $model = TableRegistry::get('BakeComments');
        $result = $this->Task->findBelongsTo($model, []);
        $expected = [
            'belongsTo' => [
                [
                    'alias' => 'BakeArticles',
                    'foreignKey' => 'bake_article_id'
                ],
                [
                    'alias' => 'BakeUsers',
                    'foreignKey' => 'bake_user_id'
                ],
            ]
        ];
        $this->assertEquals($expected, $result);

        $model = TableRegistry::get('CategoryThreads');
        $result = $this->Task->findBelongsTo($model, []);
        $expected = [
            'belongsTo' => [
                [
                    'alias' => 'ParentCategoryThreads',
                    'className' => 'CategoryThreads',
                    'foreignKey' => 'parent_id'
                ],
            ]
        ];
        $this->assertEquals($expected, $result);

        $this->Task->plugin = 'Blog';
        $result = $this->Task->findBelongsTo($model, []);
        $expected = [
            'belongsTo' => [
                [
                    'alias' => 'ParentCategoryThreads',
                    'className' => 'Blog.CategoryThreads',
                    'foreignKey' => 'parent_id'
                ],
            ]
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * Test that belongsTo generation works for models with composite
     * primary keys
     *
     * @return void
     */
    public function testBelongsToGenerationCompositeKey()
    {
        $model = TableRegistry::get('ArticlesTags');
        $result = $this->Task->findBelongsTo($model, []);
        $expected = [
            'belongsTo' => [
                [
                    'alias' => 'Articles',
                    'foreignKey' => 'article_id'
                ],
                [
                    'alias' => 'Tags',
                    'foreignKey' => 'tag_id'
                ]
            ]
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * Test that belongsTo generation ignores _id mid-column
     *
     * @return void
     */
    public function testBelongsToGenerationIdMidColumn()
    {
        $model = TableRegistry::get('Articles');
        $model->schema([
            'id' => ['type' => 'integer'],
            'thing_id_field' => ['type' => 'integer'],
        ]);
        $result = $this->Task->findBelongsTo($model, []);
        $this->assertEquals([], $result);
    }

    /**
     * test that hasOne and/or hasMany relations are generated properly.
     *
     * @return void
     */
    public function testHasManyGeneration()
    {
        $this->Task->connection = 'test';
        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->findHasMany($model, []);
        $expected = [
            'hasMany' => [
                [
                    'alias' => 'BakeComments',
                    'foreignKey' => 'bake_article_id',
                ],
            ],
        ];
        $this->assertEquals($expected, $result);

        $model = TableRegistry::get('CategoryThreads');
        $result = $this->Task->findHasMany($model, []);
        $expected = [
            'hasMany' => [
                [
                    'alias' => 'ChildCategoryThreads',
                    'className' => 'CategoryThreads',
                    'foreignKey' => 'parent_id',
                ],
            ]
        ];
        $this->assertEquals($expected, $result);

        $this->Task->plugin = 'Blog';
        $result = $this->Task->findHasMany($model, []);
        $expected = [
            'hasMany' => [
                [
                    'alias' => 'ChildCategoryThreads',
                    'className' => 'Blog.CategoryThreads',
                    'foreignKey' => 'parent_id'
                ],
            ]
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * Test that HABTM generation works
     *
     * @return void
     */
    public function testHasAndBelongsToManyGeneration()
    {
        $this->Task->connection = 'test';
        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->findBelongsToMany($model, []);
        $expected = [
            'belongsToMany' => [
                [
                    'alias' => 'BakeTags',
                    'foreignKey' => 'bake_article_id',
                    'joinTable' => 'bake_articles_bake_tags',
                    'targetForeignKey' => 'bake_tag_id',
                ],
            ],
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * Test getting accessible fields.
     *
     * @return void
     */
    public function testGetFields()
    {
        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->getFields($model);
        $expected = [
            'bake_user_id',
            'title',
            'body',
            'published',
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * Test getting accessible fields includes associations.
     *
     * @return void
     */
    public function testGetFieldsAssociations()
    {
        $model = TableRegistry::get('BakeArticles');
        $model->belongsToMany('BakeTags');
        $model->belongsTo('BakeAuthors');
        $model->hasMany('BakeComments');

        $result = $this->Task->getFields($model);
        $this->assertContains('bake_tags', $result);
        $this->assertContains('bake_comments', $result);
        $this->assertContains('bake_author', $result);
    }

    /**
     * Test getting field with the no- option
     *
     * @return void
     */
    public function testGetFieldsDisabled()
    {
        $model = TableRegistry::get('BakeArticles');
        $this->Task->params['no-fields'] = true;
        $result = $this->Task->getFields($model);
        $this->assertEquals([], $result);
    }

    /**
     * Test getting field with a whitelist
     *
     * @return void
     */
    public function testGetFieldsWhiteList()
    {
        $model = TableRegistry::get('BakeArticles');
        $this->Task->params['fields'] = 'id, title  , , body ,  created';
        $result = $this->Task->getFields($model);
        $expected = [
            'id',
            'title',
            'body',
            'created',
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * Test getting hidden fields.
     *
     * @return void
     */
    public function testGetHiddenFields()
    {
        $model = TableRegistry::get('Users');
        $result = $this->Task->getHiddenFields($model);
        $expected = [
            'password',
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * Test getting hidden field with the no- option
     *
     * @return void
     */
    public function testGetHiddenFieldsDisabled()
    {
        $model = TableRegistry::get('Users');
        $this->Task->params['no-hidden'] = true;
        $result = $this->Task->getHiddenFields($model);
        $this->assertEquals([], $result);
    }

    /**
     * Test getting hidden field with a whitelist
     *
     * @return void
     */
    public function testGetHiddenFieldsWhiteList()
    {
        $model = TableRegistry::get('Users');
        $this->Task->params['hidden'] = 'id, title  , , body ,  created';
        $result = $this->Task->getHiddenFields($model);
        $expected = [
            'id',
            'title',
            'body',
            'created',
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * Test getting primary key
     *
     * @return void
     */
    public function testGetPrimaryKey()
    {
        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->getPrimaryKey($model);
        $expected = ['id'];
        $this->assertEquals($expected, $result);

        $this->Task->params['primary-key'] = 'id, , account_id';
        $result = $this->Task->getPrimaryKey($model);
        $expected = ['id', 'account_id'];
        $this->assertEquals($expected, $result);
    }

    /**
     * test getting validation rules with the no-validation rule.
     *
     * @return void
     */
    public function testGetValidationDisabled()
    {
        $model = TableRegistry::get('BakeArticles');
        $this->Task->params['no-validation'] = true;
        $result = $this->Task->getValidation($model);
        $this->assertEquals([], $result);
    }

    /**
     * test getting validation rules.
     *
     * @return void
     */
    public function testGetValidation()
    {
        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->getValidation($model);
        $expected = [
            'bake_user_id' => ['valid' => ['rule' => 'numeric', 'allowEmpty' => false]],
            'title' => ['valid' => ['rule' => false, 'allowEmpty' => false]],
            'body' => ['valid' => ['rule' => false, 'allowEmpty' => true]],
            'published' => ['valid' => ['rule' => 'boolean', 'allowEmpty' => true]],
            'id' => ['valid' => ['rule' => 'numeric', 'allowEmpty' => 'create']]
        ];
        $this->assertEquals($expected, $result);

        $model = TableRegistry::get('BakeComments');
        $result = $this->Task->getValidation($model);
        $expected = [
            'bake_article_id' => ['valid' => ['rule' => 'numeric', 'allowEmpty' => false]],
            'bake_user_id' => ['valid' => ['rule' => 'numeric', 'allowEmpty' => false]],
            'comment' => ['valid' => ['rule' => false, 'allowEmpty' => true]],
            'published' => ['valid' => ['rule' => false, 'allowEmpty' => true]],
            'otherid' => ['valid' => ['rule' => 'numeric', 'allowEmpty' => 'create']]
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * test getting validation rules and exempting foreign keys
     *
     * @return void
     */
    public function testGetValidationExcludeForeignKeys()
    {
        $model = TableRegistry::get('BakeArticles');
        $associations = [
            'belongsTo' => [
                'BakeUsers' => ['foreignKey' => 'bake_user_id'],
            ]
        ];
        $result = $this->Task->getValidation($model, $associations);
        $expected = [
            'title' => ['valid' => ['rule' => false, 'allowEmpty' => false]],
            'body' => ['valid' => ['rule' => false, 'allowEmpty' => true]],
            'published' => ['valid' => ['rule' => 'boolean', 'allowEmpty' => true]],
            'id' => ['valid' => ['rule' => 'numeric', 'allowEmpty' => 'create']]
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * test getting validation rules with the no-rules param.
     *
     * @return void
     */
    public function testGetRulesDisabled()
    {
        $model = TableRegistry::get('Users');
        $this->Task->params['no-rules'] = true;
        $result = $this->Task->getRules($model, []);
        $this->assertEquals([], $result);
    }

    /**
     * Tests the getRules method
     *
     * @return void
     */
    public function testGetRules()
    {
        $model = TableRegistry::get('Users');
        $associations = [
            'belongsTo' => [
                [
                    'alias' => 'Countries',
                    'foreignKey' => 'country_id'
                ],
                [
                    'alias' => 'Sites',
                    'foreignKey' => 'site_id'
                ]
            ],
            'hasMany' => [
                [
                    'alias' => 'BakeComments',
                    'foreignKey' => 'bake_user_id',
                ],
            ]
        ];
        $result = $this->Task->getRules($model, $associations);
        $expected = [
            'username' => [
                'name' => 'isUnique'
            ],
            'country_id' => [
                'name' => 'existsIn',
                'extra' => 'Countries'
            ],
            'site_id' => [
                'name' => 'existsIn',
                'extra' => 'Sites'
            ]
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * test non interactive doActsAs
     *
     * @return void
     */
    public function testGetBehaviors()
    {
        $model = TableRegistry::get('NumberTrees');
        $result = $this->Task->getBehaviors($model);
        $this->assertEquals(['Tree' => []], $result);

        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->getBehaviors($model);
        $this->assertEquals(['Timestamp' => []], $result);

        TableRegistry::clear();
        TableRegistry::get('Users', [
            'table' => 'counter_cache_users'
        ]);
        $model = TableRegistry::get('Posts', [
            'table' => 'counter_cache_posts'
        ]);
        $result = $this->Task->getBehaviors($model);
        $expected = [
            'CounterCache' => ["'Users' => ['post_count']"]
        ];
        $this->assertEquals($expected, $result);
    }

    /**
     * Test getDisplayField() method.
     *
     * @return void
     */
    public function testGetDisplayField()
    {
        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->getDisplayField($model);
        $this->assertEquals('title', $result);

        $this->Task->params['display-field'] = 'custom';
        $result = $this->Task->getDisplayField($model);
        $this->assertEquals('custom', $result);
    }

    /**
     * Ensure that the fixture object is correctly called.
     *
     * @return void
     */
    public function testBakeFixture()
    {
        $this->Task->plugin = 'TestBake';
        $this->Task->Fixture->expects($this->at(0))
            ->method('bake')
            ->with('BakeArticle', 'bake_articles');
        $this->Task->bakeFixture('BakeArticle', 'bake_articles');

        $this->assertEquals($this->Task->plugin, $this->Task->Fixture->plugin);
        $this->assertEquals($this->Task->connection, $this->Task->Fixture->connection);
        $this->assertEquals($this->Task->interactive, $this->Task->Fixture->interactive);
    }

    /**
     * Ensure that the fixture baking can be disabled
     *
     * @return void
     */
    public function testBakeFixtureDisabled()
    {
        $this->Task->params['no-fixture'] = true;
        $this->Task->plugin = 'TestBake';
        $this->Task->Fixture->expects($this->never())
            ->method('bake');
        $this->Task->bakeFixture('BakeArticle', 'bake_articles');
    }

    /**
     * Ensure that the test object is correctly called.
     *
     * @return void
     */
    public function testBakeTest()
    {
        $this->Task->plugin = 'TestBake';
        $this->Task->Test->expects($this->at(0))
            ->method('bake')
            ->with('Table', 'BakeArticle');
        $this->Task->bakeTest('BakeArticle');

        $this->assertEquals($this->Task->plugin, $this->Task->Test->plugin);
        $this->assertEquals($this->Task->connection, $this->Task->Test->connection);
        $this->assertEquals($this->Task->interactive, $this->Task->Test->interactive);
    }

    /**
     * Ensure that test baking can be disabled.
     *
     * @return void
     */
    public function testBakeTestDisabled()
    {
        $this->Task->params['no-test'] = true;
        $this->Task->plugin = 'TestBake';
        $this->Task->Test->expects($this->never())
            ->method('bake');
        $this->Task->bakeTest('BakeArticle');
    }

    /**
     * test baking validation
     *
     * @return void
     */
    public function testBakeTableValidation()
    {
        $validation = [
            'id' => [
                'valid' => [
                    'allowEmpty' => 'create',
                    'rule' => 'numeric',
                ]
            ],
            'name' => [
                'valid' => [
                    'allowEmpty' => false,
                    'rule' => false,
                ]
            ],
            'email' => [
                'valid' => [
                    'allowEmpty' => true,
                    'rule' => 'email'
                ],
                'unique' => [
                    'rule' => 'validateUnique',
                    'provider' => 'table'
                ]
            ]
        ];
        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->bakeTable($model, compact('validation'));
        $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
    }

    /**
     * test baking
     *
     * @return void
     */
    public function testBakeTableConfig()
    {
        $config = [
            'table' => 'articles',
            'primaryKey' => ['id'],
            'displayField' => 'title',
            'behaviors' => ['Timestamp' => ''],
            'connection' => 'website',
        ];
        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->bakeTable($model, $config);
        $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
    }

    /**
     * test baking relations
     *
     * @return void
     */
    public function testBakeTableRelations()
    {
        $associations = [
            'belongsTo' => [
                [
                    'alias' => 'SomethingElse',
                    'foreignKey' => 'something_else_id',
                ],
                [
                    'alias' => 'BakeUser',
                    'foreignKey' => 'bake_user_id',
                ],
            ],
            'hasMany' => [
                [
                    'alias' => 'BakeComment',
                    'foreignKey' => 'parent_id',
                ],
            ],
            'belongsToMany' => [
                [
                    'alias' => 'BakeTag',
                    'foreignKey' => 'bake_article_id',
                    'joinTable' => 'bake_articles_bake_tags',
                    'targetForeignKey' => 'bake_tag_id',
                ],
            ]
        ];
        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->bakeTable($model, compact('associations'));
        $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
    }

    /**
     * test baking an entity class
     *
     * @return void
     */
    public function testBakeEntity()
    {
        $config = [
            'fields' => []
        ];
        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->bakeEntity($model, $config);
        $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
    }

    /**
     * test baking an entity class
     *
     * @return void
     */
    public function testBakeEntityFields()
    {
        $config = [
            'fields' => ['title', 'body', 'published']
        ];
        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->bakeEntity($model, $config);
        $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
    }

    /**
     * test baking an entity class sets hidden fields.
     *
     * @return void
     */
    public function testBakeEntityHidden()
    {
        $model = TableRegistry::get('BakeUsers');
        $config = [
            'hidden' => ['password'],
        ];
        $result = $this->Task->bakeEntity($model, $config);
        $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
    }

    /**
     * test bake() with a -plugin param
     *
     * @return void
     */
    public function testBakeTableWithPlugin()
    {
        $this->Task->plugin = 'ModelTest';

        // fake plugin path
        Plugin::load('ModelTest', ['path' => APP . 'Plugin' . DS . 'ModelTest' . DS]);
        $path = $this->_normalizePath(APP . 'Plugin/ModelTest/src/Model/Table/BakeArticlesTable.php');
        $this->Task->expects($this->once())->method('createFile')
            ->with($path);

        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->bakeTable($model);
        $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
    }

    /**
     * test bake() with a -plugin param
     *
     * @return void
     */
    public function testBakeEntityWithPlugin()
    {
        $this->Task->plugin = 'ModelTest';

        // fake plugin path
        Plugin::load('ModelTest', ['path' => APP . 'Plugin' . DS . 'ModelTest' . DS]);
        $path = APP . 'Plugin' . DS . 'ModelTest' . DS . 'src' . DS . 'Model' . DS . 'Entity' . DS . 'BakeArticle.php';
        $path = $this->_normalizePath($path);
        $this->Task->expects($this->once())->method('createFile')
            ->with($path);

        $model = TableRegistry::get('BakeArticles');
        $result = $this->Task->bakeEntity($model);
        $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
    }

    /**
     * Tests baking a table with rules
     *
     * @return void
     */
    public function testBakeWithRules()
    {
        $model = TableRegistry::get('Users');
        $associations = [
            'belongsTo' => [
                [
                    'alias' => 'Countries',
                    'foreignKey' => 'country_id'
                ],
                [
                    'alias' => 'Sites',
                    'foreignKey' => 'site_id'
                ]
            ],
            'hasMany' => [
                [
                    'alias' => 'BakeComments',
                    'foreignKey' => 'bake_user_id',
                ],
            ]
        ];
        $rulesChecker = $this->Task->getRules($model, $associations);
        $result = $this->Task->bakeTable($model, compact('rulesChecker'));
        $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
    }

    /**
     * test that execute with no args
     *
     * @return void
     */
    public function testMainNoArgs()
    {
        $this->_useMockedOut();
        $this->Task->connection = 'test';
        $this->Task->path = '/my/path/';

        $this->Task->expects($this->at(0))
            ->method('out')
            ->with($this->stringContains('Choose a model to bake from the following:'));

        $this->Task->main();
    }

    /**
     * test that execute passes runs bake depending with named model.
     *
     * @return void
     */
    public function testMainWithNamedModel()
    {
        $this->Task->connection = 'test';

        $tableFile = $this->_normalizePath(APP . 'Model/Table/BakeArticlesTable.php');
        $this->Task->expects($this->at(0))
            ->method('createFile')
            ->with($tableFile, $this->stringContains('class BakeArticlesTable extends Table'));

        $entityFile = $this->_normalizePath(APP . 'Model/Entity/BakeArticle.php');
        $this->Task->expects($this->at(1))
            ->method('createFile')
            ->with($entityFile, $this->stringContains('class BakeArticle extends Entity'));

        $this->Task->main('BakeArticles');
    }

    /**
     * data provider for testMainWithNamedModelVariations
     *
     * @return void
     */
    public static function nameVariations()
    {
        return [
            ['BakeArticles'], ['bake_articles']
        ];
    }

    /**
     * test that execute passes with different inflections of the same name.
     *
     * @dataProvider nameVariations
     * @return void
     */
    public function testMainWithNamedModelVariations($name)
    {
        $this->Task->connection = 'test';

        $filename = $this->_normalizePath(APP . 'Model/Table/BakeArticlesTable.php');

        $this->Task->expects($this->at(0))
            ->method('createFile')
            ->with($filename, $this->stringContains('class BakeArticlesTable extends Table'));
        $this->Task->main($name);
    }

    /**
     * test that execute runs all() when args[0] = all
     *
     * @return void
     */
    public function testMainIntoAll()
    {
        $count = count($this->Task->listAll());
        if ($count != count($this->fixtures)) {
            $this->markTestSkipped('Additional tables detected.');
        }

        $this->Task->connection = 'test';

        $this->Task->Fixture->expects($this->exactly($count))
            ->method('bake');
        $this->Task->Test->expects($this->exactly($count))
            ->method('bake');

        $filename = $this->_normalizePath(APP . 'Model/Table/ArticlesTagsTable.php');
        $this->Task->expects($this->at(1))
            ->method('createFile')
            ->with($filename, $this->stringContains('class ArticlesTagsTable extends'));

        $filename = $this->_normalizePath(APP . 'Model/Entity/ArticlesTag.php');
        $this->Task->expects($this->at(2))
            ->method('createFile')
            ->with($filename, $this->stringContains('class ArticlesTag extends'));

        $filename = $this->_normalizePath(APP . 'Model/Table/BakeArticlesTable.php');
        $this->Task->expects($this->at(3))
            ->method('createFile')
            ->with($filename, $this->stringContains('class BakeArticlesTable extends'));

        $filename = $this->_normalizePath(APP . 'Model/Entity/BakeArticle.php');
        $this->Task->expects($this->at(4))
            ->method('createFile')
            ->with($filename, $this->stringContains('class BakeArticle extends'));

        $filename = $this->_normalizePath(APP . 'Model/Table/BakeArticlesBakeTagsTable.php');
        $this->Task->expects($this->at(5))
            ->method('createFile')
            ->with($filename, $this->stringContains('class BakeArticlesBakeTagsTable extends'));

        $filename = $this->_normalizePath(APP . 'Model/Entity/BakeArticlesBakeTag.php');
        $this->Task->expects($this->at(6))
            ->method('createFile')
            ->with($filename, $this->stringContains('class BakeArticlesBakeTag extends'));

        $filename = $this->_normalizePath(APP . 'Model/Table/BakeCommentsTable.php');
        $this->Task->expects($this->at(7))
            ->method('createFile')
            ->with($filename, $this->stringContains('class BakeCommentsTable extends'));

        $filename = $this->_normalizePath(APP . 'Model/Entity/BakeComment.php');
        $this->Task->expects($this->at(8))
            ->method('createFile')
            ->with($filename, $this->stringContains('class BakeComment extends'));

        $filename = $this->_normalizePath(APP . 'Model/Table/BakeTagsTable.php');
        $this->Task->expects($this->at(9))
            ->method('createFile')
            ->with($filename, $this->stringContains('class BakeTagsTable extends'));

        $filename = $this->_normalizePath(APP . 'Model/Entity/BakeTag.php');
        $this->Task->expects($this->at(10))
            ->method('createFile')
            ->with($filename, $this->stringContains('class BakeTag extends'));

        $filename = $this->_normalizePath(APP . 'Model/Table/CategoryThreadsTable.php');
        $this->Task->expects($this->at(11))
            ->method('createFile')
            ->with($filename, $this->stringContains('class CategoryThreadsTable extends'));

        $filename = $this->_normalizePath(APP . 'Model/Entity/CategoryThread.php');
        $this->Task->expects($this->at(12))
            ->method('createFile')
            ->with($filename, $this->stringContains('class CategoryThread extends'));

        $this->Task->all();
    }

    /**
     * test that skipTables changes how all() works.
     *
     * @return void
     */
    public function testSkipTablesAndAll()
    {
        $count = count($this->Task->listAll('test'));
        if ($count != count($this->fixtures)) {
            $this->markTestSkipped('Additional tables detected.');
        }

        $this->Task->connection = 'test';
        $this->Task->skipTables = ['articles_tags', 'bake_tags', 'counter_cache_posts'];

        $this->Task->Fixture->expects($this->exactly(8))
            ->method('bake');
        $this->Task->Test->expects($this->exactly(8))
            ->method('bake');

        $filename = $this->_normalizePath(APP . 'Model/Entity/BakeArticle.php');
        $this->Task->expects($this->at(1))
            ->method('createFile')
            ->with($filename);

        $filename = $this->_normalizePath(APP . 'Model/Entity/BakeArticlesBakeTag.php');
        $this->Task->expects($this->at(3))
            ->method('createFile')
            ->with($filename);

        $filename = $this->_normalizePath(APP . 'Model/Entity/BakeComment.php');
        $this->Task->expects($this->at(5))
            ->method('createFile')
            ->with($filename);

        $filename = $this->_normalizePath(APP . 'Model/Entity/CategoryThread.php');
        $this->Task->expects($this->at(7))
            ->method('createFile')
            ->with($filename);

        $filename = $this->_normalizePath(APP . 'Model/Entity/CounterCacheUser.php');
        $this->Task->expects($this->at(9))
            ->method('createFile')
            ->with($filename);

        $filename = $this->_normalizePath(APP . 'Model/Entity/NumberTree.php');
        $this->Task->expects($this->at(11))
            ->method('createFile')
            ->with($filename);

        $this->Task->all();
    }
}