cakephp/tests/TestCase/Command/UpgradeCommandTest.php

<?php
declare(strict_types=1);

/**
 * 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         4.0.0
 * @license       https://opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Test\TestCase\Command;

use Cake\Core\Configure;
use Cake\TestSuite\ConsoleIntegrationTestTrait;
use Cake\TestSuite\TestCase;
use org\bovigo\vfs\vfsStream;
use org\bovigo\vfs\visitor\vfsStreamStructureVisitor;

/**
 * UpgradeCommand test.
 */
class UpgradeCommandTest extends TestCase
{
    use ConsoleIntegrationTestTrait;

    protected $dirStructure = [
        'forTemplate' => [
            'src' => [
                'Template' => [
                    'Email' => ['html' => ['def.php' => '']],
                    'Element' => [
                        'Flash' => ['default.ctp' => ''],
                        'foo.ctp' => '',
                    ],
                    'Layout' => ['default.ctp' => ''],
                    'Cell' => [
                        'MyCell' => ['display.ctp' => ''],
                    ],
                    'Plugin' => [
                        'TestPlugin' => [
                            'Layout' => ['Email' => ['text.php' => '']],
                            'Element' => ['bar.ctp' => ''],
                            'Posts' => ['index.ctp' => ''],
                        ],
                    ],
                    'Pages' => [
                        'home.ctp' => '',
                    ],
                ],
            ],
            'plugins' => [
                'TestPlugin' => [
                    'src' => [
                        // This is ensure "src/Cell" does not get renamed.
                        'Cell' => [
                            'TestPluginCell.php' => '',
                        ],
                        'Template' => [
                            'Element' => [
                                'foo.ctp' => '',
                            ],
                            'Layout' => [
                                'plugin.ctp' => '',
                                'Email' => ['html.php' => ''],
                            ],
                            'Cell' => [
                                'TestPluginCell' => ['bar.ctp' => ''],
                            ],
                        ],
                    ],
                ],
                'PluginWithoutTemplates' => [
                    'src' => [],
                ],
            ],
        ],
        'forLocale' => [
            'src' => [
                'Locale' => [
                    'default.pot' => '',
                    'en' => [
                        'default.po' => '',
                    ],
                ],
            ],
            'plugins' => [
                'TestVendor' => [
                    'TestPlugin' => [
                        'src' => [
                            'Locale' => [
                                'default.pot' => '',
                                'fr' => [
                                    'default.po' => '',
                                ],
                            ],
                        ],
                    ],
                ],
                'TestPluginWithLocale' => [
                    'src' => [],
                ],
            ],
        ],
    ];

    /**
     * pluginPaths
     *
     * @var array
     */
    protected $pluginPaths = [];

    /**
     * localePaths
     *
     * @var array
     */
    protected $localePaths = [];

    /**
     * Namespace
     *
     * @var string
     */
    protected $namespace = '';

    /**
     * setup method
     *
     * @return void
     */
    public function setUp(): void
    {
        parent::setUp();

        $this->useCommandRunner(true);

        $this->fs = vfsStream::setup('root');

        $this->pluginPaths = Configure::read('App.paths.plugins');
        Configure::write('App.paths.plugins', [$this->fs->url() . '/plugins'], true);

        $this->localePaths = Configure::read('App.paths.locales');
        Configure::write('App.paths.locales', [$this->fs->url() . '/src/Locale'], true);

        $this->namespace = Configure::read('App.namespace');
        Configure::write('App.namespace', 'TestApp');
    }

    /**
     * tearDown
     *
     * @return void
     */
    public function tearDown(): void
    {
        Configure::write('App.paths.plugins', $this->pluginPaths);
        Configure::write('App.paths.locales', $this->localePaths);
        Configure::write('App.namespace', $this->namespace);
    }

    /**
     * testUpgradeTemplate
     *
     * @return void
     */
    public function testUpgradeTemplate()
    {
        vfsStream::create($this->dirStructure['forTemplate']);

        $this->exec('upgrade templates --path ' . $this->fs->url());

        $ds = [
            'src' => [],
            'templates' => [
                'email' => ['html' => ['def.php' => '']],
                'element' => [
                    'flash' => ['default.php' => ''],
                    'foo.php' => '',
                ],
                'layout' => ['default.php' => ''],
                'cell' => [
                    'MyCell' => ['display.php' => ''],
                ],
                'plugin' => [
                    'TestPlugin' => [
                        'layout' => ['email' => ['text.php' => '']],
                        'element' => ['bar.php' => ''],
                        'Posts' => ['index.php' => ''],
                    ],
                ],
                'Pages' => [
                    'home.php' => '',
                ],
            ],
            'plugins' => [
                'TestPlugin' => [
                    'src' => [
                        // This is ensure "src/Cell" does not get renamed.
                        'Cell' => [
                            'TestPluginCell.php' => '',
                        ],
                    ],
                    'templates' => [
                        'element' => [
                            'foo.php' => '',
                        ],
                        'layout' => [
                            'plugin.php' => '',
                            'email' => ['html.php' => ''],
                        ],
                        'cell' => [
                            'TestPluginCell' => ['bar.php' => ''],
                        ],
                    ],
                ],
                'PluginWithoutTemplates' => [
                    'src' => [],
                ],
            ],
        ];

        $this->assertEquals(
            ['root' => $ds],
            vfsStream::inspect(new vfsStreamStructureVisitor())->getStructure()
        );
    }

    /**
     * testUpgradeLocale
     *
     * @return void
     */
    public function testUpgradeLocale()
    {
        vfsStream::create($this->dirStructure['forLocale']);

        $this->exec('upgrade locales --path ' . $this->fs->url());

        $ds = [
            'src' => [],
            'resources' => [
                'locales' => [
                    'default.pot' => '',
                    'en' => [
                        'default.po' => '',
                    ],
                ],
            ],
            'plugins' => [
                'TestVendor' => [
                    'TestPlugin' => [
                        'src' => [],
                        'resources' => [
                            'locales' => [
                                'default.pot' => '',
                                'fr' => [
                                    'default.po' => '',
                                ],
                            ],
                        ],
                    ],
                ],
                'TestPluginWithLocale' => [
                    'src' => [],
                ],
            ],
        ];

        $this->assertEquals(
            ['root' => $ds],
            vfsStream::inspect(new vfsStreamStructureVisitor())->getStructure()
        );
    }
}