Unit Testing CakePHP Shells

It’s a kick in the butt for me :) On monday I was searching how to test cakephp shells after finding basically nothing I thought to myself “Oh well need to look at cake core tests” and of course never did that…

Let’s say that your post is a sign that I must do that :)
Thank you for clear examples

Good stuff Mark. :)

I wanted to submit the following modification. It’s a base class for shell tests. To use it, derive your test case from it and define the member variable $shell to be the name of the shell being tested. Since my shells often use tasks and tasks themselves look like shells this allows me to build tests without repeating the same base code from test to test:

@
<?php
/*! This is common code that sets up testing for the shell. This is shamelessly stolen from

http://mark-story.com/posts/view/unit-testing-cakephp-shells */ ?>

<?php

/*! This section of code obtains the dispatcher and creates a partial mock object from it to disconnect it from I/O to real devices: */ if (!defined(‘DISABLE_AUTO_DISPATCH’)) { define(‘DISABLE_AUTO_DISPATCH’, true); } if (!class_exists(‘ShellDispatcher’)) { ob_start(); // This will effectively disable $argv = false; require_once(CAKE.‘console’.DS.‘cake.php’); // output. ob_end_clean(); } if (!class_exists(‘MockShellDispatcher’)) { Mock::generatePartial( ‘ShellDispatcher’, ‘MockShellDispatcher’, array(‘getInput’, ‘stdout’, ‘stderr’, ‘_stop’, ‘_initEnvironment’) ); } /*! Actual tests should subclass this class: startTest and endTest should be chained to: */ class ShellTestCase extends CakeTestCase { /*! Start the test up by creating our partially mocked dispatcher, our partially mocked shell and connecting them together: */ function startTest() { // Create the mock shell here using $shell for the name and // generating a new class named “Mock”.$shell // Mock::generatePartial( $this->shell, ‘Mock’.$this->shell, array(‘in’, ‘hr’, ‘out’, ‘err’, ‘createFile’, ‘_stop’, ‘getControllerList’) ); $this->Dispatcher =& new MockShellDispatcher(); // // Making the target shell is a bit more interesting now // Construct a class name for the mock called // Mock.$this->shell use eval to build it and // assign it to $this->Task where it can then be used as the // real shell. // $command = ‘$this->Task = new Mock’.$this->shell.’();’; eval($command); // $this->Task =& new MockTargetShell(); $this->Task->Dispatch =& $this->Dispatcher; $this->Task->Dispatch->shellPaths = Configure::read(‘shellPaths’); // Now create and insert the models in the task: if(is_array($this->Task->uses)) { $models = $this->Task->uses; foreach($models as $model) { App::Import(‘Model’, $model); // Include the code. $modelObject = &ClassRegistry::Init($model); if ($modelObject null) { trigger_error("Failed to create object for $model", E_USER_ERROR); } $code = '$this->Task->'.$model. '= $modelObject;'; $result = eval($code); if($result = false) { trigger_error(“Could not store $model: $code”, E_USER_ERROR); } } } } /*! End the test by forcing the dispatcher and shell to be destroyed and flushing the cache of loaded classes so that next test will need to rebuild. */ function endTest() { unset($this->Task, $this->Dispatcher); ClassRegistry::flush(); } }

?>
@

hmm, that didn’t quite format usably. Apologies for using the space but I’ll give this one more shot:

<?php

/*!
    This is common code that sets up testing for the shell.
    This is shamelessly stolen from


    http://mark-story.com/posts/view/unit-testing-cakephp-shells
*/
?>

	
<?php

    /*!   This section of code obtains the dispatcher and creates a partial
        mock object from it to disconnect it from I/O to real devices:
    */

    if (!defined(‘DISABLE_AUTO_DISPATCH’)) {
        define(‘DISABLE_AUTO_DISPATCH’, true);
    }

    if (!class_exists(‘ShellDispatcher’)) {
        ob_start();                                // This will effectively disable
        $argv = false;
        require_once(CAKE.‘console’.DS.‘cake.php’); // output.
        ob_end_clean();
    }
      if (!class_exists(‘MockShellDispatcher’)) { 

         Mock::generatePartial(
             ‘ShellDispatcher’, ‘MockShellDispatcher’,
             array(‘getInput’, ‘stdout’, ‘stderr’, ‘_stop’, ‘_initEnvironment’)
         );
      }

    /*!
        Actual tests should subclass this class:  startTest and endTest should be
        chained to:
    */
    class ShellTestCase extends CakeTestCase {
        /*!
            Start the test up by creating our partially mocked dispatcher,
            our partially mocked shell and connecting them together:
        */
        function startTest() {
            // Create the mock shell here using $shell for the name and
            // generating a new class named “Mock”.$shell
            // 
            Mock::generatePartial(
                $this->shell, ‘Mock’.$this->shell,
                array(‘in’, ‘hr’, ‘out’, ‘err’, ‘createFile’, ‘_stop’, ‘getControllerList’)
            );

            $this->Dispatcher     =&  new MockShellDispatcher();
            //
            // Making the target shell is a bit more interesting now
            // Construct a class name for the mock called
            // Mock.$this->shell use eval to build it and
            // assign it to $this->Task where it can then be used as the
            // real shell.
            //
            $command = ‘$this->Task = new Mock’.$this->shell.’();’;
            eval($command);
            // $this->Task           =&  new MockTargetShell();
            $this->Task->Dispatch =&  $this->Dispatcher;
            $this->Task->Dispatch->shellPaths = Configure::read(‘shellPaths’);

            // Now create and insert the models in the task:

            if(is_array($this->Task->uses)) {
               $models = $this->Task->uses;
               foreach($models as $model) {
                  App::Import(‘Model’, $model);    // Include the code.
                  $modelObject = &ClassRegistry::Init($model);
                  if ($modelObject   null) {
                     trigger_error("Failed to create object for $model", E_USER_ERROR);
                  }
                  $code = '$this->Task->'.$model. '= $modelObject;';
                  $result = eval($code);
                  if($result = false) {
                     trigger_error(“Could not store $model: $code”, E_USER_ERROR);
                  }
               }
            }
        }

        /*!
            End the test by forcing the dispatcher and shell to be destroyed
            and flushing the cache of loaded classes so that next test will
            need to rebuild.
        */
        function endTest() {
            unset($this->Task, $this->Dispatcher);
            ClassRegistry::flush();
        }
    }

	
?>