1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 

<?php
namespace Test\Tool;

class ModuleTestCase extends \PHPUnit_Framework_TestCase
{

    private $dbObjectCheckList = array();

    protected function runModuleTest(\Nethgui\Module\ModuleInterface $module, ModuleTestEnvironment $env)
    {
        $platform = $this->createPlatformMock($env);
        $module->setPlatform($platform);
        $module->initialize();

        if ($module instanceof \Nethgui\Controller\RequestHandlerInterface) {
            $request = $this->createRequestMock($env);
            $validationReport = $this->createValidationReportMock($env);
            $module->bind($request);
            $module->validate($validationReport);
            $module->process();
        }

        $view = $this->createViewMock($module, $env);
        $module->prepareView($view);

        $platform->signalFinalEvents();

        foreach ($env->getView() as $key => $value) {
            $this->assertEquals($value, $view[$key], "View parameter `{$key}`.");
        }

        $this->fullViewOutput = array(); // obsolete: $view->getClientEvents();

        foreach ($this->dbObjectCheckList as $dbStubInfo) {
            $this->assertTrue($dbStubInfo[1]->getState()->isFinal(), sprintf('Database `%s` is not in final state! %s', $dbStubInfo[0], $dbStubInfo[1]->getState()));
        }
    }

    protected function createPlatformMock(ModuleTestEnvironment $env)
    {
        $platformMock = $this->getMockBuilder('Nethgui\System\NethPlatform')
            ->disableOriginalConstructor()
            ->setMethods(array('getDatabase', 'signalEvent', 'exec'))
            ->getMock()
        ;

        // Value is TRUE if the method modifies the database state.
        $databaseMethods = array(
            'setProp' => TRUE,
            'delProp' => TRUE,
            'deleteKey' => TRUE,
            'setKey' => TRUE,
            'setType' => TRUE,
            'getAll' => FALSE,
            'getKey' => FALSE,
            'getProp' => FALSE,
            'getType' => FALSE,
        );

        $platformStub = new MockState();

        foreach ($env->getDatabaseNames() as $database) {
            $dbStub = $env->getDatabase($database);
            $dbMock = $this->getMockBuilder('Nethgui\System\EsmithDatabase')
                ->disableOriginalConstructor()
                ->setMethods(array_keys($databaseMethods))
                ->getMock();


            $methodStub = $this->returnMockObject($dbStub);

            // queue db state stub for isFinal() assertions
            $this->dbObjectCheckList[] = array($database, $methodStub);

            foreach (array_keys($databaseMethods) as $method) {
                $dbMock
                    ->expects($this->any())
                    ->method($method)
                    ->will($methodStub);
            }

            $platformStub->set(array('getDatabase', array($database)), $dbMock);
        }


        $processInterfaceMethods = array('getOutput', 'getExitStatus', 'getOutputArray', 'isExecuted', 'exec', 'addArgument', 'kill', 'readOutput', 'readExecutionState', 'setIdentifier', 'getIdentifier', 'getTimes');

        foreach ($env->getEvents() as $eventExp) {
            if (is_string($eventExp)) {
                $eventExp = array($eventExp, array());
            }

            $systemCommandMockForSignalEvent = $this->getMock('Nethgui\System\ProcessInterface', $processInterfaceMethods);

            // return a \Nethgui\System\ProcessInterface object
            $platformStub->set(array('signalEvent', array($eventExp[0], $eventExp[1])), $systemCommandMockForSignalEvent);
        }

        $platformMock->expects($this->any())
            ->method('getDatabase')
            ->will($this->returnMockObject($platformStub));

        $platformMock->expects($this->exactly(count($env->getEvents())))
            ->method('signalEvent')
            ->will($this->returnMockObject($platformStub));

        $systemCommandMock = $this->getMock('Nethgui\System\ProcessInterface', $processInterfaceMethods);
        $platformMock->expects($this->any())
            ->method('exec')
            ->will(new SystemCommandExecution($env->getCommands(), $systemCommandMock));

        return $platformMock;
    }

    protected function createViewMock(\Nethgui\Module\ModuleInterface $module, ModuleTestEnvironment $env)
    {
        $translator = $this->getMockBuilder('Nethgui\Language\Translator')
            ->disableOriginalConstructor()
            ->getMock();


        $translator->expects($this->any())
            ->method('translate')
            ->will($this->returnArgument(0));

        $translator->expects($this->any())
            ->method('getLanguageCode')
            ->will($this->returnValue('en'));

        return new \Nethgui\View\View(0, $module, $translator);
    }

    /**
     *
     * @param MockState $state
     * @return PHPUnit_Framework_MockObject_Stub
     */
    protected function returnMockObject(MockState $state)
    {
        return new MockObject($state);
    }

    /**
     *
     * @param array $a
     * @return PHPUnit_Framework_MockObject_Stub
     */
    protected function returnArrayKeyExists($a)
    {
        return new ArrayKeyExists($a);
    }

    /**
     *
     * @param array $a
     * @return PHPUnit_Framework_MockObject_Stub
     */
    protected function returnArrayKeyGetRegexp($a)
    {
        return new ArrayKeyGetRegexp($a);
    }

    /**
     *
     * @param array $a
     * @return PHPUnit_Framework_MockObject_Stub
     */
    protected function returnArrayKeyGet($a)
    {
        return new ArrayKeyGet($a);
    }

