cakephp/tests/TestCase/ORM/TableRegistryTest.php

<?php
/**
 * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
 * @link          https://cakephp.org CakePHP(tm) Project
 * @since         3.0.0
 * @license       https://opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Test\TestCase\ORM;

use Cake\ORM\TableRegistry;
use Cake\TestSuite\TestCase;

/**
 * Test case for TableRegistry
 */
class TableRegistryTest extends TestCase
{

    /**
     * Original TableLocator.
     *
     * @var \Cake\ORM\Locator\LocatorInterface
     */
    protected $_originalLocator;

    /**
     * Remember original instance to set it back on tearDown() just to make sure
     * other tests are not broken.
     *
     * @return void
     */
    public function setUp()
    {
        parent::setUp();
        $this->_originalLocator = TableRegistry::getTableLocator();
    }

    /**
     * tear down
     *
     * @return void
     */
    public function tearDown()
    {
        parent::tearDown();
        TableRegistry::setTableLocator($this->_originalLocator);
    }

    /**
     * Sets and returns mock LocatorInterface instance.
     *
     * @return \Cake\ORM\Locator\LocatorInterface|\PHPUnit_Framework_MockObject_MockObject
     */
    protected function _setMockLocator()
    {
        $locator = $this->getMockBuilder('Cake\ORM\Locator\LocatorInterface')->getMock();
        TableRegistry::setTableLocator($locator);

        return $locator;
    }

    /**
     * Test locator() method.
     *
     * @group deprecated
     * @return void
     */
    public function testLocator()
    {
        $this->deprecated(function () {
            $this->assertInstanceOf('Cake\ORM\Locator\LocatorInterface', TableRegistry::locator());

            $locator = $this->getMockBuilder('Cake\ORM\Locator\LocatorInterface')->getMock();
            TableRegistry::locator($locator);

            $this->assertSame($locator, TableRegistry::locator());
        });
    }

    /**
     * Test testSetLocator() method.
     *
     * @return void
     */
    public function testSetLocator()
    {
        $locator = $this->_setMockLocator();

        $this->assertSame($locator, TableRegistry::getTableLocator());
    }

    /**
     * Test testSetLocator() method.
     *
     * @return void
     */
    public function testGetLocator()
    {
        $this->assertInstanceOf('Cake\ORM\Locator\LocatorInterface', TableRegistry::getTableLocator());
    }

    /**
     * Test that locator() method is returning TableLocator by default.
     *
     * @return void
     */
    public function testLocatorDefault()
    {
        $locator = TableRegistry::getTableLocator();
        $this->assertInstanceOf('Cake\ORM\Locator\TableLocator', $locator);
    }

    /**
     * Test config() method.
     *
     * @return void
     */
    public function testConfig()
    {
        $this->deprecated(function () {
            $locator = $this->_setMockLocator();
            $locator->expects($this->once())->method('config')->with('Test', []);

            TableRegistry::config('Test', []);
        });
    }

    /**
     * Test the get() method.
     *
     * @return void
     */
    public function testGet()
    {
        $this->deprecated(function () {
            $locator = $this->_setMockLocator();
            $locator->expects($this->once())->method('get')->with('Test', []);

            TableRegistry::get('Test', []);
        });
    }

    /**
     * Test the get() method.
     *
     * @return void
     */
    public function testSet()
    {
        $this->deprecated(function () {
            $table = $this->getMockBuilder('Cake\ORM\Table')->getMock();

            $locator = $this->_setMockLocator();
            $locator->expects($this->once())->method('set')->with('Test', $table);

            TableRegistry::set('Test', $table);
        });
    }

    /**
     * Test the remove() method.
     *
     * @return void
     */
    public function testRemove()
    {
        $this->deprecated(function () {
            $locator = $this->_setMockLocator();
            $locator->expects($this->once())->method('remove')->with('Test');

            TableRegistry::remove('Test');
        });
    }

    /**
     * Test the clear() method.
     *
     * @return void
     */
    public function testClear()
    {
        $this->deprecated(function () {
            $locator = $this->_setMockLocator();
            $locator->expects($this->once())->method('clear');

            TableRegistry::clear();
        });
    }
}