cakephp/tests/TestCase/Console/ShellTest.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         1.2.0
 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Test\TestCase\Console;

use Cake\Console\ConsoleOptionParser;
use Cake\Console\Shell;
use Cake\Core\App;
use Cake\Core\Configure;
use Cake\Core\Plugin;
use Cake\Filesystem\Folder;
use Cake\Log\Log;
use Cake\TestSuite\TestCase;
use Cake\Utility\Hash;

/**
 * Class for testing merging vars
 */
class MergeShell extends Shell {

	public $tasks = array('DbConfig', 'Fixture');

	public $modelClass = 'Articles';

}

/**
 * ShellTestShell class
 *
 */
class ShellTestShell extends Shell {

/**
 * name property
 *
 * @var name
 */
	public $name = 'ShellTestShell';

/**
 * stopped property
 *
 * @var int
 */
	public $stopped;

/**
 * testMessage property
 *
 * @var string
 */
	public $testMessage = 'all your base are belong to us';

/**
 * stop method
 *
 * @param int $status
 * @return void
 */
	protected function _stop($status = 0) {
		$this->stopped = $status;
	}

	protected function _secret() {
	}

	//@codingStandardsIgnoreStart
	public function doSomething() {
	}

	protected function noAccess() {
	}

	public function logSomething() {
		$this->log($this->testMessage);
	}
	//@codingStandardsIgnoreEnd

	public function useLogger($enable = true) {
		$this->_useLogger($enable);
	}

}

/**
 * TestAppleTask class
 *
 */
class TestAppleTask extends Shell {
}

/**
 * TestBananaTask class
 *
 */
class TestBananaTask extends Shell {
}

class_alias(__NAMESPACE__ . '\TestAppleTask', 'Cake\Shell\Task\TestAppleTask');
class_alias(__NAMESPACE__ . '\TestBananaTask', 'Cake\Shell\Task\TestBananaTask');

/**
 * ShellTest class
 *
 */
class ShellTest extends TestCase {

/**
 * Fixtures used in this test case
 *
 * @var array
 */
	public $fixtures = array(
		'core.post', 'core.comment', 'core.article', 'core.user',
		'core.tag', 'core.articles_tag', 'core.attachment'
	);

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

		$this->io = $this->getMock('Cake\Console\ConsoleIo', [], [], '', false);
		$this->Shell = new ShellTestShell($this->io);

		if (is_dir(TMP . 'shell_test')) {
			$Folder = new Folder(TMP . 'shell_test');
			$Folder->delete();
		}
	}

/**
 * testConstruct method
 *
 * @return void
 */
	public function testConstruct() {
		$this->assertEquals('ShellTestShell', $this->Shell->name);
		$this->assertInstanceOf('Cake\Console\ConsoleIo', $this->Shell->io());
	}

/**
 * testInitialize method
 *
 * @return void
 */
	public function testInitialize() {
		Configure::write('App.namespace', 'TestApp');

		Plugin::load('TestPlugin');
		$this->Shell->tasks = array('DbConfig' => array('one', 'two'));
		$this->Shell->plugin = 'TestPlugin';
		$this->Shell->modelClass = 'TestPlugin.TestPluginComments';
		$this->Shell->initialize();
		$this->Shell->loadModel();

		$this->assertTrue(isset($this->Shell->TestPluginComments));
		$this->assertInstanceOf(
			'TestPlugin\Model\Table\TestPluginCommentsTable',
			$this->Shell->TestPluginComments
		);
	}

/**
 * test LoadModel method
 *
 * @return void
 */
	public function testLoadModel() {
		Configure::write('App.namespace', 'TestApp');

		$Shell = new MergeShell();
		$this->assertInstanceOf(
			'TestApp\Model\Table\ArticlesTable',
			$Shell->Articles
		);
		$this->assertEquals('Articles', $Shell->modelClass);

		Plugin::load('TestPlugin');
		$result = $this->Shell->loadModel('TestPlugin.TestPluginComments');
		$this->assertInstanceOf(
			'TestPlugin\Model\Table\TestPluginCommentsTable',
			$result
		);
		$this->assertInstanceOf(
			'TestPlugin\Model\Table\TestPluginCommentsTable',
			$this->Shell->TestPluginComments
		);
	}

