Completed test coverage for current Shell.

Also fixes #2.

Author: beporter

src/Shell/ConfigReadShell.php

@@ -49,8 +49,6 @@ public function _welcome() {
 	public function startup() {
 		parent::startup();
 
-		Configure::write('debug', 0);
-
 		if (isset($this->params['h'])) {
 			return $this->help();
 		}

tests/TestCase/Shell/ConfigReadShellTest.php

@@ -7,14 +7,9 @@
 use ConfigRead\Shell\ConfigReadShell;
 
 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\Console\Shell;
+use Cake\Core\Configure;
 use Cake\TestSuite\TestCase;
-// use Cake\Utility\Hash;
 
 /**
  * TestConfigReadShell class
@@ -23,8 +18,6 @@
  */
 class TestConfigReadShell extends ConfigReadShell
 {
-	public $formatBash = false;
-
 	public function fetchVal($key) {
 		return parent::fetchVal($key);
 	}
@@ -53,6 +46,15 @@ class ConfigReadShellTest extends TestCase
     public $fixtures = [
     ];
 
+    /**
+     * Acts as an accumulator for output produced by the Shell.
+     *
+     * @var array
+     * @see ::initSUIT()
+     */
+    public $output = [
+    ];
+
     /**
      * setUp method
      *
@@ -62,6 +64,7 @@ public function setUp()
     {
         parent::setUp();
 
+        $this->output = [];
         $this->Shell = $this->initSUT();
     }
 
@@ -73,10 +76,22 @@ public function setUp()
     public function tearDown()
     {
         unset($this->io, $this->Shell);
+        $this->output = [];
 
         parent::tearDown();
     }
 
+	/**
+	 * Helper for accumulating I/O output generated by the Shell.
+	 *
+	 * @param string $s	The output string being printed.
+	 * @see ::initSUT()
+	 */
+	public function outputCollector($s)
+	{
+		$this->output[] = $s;
+	}
+
 	/**
 	 * Helper for determing the subject class to initialize for testing.
 	 *
@@ -96,7 +111,7 @@ public function tearDown()
 	 */
 	protected function getSUTClassName()
 	{
-		$testCaseClass = get_class($this);
+		$testCaseClass = '\\' . get_class($this);
 			// -> ConfigRead\Test\TestCase\Shell\ConfigReadShellTest
 
 		$testingOverrideClass = preg_replace(
@@ -142,18 +157,25 @@ protected function initSUT($additionalMocks = []) {
 		$defaultMocks = [
 			'help', //'in', 'out', 'hr', 'error', 'err', '_stop', 'initialize', '_run', 'clear',
 		];
-        $this->io = $this->getMock('Cake\Console\ConsoleIo', [], [], '', false);
+
+        $this->io = $this->getMock('\Cake\Console\ConsoleIo', [], [], '', false);
+		$this->io->expects($this->any())
+			->method('out')
+			->with($this->anything())
+			->will($this->returnCallback([$this, 'outputCollector']));
+
 
 		$class = $this->getSUTClassName();
+		$mockedMethods = array_merge($defaultMocks, $additionalMocks);
 		$shell = $this->getMock(
 			$class,
-			array_merge($defaultMocks, $additionalMocks),
-			[$this->io],
-			"Mock_{$this->classBasename}"
+			$mockedMethods,
+			[$this->io]
 		);
 
-		$shell->OptionParser = $this->getMock('Cake\Console\ConsoleOptionParser', [], [null, false]);
+		$shell->OptionParser = $this->getMock('\Cake\Console\ConsoleOptionParser', [], [null, false]);
 
+		//@TODO: Update this Cake2-centric code to load models in a Cake 3 Shell.
 		// Load and attach all fixtures defined in this test case.
 // 		foreach ($this->fixtures as $fixture) {
 // 			$modelName = str_replace('App.', '', implode('.', array_map('Inflector::classify', explode('.', $fixture))));
@@ -227,82 +249,73 @@ public function testStartupBashModeMultiArgs()
      */
     public function testMain()
     {
-        $io = $this->getMock('Cake\Console\ConsoleIo');
-        $shell = $this->getMock('Cake\Console\Shell', ['main', 'startup'], [$io]);
+		$expected = [
+			'key' => 'val',
+			'debug' => true,
+			'ary' => [
+				'foo' => 'bar',
+				'fizz' => 'buzz',
+			],
+		];
 
-        $shell->expects($this->once())->method('startup');
-        $shell->expects($this->once())->method('main')
-            ->with('debug')
-            ->will($this->returnValue('canary'));
+        $shell = $this->initSUT(['fetchVal', 'iterateOnKey']);
+		$shell->args = array_keys($expected);
 
-        $result = $shell->runCommand(['debug', '--verbose']);
-        $this->assertEquals('canary', $result);
-    }
+ 		$i = 0;
+ 		foreach ($expected as $k => $v) {
+			$shell->expects($this->at($i++))
+				->method('fetchVal')
+				->with($k)
+				->will($this->returnValue($v));
+			$shell->expects($this->at($i++))
+				->method('iterateOnKey')
+				->with($k, $v);
+		}
 
-    /**
-     * Test reading params
-     *
-     * @dataProvider paramReadingDataProvider
-     */
-    public function testParamReading($toRead, $expected)
-    {
-        $this->Shell->params = [
-            'key' => 'value',
-            'help' => false,
-            'emptykey' => '',
-            'truthy' => true
-        ];
-        $this->assertSame($expected, $this->Shell->param($toRead));
-    }
+        $shell->startup();
+        $shell->main();
 
-    /**
-     * Data provider for testing reading values with Shell::param()
-     *
-     * @return array
-     */
-    public function paramReadingDataProvider()
-    {
-        return [
-            [
-                'key',
-                'value',
-            ],
-            [
-                'help',
-                false,
-            ],
-            [
-                'emptykey',
-                '',
-            ],
-            [
-                'truthy',
-                true,
-            ],
-            [
-                'does_not_exist',
-                null,
-            ]
-        ];
+        $this->assertTrue(
+        	$shell->formatBash,
+        	'Bash output should be engaged automatically by presence of multiple command line args.'
+        );
     }
 
     /**
-     * Tests __debugInfo
+     * test main(), including associated protected methods.
      *
      * @return void
      */
-    public function testDebugInfo()
+    public function testMainIntegrationStyle()
     {
-        $expected = [
-            'plugin' => null,
-            'command' => null,
-            'tasks' => [],
-            'params' => [],
-            'args' => [],
-            'interactive' => true,
-            'name' => str_replace('Shell', '', "Mock_{$this->classBasename}"),
-        ];
-        $result = $this->Shell->__debugInfo();
-        $this->assertEquals($expected, $result);
+		$configure = [
+			'key' => 'val',
+			'debug' => true,
+			'ary' => [
+				'foo' => 'bar',
+				'fizz' => 'buzz',
+			],
+		];
+		$expected = [
+			"KEY='val'",
+			"DEBUG='1'",
+			"ARY_FOO='bar'",
+			"ARY_FIZZ='buzz'",
+		];
+		Configure::write($configure);
+		$this->Shell->args = array_keys($configure);
+
+        $this->Shell->startup();
+        $this->Shell->main();
+
+        $this->assertEquals(
+        	$expected,
+        	$this->output,
+        	'The output produced from running the shell on the given arguments should match our expected result.'
+        );
+        $this->assertTrue(
+        	$this->Shell->formatBash,
+        	'Bash output should be engaged automatically by presence of multiple command line args.'
+        );
     }
 }