    /**
     *
     *
     * @param type $request
     * @param type $arguments
     * @param type $isSubmitted
     * @return \Nethgui\Controller\RequestInterface
     */
    protected function createRequestMock(ModuleTestEnvironment $env)
    {
        $data = $env->getRequest();
        $arguments = $env->getArguments();
        $submitted = $env->isMutation();
        $user = $this->createUserMock($env);
        return new \Nethgui\Controller\Request($user, $data, $submitted, $arguments, array());
    }

    protected function createUserMock(ModuleTestEnvironment $env)
    {
        return $this->getMock('Nethgui\Authorization\UserInterface');
    }

    protected function createValidationReportMock(ModuleTestEnvironment $env)
    {
        $reportMock = $this->getMockBuilder('Nethgui\Controller\ValidationReportInterface')
            ->setConstructorArgs(array($this->createUserMock($env)))
            ->setMethods(array('addValidationError', 'addValidationErrorMessage', 'hasValidationErrors'))
            ->getMock();

        // Check addError() is never called.
        // If you need to check for validation errors
        // override this method to provide another object mock.
        $reportMock->expects($this->never())
            ->method('addValidationError')
            ->withAnyParameters();

        $reportMock->expects($this->any())
            ->method('hasValidationErrors')
            ->withAnyParameters()
            ->will($this->returnValue(FALSE));

        return $reportMock;
    }

}

/**
 *
 */
class ArrayKeyGetRegexp implements \PHPUnit_Framework_MockObject_Stub
{

    /**
     *
     * @var array
     */
    private $a;

    public function __construct($a)
    {
        $this->a = $a;
    }

    public function invoke(\PHPUnit_Framework_MockObject_Invocation $invocation)
    {
        $parameterName = array_shift($invocation->parameters);

        foreach ($this->a as $regexp => $returnValue) {
            if (preg_match($regexp, $parameterName) > 0) {
                return $returnValue;
            }
        }

        throw new \PHPUnit_Framework_ExpectationFailedException("The requested key `{$parameterName}` does not match any given pattern!");
    }

    public function toString()
    {
        return \PHPUnit_Util_Type::toString($this);
    }

}

/**
 *
 */
class ArrayKeyGet implements \PHPUnit_Framework_MockObject_Stub
{

    /**
     *
     * @var array
     */
    private $a;

    public function __construct($a)
    {
        $this->a = $a;
    }

    public function invoke(\PHPUnit_Framework_MockObject_Invocation $invocation)
    {
        $parameterName = array_shift($invocation->parameters);

        if (is_array($this->a) && array_key_exists($parameterName, $this->a)) {
            return $this->a[$parameterName];
        }

        throw new \PHPUnit_Framework_ExpectationFailedException("The requested key `{$parameterName}` does not exist!");
    }

    public function toString()
    {
        return \PHPUnit_Util_Type::toString($this);
    }

}

/**
 *
 */
class ArrayKeyExists implements \PHPUnit_Framework_MockObject_Stub
{

    /**
     *
     * @var array
     */
    private $a;

    public function __construct($a)
    {
        $this->a = $a;
    }

    public function invoke(\PHPUnit_Framework_MockObject_Invocation $invocation)
    {
        $parameterName = array_shift($invocation->parameters);

        if (is_array($this->a) && array_key_exists($parameterName, $this->a)) {
            return TRUE;
        }

        return FALSE;
    }

    public function toString()
    {
        return \PHPUnit_Util_Type::toString($this);
    }

}

/**
 * @see \Nethgui\System\ProcessInterface
 */
class SystemCommandExecution extends ArrayKeyGetRegexp
{

    /**
     *
     * @var 
     */
    private $mock;

    public function __construct($a, $mock)
    {
        parent::__construct($a);
        $this->mock = $mock;
    }

    public function invoke(\PHPUnit_Framework_MockObject_Invocation $invocation)
    {
        $returnData = parent::invoke($invocation);

        if (is_string($returnData)) {
            $returnData = array(0, $returnData);
        }

        $mock = clone $this->mock;

        if ($mock instanceof \PHPUnit_Framework_MockObject_MockObject) {
            $mock->expects(\PHPUnit_Framework_TestCase::any())
                ->method('getOutput')
                ->will(\PHPUnit_Framework_TestCase::returnValue($returnData[1]));

            $mock->expects(\PHPUnit_Framework_TestCase::any())
                ->method('getOutputArray')
                ->will(\PHPUnit_Framework_TestCase::returnValue(explode("\n", $returnData[1])));

            $mock->expects(\PHPUnit_Framework_TestCase::any())
                ->method('isExecuted')
                ->will(\PHPUnit_Framework_TestCase::returnValue(TRUE));

            $mock->expects(\PHPUnit_Framework_TestCase::any())
                ->method('getExitStatus')
                ->will(\PHPUnit_Framework_TestCase::returnValue($returnData[0]));

            $mock->expects(\PHPUnit_Framework_TestCase::never())
                ->method('exec');

            $mock->expects(\PHPUnit_Framework_TestCase::never())
                ->method('addArgument');

            $mock->expects(\PHPUnit_Framework_TestCase::never())
                ->method('readOutput');

            $mock->expects(\PHPUnit_Framework_TestCase::never())
                ->method('kill');

            $mock->expects(\PHPUnit_Framework_TestCase::never())
                ->method('readExecutionState');
        }
        return $mock;
    }

}