/**
 * testIn method
 *
 * @return void
 */
	public function testIn() {
		$this->io->expects($this->at(0))
			->method('askChoice')
			->with('Just a test?', ['y', 'n'], 'n')
			->will($this->returnValue('n'));

		$this->io->expects($this->at(1))
			->method('ask')
			->with('Just a test?', 'n')
			->will($this->returnValue('n'));

		$result = $this->Shell->in('Just a test?', array('y', 'n'), 'n');
		$this->assertEquals('n', $result);

		$result = $this->Shell->in('Just a test?', null, 'n');
		$this->assertEquals('n', $result);
	}

/**
 * Test in() when not interactive.
 *
 * @return void
 */
	public function testInNonInteractive() {
		$this->io->expects($this->never())
			->method('askChoice');
		$this->io->expects($this->never())
			->method('ask');

		$this->Shell->interactive = false;

		$result = $this->Shell->in('Just a test?', 'y/n', 'n');
		$this->assertEquals('n', $result);
	}

/**
 * testOut method
 *
 * @return void
 */
	public function testOut() {
		$this->io->expects($this->once())
			->method('out')
			->with('Just a test', 1);

		$this->Shell->out('Just a test');
	}

/**
 * testErr method
 *
 * @return void
 */
	public function testErr() {
		$this->io->expects($this->once())
			->method('err')
			->with('Just a test', 1);

		$this->Shell->err('Just a test');
	}

/**
 * testNl
 *
 * @return void
 */
	public function testNl() {
		$this->io->expects($this->once())
			->method('nl')
			->with(2);

		$this->Shell->nl(2);
	}

/**
 * testHr
 *
 * @return void
 */
	public function testHr() {
		$this->io->expects($this->once())
			->method('hr')
			->with(2);

		$this->Shell->hr(2);
	}

/**
 * testError
 *
 * @return void
 */
	public function testError() {
		$this->io->expects($this->at(0))
			->method('err')
			->with('<error>Error:</error> Foo Not Found');

		$this->io->expects($this->at(1))
			->method('err')
			->with("Searched all...");

		$this->Shell->error('Foo Not Found', 'Searched all...');
		$this->assertSame($this->Shell->stopped, 1);
	}

/**
 * testLoadTasks method
 *
 * @return void
 */
	public function testLoadTasks() {
		$this->assertTrue($this->Shell->loadTasks());

		$this->Shell->tasks = null;
		$this->assertTrue($this->Shell->loadTasks());

		$this->Shell->tasks = false;
		$this->assertTrue($this->Shell->loadTasks());

		$this->Shell->tasks = true;
		$this->assertTrue($this->Shell->loadTasks());

		$this->Shell->tasks = array();
		$this->assertTrue($this->Shell->loadTasks());

		$this->Shell->tasks = array('TestApple');
		$this->assertTrue($this->Shell->loadTasks());
		$this->assertInstanceOf('Cake\Shell\Task\TestAppleTask', $this->Shell->TestApple);

		$this->Shell->tasks = 'TestBanana';
		$this->assertTrue($this->Shell->loadTasks());
		$this->assertInstanceOf('Cake\Shell\Task\TestAppleTask', $this->Shell->TestApple);
		$this->assertInstanceOf('Cake\Shell\Task\TestBananaTask', $this->Shell->TestBanana);

		unset($this->Shell->ShellTestApple, $this->Shell->TestBanana);

		$this->Shell->tasks = array('TestApple', 'TestBanana');
		$this->assertTrue($this->Shell->loadTasks());
		$this->assertInstanceOf('Cake\Shell\Task\TestAppleTask', $this->Shell->TestApple);
		$this->assertInstanceOf('Cake\Shell\Task\TestBananaTask', $this->Shell->TestBanana);
	}

/**
 * test that __get() makes args and params references
 *
 * @return void
 */
	public function testMagicGetArgAndParamReferences() {
		$this->Shell->tasks = array('TestApple');
		$this->Shell->args = array('one');
		$this->Shell->params = array('help' => false);
		$this->Shell->loadTasks();
		$result = $this->Shell->TestApple;

		$this->Shell->args = array('one', 'two');

		$this->assertSame($this->Shell->args, $result->args);
		$this->assertSame($this->Shell->params, $result->params);
	}

/**
 * testShortPath method
 *
 * @return void
 */
	public function testShortPath() {
		$path = $expected = DS . 'tmp/ab/cd';
		$this->assertPathEquals($expected, $this->Shell->shortPath($path));

		$path = $expected = DS . 'tmp/ab/cd/';
		$this->assertPathEquals($expected, $this->Shell->shortPath($path));

		$path = $expected = DS . 'tmp/ab/index.php';
		$this->assertPathEquals($expected, $this->Shell->shortPath($path));

		$path = DS . 'tmp/ab/' . DS . 'cd';
		$expected = DS . 'tmp/ab/cd';
		$this->assertPathEquals($expected, $this->Shell->shortPath($path));

		$path = 'tmp/ab';
		$expected = 'tmp/ab';
		$this->assertPathEquals($expected, $this->Shell->shortPath($path));

		$path = 'tmp/ab';
		$expected = 'tmp/ab';
		$this->assertPathEquals($expected, $this->Shell->shortPath($path));

		$path = APP;
		$result = $this->Shell->shortPath($path);
		$this->assertNotContains(ROOT, $result, 'Short paths should not contain ROOT');
	}

/**
 * testCreateFile method
 *
 * @return void
 */
	public function testCreateFileNonInteractive() {
		$eol = PHP_EOL;
		$path = TMP . 'shell_test';
		$file = $path . DS . 'file1.php';

		new Folder($path, true);

		$contents = "<?php{$eol}echo 'test';${eol}\$te = 'st';{$eol}";
		$result = $this->Shell->createFile($file, $contents);
		$this->assertTrue($result);
		$this->assertTrue(file_exists($file));
		$this->assertEquals(file_get_contents($file), $contents);
	}

/**
 * Test that files are not changed with a 'n' reply.
 *
 * @return void
 */
	public function testCreateFileNoReply() {
		$eol = PHP_EOL;
		$path = TMP . 'shell_test';
		$file = $path . DS . 'file1.php';

		new Folder($path, true);

		$this->io->expects($this->once())
			->method('askChoice')
			->will($this->returnValue('n'));

		touch($file);
		$this->assertTrue(file_exists($file));

		$contents = "My content";
		$result = $this->Shell->createFile($file, $contents);
		$this->assertTrue(file_exists($file));
		$this->assertTextEquals('', file_get_contents($file));
		$this->assertFalse($result, 'Did not create file.');
	}

/**
 * Test that files are changed with a 'y' reply.
 *
 * @return void
 */
	public function testCreateFileOverwrite() {
		$eol = PHP_EOL;
		$path = TMP . 'shell_test';
		$file = $path . DS . 'file1.php';

		new Folder($path, true);

		$this->io->expects($this->once())
			->method('askChoice')
			->will($this->returnValue('y'));

		touch($file);
		$this->assertTrue(file_exists($file));

		$contents = "My content";
		$result = $this->Shell->createFile($file, $contents);
		$this->assertTrue(file_exists($file));
		$this->assertTextEquals($contents, file_get_contents($file));
		$this->assertTrue($result, 'Did create file.');
	}

/**
 * Test that you can't create files that aren't writable.
 *
 * @return void
 */
	public function testCreateFileNoPermissions() {
		$this->skipIf(DIRECTORY_SEPARATOR === '\\', 'Cant perform operations using permissions on windows.');

		$path = TMP . 'shell_test';
		$file = $path . DS . 'no_perms';

		if (!is_dir($path)) {
			mkdir($path);
		}
		chmod($path, 0444);

		$this->Shell->createFile($file, 'testing');
		$this->assertFalse(file_exists($file));

		chmod($path, 0744);
		rmdir($path);
	}

/**
 * test hasTask method
 *
 * @return void
 */
	public function testHasTask() {
		$this->Shell->tasks = array('Extract', 'DbConfig');
		$this->Shell->loadTasks();

		$this->assertTrue($this->Shell->hasTask('extract'));
		$this->assertTrue($this->Shell->hasTask('Extract'));
		$this->assertFalse($this->Shell->hasTask('random'));

		$this->assertTrue($this->Shell->hasTask('db_config'));
		$this->assertTrue($this->Shell->hasTask('DbConfig'));
	}

/**
 * test the hasMethod
 *
 * @return void
 */
	public function testHasMethod() {
		$this->assertTrue($this->Shell->hasMethod('doSomething'));
		$this->assertFalse($this->Shell->hasMethod('hr'), 'hr is callable');
		$this->assertFalse($this->Shell->hasMethod('_secret'), '_secret is callable');
		$this->assertFalse($this->Shell->hasMethod('no_access'), 'no_access is callable');
	}

/**
 * test run command calling main.
 *
 * @return void
 */
	public function testRunCommandMain() {
		$io = $this->getMock('Cake\Console\ConsoleIo');
		$shell = $this->getMock('Cake\Console\Shell', ['main', 'startup'], [$io]);

		$shell->expects($this->once())->method('startup');
		$shell->expects($this->once())->method('main')
			->with('cakes')
			->will($this->returnValue(true));
		$result = $shell->runCommand(['cakes', '--verbose']);
		$this->assertTrue($result);
	}

/**
 * test run command calling a real method with no subcommands defined.
 *
 * @return void
 */
	public function testRunCommandWithMethod() {
		$io = $this->getMock('Cake\Console\ConsoleIo');
		$shell = $this->getMock('Cake\Console\Shell', ['hitMe', 'startup'], [$io]);

		$shell->expects($this->once())->method('startup');
		$shell->expects($this->once())->method('hitMe')
			->with('cakes')
			->will($this->returnValue(true));
		$result = $shell->runCommand(['hit_me', 'cakes', '--verbose'], true);
		$this->assertTrue($result);
	}

/**
 * Test that runCommand() doesn't call public methods when the second arg is false.
 *
 * @return void
 */
	public function testRunCommandAutoMethodOff() {
		$io = $this->getMock('Cake\Console\ConsoleIo');
		$shell = $this->getMock('Cake\Console\Shell', ['hit_me', 'startup'], [$io]);

		$shell->expects($this->never())->method('startup');
		$shell->expects($this->never())->method('hit_me');

		$result = $shell->runCommand(['hit_me', 'baseball'], false);
		$this->assertFalse($result);

		$result = $shell->runCommand(['hit_me', 'baseball']);
		$this->assertFalse($result, 'Default value of runCommand() should be false');
	}

/**
 * test run command calling a real method with mismatching subcommands defined.
 *
 * @return void
 */
	public function testRunCommandWithMethodNotInSubcommands() {
		$parser = $this->getMock('Cake\Console\ConsoleOptionParser', ['help'], ['knife']);
		$io = $this->getMock('Cake\Console\ConsoleIo');
		$shell = $this->getMock('Cake\Console\Shell', ['getOptionParser', 'roll', 'startup'], [$io]);

		$parser->addSubCommand('slice');

		$shell->expects($this->any())
			->method('getOptionParser')
			->will($this->returnValue($parser));

		$parser->expects($this->once())
			->method('help');

		$shell->expects($this->never())->method('startup');
		$shell->expects($this->never())->method('roll');

		$result = $shell->runCommand(['roll', 'cakes', '--verbose']);
		$this->assertFalse($result);
	}

/**
 * test run command calling a real method with subcommands defined.
 *
 * @return void
 */
	public function testRunCommandWithMethodInSubcommands() {
		$parser = $this->getMock('Cake\Console\ConsoleOptionParser', ['help'], ['knife']);
		$io = $this->getMock('Cake\Console\ConsoleIo');
		$shell = $this->getMock('Cake\Console\Shell', ['getOptionParser', 'slice', 'startup'], [$io]);

		$parser->addSubCommand('slice');

		$shell->expects($this->any())
			->method('getOptionParser')
			->will($this->returnValue($parser));

		$shell->expects($this->once())->method('startup');
		$shell->expects($this->once())
			->method('slice')
			->with('cakes');

		$shell->runCommand(['slice', 'cakes', '--verbose']);
	}

/**
 * test run command calling a missing method with subcommands defined.
 *
 * @return void
 */
	public function testRunCommandWithMissingMethodInSubcommands() {
		$parser = $this->getMock('Cake\Console\ConsoleOptionParser', ['help'], ['knife']);
		$parser->addSubCommand('slice');

		$io = $this->getMock('Cake\Console\ConsoleIo');
		$shell = $this->getMock('Cake\Console\Shell', ['getOptionParser', 'startup'], [$io]);
		$shell->expects($this->any())
			->method('getOptionParser')
			->will($this->returnValue($parser));

		$shell->expects($this->never())
			->method('startup');

		$parser->expects($this->once())
			->method('help');

		$shell->runCommand(['slice', 'cakes', '--verbose']);
	}

/**
 * test run command causing exception on Shell method.
 *
 * @return void
 */
	public function testRunCommandBaseclassMethod() {
		$shell = $this->getMock('Cake\Console\Shell', array('startup', 'getOptionParser', 'out'), array(), '', false);
		$parser = $this->getMock('Cake\Console\ConsoleOptionParser', array(), array(), '', false);

		$parser->expects($this->once())->method('help');
		$shell->expects($this->once())->method('getOptionParser')
			->will($this->returnValue($parser));
		$shell->expects($this->never())->method('hr');
		$shell->expects($this->once())->method('out');

		$shell->runCommand(['hr']);
	}

/**
 * test run command causing exception on Shell method.
 *
 * @return void
 */
	public function testRunCommandMissingMethod() {
		$shell = $this->getMock('Cake\Console\Shell', array('startup', 'getOptionParser', 'out'), array(), '', false);
		$parser = $this->getMock('Cake\Console\ConsoleOptionParser', array(), array(), '', false);

		$parser->expects($this->once())->method('help');
		$shell->expects($this->once())->method('getOptionParser')
			->will($this->returnValue($parser));
		$shell->expects($this->once())->method('out');

		$result = $shell->runCommand(['idontexist']);
		$this->assertFalse($result);
	}

/**
 * test that a --help causes help to show.
 *
 * @return void
 */
	public function testRunCommandTriggeringHelp() {
		$Parser = $this->getMock('Cake\Console\ConsoleOptionParser', array(), array(), '', false);
		$Parser->expects($this->once())->method('parse')
			->with(array('--help'))
			->will($this->returnValue(array(array('help' => true), array())));
		$Parser->expects($this->once())->method('help');

		$Shell = $this->getMock('Cake\Console\Shell', array('getOptionParser', 'out', 'startup', '_welcome'), array(), '', false);
		$Shell->expects($this->once())->method('getOptionParser')
			->will($this->returnValue($Parser));
		$Shell->expects($this->once())->method('out');

		$Shell->runCommand(['--help']);
	}

/**
 * test that runCommand will not call runCommand on tasks that are not subcommands.
 *
 * @return void
 */
	public function testRunCommandNotCallUnexposedTask() {
		$shell = $this->getMock('Cake\Console\Shell', ['startup', 'hasTask', 'out'], [], '', false);
		$task = $this->getMock('Cake\Console\Shell', ['runCommand'], [], '', false);

		$task->expects($this->never())
			->method('runCommand');

		$shell->expects($this->any())
			->method('hasTask')
			->will($this->returnValue(true));
		$shell->expects($this->never())->method('startup');
		$shell->expects($this->once())->method('out');
		$shell->RunCommand = $task;

		$result = $shell->runCommand(['run_command', 'one']);
		$this->assertFalse($result);
	}

/**
 * test that runCommand will call runCommand on the task.
 *
 * @return void
 */
	public function testRunCommandHittingTaskInSubcommand() {
		$parser = new ConsoleOptionParser('knife');
		$parser->addSubcommand('slice');

		$shell = $this->getMock('Cake\Console\Shell', ['hasTask', 'startup', 'getOptionParser'], [], '', false);
		$task = $this->getMock('Cake\Console\Shell', ['main', 'runCommand'], [], '', false);
		$task->expects($this->once())
			->method('runCommand')
			->with(['one'], false);

		$shell->expects($this->once())->method('getOptionParser')
			->will($this->returnValue($parser));

		$shell->expects($this->once())->method('startup');
		$shell->expects($this->any())
			->method('hasTask')
			->will($this->returnValue(true));

		$shell->Slice = $task;
		$shell->runCommand(['slice', 'one']);
	}

/**
 * test wrapBlock wrapping text.
 *
 * @return void
 */
	public function testWrapText() {
		$text = 'This is the song that never ends. This is the song that never ends. This is the song that never ends.';
		$result = $this->Shell->wrapText($text, array('width' => 33));
		$expected = <<<TEXT
This is the song that never ends.
This is the song that never ends.
This is the song that never ends.
TEXT;
		$this->assertTextEquals($expected, $result, 'Text not wrapped.');

		$result = $this->Shell->wrapText($text, array('indent' => '  ', 'width' => 33));
		$expected = <<<TEXT
  This is the song that never ends.
  This is the song that never ends.
  This is the song that never ends.
TEXT;
		$this->assertTextEquals($expected, $result, 'Text not wrapped.');
	}

/**
 * Testing camel cased naming of tasks
 *
 * @return void
 */
	public function testShellNaming() {
		$this->Shell->tasks = array('TestApple');
		$this->Shell->loadTasks();
		$expected = 'TestApple';
		$this->assertEquals($expected, $this->Shell->TestApple->name);
	}

/**
 * Test reading params
 *
 * @dataProvider paramReadingDataProvider
 */
	public function testParamReading($toRead, $expected) {
		$this->Shell->params = array(
			'key' => 'value',
			'help' => false,
			'emptykey' => '',
			'truthy' => true
		);
		$this->assertSame($expected, $this->Shell->param($toRead));
	}

/**
 * Data provider for testing reading values with Shell::param()
 *
 * @return array
 */
	public function paramReadingDataProvider() {
		return array(
			array(
				'key',
				'value',
			),
			array(
				'help',
				false,
			),
			array(
				'emptykey',
				'',
			),
			array(
				'truthy',
				true,
			),
			array(
				'does_not_exist',
				null,
			)
		);
	}

/**
 * Test that option parsers are created with the correct name/command.
 *
 * @return void
 */
	public function testGetOptionParser() {
		$this->Shell->name = 'test';
		$this->Shell->plugin = 'plugin';
		$parser = $this->Shell->getOptionParser();

		$this->assertEquals('plugin.test', $parser->command());
	}

/**
 * Test file and console and logging quiet output
 *
 * @return void
 */
	public function testQuietLog() {
		$io = $this->getMock('Cake\Console\ConsoleIo', [], [], '', false);
		$io->expects($this->once())
			->method('level')
			->with(Shell::QUIET);
		$io->expects($this->at(0))
			->method('setLoggers')
			->with(true);
		$io->expects($this->at(2))
			->method('setLoggers')
			->with(false);

		$this->Shell = $this->getMock(__NAMESPACE__ . '\ShellTestShell', array('_useLogger'), array($io));
		$this->Shell->runCommand(['foo', '--quiet']);
	}

}