CONTRIBUTING.md000064400000006316150031475740007011 0ustar00# Contributing We'd love you to help out with mockery and no contribution is too small. ## Reporting Bugs Issues can be reported on the [issue tracker](https://github.com/padraic/mockery/issues). Please try and report any bugs with a minimal reproducible example, it will make things easier for other contributors and your problems will hopefully be resolved quickly. ## Requesting Features We're always interested to hear about your ideas and you can request features by creating a ticket in the [issue tracker](https://github.com/padraic/mockery/issues). We can't always guarantee someone will jump on it straight away, but putting it out there to see if anyone else is interested is a good idea. Likewise, if a feature you would like is already listed in the issue tracker, add a :+1: so that other contributors know it's a feature that would help others. ## Contributing code and documentation We loosely follow the [PSR-1](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md) and [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) coding standards, but we'll probably merge any code that looks close enough. * Fork the [repository](https://github.com/padraic/mockery) on GitHub * Add the code for your feature or bug * Add some tests for your feature or bug * Optionally, but preferably, write some documentation * Optionally, update the CHANGELOG.md file with your feature or [BC](http://en.wikipedia.org/wiki/Backward_compatibility) break * Send a [Pull Request](https://help.github.com/articles/creating-a-pull-request) to the correct target branch (see below) If you have a big change or would like to discuss something, create an issue in the [issue tracker](https://github.com/padraic/mockery/issues) or jump in to \#mockery on freenode Any code you contribute must be licensed under the [BSD 3-Clause License](http://opensource.org/licenses/BSD-3-Clause). ## Target Branch Mockery may have several active branches at any one time and roughly follows a [Git Branching Model](https://igor.io/2013/10/21/git-branching-model.html). Generally, if you're developing a new feature, you want to be targeting the master branch, if it's a bug fix, you want to be targeting a release branch, e.g. 0.8. ## Testing Mockery To run the unit tests for Mockery, clone the git repository, download Composer using the instructions at [http://getcomposer.org/download/](http://getcomposer.org/download/), then install the dependencies with `php /path/to/composer.phar install`. This will install the required PHPUnit and Hamcrest dev dependencies and create the autoload files required by the unit tests. You may run the `vendor/bin/phpunit` command to run the unit tests. If everything goes to plan, there will be no failed tests! ## Debugging Mockery Mockery and its code generation can be difficult to debug. A good start is to use the `RequireLoader`, which will dump the code generated by mockery to a file before requiring it, rather than using eval. This will help with stack traces, and you will be able to open the mock class in your editor. ``` php // tests/bootstrap.php Mockery::setLoader(new Mockery\Loader\RequireLoader(sys_get_temp_dir())); ``` LICENSE000064400000002707150031475740005565 0ustar00Copyright (c) 2010, Pádraic Brady All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pádraic Brady may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. CHANGELOG.md000064400000021277150031475740006374 0ustar00# Change Log ## 1.3.6 (2022-09-07) * PHP 8.2 | Fix "Use of "parent" in callables is deprecated" notice #1169 ## 1.5.1 (2022-09-07) * [PHP 8.2] Various tests: explicitly declare properties #1170 * [PHP 8.2] Fix "Use of "parent" in callables is deprecated" notice #1169 * [PHP 8.1] Support intersection types #1164 * Handle final `__toString` methods #1162 ## 1.5.0 (2022-01-20) * Override default call count expectations via expects() #1146 * Mock methods with static return types #1157 * Mock methods with mixed return type #1156 * Mock classes with new in initializers on PHP 8.1 #1160 * Removes redundant PHPUnitConstraint #1158 ## 1.4.4 (2021-09-13) * Fixes auto-generated return values #1144 * Adds support for tentative types #1130 * Fixes for PHP 8.1 Support (#1130 and #1140) * Add method that allows defining a set of arguments the mock should yield #1133 * Added option to configure default matchers for objects `\Mockery::getConfiguration()->setDefaultMatcher($class, $matcherClass)` #1120 ## 1.3.5 (2021-09-13) * Fix auto-generated return values with union types #1143 * Adds support for tentative types #1130 * Fixes for PHP 8.1 Support (#1130 and #1140) * Add method that allows defining a set of arguments the mock should yield #1133 * Added option to configure default matchers for objects `\Mockery::getConfiguration()->setDefaultMatcher($class, $matcherClass)` #1120 ## 1.4.3 (2021-02-24) * Fixes calls to fetchMock before initialisation #1113 * Allow shouldIgnoreMissing() to behave in a recursive fashion #1097 * Custom object formatters #766 (Needs Docs) * Fix crash on a union type including null #1106 ## 1.3.4 (2021-02-24) * Fixes calls to fetchMock before initialisation #1113 * Fix crash on a union type including null #1106 ## 1.4.2 (2020-08-11) * Fix array to string conversion in ConstantsPass (#1086) * Fixed nullable PHP 8.0 union types (#1088, #1089) * Fixed support for PHP 8.0 parent type (#1088, #1089) * Fixed PHP 8.0 mixed type support (#1088, #1089) * Fixed PHP 8.0 union return types (#1088, #1089) ## 1.4.1 (2020-07-09) * Allow quick definitions to use 'at least once' expectation `\Mockery::getConfiguration()->getQuickDefinitions()->shouldBeCalledAtLeastOnce(true)` (#1056) * Added provisional support for PHP 8.0 (#1068, #1072,#1079) * Fix mocking methods with iterable return type without specifying a return value (#1075) ## 1.3.3 (2020-08-11) * Fix array to string conversion in ConstantsPass (#1086) * Fixed nullable PHP 8.0 union types (#1088) * Fixed support for PHP 8.0 parent type (#1088) * Fixed PHP 8.0 mixed type support (#1088) * Fixed PHP 8.0 union return types (#1088) ## 1.3.2 (2020-07-09) * Fix mocking with anonymous classes (#1039) * Fix andAnyOthers() to properly match earlier expectations (#1051) * Added provisional support for PHP 8.0 (#1068, #1072,#1079) * Fix mocking methods with iterable return type without specifying a return value (#1075) ## 1.4.0 (2020-05-19) * Fix mocking with anonymous classes (#1039) * Fix andAnyOthers() to properly match earlier expectations (#1051) * Drops support for PHP < 7.3 and PHPUnit < 8 (#1059) ## 1.3.1 (2019-12-26) * Revert improved exception debugging due to BC breaks (#1032) ## 1.3.0 (2019-11-24) * Added capture `Mockery::capture` convenience matcher (#1020) * Added `andReturnArg` to echo back an argument passed to a an expectation (#992) * Improved exception debugging (#1000) * Fixed `andSet` to not reuse properties between mock objects (#1012) ## 1.2.4 (2019-09-30) * Fix a bug introduced with previous release, for empty method definition lists (#1009) ## 1.2.3 (2019-08-07) * Allow mocking classes that have allows and expects methods (#868) * Allow passing thru __call method in all mock types (experimental) (#969) * Add support for `!` to blacklist methods (#959) * Added `withSomeOfArgs` to partial match a list of args (#967) * Fix chained demeter calls with type hint (#956) ## 1.2.2 (2019-02-13) * Fix a BC breaking change for PHP 5.6/PHPUnit 5.7.27 (#947) ## 1.2.1 (2019-02-07) * Support for PHPUnit 8 (#942) * Allow mocking static methods called on instance (#938) ## 1.2.0 (2018-10-02) * Starts counting default expectations towards count (#910) * Adds workaround for some HHVM return types (#909) * Adds PhpStorm metadata support for autocomplete etc (#904) * Further attempts to support multiple PHPUnit versions (#903) * Allows setting constructor expectations on instance mocks (#900) * Adds workaround for HHVM memoization decorator (#893) * Adds experimental support for callable spys (#712) ## 1.1.0 (2018-05-08) * Allows use of string method names in allows and expects (#794) * Finalises allows and expects syntax in API (#799) * Search for handlers in a case instensitive way (#801) * Deprecate allowMockingMethodsUnnecessarily (#808) * Fix risky tests (#769) * Fix namespace in TestListener (#812) * Fixed conflicting mock names (#813) * Clean elses (#819) * Updated protected method mocking exception message (#826) * Map of constants to mock (#829) * Simplify foreach with `in_array` function (#830) * Typehinted return value on Expectation#verify. (#832) * Fix shouldNotHaveReceived with HigherOrderMessage (#842) * Deprecates shouldDeferMissing (#839) * Adds support for return type hints in Demeter chains (#848) * Adds shouldNotReceive to composite expectation (#847) * Fix internal error when using --static-backup (#845) * Adds `andAnyOtherArgs` as an optional argument matcher (#860) * Fixes namespace qualifying with namespaced named mocks (#872) * Added possibility to add Constructor-Expections on hard dependencies, read: Mockery::mock('overload:...') (#781) ## 1.0.0 (2017-09-06) * Destructors (`__destruct`) are stubbed out where it makes sense * Allow passing a closure argument to `withArgs()` to validate multiple arguments at once. * `Mockery\Adapter\Phpunit\TestListener` has been rewritten because it incorrectly marked some tests as risky. It will no longer verify mock expectations but instead check that tests do that themselves. PHPUnit 6 is required if you want to use this fail safe. * Removes SPL Class Loader * Removed object recorder feature * Bumped minimum PHP version to 5.6 * `andThrow` will now throw anything `\Throwable` * Adds `allows` and `expects` syntax * Adds optional global helpers for `mock`, `namedMock` and `spy` * Adds ability to create objects using traits * `Mockery\Matcher\MustBe` was deprecated * Marked `Mockery\MockInterface` as internal * Subset matcher matches recursively * BC BREAK - Spies return `null` by default from ignored (non-mocked) methods with nullable return type * Removed extracting getter methods of object instances * BC BREAK - Remove implicit regex matching when trying to match string arguments, introduce `\Mockery::pattern()` when regex matching is needed * Fix Mockery not getting closed in cases of failing test cases * Fix Mockery not setting properties on overloaded instance mocks * BC BREAK - Fix Mockery not trying default expectations if there is any concrete expectation * BC BREAK - Mockery's PHPUnit integration will mark a test as risky if it thinks one it's exceptions has been swallowed in PHPUnit > 5.7.6. Use `$e->dismiss()` to dismiss. ## 0.9.4 (XXXX-XX-XX) * `shouldIgnoreMissing` will respect global `allowMockingNonExistentMethods` config * Some support for variadic parameters * Hamcrest is now a required dependency * Instance mocks now respect `shouldIgnoreMissing` call on control instance * This will be the *last version to support PHP 5.3* * Added `Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration` trait * Added `makePartial` to `Mockery\MockInterface` as it was missing ## 0.9.3 (2014-12-22) * Added a basic spy implementation * Added `Mockery\Adapter\Phpunit\MockeryTestCase` for more reliable PHPUnit integration ## 0.9.2 (2014-09-03) * Some workarounds for the serialisation problems created by changes to PHP in 5.5.13, 5.4.29, 5.6. * Demeter chains attempt to reuse doubles as they see fit, so for foo->bar and foo->baz, we'll attempt to use the same foo ## 0.9.1 (2014-05-02) * Allow specifying consecutive exceptions to be thrown with `andThrowExceptions` * Allow specifying methods which can be mocked when using `Mockery\Configuration::allowMockingNonExistentMethods(false)` with `Mockery\MockInterface::shouldAllowMockingMethod($methodName)` * Added andReturnSelf method: `$mock->shouldReceive("foo")->andReturnSelf()` * `shouldIgnoreMissing` now takes an optional value that will be return instead of null, e.g. `$mock->shouldIgnoreMissing($mock)` ## 0.9.0 (2014-02-05) * Allow mocking classes with final __wakeup() method * Quick definitions are now always `byDefault` * Allow mocking of protected methods with `shouldAllowMockingProtectedMethods` * Support official Hamcrest package * Generator completely rewritten * Easily create named mocks with namedMock library/Mockery/ReceivedMethodCalls.php000064400000002452150031475740014211 0ustar00methodCalls[] = $methodCall; } public function verify(Expectation $expectation) { foreach ($this->methodCalls as $methodCall) { if ($methodCall->getMethod() !== $expectation->getName()) { continue; } if (!$expectation->matchArgs($methodCall->getArgs())) { continue; } $expectation->verifyCall($methodCall->getArgs()); } $expectation->verify(); } } library/Mockery/ExpectsHigherOrderMessage.php000064400000002074150031475740015406 0ustar00once(); } } library/Mockery/Mock.php000064400000071214150031475740011236 0ustar00_mockery_container = $container; if (!is_null($partialObject)) { $this->_mockery_partial = $partialObject; } if (!\Mockery::getConfiguration()->mockingNonExistentMethodsAllowed()) { foreach ($this->mockery_getMethods() as $method) { if ($method->isPublic()) { $this->_mockery_mockableMethods[] = $method->getName(); } } } $this->_mockery_instanceMock = $instanceMock; } /** * Set expected method calls * * @param string ...$methodNames one or many methods that are expected to be called in this mock * * @return \Mockery\ExpectationInterface|\Mockery\Expectation|\Mockery\HigherOrderMessage */ public function shouldReceive(...$methodNames) { if (count($methodNames) === 0) { return new HigherOrderMessage($this, "shouldReceive"); } foreach ($methodNames as $method) { if ("" == $method) { throw new \InvalidArgumentException("Received empty method name"); } } $self = $this; $allowMockingProtectedMethods = $this->_mockery_allowMockingProtectedMethods; $lastExpectation = \Mockery::parseShouldReturnArgs( $this, $methodNames, function ($method) use ($self, $allowMockingProtectedMethods) { $rm = $self->mockery_getMethod($method); if ($rm) { if ($rm->isPrivate()) { throw new \InvalidArgumentException("$method() cannot be mocked as it is a private method"); } if (!$allowMockingProtectedMethods && $rm->isProtected()) { throw new \InvalidArgumentException("$method() cannot be mocked as it is a protected method and mocking protected methods is not enabled for the currently used mock object. Use shouldAllowMockingProtectedMethods() to enable mocking of protected methods."); } } $director = $self->mockery_getExpectationsFor($method); if (!$director) { $director = new \Mockery\ExpectationDirector($method, $self); $self->mockery_setExpectationsFor($method, $director); } $expectation = new \Mockery\Expectation($self, $method); $director->addExpectation($expectation); return $expectation; } ); return $lastExpectation; } // start method allows /** * @param mixed $something String method name or map of method => return * @return self|\Mockery\ExpectationInterface|\Mockery\Expectation|\Mockery\HigherOrderMessage */ public function allows($something = []) { if (is_string($something)) { return $this->shouldReceive($something); } if (empty($something)) { return $this->shouldReceive(); } foreach ($something as $method => $returnValue) { $this->shouldReceive($method)->andReturn($returnValue); } return $this; } // end method allows // start method expects /** /** * @param mixed $something String method name (optional) * @return \Mockery\ExpectationInterface|\Mockery\Expectation|ExpectsHigherOrderMessage */ public function expects($something = null) { if (is_string($something)) { return $this->shouldReceive($something)->once(); } return new ExpectsHigherOrderMessage($this); } // end method expects /** * Shortcut method for setting an expectation that a method should not be called. * * @param string ...$methodNames one or many methods that are expected not to be called in this mock * @return \Mockery\ExpectationInterface|\Mockery\Expectation|\Mockery\HigherOrderMessage */ public function shouldNotReceive(...$methodNames) { if (count($methodNames) === 0) { return new HigherOrderMessage($this, "shouldNotReceive"); } $expectation = call_user_func_array(array($this, 'shouldReceive'), $methodNames); $expectation->never(); return $expectation; } /** * Allows additional methods to be mocked that do not explicitly exist on mocked class * @param String $method name of the method to be mocked * @return Mock */ public function shouldAllowMockingMethod($method) { $this->_mockery_mockableMethods[] = $method; return $this; } /** * Set mock to ignore unexpected methods and return Undefined class * @param mixed $returnValue the default return value for calls to missing functions on this mock * @param bool $recursive Specify if returned mocks should also have shouldIgnoreMissing set * @return Mock */ public function shouldIgnoreMissing($returnValue = null, $recursive = false) { $this->_mockery_ignoreMissing = true; $this->_mockery_ignoreMissingRecursive = $recursive; $this->_mockery_defaultReturnValue = $returnValue; return $this; } public function asUndefined() { $this->_mockery_ignoreMissing = true; $this->_mockery_defaultReturnValue = new \Mockery\Undefined(); return $this; } /** * @return Mock */ public function shouldAllowMockingProtectedMethods() { if (!\Mockery::getConfiguration()->mockingNonExistentMethodsAllowed()) { foreach ($this->mockery_getMethods() as $method) { if ($method->isProtected()) { $this->_mockery_mockableMethods[] = $method->getName(); } } } $this->_mockery_allowMockingProtectedMethods = true; return $this; } /** * Set mock to defer unexpected methods to it's parent * * This is particularly useless for this class, as it doesn't have a parent, * but included for completeness * * @deprecated 2.0.0 Please use makePartial() instead * * @return Mock */ public function shouldDeferMissing() { return $this->makePartial(); } /** * Set mock to defer unexpected methods to it's parent * * It was an alias for shouldDeferMissing(), which will be removed * in 2.0.0. * * @return Mock */ public function makePartial() { $this->_mockery_deferMissing = true; return $this; } /** * In the event shouldReceive() accepting one or more methods/returns, * this method will switch them from normal expectations to default * expectations * * @return self */ public function byDefault() { foreach ($this->_mockery_expectations as $director) { $exps = $director->getExpectations(); foreach ($exps as $exp) { $exp->byDefault(); } } return $this; } /** * Capture calls to this mock */ public function __call($method, array $args) { return $this->_mockery_handleMethodCall($method, $args); } public static function __callStatic($method, array $args) { return self::_mockery_handleStaticMethodCall($method, $args); } /** * Forward calls to this magic method to the __call method */ public function __toString() { return $this->__call('__toString', array()); } /** * Iterate across all expectation directors and validate each * * @throws \Mockery\CountValidator\Exception * @return void */ public function mockery_verify() { if ($this->_mockery_verified) { return; } if (isset($this->_mockery_ignoreVerification) && $this->_mockery_ignoreVerification == true) { return; } $this->_mockery_verified = true; foreach ($this->_mockery_expectations as $director) { $director->verify(); } } /** * Gets a list of exceptions thrown by this mock * * @return array */ public function mockery_thrownExceptions() { return $this->_mockery_thrownExceptions; } /** * Tear down tasks for this mock * * @return void */ public function mockery_teardown() { } /** * Fetch the next available allocation order number * * @return int */ public function mockery_allocateOrder() { $this->_mockery_allocatedOrder += 1; return $this->_mockery_allocatedOrder; } /** * Set ordering for a group * * @param mixed $group * @param int $order */ public function mockery_setGroup($group, $order) { $this->_mockery_groups[$group] = $order; } /** * Fetch array of ordered groups * * @return array */ public function mockery_getGroups() { return $this->_mockery_groups; } /** * Set current ordered number * * @param int $order */ public function mockery_setCurrentOrder($order) { $this->_mockery_currentOrder = $order; return $this->_mockery_currentOrder; } /** * Get current ordered number * * @return int */ public function mockery_getCurrentOrder() { return $this->_mockery_currentOrder; } /** * Validate the current mock's ordering * * @param string $method * @param int $order * @throws \Mockery\Exception * @return void */ public function mockery_validateOrder($method, $order) { if ($order < $this->_mockery_currentOrder) { $exception = new \Mockery\Exception\InvalidOrderException( 'Method ' . __CLASS__ . '::' . $method . '()' . ' called out of order: expected order ' . $order . ', was ' . $this->_mockery_currentOrder ); $exception->setMock($this) ->setMethodName($method) ->setExpectedOrder($order) ->setActualOrder($this->_mockery_currentOrder); throw $exception; } $this->mockery_setCurrentOrder($order); } /** * Gets the count of expectations for this mock * * @return int */ public function mockery_getExpectationCount() { $count = $this->_mockery_expectations_count; foreach ($this->_mockery_expectations as $director) { $count += $director->getExpectationCount(); } return $count; } /** * Return the expectations director for the given method * * @var string $method * @return \Mockery\ExpectationDirector|null */ public function mockery_setExpectationsFor($method, \Mockery\ExpectationDirector $director) { $this->_mockery_expectations[$method] = $director; } /** * Return the expectations director for the given method * * @var string $method * @return \Mockery\ExpectationDirector|null */ public function mockery_getExpectationsFor($method) { if (isset($this->_mockery_expectations[$method])) { return $this->_mockery_expectations[$method]; } } /** * Find an expectation matching the given method and arguments * * @var string $method * @var array $args * @return \Mockery\Expectation|null */ public function mockery_findExpectation($method, array $args) { if (!isset($this->_mockery_expectations[$method])) { return null; } $director = $this->_mockery_expectations[$method]; return $director->findExpectation($args); } /** * Return the container for this mock * * @return \Mockery\Container */ public function mockery_getContainer() { return $this->_mockery_container; } /** * Return the name for this mock * * @return string */ public function mockery_getName() { return __CLASS__; } /** * @return array */ public function mockery_getMockableProperties() { return $this->_mockery_mockableProperties; } public function __isset($name) { if (false === stripos($name, '_mockery_') && get_parent_class($this) && method_exists(get_parent_class($this), '__isset')) { return call_user_func(get_parent_class($this) . '::__isset', $name); } return false; } public function mockery_getExpectations() { return $this->_mockery_expectations; } /** * Calls a parent class method and returns the result. Used in a passthru * expectation where a real return value is required while still taking * advantage of expectation matching and call count verification. * * @param string $name * @param array $args * @return mixed */ public function mockery_callSubjectMethod($name, array $args) { if (!method_exists($this, $name) && get_parent_class($this) && method_exists(get_parent_class($this), '__call')) { return call_user_func(get_parent_class($this) . '::__call', $name, $args); } return call_user_func_array(get_parent_class($this) . '::' . $name, $args); } /** * @return string[] */ public function mockery_getMockableMethods() { return $this->_mockery_mockableMethods; } /** * @return bool */ public function mockery_isAnonymous() { $rfc = new \ReflectionClass($this); // PHP 8 has Stringable interface $interfaces = array_filter($rfc->getInterfaces(), function ($i) { return $i->getName() !== 'Stringable'; }); return false === $rfc->getParentClass() && 2 === count($interfaces); } public function mockery_isInstance() { return $this->_mockery_instanceMock; } public function __wakeup() { /** * This does not add __wakeup method support. It's a blind method and any * expected __wakeup work will NOT be performed. It merely cuts off * annoying errors where a __wakeup exists but is not essential when * mocking */ } public function __destruct() { /** * Overrides real class destructor in case if class was created without original constructor */ } public function mockery_getMethod($name) { foreach ($this->mockery_getMethods() as $method) { if ($method->getName() == $name) { return $method; } } return null; } /** * @param string $name Method name. * * @return mixed Generated return value based on the declared return value of the named method. */ public function mockery_returnValueForMethod($name) { $rm = $this->mockery_getMethod($name); if ($rm === null) { return null; } $returnType = Reflector::getSimplestReturnType($rm); switch ($returnType) { case null: return null; case 'string': return ''; case 'int': return 0; case 'float': return 0.0; case 'bool': return false; case 'array': case 'iterable': return []; case 'callable': case '\Closure': return function () { }; case '\Traversable': case '\Generator': $generator = function () { yield; }; return $generator(); case 'void': return null; case 'static': return $this; case 'object': $mock = \Mockery::mock(); if ($this->_mockery_ignoreMissingRecursive) { $mock->shouldIgnoreMissing($this->_mockery_defaultReturnValue, true); } return $mock; default: $mock = \Mockery::mock($returnType); if ($this->_mockery_ignoreMissingRecursive) { $mock->shouldIgnoreMissing($this->_mockery_defaultReturnValue, true); } return $mock; } } public function shouldHaveReceived($method = null, $args = null) { if ($method === null) { return new HigherOrderMessage($this, "shouldHaveReceived"); } $expectation = new \Mockery\VerificationExpectation($this, $method); if (null !== $args) { $expectation->withArgs($args); } $expectation->atLeast()->once(); $director = new \Mockery\VerificationDirector($this->_mockery_getReceivedMethodCalls(), $expectation); $this->_mockery_expectations_count++; $director->verify(); return $director; } public function shouldHaveBeenCalled() { return $this->shouldHaveReceived("__invoke"); } public function shouldNotHaveReceived($method = null, $args = null) { if ($method === null) { return new HigherOrderMessage($this, "shouldNotHaveReceived"); } $expectation = new \Mockery\VerificationExpectation($this, $method); if (null !== $args) { $expectation->withArgs($args); } $expectation->never(); $director = new \Mockery\VerificationDirector($this->_mockery_getReceivedMethodCalls(), $expectation); $this->_mockery_expectations_count++; $director->verify(); return null; } public function shouldNotHaveBeenCalled(array $args = null) { return $this->shouldNotHaveReceived("__invoke", $args); } protected static function _mockery_handleStaticMethodCall($method, array $args) { $associatedRealObject = \Mockery::fetchMock(__CLASS__); try { return $associatedRealObject->__call($method, $args); } catch (BadMethodCallException $e) { throw new BadMethodCallException( 'Static method ' . $associatedRealObject->mockery_getName() . '::' . $method . '() does not exist on this mock object', 0, $e ); } } protected function _mockery_getReceivedMethodCalls() { return $this->_mockery_receivedMethodCalls ?: $this->_mockery_receivedMethodCalls = new \Mockery\ReceivedMethodCalls(); } /** * Called when an instance Mock was created and its constructor is getting called * * @see \Mockery\Generator\StringManipulation\Pass\InstanceMockPass * @param array $args */ protected function _mockery_constructorCalled(array $args) { if (!isset($this->_mockery_expectations['__construct']) /* _mockery_handleMethodCall runs the other checks */) { return; } $this->_mockery_handleMethodCall('__construct', $args); } protected function _mockery_findExpectedMethodHandler($method) { if (isset($this->_mockery_expectations[$method])) { return $this->_mockery_expectations[$method]; } $lowerCasedMockeryExpectations = array_change_key_case($this->_mockery_expectations, CASE_LOWER); $lowerCasedMethod = strtolower($method); if (isset($lowerCasedMockeryExpectations[$lowerCasedMethod])) { return $lowerCasedMockeryExpectations[$lowerCasedMethod]; } return null; } protected function _mockery_handleMethodCall($method, array $args) { $this->_mockery_getReceivedMethodCalls()->push(new \Mockery\MethodCall($method, $args)); $rm = $this->mockery_getMethod($method); if ($rm && $rm->isProtected() && !$this->_mockery_allowMockingProtectedMethods) { if ($rm->isAbstract()) { return; } try { $prototype = $rm->getPrototype(); if ($prototype->isAbstract()) { return; } } catch (\ReflectionException $re) { // noop - there is no hasPrototype method } return call_user_func_array(get_parent_class($this) . '::' . $method, $args); } $handler = $this->_mockery_findExpectedMethodHandler($method); if ($handler !== null && !$this->_mockery_disableExpectationMatching) { try { return $handler->call($args); } catch (\Mockery\Exception\NoMatchingExpectationException $e) { if (!$this->_mockery_ignoreMissing && !$this->_mockery_deferMissing) { throw $e; } } } if (!is_null($this->_mockery_partial) && (method_exists($this->_mockery_partial, $method) || method_exists($this->_mockery_partial, '__call')) ) { return call_user_func_array(array($this->_mockery_partial, $method), $args); } elseif ($this->_mockery_deferMissing && is_callable(get_parent_class($this) . '::' . $method) && (!$this->hasMethodOverloadingInParentClass() || (get_parent_class($this) && method_exists(get_parent_class($this), $method)))) { return call_user_func_array(get_parent_class($this) . '::' . $method, $args); } elseif ($this->_mockery_deferMissing && get_parent_class($this) && method_exists(get_parent_class($this), '__call')) { return call_user_func(get_parent_class($this) . '::__call', $method, $args); } elseif ($method == '__toString') { // __toString is special because we force its addition to the class API regardless of the // original implementation. Thus, we should always return a string rather than honor // _mockery_ignoreMissing and break the API with an error. return sprintf("%s#%s", __CLASS__, spl_object_hash($this)); } elseif ($this->_mockery_ignoreMissing) { if (\Mockery::getConfiguration()->mockingNonExistentMethodsAllowed() || (!is_null($this->_mockery_partial) && method_exists($this->_mockery_partial, $method)) || is_callable(get_parent_class($this) . '::' . $method)) { if ($this->_mockery_defaultReturnValue instanceof \Mockery\Undefined) { return call_user_func_array(array($this->_mockery_defaultReturnValue, $method), $args); } elseif (null === $this->_mockery_defaultReturnValue) { return $this->mockery_returnValueForMethod($method); } return $this->_mockery_defaultReturnValue; } } $message = 'Method ' . __CLASS__ . '::' . $method . '() does not exist on this mock object'; if (!is_null($rm)) { $message = 'Received ' . __CLASS__ . '::' . $method . '(), but no expectations were specified'; } $bmce = new BadMethodCallException($message); $this->_mockery_thrownExceptions[] = $bmce; throw $bmce; } /** * Uses reflection to get the list of all * methods within the current mock object * * @return array */ protected function mockery_getMethods() { if (static::$_mockery_methods && \Mockery::getConfiguration()->reflectionCacheEnabled()) { return static::$_mockery_methods; } if (isset($this->_mockery_partial)) { $reflected = new \ReflectionObject($this->_mockery_partial); } else { $reflected = new \ReflectionClass($this); } return static::$_mockery_methods = $reflected->getMethods(); } private function hasMethodOverloadingInParentClass() { // if there's __call any name would be callable return is_callable(get_parent_class($this) . '::aFunctionNameThatNoOneWouldEverUseInRealLife12345'); } /** * @return array */ private function getNonPublicMethods() { return array_map( function ($method) { return $method->getName(); }, array_filter($this->mockery_getMethods(), function ($method) { return !$method->isPublic(); }) ); } } library/Mockery/Matcher/HasKey.php000064400000002230150031475740013104 0ustar00_expected, $actual); } /** * Return a string representation of this Matcher * * @return string */ public function __toString() { return "_expected]>"; } } library/Mockery/Matcher/Any.php000064400000002131150031475740012447 0ustar00'; } } library/Mockery/Matcher/Type.php000064400000003066150031475740012651 0ustar00_expected == 'real') { $function = 'is_float'; } else { $function = 'is_' . strtolower($this->_expected); } if (function_exists($function)) { return $function($actual); } elseif (is_string($this->_expected) && (class_exists($this->_expected) || interface_exists($this->_expected))) { return $actual instanceof $this->_expected; } return false; } /** * Return a string representation of this Matcher * * @return string */ public function __toString() { return '<' . ucfirst($this->_expected) . '>'; } } library/Mockery/Matcher/AndAnyOtherArgs.php000064400000002156150031475740014720 0ustar00'; } } library/Mockery/Matcher/MultiArgumentClosure.php000064400000002561150031475740016061 0ustar00_expected; return true === call_user_func_array($closure, $actual); } /** * Return a string representation of this Matcher * * @return string */ public function __toString() { return ''; } } library/Mockery/Matcher/Not.php000064400000002255150031475740012467 0ustar00_expected; } /** * Return a string representation of this Matcher * * @return string */ public function __toString() { return ''; } } library/Mockery/Matcher/NotAnyOf.php000064400000002466150031475740013430 0ustar00_expected as $exp) { if ($actual === $exp || $actual == $exp) { return false; } } return true; } /** * Return a string representation of this Matcher * * @return string */ public function __toString() { return ''; } } library/Mockery/Matcher/Subset.php000064400000004441150031475740013173 0ustar00expected = $expected; $this->strict = $strict; } /** * @param array $expected Expected subset of data * * @return Subset */ public static function strict(array $expected) { return new static($expected, true); } /** * @param array $expected Expected subset of data * * @return Subset */ public static function loose(array $expected) { return new static($expected, false); } /** * Check if the actual value matches the expected. * * @param mixed $actual * @return bool */ public function match(&$actual) { if (!is_array($actual)) { return false; } if ($this->strict) { return $actual === array_replace_recursive($actual, $this->expected); } return $actual == array_replace_recursive($actual, $this->expected); } /** * Return a string representation of this Matcher * * @return string */ public function __toString() { $return = 'expected as $k=>$v) { $elements[] = $k . '=' . (string) $v; } $return .= implode(', ', $elements) . ']>'; return $return; } } library/Mockery/Matcher/Pattern.php000064400000002230150031475740013335 0ustar00_expected, (string) $actual) >= 1; } /** * Return a string representation of this Matcher * * @return string */ public function __toString() { return ''; } } library/Mockery/Matcher/Contains.php000064400000003262150031475740013504 0ustar00_expected as $exp) { $match = false; foreach ($values as $val) { if ($exp === $val || $exp == $val) { $match = true; break; } } if ($match === false) { return false; } } return true; } /** * Return a string representation of this Matcher * * @return string */ public function __toString() { $return = '_expected as $v) { $elements[] = (string) $v; } $return .= implode(', ', $elements) . ']>'; return $return; } } library/Mockery/Matcher/HasValue.php000064400000002300150031475740013426 0ustar00_expected, $actual); } /** * Return a string representation of this Matcher * * @return string */ public function __toString() { $return = '_expected . ']>'; return $return; } } library/Mockery/Matcher/NoArgs.php000064400000001730150031475740013115 0ustar00'; } } library/Mockery/Matcher/Closure.php000064400000002276150031475740013346 0ustar00_expected; $result = $closure($actual); return $result === true; } /** * Return a string representation of this Matcher * * @return string */ public function __toString() { return ''; } } library/Mockery/Matcher/MustBe.php000064400000002446150031475740013130 0ustar00_expected === $actual; } return $this->_expected == $actual; } /** * Return a string representation of this Matcher * * @return string */ public function __toString() { return ''; } } library/Mockery/Matcher/Ducktype.php000064400000002555150031475740013522 0ustar00_expected as $method) { if (!method_exists($actual, $method)) { return false; } } return true; } /** * Return a string representation of this Matcher * * @return string */ public function __toString() { return '_expected) . ']>'; } } library/Mockery/Matcher/AnyArgs.php000064400000001713150031475740013271 0ustar00'; } } library/Mockery/Matcher/AnyOf.php000064400000002276150031475740012746 0ustar00_expected, true); } /** * Return a string representation of this Matcher * * @return string */ public function __toString() { return ''; } } library/Mockery/Matcher/MatcherAbstract.php000064400000002723150031475740014776 0ustar00_expected = $expected; } /** * Check if the actual value matches the expected. * Actual passed by reference to preserve reference trail (where applicable) * back to the original method parameter. * * @param mixed $actual * @return bool */ abstract public function match(&$actual); /** * Return a string representation of this Matcher * * @return string */ abstract public function __toString(); } library/Mockery/Matcher/ArgumentListMatcher.php000064400000001311150031475740015641 0ustar00mockObject = $mock; return $this; } public function setMethodName($name) { $this->method = $name; return $this; } public function setActualCount($count) { $this->actual = $count; return $this; } public function setExpectedCount($count) { $this->expected = $count; return $this; } public function setExpectedCountComparative($comp) { if (!in_array($comp, array('=', '>', '<', '>=', '<='))) { throw new RuntimeException( 'Illegal comparative for expected call counts set: ' . $comp ); } $this->expectedComparative = $comp; return $this; } public function getMock() { return $this->mockObject; } public function getMethodName() { return $this->method; } public function getActualCount() { return $this->actual; } public function getExpectedCount() { return $this->expected; } public function getMockName() { return $this->getMock()->mockery_getName(); } public function getExpectedCountComparative() { return $this->expectedComparative; } } library/Mockery/Exception/InvalidOrderException.php000064400000003402150031475740016536 0ustar00mockObject = $mock; return $this; } public function setMethodName($name) { $this->method = $name; return $this; } public function setActualOrder($count) { $this->actual = $count; return $this; } public function setExpectedOrder($count) { $this->expected = $count; return $this; } public function getMock() { return $this->mockObject; } public function getMethodName() { return $this->method; } public function getActualOrder() { return $this->actual; } public function getExpectedOrder() { return $this->expected; } public function getMockName() { return $this->getMock()->mockery_getName(); } } library/Mockery/Exception/RuntimeException.php000064400000001367150031475740015607 0ustar00dismissed = true; // we sometimes stack them if ($this->getPrevious() && $this->getPrevious() instanceof BadMethodCallException) { $this->getPrevious()->dismiss(); } } public function dismissed() { return $this->dismissed; } } library/Mockery/Exception/InvalidArgumentException.php000064400000001416150031475740017250 0ustar00mockObject = $mock; return $this; } public function setMethodName($name) { $this->method = $name; return $this; } public function setActualArguments($count) { $this->actual = $count; return $this; } public function getMock() { return $this->mockObject; } public function getMethodName() { return $this->method; } public function getActualArguments() { return $this->actual; } public function getMockName() { return $this->getMock()->mockery_getName(); } } library/Mockery/HigherOrderMessage.php000064400000002461150031475740014052 0ustar00mock = $mock; $this->method = $method; } /** * @return \Mockery\Expectation */ public function __call($method, $args) { if ($this->method === 'shouldNotHaveReceived') { return $this->mock->{$this->method}($method, $args); } $expectation = $this->mock->{$this->method}($method); return $expectation->withArgs($args); } } library/Mockery/Configuration.php000064400000020033150031475740013145 0ustar00_quickDefinitionsConfiguration = new QuickDefinitionsConfiguration(); } /** * Custom object formatters * * @var array */ protected $_objectFormatters = array(); /** * Default argument matchers * * @var array */ protected $_defaultMatchers = array(); /** * Set boolean to allow/prevent mocking of non-existent methods * * @param bool $flag */ public function allowMockingNonExistentMethods($flag = true) { $this->_allowMockingNonExistentMethod = (bool) $flag; } /** * Return flag indicating whether mocking non-existent methods allowed * * @return bool */ public function mockingNonExistentMethodsAllowed() { return $this->_allowMockingNonExistentMethod; } /** * Set boolean to allow/prevent unnecessary mocking of methods * * @param bool $flag * * @deprecated since 1.4.0 */ public function allowMockingMethodsUnnecessarily($flag = true) { @trigger_error(sprintf("The %s method is deprecated and will be removed in a future version of Mockery", __METHOD__), E_USER_DEPRECATED); $this->_allowMockingMethodsUnnecessarily = (bool) $flag; } /** * Return flag indicating whether mocking non-existent methods allowed * * @return bool * * @deprecated since 1.4.0 */ public function mockingMethodsUnnecessarilyAllowed() { @trigger_error(sprintf("The %s method is deprecated and will be removed in a future version of Mockery", __METHOD__), E_USER_DEPRECATED); return $this->_allowMockingMethodsUnnecessarily; } /** * Set a parameter map (array of param signature strings) for the method * of an internal PHP class. * * @param string $class * @param string $method * @param array $map */ public function setInternalClassMethodParamMap($class, $method, array $map) { if (\PHP_MAJOR_VERSION > 7) { throw new \LogicException('Internal class parameter overriding is not available in PHP 8. Incompatible signatures have been reclassified as fatal errors.'); } if (!isset($this->_internalClassParamMap[strtolower($class)])) { $this->_internalClassParamMap[strtolower($class)] = array(); } $this->_internalClassParamMap[strtolower($class)][strtolower($method)] = $map; } /** * Remove all overridden parameter maps from internal PHP classes. */ public function resetInternalClassMethodParamMaps() { $this->_internalClassParamMap = array(); } /** * Get the parameter map of an internal PHP class method * * @return array|null */ public function getInternalClassMethodParamMap($class, $method) { if (isset($this->_internalClassParamMap[strtolower($class)][strtolower($method)])) { return $this->_internalClassParamMap[strtolower($class)][strtolower($method)]; } } public function getInternalClassMethodParamMaps() { return $this->_internalClassParamMap; } public function setConstantsMap(array $map) { $this->_constantsMap = $map; } public function getConstantsMap() { return $this->_constantsMap; } /** * Returns the quick definitions configuration */ public function getQuickDefinitions(): QuickDefinitionsConfiguration { return $this->_quickDefinitionsConfiguration; } /** * Disable reflection caching * * It should be always enabled, except when using * PHPUnit's --static-backup option. * * @see https://github.com/mockery/mockery/issues/268 */ public function disableReflectionCache() { $this->_reflectionCacheEnabled = false; } /** * Enable reflection caching * * It should be always enabled, except when using * PHPUnit's --static-backup option. * * @see https://github.com/mockery/mockery/issues/268 */ public function enableReflectionCache() { $this->_reflectionCacheEnabled = true; } /** * Is reflection cache enabled? */ public function reflectionCacheEnabled() { return $this->_reflectionCacheEnabled; } public function setObjectFormatter($class, $formatterCallback) { $this->_objectFormatters[$class] = $formatterCallback; } public function getObjectFormatter($class, $defaultFormatter) { $parentClass = $class; do { $classes[] = $parentClass; $parentClass = get_parent_class($parentClass); } while ($parentClass); $classesAndInterfaces = array_merge($classes, class_implements($class)); foreach ($classesAndInterfaces as $type) { if (isset($this->_objectFormatters[$type])) { return $this->_objectFormatters[$type]; } } return $defaultFormatter; } /** * @param string $class * @param string $matcherClass */ public function setDefaultMatcher($class, $matcherClass) { if (!is_a($matcherClass, \Mockery\Matcher\MatcherAbstract::class, true) && !is_a($matcherClass, \Hamcrest\Matcher::class, true) && !is_a($matcherClass, \Hamcrest_Matcher::class, true) ) { throw new \InvalidArgumentException( "Matcher class must be either Hamcrest matcher or extend \Mockery\Matcher\MatcherAbstract, " . "'$matcherClass' given." ); } $this->_defaultMatchers[$class] = $matcherClass; } public function getDefaultMatcher($class) { $parentClass = $class; do { $classes[] = $parentClass; $parentClass = get_parent_class($parentClass); } while ($parentClass); $classesAndInterfaces = array_merge($classes, class_implements($class)); foreach ($classesAndInterfaces as $type) { if (isset($this->_defaultMatchers[$type])) { return $this->_defaultMatchers[$type]; } } return null; } } library/Mockery/CountValidator/AtLeast.php000064400000003476150031475740014645 0ustar00_limit > $n) { $exception = new Mockery\Exception\InvalidCountException( 'Method ' . (string) $this->_expectation . ' from ' . $this->_expectation->getMock()->mockery_getName() . ' should be called' . PHP_EOL . ' at least ' . $this->_limit . ' times but called ' . $n . ' times.' ); $exception->setMock($this->_expectation->getMock()) ->setMethodName((string) $this->_expectation) ->setExpectedCountComparative('>=') ->setExpectedCount($this->_limit) ->setActualCount($n); throw $exception; } } } library/Mockery/CountValidator/Exception.php000064400000001400150031475740015227 0ustar00_limit !== $n) { $because = $this->_expectation->getExceptionMessage(); $exception = new Mockery\Exception\InvalidCountException( 'Method ' . (string) $this->_expectation . ' from ' . $this->_expectation->getMock()->mockery_getName() . ' should be called' . PHP_EOL . ' exactly ' . $this->_limit . ' times but called ' . $n . ' times.' . ($because ? ' Because ' . $this->_expectation->getExceptionMessage() : '') ); $exception->setMock($this->_expectation->getMock()) ->setMethodName((string) $this->_expectation) ->setExpectedCountComparative('=') ->setExpectedCount($this->_limit) ->setActualCount($n); throw $exception; } } } library/Mockery/CountValidator/AtMost.php000064400000003166150031475740014513 0ustar00_limit < $n) { $exception = new Mockery\Exception\InvalidCountException( 'Method ' . (string) $this->_expectation . ' from ' . $this->_expectation->getMock()->mockery_getName() . ' should be called' . PHP_EOL . ' at most ' . $this->_limit . ' times but called ' . $n . ' times.' ); $exception->setMock($this->_expectation->getMock()) ->setMethodName((string) $this->_expectation) ->setExpectedCountComparative('<=') ->setExpectedCount($this->_limit) ->setActualCount($n); throw $exception; } } } library/Mockery/CountValidator/CountValidatorAbstract.php000064400000003231150031475740017717 0ustar00_expectation = $expectation; $this->_limit = $limit; } /** * Checks if the validator can accept an additional nth call * * @param int $n * @return bool */ public function isEligible($n) { return ($n < $this->_limit); } /** * Validate the call count against this validator * * @param int $n * @return bool */ abstract public function validate($n); } library/Mockery/MockInterface.php000064400000002353150031475740013055 0ustar00 return * @return self|\Mockery\ExpectationInterface|\Mockery\Expectation|\Mockery\HigherOrderMessage */ public function allows($something = []); /** * @param mixed $something String method name (optional) * @return \Mockery\ExpectationInterface|\Mockery\Expectation|\Mockery\ExpectsHigherOrderMessage */ public function expects($something = null); } library/Mockery/Loader/EvalLoader.php000064400000001774150031475740013575 0ustar00getClassName(), false)) { return; } eval("?>" . $definition->getCode()); } } library/Mockery/Loader/Loader.php000064400000001470150031475740012756 0ustar00path = realpath($path) ?: sys_get_temp_dir(); } public function load(MockDefinition $definition) { if (class_exists($definition->getClassName(), false)) { return; } $tmpfname = $this->path . DIRECTORY_SEPARATOR . "Mockery_" . uniqid() . ".php"; file_put_contents($tmpfname, $definition->getCode()); require $tmpfname; } } library/Mockery/Expectation.php000064400000056146150031475740012637 0ustar00_mock = $mock; $this->_name = $name; $this->withAnyArgs(); } /** * Return a string with the method name and arguments formatted * * @param string $name Name of the expected method * @param array $args List of arguments to the method * @return string */ public function __toString() { return \Mockery::formatArgs($this->_name, $this->_expectedArgs); } /** * Verify the current call, i.e. that the given arguments match those * of this expectation * * @param array $args * @return mixed */ public function verifyCall(array $args) { $this->validateOrder(); $this->_actualCount++; if (true === $this->_passthru) { return $this->_mock->mockery_callSubjectMethod($this->_name, $args); } $return = $this->_getReturnValue($args); $this->throwAsNecessary($return); $this->_setValues(); return $return; } /** * Throws an exception if the expectation has been configured to do so * * @throws \Throwable * @return void */ private function throwAsNecessary($return) { if (!$this->_throw) { return; } if ($return instanceof \Throwable) { throw $return; } return; } /** * Sets public properties with queued values to the mock object * * @param array $args * @return mixed */ protected function _setValues() { $mockClass = get_class($this->_mock); $container = $this->_mock->mockery_getContainer(); /** @var Mock[] $mocks */ $mocks = $container->getMocks(); foreach ($this->_setQueue as $name => &$values) { if (count($values) > 0) { $value = array_shift($values); $this->_mock->{$name} = $value; foreach ($mocks as $mock) { if (is_a($mock, $mockClass) && $mock->mockery_isInstance()) { $mock->{$name} = $value; } } } } } /** * Fetch the return value for the matching args * * @param array $args * @return mixed */ protected function _getReturnValue(array $args) { if (count($this->_closureQueue) > 1) { return call_user_func_array(array_shift($this->_closureQueue), $args); } elseif (count($this->_closureQueue) > 0) { return call_user_func_array(current($this->_closureQueue), $args); } elseif (count($this->_returnQueue) > 1) { return array_shift($this->_returnQueue); } elseif (count($this->_returnQueue) > 0) { return current($this->_returnQueue); } return $this->_mock->mockery_returnValueForMethod($this->_name); } /** * Checks if this expectation is eligible for additional calls * * @return bool */ public function isEligible() { foreach ($this->_countValidators as $validator) { if (!$validator->isEligible($this->_actualCount)) { return false; } } return true; } /** * Check if there is a constraint on call count * * @return bool */ public function isCallCountConstrained() { return (count($this->_countValidators) > 0); } /** * Verify call order * * @return void */ public function validateOrder() { if ($this->_orderNumber) { $this->_mock->mockery_validateOrder((string) $this, $this->_orderNumber, $this->_mock); } if ($this->_globalOrderNumber) { $this->_mock->mockery_getContainer() ->mockery_validateOrder((string) $this, $this->_globalOrderNumber, $this->_mock); } } /** * Verify this expectation * * @return void */ public function verify() { foreach ($this->_countValidators as $validator) { $validator->validate($this->_actualCount); } } /** * Check if the registered expectation is an ArgumentListMatcher * @return bool */ private function isArgumentListMatcher() { return (count($this->_expectedArgs) === 1 && ($this->_expectedArgs[0] instanceof ArgumentListMatcher)); } private function isAndAnyOtherArgumentsMatcher($expectedArg) { return $expectedArg instanceof AndAnyOtherArgs; } /** * Check if passed arguments match an argument expectation * * @param array $args * @return bool */ public function matchArgs(array $args) { if ($this->isArgumentListMatcher()) { return $this->_matchArg($this->_expectedArgs[0], $args); } $argCount = count($args); if ($argCount !== count((array) $this->_expectedArgs)) { $lastExpectedArgument = end($this->_expectedArgs); reset($this->_expectedArgs); if ($this->isAndAnyOtherArgumentsMatcher($lastExpectedArgument)) { $args = array_slice($args, 0, array_search($lastExpectedArgument, $this->_expectedArgs, true)); return $this->_matchArgs($args); } return false; } return $this->_matchArgs($args); } /** * Check if the passed arguments match the expectations, one by one. * * @param array $args * @return bool */ protected function _matchArgs($args) { $argCount = count($args); for ($i=0; $i<$argCount; $i++) { $param =& $args[$i]; if (!$this->_matchArg($this->_expectedArgs[$i], $param)) { return false; } } return true; } /** * Check if passed argument matches an argument expectation * * @param mixed $expected * @param mixed $actual * @return bool */ protected function _matchArg($expected, &$actual) { if ($expected === $actual) { return true; } if (!is_object($expected) && !is_object($actual) && $expected == $actual) { return true; } if (is_string($expected) && is_object($actual)) { $result = $actual instanceof $expected; if ($result) { return true; } } if (is_object($expected)) { $matcher = \Mockery::getConfiguration()->getDefaultMatcher(get_class($expected)); if ($matcher !== null) { $expected = new $matcher($expected); } } if ($expected instanceof \Mockery\Matcher\MatcherAbstract) { return $expected->match($actual); } if ($expected instanceof \Hamcrest\Matcher || $expected instanceof \Hamcrest_Matcher) { return $expected->matches($actual); } return false; } /** * Expected argument setter for the expectation * * @param mixed ...$args * * @return self */ public function with(...$args) { return $this->withArgs($args); } /** * Expected arguments for the expectation passed as an array * * @param array $arguments * @return self */ private function withArgsInArray(array $arguments) { if (empty($arguments)) { return $this->withNoArgs(); } $this->_expectedArgs = $arguments; return $this; } /** * Expected arguments have to be matched by the given closure. * * @param Closure $closure * @return self */ private function withArgsMatchedByClosure(Closure $closure) { $this->_expectedArgs = [new MultiArgumentClosure($closure)]; return $this; } /** * Expected arguments for the expectation passed as an array or a closure that matches each passed argument on * each function call. * * @param array|Closure $argsOrClosure * @return self */ public function withArgs($argsOrClosure) { if (is_array($argsOrClosure)) { $this->withArgsInArray($argsOrClosure); } elseif ($argsOrClosure instanceof Closure) { $this->withArgsMatchedByClosure($argsOrClosure); } else { throw new \InvalidArgumentException(sprintf('Call to %s with an invalid argument (%s), only array and ' . 'closure are allowed', __METHOD__, $argsOrClosure)); } return $this; } /** * Set with() as no arguments expected * * @return self */ public function withNoArgs() { $this->_expectedArgs = [new NoArgs()]; return $this; } /** * Set expectation that any arguments are acceptable * * @return self */ public function withAnyArgs() { $this->_expectedArgs = [new AnyArgs()]; return $this; } /** * Expected arguments should partially match the real arguments * * @param mixed ...$expectedArgs * @return self */ public function withSomeOfArgs(...$expectedArgs) { return $this->withArgs(function (...$args) use ($expectedArgs) { foreach ($expectedArgs as $expectedArg) { if (!in_array($expectedArg, $args, true)) { return false; } } return true; }); } /** * Set a return value, or sequential queue of return values * * @param mixed ...$args * @return self */ public function andReturn(...$args) { $this->_returnQueue = $args; return $this; } /** * Set a return value, or sequential queue of return values * * @param mixed ...$args * @return self */ public function andReturns(...$args) { return call_user_func_array([$this, 'andReturn'], $args); } /** * Return this mock, like a fluent interface * * @return self */ public function andReturnSelf() { return $this->andReturn($this->_mock); } /** * Set a sequential queue of return values with an array * * @param array $values * @return self */ public function andReturnValues(array $values) { call_user_func_array(array($this, 'andReturn'), $values); return $this; } /** * Set a closure or sequence of closures with which to generate return * values. The arguments passed to the expected method are passed to the * closures as parameters. * * @param callable ...$args * @return self */ public function andReturnUsing(...$args) { $this->_closureQueue = $args; return $this; } /** * Sets up a closure to return the nth argument from the expected method call * * @param int $index * @return self */ public function andReturnArg($index) { if (!is_int($index) || $index < 0) { throw new \InvalidArgumentException("Invalid argument index supplied. Index must be a non-negative integer."); } $closure = function (...$args) use ($index) { if (array_key_exists($index, $args)) { return $args[$index]; } throw new \OutOfBoundsException("Cannot return an argument value. No argument exists for the index $index"); }; $this->_closureQueue = [$closure]; return $this; } /** * Return a self-returning black hole object. * * @return self */ public function andReturnUndefined() { $this->andReturn(new \Mockery\Undefined()); return $this; } /** * Return null. This is merely a language construct for Mock describing. * * @return self */ public function andReturnNull() { return $this->andReturn(null); } public function andReturnFalse() { return $this->andReturn(false); } public function andReturnTrue() { return $this->andReturn(true); } /** * Set Exception class and arguments to that class to be thrown * * @param string|\Exception $exception * @param string $message * @param int $code * @param \Exception $previous * @return self */ public function andThrow($exception, $message = '', $code = 0, \Exception $previous = null) { $this->_throw = true; if (is_object($exception)) { $this->andReturn($exception); } else { $this->andReturn(new $exception($message, $code, $previous)); } return $this; } public function andThrows($exception, $message = '', $code = 0, \Exception $previous = null) { return $this->andThrow($exception, $message, $code, $previous); } /** * Set Exception classes to be thrown * * @param array $exceptions * @return self */ public function andThrowExceptions(array $exceptions) { $this->_throw = true; foreach ($exceptions as $exception) { if (!is_object($exception)) { throw new Exception('You must pass an array of exception objects to andThrowExceptions'); } } return $this->andReturnValues($exceptions); } /** * Register values to be set to a public property each time this expectation occurs * * @param string $name * @param array ...$values * @return self */ public function andSet($name, ...$values) { $this->_setQueue[$name] = $values; return $this; } /** * Sets up a closure that will yield each of the provided args * * @param mixed ...$args * @return self */ public function andYield(...$args) { $this->_closureQueue = [ static function () use ($args) { foreach ($args as $arg) { yield $arg; } }, ]; return $this; } /** * Alias to andSet(). Allows the natural English construct * - set('foo', 'bar')->andReturn('bar') * * @param string $name * @param mixed $value * @return self */ public function set($name, $value) { return call_user_func_array(array($this, 'andSet'), func_get_args()); } /** * Indicates this expectation should occur zero or more times * * @return self */ public function zeroOrMoreTimes() { $this->atLeast()->never(); } /** * Indicates the number of times this expectation should occur * * @param int $limit * @throws \InvalidArgumentException * @return self */ public function times($limit = null) { if (is_null($limit)) { return $this; } if (!is_int($limit)) { throw new \InvalidArgumentException('The passed Times limit should be an integer value'); } $this->_countValidators[$this->_countValidatorClass] = new $this->_countValidatorClass($this, $limit); if ('Mockery\CountValidator\Exact' !== $this->_countValidatorClass) { $this->_countValidatorClass = 'Mockery\CountValidator\Exact'; unset($this->_countValidators[$this->_countValidatorClass]); } return $this; } /** * Indicates that this expectation is never expected to be called * * @return self */ public function never() { return $this->times(0); } /** * Indicates that this expectation is expected exactly once * * @return self */ public function once() { return $this->times(1); } /** * Indicates that this expectation is expected exactly twice * * @return self */ public function twice() { return $this->times(2); } /** * Sets next count validator to the AtLeast instance * * @return self */ public function atLeast() { $this->_countValidatorClass = 'Mockery\CountValidator\AtLeast'; return $this; } /** * Sets next count validator to the AtMost instance * * @return self */ public function atMost() { $this->_countValidatorClass = 'Mockery\CountValidator\AtMost'; return $this; } /** * Shorthand for setting minimum and maximum constraints on call counts * * @param int $minimum * @param int $maximum */ public function between($minimum, $maximum) { return $this->atLeast()->times($minimum)->atMost()->times($maximum); } /** * Set the exception message * * @param string $message * @return $this */ public function because($message) { $this->_because = $message; return $this; } /** * Indicates that this expectation must be called in a specific given order * * @param string $group Name of the ordered group * @return self */ public function ordered($group = null) { if ($this->_globally) { $this->_globalOrderNumber = $this->_defineOrdered($group, $this->_mock->mockery_getContainer()); } else { $this->_orderNumber = $this->_defineOrdered($group, $this->_mock); } $this->_globally = false; return $this; } /** * Indicates call order should apply globally * * @return self */ public function globally() { $this->_globally = true; return $this; } /** * Setup the ordering tracking on the mock or mock container * * @param string $group * @param object $ordering * @return int */ protected function _defineOrdered($group, $ordering) { $groups = $ordering->mockery_getGroups(); if (is_null($group)) { $result = $ordering->mockery_allocateOrder(); } elseif (isset($groups[$group])) { $result = $groups[$group]; } else { $result = $ordering->mockery_allocateOrder(); $ordering->mockery_setGroup($group, $result); } return $result; } /** * Return order number * * @return int */ public function getOrderNumber() { return $this->_orderNumber; } /** * Mark this expectation as being a default * * @return self */ public function byDefault() { $director = $this->_mock->mockery_getExpectationsFor($this->_name); if (!empty($director)) { $director->makeExpectationDefault($this); } return $this; } /** * Return the parent mock of the expectation * * @return \Mockery\LegacyMockInterface|\Mockery\MockInterface */ public function getMock() { return $this->_mock; } /** * Flag this expectation as calling the original class method with the * any provided arguments instead of using a return value queue. * * @return self */ public function passthru() { if ($this->_mock instanceof Mock) { throw new Exception( 'Mock Objects not created from a loaded/existing class are ' . 'incapable of passing method calls through to a parent class' ); } $this->_passthru = true; return $this; } /** * Cloning logic * */ public function __clone() { $newValidators = array(); $countValidators = $this->_countValidators; foreach ($countValidators as $validator) { $newValidators[] = clone $validator; } $this->_countValidators = $newValidators; } public function getName() { return $this->_name; } public function getExceptionMessage() { return $this->_because; } } library/Mockery/VerificationDirector.php000064400000006061150031475740014461 0ustar00receivedMethodCalls = $receivedMethodCalls; $this->expectation = $expectation; } public function verify() { return $this->receivedMethodCalls->verify($this->expectation); } public function with(...$args) { return $this->cloneApplyAndVerify("with", $args); } public function withArgs($args) { return $this->cloneApplyAndVerify("withArgs", array($args)); } public function withNoArgs() { return $this->cloneApplyAndVerify("withNoArgs", array()); } public function withAnyArgs() { return $this->cloneApplyAndVerify("withAnyArgs", array()); } public function times($limit = null) { return $this->cloneWithoutCountValidatorsApplyAndVerify("times", array($limit)); } public function once() { return $this->cloneWithoutCountValidatorsApplyAndVerify("once", array()); } public function twice() { return $this->cloneWithoutCountValidatorsApplyAndVerify("twice", array()); } public function atLeast() { return $this->cloneWithoutCountValidatorsApplyAndVerify("atLeast", array()); } public function atMost() { return $this->cloneWithoutCountValidatorsApplyAndVerify("atMost", array()); } public function between($minimum, $maximum) { return $this->cloneWithoutCountValidatorsApplyAndVerify("between", array($minimum, $maximum)); } protected function cloneWithoutCountValidatorsApplyAndVerify($method, $args) { $expectation = clone $this->expectation; $expectation->clearCountValidators(); call_user_func_array(array($expectation, $method), $args); $director = new VerificationDirector($this->receivedMethodCalls, $expectation); $director->verify(); return $director; } protected function cloneApplyAndVerify($method, $args) { $expectation = clone $this->expectation; call_user_func_array(array($expectation, $method), $args); $director = new VerificationDirector($this->receivedMethodCalls, $expectation); $director->verify(); return $director; } } library/Mockery/Container.php000064400000037163150031475740012274 0ustar00_generator = $generator ?: \Mockery::getDefaultGenerator(); $this->_loader = $loader ?: \Mockery::getDefaultLoader(); } /** * Generates a new mock object for this container * * I apologies in advance for this. A God Method just fits the API which * doesn't require differentiating between classes, interfaces, abstracts, * names or partials - just so long as it's something that can be mocked. * I'll refactor it one day so it's easier to follow. * * @param array ...$args * * @return Mock * @throws Exception\RuntimeException */ public function mock(...$args) { $expectationClosure = null; $quickdefs = array(); $constructorArgs = null; $blocks = array(); $class = null; if (count($args) > 1) { $finalArg = end($args); reset($args); if (is_callable($finalArg) && is_object($finalArg)) { $expectationClosure = array_pop($args); } } $builder = new MockConfigurationBuilder(); foreach ($args as $k => $arg) { if ($arg instanceof MockConfigurationBuilder) { $builder = $arg; unset($args[$k]); } } reset($args); $builder->setParameterOverrides(\Mockery::getConfiguration()->getInternalClassMethodParamMaps()); $builder->setConstantsMap(\Mockery::getConfiguration()->getConstantsMap()); while (count($args) > 0) { $arg = array_shift($args); // check for multiple interfaces if (is_string($arg)) { foreach (explode('|', $arg) as $type) { if ($arg === 'null') { // skip PHP 8 'null's } elseif (strpos($type, ',') && !strpos($type, ']')) { $interfaces = explode(',', str_replace(' ', '', $type)); $builder->addTargets($interfaces); } elseif (substr($type, 0, 6) == 'alias:') { $type = str_replace('alias:', '', $type); $builder->addTarget('stdClass'); $builder->setName($type); } elseif (substr($type, 0, 9) == 'overload:') { $type = str_replace('overload:', '', $type); $builder->setInstanceMock(true); $builder->addTarget('stdClass'); $builder->setName($type); } elseif (substr($type, strlen($type)-1, 1) == ']') { $parts = explode('[', $type); if (!class_exists($parts[0], true) && !interface_exists($parts[0], true)) { throw new \Mockery\Exception('Can only create a partial mock from' . ' an existing class or interface'); } $class = $parts[0]; $parts[1] = str_replace(' ', '', $parts[1]); $partialMethods = array_filter(explode(',', strtolower(rtrim($parts[1], ']')))); $builder->addTarget($class); foreach ($partialMethods as $partialMethod) { if ($partialMethod[0] === '!') { $builder->addBlackListedMethod(substr($partialMethod, 1)); continue; } $builder->addWhiteListedMethod($partialMethod); } } elseif (class_exists($type, true) || interface_exists($type, true) || trait_exists($type, true)) { $builder->addTarget($type); } elseif (!\Mockery::getConfiguration()->mockingNonExistentMethodsAllowed() && (!class_exists($type, true) && !interface_exists($type, true))) { throw new \Mockery\Exception("Mockery can't find '$type' so can't mock it"); } else { if (!$this->isValidClassName($type)) { throw new \Mockery\Exception('Class name contains invalid characters'); } $builder->addTarget($type); } break; // unions are "sum" types and not "intersections", and so we must only process the first part } } elseif (is_object($arg)) { $builder->addTarget($arg); } elseif (is_array($arg)) { if (!empty($arg) && array_keys($arg) !== range(0, count($arg) - 1)) { // if associative array if (array_key_exists(self::BLOCKS, $arg)) { $blocks = $arg[self::BLOCKS]; } unset($arg[self::BLOCKS]); $quickdefs = $arg; } else { $constructorArgs = $arg; } } else { throw new \Mockery\Exception( 'Unable to parse arguments sent to ' . get_class($this) . '::mock()' ); } } $builder->addBlackListedMethods($blocks); if (!is_null($constructorArgs)) { $builder->addBlackListedMethod("__construct"); // we need to pass through } else { $builder->setMockOriginalDestructor(true); } if (!empty($partialMethods) && $constructorArgs === null) { $constructorArgs = array(); } $config = $builder->getMockConfiguration(); $this->checkForNamedMockClashes($config); $def = $this->getGenerator()->generate($config); if (class_exists($def->getClassName(), $attemptAutoload = false)) { $rfc = new \ReflectionClass($def->getClassName()); if (!$rfc->implementsInterface("Mockery\LegacyMockInterface")) { throw new \Mockery\Exception\RuntimeException("Could not load mock {$def->getClassName()}, class already exists"); } } $this->getLoader()->load($def); $mock = $this->_getInstance($def->getClassName(), $constructorArgs); $mock->mockery_init($this, $config->getTargetObject(), $config->isInstanceMock()); if (!empty($quickdefs)) { if (\Mockery::getConfiguration()->getQuickDefinitions()->shouldBeCalledAtLeastOnce()) { $mock->shouldReceive($quickdefs)->atLeast()->once(); } else { $mock->shouldReceive($quickdefs)->byDefault(); } } if (!empty($expectationClosure)) { $expectationClosure($mock); } $this->rememberMock($mock); return $mock; } public function instanceMock() { } public function getLoader() { return $this->_loader; } public function getGenerator() { return $this->_generator; } /** * @param string $method * @param string $parent * @return string|null */ public function getKeyOfDemeterMockFor($method, $parent) { $keys = array_keys($this->_mocks); $match = preg_grep("/__demeter_" . md5($parent) . "_{$method}$/", $keys); if (count($match) == 1) { $res = array_values($match); if (count($res) > 0) { return $res[0]; } } return null; } /** * @return array */ public function getMocks() { return $this->_mocks; } /** * Tear down tasks for this container * * @throws \Exception * @return void */ public function mockery_teardown() { try { $this->mockery_verify(); } catch (\Exception $e) { $this->mockery_close(); throw $e; } } /** * Verify the container mocks * * @return void */ public function mockery_verify() { foreach ($this->_mocks as $mock) { $mock->mockery_verify(); } } /** * Retrieves all exceptions thrown by mocks * * @return array */ public function mockery_thrownExceptions() { $e = []; foreach ($this->_mocks as $mock) { $e = array_merge($e, $mock->mockery_thrownExceptions()); } return $e; } /** * Reset the container to its original state * * @return void */ public function mockery_close() { foreach ($this->_mocks as $mock) { $mock->mockery_teardown(); } $this->_mocks = array(); } /** * Fetch the next available allocation order number * * @return int */ public function mockery_allocateOrder() { $this->_allocatedOrder += 1; return $this->_allocatedOrder; } /** * Set ordering for a group * * @param mixed $group * @param int $order */ public function mockery_setGroup($group, $order) { $this->_groups[$group] = $order; } /** * Fetch array of ordered groups * * @return array */ public function mockery_getGroups() { return $this->_groups; } /** * Set current ordered number * * @param int $order * @return int The current order number that was set */ public function mockery_setCurrentOrder($order) { $this->_currentOrder = $order; return $this->_currentOrder; } /** * Get current ordered number * * @return int */ public function mockery_getCurrentOrder() { return $this->_currentOrder; } /** * Validate the current mock's ordering * * @param string $method * @param int $order * @throws \Mockery\Exception * @return void */ public function mockery_validateOrder($method, $order, \Mockery\LegacyMockInterface $mock) { if ($order < $this->_currentOrder) { $exception = new \Mockery\Exception\InvalidOrderException( 'Method ' . $method . ' called out of order: expected order ' . $order . ', was ' . $this->_currentOrder ); $exception->setMock($mock) ->setMethodName($method) ->setExpectedOrder($order) ->setActualOrder($this->_currentOrder); throw $exception; } $this->mockery_setCurrentOrder($order); } /** * Gets the count of expectations on the mocks * * @return int */ public function mockery_getExpectationCount() { $count = 0; foreach ($this->_mocks as $mock) { $count += $mock->mockery_getExpectationCount(); } return $count; } /** * Store a mock and set its container reference * * @param \Mockery\Mock $mock * @return \Mockery\LegacyMockInterface|\Mockery\MockInterface */ public function rememberMock(\Mockery\LegacyMockInterface $mock) { if (!isset($this->_mocks[get_class($mock)])) { $this->_mocks[get_class($mock)] = $mock; } else { /** * This condition triggers for an instance mock where origin mock * is already remembered */ $this->_mocks[] = $mock; } return $mock; } /** * Retrieve the last remembered mock object, which is the same as saying * retrieve the current mock being programmed where you have yet to call * mock() to change it - thus why the method name is "self" since it will be * be used during the programming of the same mock. * * @return \Mockery\Mock */ public function self() { $mocks = array_values($this->_mocks); $index = count($mocks) - 1; return $mocks[$index]; } /** * Return a specific remembered mock according to the array index it * was stored to in this container instance * * @return \Mockery\Mock */ public function fetchMock($reference) { if (isset($this->_mocks[$reference])) { return $this->_mocks[$reference]; } } protected function _getInstance($mockName, $constructorArgs = null) { if ($constructorArgs !== null) { $r = new \ReflectionClass($mockName); return $r->newInstanceArgs($constructorArgs); } try { $instantiator = new Instantiator(); $instance = $instantiator->instantiate($mockName); } catch (\Exception $ex) { $internalMockName = $mockName . '_Internal'; if (!class_exists($internalMockName)) { eval("class $internalMockName extends $mockName {" . 'public function __construct() {}' . '}'); } $instance = new $internalMockName(); } return $instance; } protected function checkForNamedMockClashes($config) { $name = $config->getName(); if (!$name) { return; } $hash = $config->getHash(); if (isset($this->_namedMocks[$name])) { if ($hash !== $this->_namedMocks[$name]) { throw new \Mockery\Exception( "The mock named '$name' has been already defined with a different mock configuration" ); } } $this->_namedMocks[$name] = $hash; } /** * see http://php.net/manual/en/language.oop5.basic.php * @param string $className * @return bool */ public function isValidClassName($className) { $pos = strpos($className, '\\'); if ($pos === 0) { $className = substr($className, 1); // remove the first backslash } // all the namespaces and class name should match the regex $invalidNames = array_filter(explode('\\', $className), function ($name) { return !preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $name); }); return empty($invalidNames); } } library/Mockery/Exception.php000064400000001365150031475740012303 0ustar00closure = $closure; } public function __invoke() { return call_user_func_array($this->closure, func_get_args()); } } library/Mockery/CompositeExpectation.php000064400000007641150031475740014516 0ustar00_expectations[] = $expectation; } /** * @param mixed ...$args */ public function andReturn(...$args) { return $this->__call(__FUNCTION__, $args); } /** * Set a return value, or sequential queue of return values * * @param mixed ...$args * @return self */ public function andReturns(...$args) { return call_user_func_array([$this, 'andReturn'], $args); } /** * Intercept any expectation calls and direct against all expectations * * @param string $method * @param array $args * @return self */ public function __call($method, array $args) { foreach ($this->_expectations as $expectation) { call_user_func_array(array($expectation, $method), $args); } return $this; } /** * Return order number of the first expectation * * @return int */ public function getOrderNumber() { reset($this->_expectations); $first = current($this->_expectations); return $first->getOrderNumber(); } /** * Return the parent mock of the first expectation * * @return \Mockery\MockInterface|\Mockery\LegacyMockInterface */ public function getMock() { reset($this->_expectations); $first = current($this->_expectations); return $first->getMock(); } /** * Mockery API alias to getMock * * @return \Mockery\LegacyMockInterface|\Mockery\MockInterface */ public function mock() { return $this->getMock(); } /** * Starts a new expectation addition on the first mock which is the primary * target outside of a demeter chain * * @param mixed ...$args * @return \Mockery\Expectation */ public function shouldReceive(...$args) { reset($this->_expectations); $first = current($this->_expectations); return call_user_func_array(array($first->getMock(), 'shouldReceive'), $args); } /** * Starts a new expectation addition on the first mock which is the primary * target outside of a demeter chain * * @param mixed ...$args * @return \Mockery\Expectation */ public function shouldNotReceive(...$args) { reset($this->_expectations); $first = current($this->_expectations); return call_user_func_array(array($first->getMock(), 'shouldNotReceive'), $args); } /** * Return the string summary of this composite expectation * * @return string */ public function __toString() { $return = '['; $parts = array(); foreach ($this->_expectations as $exp) { $parts[] = (string) $exp; } $return .= implode(', ', $parts) . ']'; return $return; } } library/Mockery/LegacyMockInterface.php000064400000013746150031475740014212 0ustar00_countValidators = array(); } public function __clone() { parent::__clone(); $this->_actualCount = 0; } } library/Mockery/ExpectationDirector.php000064400000013470150031475740014324 0ustar00_name = $name; $this->_mock = $mock; } /** * Add a new expectation to the director * * @param \Mockery\Expectation $expectation */ public function addExpectation(\Mockery\Expectation $expectation) { $this->_expectations[] = $expectation; } /** * Handle a method call being directed by this instance * * @param array $args * @return mixed */ public function call(array $args) { $expectation = $this->findExpectation($args); if (is_null($expectation)) { $exception = new \Mockery\Exception\NoMatchingExpectationException( 'No matching handler found for ' . $this->_mock->mockery_getName() . '::' . \Mockery::formatArgs($this->_name, $args) . '. Either the method was unexpected or its arguments matched' . ' no expected argument list for this method' . PHP_EOL . PHP_EOL . \Mockery::formatObjects($args) ); $exception->setMock($this->_mock) ->setMethodName($this->_name) ->setActualArguments($args); throw $exception; } return $expectation->verifyCall($args); } /** * Verify all expectations of the director * * @throws \Mockery\CountValidator\Exception * @return void */ public function verify() { if (!empty($this->_expectations)) { foreach ($this->_expectations as $exp) { $exp->verify(); } } else { foreach ($this->_defaults as $exp) { $exp->verify(); } } } /** * Attempt to locate an expectation matching the provided args * * @param array $args * @return mixed */ public function findExpectation(array $args) { $expectation = null; if (!empty($this->_expectations)) { $expectation = $this->_findExpectationIn($this->_expectations, $args); } if ($expectation === null && !empty($this->_defaults)) { $expectation = $this->_findExpectationIn($this->_defaults, $args); } return $expectation; } /** * Make the given expectation a default for all others assuming it was * correctly created last * * @param \Mockery\Expectation $expectation */ public function makeExpectationDefault(\Mockery\Expectation $expectation) { $last = end($this->_expectations); if ($last === $expectation) { array_pop($this->_expectations); array_unshift($this->_defaults, $expectation); } else { throw new \Mockery\Exception( 'Cannot turn a previously defined expectation into a default' ); } } /** * Search current array of expectations for a match * * @param array $expectations * @param array $args * @return mixed */ protected function _findExpectationIn(array $expectations, array $args) { foreach ($expectations as $exp) { if ($exp->isEligible() && $exp->matchArgs($args)) { return $exp; } } foreach ($expectations as $exp) { if ($exp->matchArgs($args)) { return $exp; } } } /** * Return all expectations assigned to this director * * @return array */ public function getExpectations() { return $this->_expectations; } /** * Return all expectations assigned to this director * * @return array */ public function getDefaultExpectations() { return $this->_defaults; } /** * Return the number of expectations assigned to this director. * * @return int */ public function getExpectationCount() { $count = 0; /** @var Expectation $expectations */ $expectations = $this->getExpectations() ?: $this->getDefaultExpectations(); foreach ($expectations as $expectation) { if ($expectation->isCallCountConstrained()) { $count++; } } return $count; } } library/Mockery/Generator/TargetClassInterface.php000064400000004476150031475740016336 0ustar00passes = $passes; } public function generate(MockConfiguration $config) { $code = file_get_contents(__DIR__ . '/../Mock.php'); $className = $config->getName() ?: $config->generateName(); $namedConfig = $config->rename($className); foreach ($this->passes as $pass) { $code = $pass->apply($code, $namedConfig); } return new MockDefinition($namedConfig, $code); } public function addPass(Pass $pass) { $this->passes[] = $pass; } } library/Mockery/Generator/MockConfigurationBuilder.php000064400000012320150031475740017214 0ustar00blackListedMethods = array_diff($this->blackListedMethods, $this->php7SemiReservedKeywords); } public function addTarget($target) { $this->targets[] = $target; return $this; } public function addTargets($targets) { foreach ($targets as $target) { $this->addTarget($target); } return $this; } public function setName($name) { $this->name = $name; return $this; } public function addBlackListedMethod($blackListedMethod) { $this->blackListedMethods[] = $blackListedMethod; return $this; } public function addBlackListedMethods(array $blackListedMethods) { foreach ($blackListedMethods as $method) { $this->addBlackListedMethod($method); } return $this; } public function setBlackListedMethods(array $blackListedMethods) { $this->blackListedMethods = $blackListedMethods; return $this; } public function addWhiteListedMethod($whiteListedMethod) { $this->whiteListedMethods[] = $whiteListedMethod; return $this; } public function addWhiteListedMethods(array $whiteListedMethods) { foreach ($whiteListedMethods as $method) { $this->addWhiteListedMethod($method); } return $this; } public function setWhiteListedMethods(array $whiteListedMethods) { $this->whiteListedMethods = $whiteListedMethods; return $this; } public function setInstanceMock($instanceMock) { $this->instanceMock = (bool) $instanceMock; } public function setParameterOverrides(array $overrides) { $this->parameterOverrides = $overrides; } public function setMockOriginalDestructor($mockDestructor) { $this->mockOriginalDestructor = $mockDestructor; return $this; } public function setConstantsMap(array $map) { $this->constantsMap = $map; } public function getMockConfiguration() { return new MockConfiguration( $this->targets, $this->blackListedMethods, $this->whiteListedMethods, $this->name, $this->instanceMock, $this->parameterOverrides, $this->mockOriginalDestructor, $this->constantsMap ); } } library/Mockery/Generator/StringManipulation/Pass/CallTypeHintPass.php000064400000002666150031475740022224 0ustar00requiresCallTypeHintRemoval()) { $code = str_replace( 'public function __call($method, array $args)', 'public function __call($method, $args)', $code ); } if ($config->requiresCallStaticTypeHintRemoval()) { $code = str_replace( 'public static function __callStatic($method, array $args)', 'public static function __callStatic($method, $args)', $code ); } return $code; } } Mockery/Generator/StringManipulation/Pass/RemoveUnserializeForInternalSerializableClassesPass.php000064400000003647150031475740031266 0ustar00librarygetTargetClass(); if (!$target) { return $code; } if (!$target->hasInternalAncestor() || !$target->implementsInterface("Serializable")) { return $code; } $code = $this->appendToClass($code, \PHP_VERSION_ID < 80100 ? self::DUMMY_METHOD_DEFINITION_LEGACY : self::DUMMY_METHOD_DEFINITION); return $code; } protected function appendToClass($class, $code) { $lastBrace = strrpos($class, "}"); $class = substr($class, 0, $lastBrace) . $code . "\n }\n"; return $class; } } library/Mockery/Generator/StringManipulation/Pass/ClassPass.php000064400000002602150031475740020717 0ustar00getTargetClass(); if (!$target) { return $code; } if ($target->isFinal()) { return $code; } $className = ltrim($target->getName(), "\\"); if (!class_exists($className)) { \Mockery::declareClass($className); } $code = str_replace( "implements MockInterface", "extends \\" . $className . " implements MockInterface", $code ); return $code; } } library/Mockery/Generator/StringManipulation/Pass/InstanceMockPass.php000064400000005671150031475740022241 0ustar00_mockery_ignoreVerification = false; \$associatedRealObject = \Mockery::fetchMock(__CLASS__); foreach (get_object_vars(\$this) as \$attr => \$val) { if (\$attr !== "_mockery_ignoreVerification" && \$attr !== "_mockery_expectations") { \$this->\$attr = \$associatedRealObject->\$attr; } } \$directors = \$associatedRealObject->mockery_getExpectations(); foreach (\$directors as \$method=>\$director) { // get the director method needed \$existingDirector = \$this->mockery_getExpectationsFor(\$method); if (!\$existingDirector) { \$existingDirector = new \Mockery\ExpectationDirector(\$method, \$this); \$this->mockery_setExpectationsFor(\$method, \$existingDirector); } \$expectations = \$director->getExpectations(); foreach (\$expectations as \$expectation) { \$clonedExpectation = clone \$expectation; \$existingDirector->addExpectation(\$clonedExpectation); } \$defaultExpectations = \$director->getDefaultExpectations(); foreach (array_reverse(\$defaultExpectations) as \$expectation) { \$clonedExpectation = clone \$expectation; \$existingDirector->addExpectation(\$clonedExpectation); \$existingDirector->makeExpectationDefault(\$clonedExpectation); } } \Mockery::getContainer()->rememberMock(\$this); \$this->_mockery_constructorCalled(func_get_args()); } MOCK; public function apply($code, MockConfiguration $config) { if ($config->isInstanceMock()) { $code = $this->appendToClass($code, static::INSTANCE_MOCK_CODE); } return $code; } protected function appendToClass($class, $code) { $lastBrace = strrpos($class, "}"); $class = substr($class, 0, $lastBrace) . $code . "\n }\n"; return $class; } } library/Mockery/Generator/StringManipulation/Pass/MagicMethodTypeHintsPass.php000064400000013250150031475740023704 0ustar00getMagicMethods($config->getTargetClass()); foreach ($config->getTargetInterfaces() as $interface) { $magicMethods = array_merge($magicMethods, $this->getMagicMethods($interface)); } foreach ($magicMethods as $method) { $code = $this->applyMagicTypeHints($code, $method); } return $code; } /** * Returns the magic methods within the * passed DefinedTargetClass. * * @param TargetClassInterface $class * @return array */ public function getMagicMethods( TargetClassInterface $class = null ) { if (is_null($class)) { return array(); } return array_filter($class->getMethods(), function (Method $method) { return in_array($method->getName(), $this->mockMagicMethods); }); } /** * Applies type hints of magic methods from * class to the passed code. * * @param int $code * @param Method $method * @return string */ private function applyMagicTypeHints($code, Method $method) { if ($this->isMethodWithinCode($code, $method)) { $namedParameters = $this->getOriginalParameters( $code, $method ); $code = preg_replace( $this->getDeclarationRegex($method->getName()), $this->getMethodDeclaration($method, $namedParameters), $code ); } return $code; } /** * Checks if the method is declared within code. * * @param int $code * @param Method $method * @return boolean */ private function isMethodWithinCode($code, Method $method) { return preg_match( $this->getDeclarationRegex($method->getName()), $code ) == 1; } /** * Returns the method original parameters, as they're * described in the $code string. * * @param int $code * @param Method $method * @return array */ private function getOriginalParameters($code, Method $method) { $matches = []; $parameterMatches = []; preg_match( $this->getDeclarationRegex($method->getName()), $code, $matches ); if (count($matches) > 0) { preg_match_all( '/(?<=\$)(\w+)+/i', $matches[0], $parameterMatches ); } $groupMatches = end($parameterMatches); $parameterNames = is_array($groupMatches) ? $groupMatches : [$groupMatches]; return $parameterNames; } /** * Gets the declaration code, as a string, for the passed method. * * @param Method $method * @param array $namedParameters * @return string */ private function getMethodDeclaration( Method $method, array $namedParameters ) { $declaration = 'public'; $declaration .= $method->isStatic() ? ' static' : ''; $declaration .= ' function ' . $method->getName() . '('; foreach ($method->getParameters() as $index => $parameter) { $declaration .= $this->renderTypeHint($parameter); $name = isset($namedParameters[$index]) ? $namedParameters[$index] : $parameter->getName(); $declaration .= '$' . $name; $declaration .= ','; } $declaration = rtrim($declaration, ','); $declaration .= ') '; $returnType = $method->getReturnType(); if ($returnType !== null) { $declaration .= sprintf(': %s', $returnType); } return $declaration; } protected function renderTypeHint(Parameter $param) { $typeHint = $param->getTypeHint(); return $typeHint === null ? '' : sprintf('%s ', $typeHint); } /** * Returns a regex string used to match the * declaration of some method. * * @param string $methodName * @return string */ private function getDeclarationRegex($methodName) { return "/public\s+(?:static\s+)?function\s+$methodName\s*\(.*\)\s*(?=\{)/i"; } } library/Mockery/Generator/StringManipulation/Pass/ClassNamePass.php000064400000002466150031475740021530 0ustar00getNamespaceName(); $namespace = ltrim($namespace, "\\"); $className = $config->getShortName(); $code = str_replace( 'namespace Mockery;', $namespace ? 'namespace ' . $namespace . ';' : '', $code ); $code = str_replace( 'class Mock', 'class ' . $className, $code ); return $code; } } library/Mockery/Generator/StringManipulation/Pass/RemoveBuiltinMethodsThatAreFinalPass.php000064400000003272150031475740026211 0ustar00 '/public function __wakeup\(\)\s+\{.*?\}/sm', '__toString' => '/public function __toString\(\)\s+(:\s+string)?\s*\{.*?\}/sm', ); public function apply($code, MockConfiguration $config) { $target = $config->getTargetClass(); if (!$target) { return $code; } foreach ($target->getMethods() as $method) { if ($method->isFinal() && isset($this->methods[$method->getName()])) { $code = preg_replace($this->methods[$method->getName()], '', $code); } } return $code; } } library/Mockery/Generator/StringManipulation/Pass/InterfacePass.php000064400000002676150031475740021565 0ustar00getTargetInterfaces() as $i) { $name = ltrim($i->getName(), "\\"); if (!interface_exists($name)) { \Mockery::declareInterface($name); } } $interfaces = array_reduce((array) $config->getTargetInterfaces(), function ($code, $i) { return $code . ", \\" . ltrim($i->getName(), "\\"); }, ""); $code = str_replace( "implements MockInterface", "implements MockInterface" . $interfaces, $code ); return $code; } } library/Mockery/Generator/StringManipulation/Pass/TraitPass.php000064400000002446150031475740020743 0ustar00getTargetTraits(); if (empty($traits)) { return $code; } $useStatements = array_map(function ($trait) { return "use \\\\" . ltrim($trait->getName(), "\\") . ";"; }, $traits); $code = preg_replace( '/^{$/m', "{\n " . implode("\n ", $useStatements) . "\n", $code ); return $code; } } library/Mockery/Generator/StringManipulation/Pass/AvoidMethodClashPass.php000064400000002771150031475740023037 0ustar00getName(); }, $config->getMethodsToMock()); foreach (["allows", "expects"] as $method) { if (in_array($method, $names)) { $code = preg_replace( "#// start method {$method}.*// end method {$method}#ms", "", $code ); $code = str_replace(" implements MockInterface", " implements LegacyMockInterface", $code); } } return $code; } } library/Mockery/Generator/StringManipulation/Pass/ConstantsPass.php000064400000001405150031475740021626 0ustar00getConstantsMap(); if (empty($cm)) { return $code; } if (!isset($cm[$config->getName()])) { return $code; } $cm = $cm[$config->getName()]; $constantsCode = ''; foreach ($cm as $constant => $value) { $constantsCode .= sprintf("\n const %s = %s;\n", $constant, var_export($value, true)); } $i = strrpos($code, '}'); $code = substr_replace($code, $constantsCode, $i); $code .= "}\n"; return $code; } } library/Mockery/Generator/StringManipulation/Pass/MethodDefinitionPass.php000064400000012454150031475740023111 0ustar00getMethodsToMock() as $method) { if ($method->isPublic()) { $methodDef = 'public'; } elseif ($method->isProtected()) { $methodDef = 'protected'; } else { $methodDef = 'private'; } if ($method->isStatic()) { $methodDef .= ' static'; } $methodDef .= ' function '; $methodDef .= $method->returnsReference() ? ' & ' : ''; $methodDef .= $method->getName(); $methodDef .= $this->renderParams($method, $config); $methodDef .= $this->renderReturnType($method); $methodDef .= $this->renderMethodBody($method, $config); $code = $this->appendToClass($code, $methodDef); } return $code; } protected function renderParams(Method $method, $config) { $class = $method->getDeclaringClass(); if ($class->isInternal()) { $overrides = $config->getParameterOverrides(); if (isset($overrides[strtolower($class->getName())][$method->getName()])) { return '(' . implode(',', $overrides[strtolower($class->getName())][$method->getName()]) . ')'; } } $methodParams = array(); $params = $method->getParameters(); foreach ($params as $param) { $paramDef = $this->renderTypeHint($param); $paramDef .= $param->isPassedByReference() ? '&' : ''; $paramDef .= $param->isVariadic() ? '...' : ''; $paramDef .= '$' . $param->getName(); if (!$param->isVariadic()) { if (false !== $param->isDefaultValueAvailable()) { $defaultValue = $param->getDefaultValue(); $paramDef .= ' = ' . (is_object($defaultValue) ? get_class($defaultValue) : var_export($defaultValue, true)); } elseif ($param->isOptional()) { $paramDef .= ' = null'; } } $methodParams[] = $paramDef; } return '(' . implode(', ', $methodParams) . ')'; } protected function renderReturnType(Method $method) { $type = $method->getReturnType(); return $type ? sprintf(': %s', $type) : ''; } protected function appendToClass($class, $code) { $lastBrace = strrpos($class, "}"); $class = substr($class, 0, $lastBrace) . $code . "\n }\n"; return $class; } protected function renderTypeHint(Parameter $param) { $typeHint = $param->getTypeHint(); return $typeHint === null ? '' : sprintf('%s ', $typeHint); } private function renderMethodBody($method, $config) { $invoke = $method->isStatic() ? 'static::_mockery_handleStaticMethodCall' : '$this->_mockery_handleMethodCall'; $body = <<getDeclaringClass(); $class_name = strtolower($class->getName()); $overrides = $config->getParameterOverrides(); if (isset($overrides[$class_name][$method->getName()])) { $params = array_values($overrides[$class_name][$method->getName()]); $paramCount = count($params); for ($i = 0; $i < $paramCount; ++$i) { $param = $params[$i]; if (strpos($param, '&') !== false) { $body .= << $i) { \$argv[$i] = {$param}; } BODY; } } } else { $params = array_values($method->getParameters()); $paramCount = count($params); for ($i = 0; $i < $paramCount; ++$i) { $param = $params[$i]; if (!$param->isPassedByReference()) { continue; } $body .= << $i) { \$argv[$i] =& \${$param->getName()}; } BODY; } } $body .= "\$ret = {$invoke}(__FUNCTION__, \$argv);\n"; if (! in_array($method->getReturnType(), ['never','void'], true)) { $body .= "return \$ret;\n"; } $body .= "}\n"; return $body; } } library/Mockery/Generator/StringManipulation/Pass/RemoveDestructorPass.php000064400000002426150031475740023172 0ustar00 */ namespace Mockery\Generator\StringManipulation\Pass; use Mockery\Generator\MockConfiguration; /** * Remove mock's empty destructor if we tend to use original class destructor */ class RemoveDestructorPass { public function apply($code, MockConfiguration $config) { $target = $config->getTargetClass(); if (!$target) { return $code; } if (!$config->isMockOriginalDestructor()) { $code = preg_replace('/public function __destruct\(\)\s+\{.*?\}/sm', '', $code); } return $code; } } library/Mockery/Generator/StringManipulation/Pass/Pass.php000064400000001533150031475740017733 0ustar00generator = $generator; } public function generate(MockConfiguration $config) { $hash = $config->getHash(); if (isset($this->cache[$hash])) { return $this->cache[$hash]; } $definition = $this->generator->generate($config); $this->cache[$hash] = $definition; return $definition; } } library/Mockery/Generator/DefinedTargetClass.php000064400000005042150031475740015762 0ustar00rfc = $rfc; $this->name = $alias === null ? $rfc->getName() : $alias; } public static function factory($name, $alias = null) { return new self(new \ReflectionClass($name), $alias); } public function getName() { return $this->name; } public function isAbstract() { return $this->rfc->isAbstract(); } public function isFinal() { return $this->rfc->isFinal(); } public function getMethods() { return array_map(function ($method) { return new Method($method); }, $this->rfc->getMethods()); } public function getInterfaces() { $class = __CLASS__; return array_map(function ($interface) use ($class) { return new $class($interface); }, $this->rfc->getInterfaces()); } public function __toString() { return $this->getName(); } public function getNamespaceName() { return $this->rfc->getNamespaceName(); } public function inNamespace() { return $this->rfc->inNamespace(); } public function getShortName() { return $this->rfc->getShortName(); } public function implementsInterface($interface) { return $this->rfc->implementsInterface($interface); } public function hasInternalAncestor() { if ($this->rfc->isInternal()) { return true; } $child = $this->rfc; while ($parent = $child->getParentClass()) { if ($parent->isInternal()) { return true; } $child = $parent; } return false; } } library/Mockery/Generator/Generator.php000064400000001475150031475740014223 0ustar00rfp = $rfp; } public function __call($method, array $args) { return call_user_func_array(array($this->rfp, $method), $args); } /** * Get the reflection class for the parameter type, if it exists. * * This will be null if there was no type, or it was a scalar or a union. * * @return \ReflectionClass|null * * @deprecated since 1.3.3 and will be removed in 2.0. */ public function getClass() { $typeHint = Reflector::getTypeHint($this->rfp, true); return \class_exists($typeHint) ? DefinedTargetClass::factory($typeHint, false) : null; } /** * Get the string representation for the paramater type. * * @return string|null */ public function getTypeHint() { return Reflector::getTypeHint($this->rfp); } /** * Get the string representation for the paramater type. * * @return string * * @deprecated since 1.3.2 and will be removed in 2.0. Use getTypeHint() instead. */ public function getTypeHintAsString() { return (string) Reflector::getTypeHint($this->rfp, true); } /** * Get the name of the parameter. * * Some internal classes have funny looking definitions! * * @return string */ public function getName() { $name = $this->rfp->getName(); if (!$name || $name == '...') { $name = 'arg' . self::$parameterCounter++; } return $name; } /** * Determine if the parameter is an array. * * @return bool */ public function isArray() { return Reflector::isArray($this->rfp); } /** * Determine if the parameter is variadic. * * @return bool */ public function isVariadic() { return $this->rfp->isVariadic(); } } library/Mockery/Generator/Method.php000064400000002645150031475740013515 0ustar00method = $method; } public function __call($method, $args) { return call_user_func_array(array($this->method, $method), $args); } /** * @return Parameter[] */ public function getParameters() { return array_map(function (\ReflectionParameter $parameter) { return new Parameter($parameter); }, $this->method->getParameters()); } /** * @return string|null */ public function getReturnType() { return Reflector::getReturnType($this->method); } } library/Mockery/Generator/MockNameBuilder.php000064400000002175150031475740015274 0ustar00parts[] = $part; return $this; } public function build() { $parts = ['Mockery', static::$mockCounter++]; foreach ($this->parts as $part) { $parts[] = str_replace("\\", "_", $part); } return implode('_', $parts); } } library/Mockery/Generator/MockConfiguration.php000064400000040241150031475740015710 0ustar00addTargets($targets); $this->blackListedMethods = $blackListedMethods; $this->whiteListedMethods = $whiteListedMethods; $this->name = $name; $this->instanceMock = $instanceMock; $this->parameterOverrides = $parameterOverrides; $this->mockOriginalDestructor = $mockOriginalDestructor; $this->constantsMap = $constantsMap; } /** * Attempt to create a hash of the configuration, in order to allow caching * * @TODO workout if this will work * * @return string */ public function getHash() { $vars = array( 'targetClassName' => $this->targetClassName, 'targetInterfaceNames' => $this->targetInterfaceNames, 'targetTraitNames' => $this->targetTraitNames, 'name' => $this->name, 'blackListedMethods' => $this->blackListedMethods, 'whiteListedMethod' => $this->whiteListedMethods, 'instanceMock' => $this->instanceMock, 'parameterOverrides' => $this->parameterOverrides, 'mockOriginalDestructor' => $this->mockOriginalDestructor ); return md5(serialize($vars)); } /** * Gets a list of methods from the classes, interfaces and objects and * filters them appropriately. Lot's of filtering going on, perhaps we could * have filter classes to iterate through */ public function getMethodsToMock() { $methods = $this->getAllMethods(); foreach ($methods as $key => $method) { if ($method->isFinal()) { unset($methods[$key]); } } /** * Whitelist trumps everything else */ if (count($this->getWhiteListedMethods())) { $whitelist = array_map('strtolower', $this->getWhiteListedMethods()); $methods = array_filter($methods, function ($method) use ($whitelist) { return $method->isAbstract() || in_array(strtolower($method->getName()), $whitelist); }); return $methods; } /** * Remove blacklisted methods */ if (count($this->getBlackListedMethods())) { $blacklist = array_map('strtolower', $this->getBlackListedMethods()); $methods = array_filter($methods, function ($method) use ($blacklist) { return !in_array(strtolower($method->getName()), $blacklist); }); } /** * Internal objects can not be instantiated with newInstanceArgs and if * they implement Serializable, unserialize will have to be called. As * such, we can't mock it and will need a pass to add a dummy * implementation */ if ($this->getTargetClass() && $this->getTargetClass()->implementsInterface("Serializable") && $this->getTargetClass()->hasInternalAncestor()) { $methods = array_filter($methods, function ($method) { return $method->getName() !== "unserialize"; }); } return array_values($methods); } /** * We declare the __call method to handle undefined stuff, if the class * we're mocking has also defined it, we need to comply with their interface */ public function requiresCallTypeHintRemoval() { foreach ($this->getAllMethods() as $method) { if ("__call" === $method->getName()) { $params = $method->getParameters(); return !$params[1]->isArray(); } } return false; } /** * We declare the __callStatic method to handle undefined stuff, if the class * we're mocking has also defined it, we need to comply with their interface */ public function requiresCallStaticTypeHintRemoval() { foreach ($this->getAllMethods() as $method) { if ("__callStatic" === $method->getName()) { $params = $method->getParameters(); return !$params[1]->isArray(); } } return false; } public function rename($className) { $targets = array(); if ($this->targetClassName) { $targets[] = $this->targetClassName; } if ($this->targetInterfaceNames) { $targets = array_merge($targets, $this->targetInterfaceNames); } if ($this->targetTraitNames) { $targets = array_merge($targets, $this->targetTraitNames); } if ($this->targetObject) { $targets[] = $this->targetObject; } return new self( $targets, $this->blackListedMethods, $this->whiteListedMethods, $className, $this->instanceMock, $this->parameterOverrides, $this->mockOriginalDestructor, $this->constantsMap ); } protected function addTarget($target) { if (is_object($target)) { $this->setTargetObject($target); $this->setTargetClassName(get_class($target)); return $this; } if ($target[0] !== "\\") { $target = "\\" . $target; } if (class_exists($target)) { $this->setTargetClassName($target); return $this; } if (interface_exists($target)) { $this->addTargetInterfaceName($target); return $this; } if (trait_exists($target)) { $this->addTargetTraitName($target); return $this; } /** * Default is to set as class, or interface if class already set * * Don't like this condition, can't remember what the default * targetClass is for */ if ($this->getTargetClassName()) { $this->addTargetInterfaceName($target); return $this; } $this->setTargetClassName($target); } protected function addTargets($interfaces) { foreach ($interfaces as $interface) { $this->addTarget($interface); } } public function getTargetClassName() { return $this->targetClassName; } public function getTargetClass() { if ($this->targetClass) { return $this->targetClass; } if (!$this->targetClassName) { return null; } if (class_exists($this->targetClassName)) { $alias = null; if (strpos($this->targetClassName, '@') !== false) { $alias = (new MockNameBuilder()) ->addPart('anonymous_class') ->addPart(md5($this->targetClassName)) ->build(); class_alias($this->targetClassName, $alias); } $dtc = DefinedTargetClass::factory($this->targetClassName, $alias); if ($this->getTargetObject() == false && $dtc->isFinal()) { throw new \Mockery\Exception( 'The class ' . $this->targetClassName . ' is marked final and its methods' . ' cannot be replaced. Classes marked final can be passed in' . ' to \Mockery::mock() as instantiated objects to create a' . ' partial mock, but only if the mock is not subject to type' . ' hinting checks.' ); } $this->targetClass = $dtc; } else { $this->targetClass = UndefinedTargetClass::factory($this->targetClassName); } return $this->targetClass; } public function getTargetTraits() { if (!empty($this->targetTraits)) { return $this->targetTraits; } foreach ($this->targetTraitNames as $targetTrait) { $this->targetTraits[] = DefinedTargetClass::factory($targetTrait); } $this->targetTraits = array_unique($this->targetTraits); // just in case return $this->targetTraits; } public function getTargetInterfaces() { if (!empty($this->targetInterfaces)) { return $this->targetInterfaces; } foreach ($this->targetInterfaceNames as $targetInterface) { if (!interface_exists($targetInterface)) { $this->targetInterfaces[] = UndefinedTargetClass::factory($targetInterface); continue; } $dtc = DefinedTargetClass::factory($targetInterface); $extendedInterfaces = array_keys($dtc->getInterfaces()); $extendedInterfaces[] = $targetInterface; $traversableFound = false; $iteratorShiftedToFront = false; foreach ($extendedInterfaces as $interface) { if (!$traversableFound && preg_match("/^\\?Iterator(|Aggregate)$/i", $interface)) { break; } if (preg_match("/^\\\\?IteratorAggregate$/i", $interface)) { $this->targetInterfaces[] = DefinedTargetClass::factory("\\IteratorAggregate"); $iteratorShiftedToFront = true; } elseif (preg_match("/^\\\\?Iterator$/i", $interface)) { $this->targetInterfaces[] = DefinedTargetClass::factory("\\Iterator"); $iteratorShiftedToFront = true; } elseif (preg_match("/^\\\\?Traversable$/i", $interface)) { $traversableFound = true; } } if ($traversableFound && !$iteratorShiftedToFront) { $this->targetInterfaces[] = DefinedTargetClass::factory("\\IteratorAggregate"); } /** * We never straight up implement Traversable */ if (!preg_match("/^\\\\?Traversable$/i", $targetInterface)) { $this->targetInterfaces[] = $dtc; } } $this->targetInterfaces = array_unique($this->targetInterfaces); // just in case return $this->targetInterfaces; } public function getTargetObject() { return $this->targetObject; } public function getName() { return $this->name; } /** * Generate a suitable name based on the config */ public function generateName() { $nameBuilder = new MockNameBuilder(); if ($this->getTargetObject()) { $className = get_class($this->getTargetObject()); $nameBuilder->addPart(strpos($className, '@') !== false ? md5($className) : $className); } if ($this->getTargetClass()) { $className = $this->getTargetClass()->getName(); $nameBuilder->addPart(strpos($className, '@') !== false ? md5($className) : $className); } foreach ($this->getTargetInterfaces() as $targetInterface) { $nameBuilder->addPart($targetInterface->getName()); } return $nameBuilder->build(); } public function getShortName() { $parts = explode("\\", $this->getName()); return array_pop($parts); } public function getNamespaceName() { $parts = explode("\\", $this->getName()); array_pop($parts); if (count($parts)) { return implode("\\", $parts); } return ""; } public function getBlackListedMethods() { return $this->blackListedMethods; } public function getWhiteListedMethods() { return $this->whiteListedMethods; } public function isInstanceMock() { return $this->instanceMock; } public function getParameterOverrides() { return $this->parameterOverrides; } public function isMockOriginalDestructor() { return $this->mockOriginalDestructor; } protected function setTargetClassName($targetClassName) { $this->targetClassName = $targetClassName; } protected function getAllMethods() { if ($this->allMethods) { return $this->allMethods; } $classes = $this->getTargetInterfaces(); if ($this->getTargetClass()) { $classes[] = $this->getTargetClass(); } $methods = array(); foreach ($classes as $class) { $methods = array_merge($methods, $class->getMethods()); } foreach ($this->getTargetTraits() as $trait) { foreach ($trait->getMethods() as $method) { if ($method->isAbstract()) { $methods[] = $method; } } } $names = array(); $methods = array_filter($methods, function ($method) use (&$names) { if (in_array($method->getName(), $names)) { return false; } $names[] = $method->getName(); return true; }); return $this->allMethods = $methods; } /** * If we attempt to implement Traversable, we must ensure we are also * implementing either Iterator or IteratorAggregate, and that whichever one * it is comes before Traversable in the list of implements. */ protected function addTargetInterfaceName($targetInterface) { $this->targetInterfaceNames[] = $targetInterface; } protected function addTargetTraitName($targetTraitName) { $this->targetTraitNames[] = $targetTraitName; } protected function setTargetObject($object) { $this->targetObject = $object; } public function getConstantsMap() { return $this->constantsMap; } } library/Mockery/Generator/MockDefinition.php000064400000002415150031475740015172 0ustar00getName()) { throw new \InvalidArgumentException("MockConfiguration must contain a name"); } $this->config = $config; $this->code = $code; } public function getConfig() { return $this->config; } public function getClassName() { return $this->config->getName(); } public function getCode() { return $this->code; } } library/Mockery/Generator/UndefinedTargetClass.php000064400000003644150031475740016333 0ustar00name = $name; } public static function factory($name) { return new self($name); } public function getName() { return $this->name; } public function isAbstract() { return false; } public function isFinal() { return false; } public function getMethods() { return array(); } public function getInterfaces() { return array(); } public function getNamespaceName() { $parts = explode("\\", ltrim($this->getName(), "\\")); array_pop($parts); return implode("\\", $parts); } public function inNamespace() { return $this->getNamespaceName() !== ''; } public function getShortName() { $parts = explode("\\", $this->getName()); return array_pop($parts); } public function implementsInterface($interface) { return false; } public function hasInternalAncestor() { return false; } public function __toString() { return $this->name; } } library/Mockery/ExpectationInterface.php000064400000002074150031475740014447 0ustar00getType(); return $type instanceof \ReflectionNamedType && $type->getName(); } /** * Compute the string representation for the paramater type. * * @param \ReflectionParameter $param * @param bool $withoutNullable * * @return string|null */ public static function getTypeHint(\ReflectionParameter $param, $withoutNullable = false) { if (!$param->hasType()) { return null; } $type = $param->getType(); $declaringClass = $param->getDeclaringClass(); $typeHint = self::typeToString($type, $declaringClass); return (!$withoutNullable && $type->allowsNull()) ? self::formatNullableType($typeHint) : $typeHint; } /** * Compute the string representation for the return type. * * @param \ReflectionParameter $param * @param bool $withoutNullable * * @return string|null */ public static function getReturnType(\ReflectionMethod $method, $withoutNullable = false) { $type = $method->getReturnType(); if (is_null($type) && method_exists($method, 'getTentativeReturnType')) { $type = $method->getTentativeReturnType(); } if (is_null($type)) { return null; } $typeHint = self::typeToString($type, $method->getDeclaringClass()); return (!$withoutNullable && $type->allowsNull()) ? self::formatNullableType($typeHint) : $typeHint; } /** * Compute the string representation for the simplest return type. * * @param \ReflectionParameter $param * * @return string|null */ public static function getSimplestReturnType(\ReflectionMethod $method) { $type = $method->getReturnType(); if (is_null($type) && method_exists($method, 'getTentativeReturnType')) { $type = $method->getTentativeReturnType(); } if (is_null($type) || $type->allowsNull()) { return null; } $typeInformation = self::getTypeInformation($type, $method->getDeclaringClass()); // return the first primitive type hint foreach ($typeInformation as $info) { if ($info['isPrimitive']) { return $info['typeHint']; } } // if no primitive type, return the first type foreach ($typeInformation as $info) { return $info['typeHint']; } return null; } /** * Get the string representation of the given type. * * @param \ReflectionType $type * @param string $declaringClass * * @return string|null */ private static function typeToString(\ReflectionType $type, \ReflectionClass $declaringClass) { return \implode('|', \array_map(function (array $typeInformation) { return $typeInformation['typeHint']; }, self::getTypeInformation($type, $declaringClass))); } /** * Get the string representation of the given type. * * @param \ReflectionType $type * @param \ReflectionClass $declaringClass * * @return list */ private static function getTypeInformation(\ReflectionType $type, \ReflectionClass $declaringClass) { // PHP 8 union types and PHP 8.1 intersection types can be recursively processed if ($type instanceof \ReflectionUnionType || $type instanceof \ReflectionIntersectionType) { $types = []; foreach ($type->getTypes() as $innterType) { foreach (self::getTypeInformation($innterType, $declaringClass) as $info) { if ($info['typeHint'] === 'null' && $info['isPrimitive']) { continue; } $types[] = $info; } } return $types; } // $type must be an instance of \ReflectionNamedType $typeHint = $type->getName(); // builtins can be returned as is if ($type->isBuiltin()) { return [ [ 'typeHint' => $typeHint, 'isPrimitive' => in_array($typeHint, ['array', 'bool', 'int', 'float', 'null', 'object', 'string']), ], ]; } // 'static' can be returned as is if ($typeHint === 'static') { return [ [ 'typeHint' => $typeHint, 'isPrimitive' => false, ], ]; } // 'self' needs to be resolved to the name of the declaring class if ($typeHint === 'self') { $typeHint = $declaringClass->getName(); } // 'parent' needs to be resolved to the name of the parent class if ($typeHint === 'parent') { $typeHint = $declaringClass->getParentClass()->getName(); } // class names need prefixing with a slash return [ [ 'typeHint' => sprintf('\\%s', $typeHint), 'isPrimitive' => false, ], ]; } /** * Format the given type as a nullable type. * * @param string $typeHint * * @return string */ private static function formatNullableType($typeHint) { if (\PHP_VERSION_ID < 80000) { return sprintf('?%s', $typeHint); } return $typeHint === 'mixed' ? 'mixed' : sprintf('%s|null', $typeHint); } } library/Mockery/Undefined.php000064400000002212150031475740012236 0ustar00method = $method; $this->args = $args; } public function getMethod() { return $this->method; } public function getArgs() { return $this->args; } } library/Mockery/QuickDefinitionsConfiguration.php000064400000004161150031475740016342 0ustar00_quickDefinitionsApplicationMode = $newValue ? self::QUICK_DEFINITIONS_MODE_MOCK_AT_LEAST_ONCE : self::QUICK_DEFINITIONS_MODE_DEFAULT_EXPECTATION; } return $this->_quickDefinitionsApplicationMode === self::QUICK_DEFINITIONS_MODE_MOCK_AT_LEAST_ONCE; } } library/Mockery/Adapter/Phpunit/TestListenerTrait.php000064400000005610150031475740017002 0ustar00getStatus() !== BaseTestRunner::STATUS_PASSED) { // If the test didn't pass there is no guarantee that // verifyMockObjects and assertPostConditions have been called. // And even if it did, the point here is to prevent false // negatives, not to make failing tests fail for more reasons. return; } try { // The self() call is used as a sentinel. Anything that throws if // the container is closed already will do. \Mockery::self(); } catch (\LogicException $_) { return; } $e = new ExpectationFailedException( \sprintf( "Mockery's expectations have not been verified. Make sure that \Mockery::close() is called at the end of the test. Consider using %s\MockeryPHPUnitIntegration or extending %s\MockeryTestCase.", __NAMESPACE__, __NAMESPACE__ ) ); /** @var \PHPUnit\Framework\TestResult $result */ $result = $test->getTestResultObject(); if ($result !== null) { $result->addFailure($test, $e, $time); } } public function startTestSuite() { if (method_exists(Blacklist::class, 'addDirectory')) { (new BlackList())->getBlacklistedDirectories(); Blacklist::addDirectory(\dirname((new \ReflectionClass(\Mockery::class))->getFileName())); } else { Blacklist::$blacklistedClassNames[\Mockery::class] = 1; } } } library/Mockery/Adapter/Phpunit/MockeryPHPUnitIntegration.php000064400000004470150031475740020401 0ustar00addMockeryExpectationsToAssertionCount(); $this->checkMockeryExceptions(); $this->closeMockery(); parent::assertPostConditions(); } protected function addMockeryExpectationsToAssertionCount() { $this->addToAssertionCount(Mockery::getContainer()->mockery_getExpectationCount()); } protected function checkMockeryExceptions() { if (!method_exists($this, "markAsRisky")) { return; } foreach (Mockery::getContainer()->mockery_thrownExceptions() as $e) { if (!$e->dismissed()) { $this->markAsRisky(); } } } protected function closeMockery() { Mockery::close(); $this->mockeryOpen = false; } /** * @before */ protected function startMockery() { $this->mockeryOpen = true; } /** * @after */ protected function purgeMockeryContainer() { if ($this->mockeryOpen) { // post conditions wasn't called, so test probably failed Mockery::close(); } } } library/Mockery/Adapter/Phpunit/MockeryTestCase.php000064400000001710150031475740016413 0ustar00trait = new TestListenerTrait(); } public function endTest(Test $test, float $time): void { $this->trait->endTest($test, $time); } public function startTestSuite(TestSuite $suite): void { $this->trait->startTestSuite(); } } library/Mockery/Adapter/Phpunit/MockeryTestCaseSetUp.php000064400000001707150031475740017402 0ustar00mockeryTestSetUp(); } protected function tearDown(): void { $this->mockeryTestTearDown(); parent::tearDown(); } } library/Mockery/Adapter/Phpunit/MockeryPHPUnitIntegrationAssertPostConditions.php000064400000001552150031475740024461 0ustar00mockeryAssertPostConditions(); } } library/Mockery/Instantiator.php000064400000011453150031475740013023 0ustar00. */ namespace Mockery; use Closure; use ReflectionClass; use UnexpectedValueException; use InvalidArgumentException; /** * This is a trimmed down version of https://github.com/doctrine/instantiator, * basically without the caching * * @author Marco Pivetta */ final class Instantiator { /** * {@inheritDoc} */ public function instantiate($className) { $factory = $this->buildFactory($className); $instance = $factory(); return $instance; } /** * Builds a {@see \Closure} capable of instantiating the given $className without * invoking its constructor. * * @param string $className * * @return Closure */ private function buildFactory($className) { $reflectionClass = $this->getReflectionClass($className); if ($this->isInstantiableViaReflection($reflectionClass)) { return function () use ($reflectionClass) { return $reflectionClass->newInstanceWithoutConstructor(); }; } $serializedString = sprintf( 'O:%d:"%s":0:{}', strlen($className), $className ); $this->attemptInstantiationViaUnSerialization($reflectionClass, $serializedString); return function () use ($serializedString) { return unserialize($serializedString); }; } /** * @param string $className * * @return ReflectionClass * * @throws InvalidArgumentException */ private function getReflectionClass($className) { if (! class_exists($className)) { throw new InvalidArgumentException("Class:$className does not exist"); } $reflection = new ReflectionClass($className); if ($reflection->isAbstract()) { throw new InvalidArgumentException("Class:$className is an abstract class"); } return $reflection; } /** * @param ReflectionClass $reflectionClass * @param string $serializedString * * @throws UnexpectedValueException * * @return void */ private function attemptInstantiationViaUnSerialization(ReflectionClass $reflectionClass, $serializedString) { set_error_handler(function ($code, $message, $file, $line) use ($reflectionClass, & $error) { $msg = sprintf( 'Could not produce an instance of "%s" via un-serialization, since an error was triggered in file "%s" at line "%d"', $reflectionClass->getName(), $file, $line ); $error = new UnexpectedValueException($msg, 0, new \Exception($message, $code)); }); try { unserialize($serializedString); } catch (\Exception $exception) { restore_error_handler(); throw new UnexpectedValueException("An exception was raised while trying to instantiate an instance of \"{$reflectionClass->getName()}\" via un-serialization", 0, $exception); } restore_error_handler(); if ($error) { throw $error; } } /** * @param ReflectionClass $reflectionClass * * @return bool */ private function isInstantiableViaReflection(ReflectionClass $reflectionClass) { return ! ($reflectionClass->isInternal() && $reflectionClass->isFinal()); } /** * Verifies whether the given class is to be considered internal * * @param ReflectionClass $reflectionClass * * @return bool */ private function hasInternalAncestors(ReflectionClass $reflectionClass) { do { if ($reflectionClass->isInternal()) { return true; } } while ($reflectionClass = $reflectionClass->getParentClass()); return false; } } library/Mockery.php000064400000061024150031475740010343 0ustar00shouldIgnoreMissing(); } /** * Static and Semantic shortcut to \Mockery\Container::mock(). * * @param mixed ...$args * * @return \Mockery\MockInterface|\Mockery\LegacyMockInterface */ public static function instanceMock(...$args) { return call_user_func_array(array(self::getContainer(), 'mock'), $args); } /** * Static shortcut to \Mockery\Container::mock(), first argument names the mock. * * @param mixed ...$args * * @return \Mockery\MockInterface|\Mockery\LegacyMockInterface */ public static function namedMock(...$args) { $name = array_shift($args); $builder = new MockConfigurationBuilder(); $builder->setName($name); array_unshift($args, $builder); return call_user_func_array(array(self::getContainer(), 'mock'), $args); } /** * Static shortcut to \Mockery\Container::self(). * * @throws LogicException * * @return \Mockery\MockInterface|\Mockery\LegacyMockInterface */ public static function self() { if (is_null(self::$_container)) { throw new \LogicException('You have not declared any mocks yet'); } return self::$_container->self(); } /** * Static shortcut to closing up and verifying all mocks in the global * container, and resetting the container static variable to null. * * @return void */ public static function close() { foreach (self::$_filesToCleanUp as $fileName) { @unlink($fileName); } self::$_filesToCleanUp = []; if (is_null(self::$_container)) { return; } $container = self::$_container; self::$_container = null; $container->mockery_teardown(); $container->mockery_close(); } /** * Static fetching of a mock associated with a name or explicit class poser. * * @param string $name * * @return \Mockery\Mock */ public static function fetchMock($name) { return self::getContainer()->fetchMock($name); } /** * Lazy loader and getter for * the container property. * * @return Mockery\Container */ public static function getContainer() { if (is_null(self::$_container)) { self::$_container = new Mockery\Container(self::getGenerator(), self::getLoader()); } return self::$_container; } /** * Setter for the $_generator static property. * * @param \Mockery\Generator\Generator $generator */ public static function setGenerator(Generator $generator) { self::$_generator = $generator; } /** * Lazy loader method and getter for * the generator property. * * @return Generator */ public static function getGenerator() { if (is_null(self::$_generator)) { self::$_generator = self::getDefaultGenerator(); } return self::$_generator; } /** * Creates and returns a default generator * used inside this class. * * @return CachingGenerator */ public static function getDefaultGenerator() { return new CachingGenerator(StringManipulationGenerator::withDefaultPasses()); } /** * Setter for the $_loader static property. * * @param Loader $loader */ public static function setLoader(Loader $loader) { self::$_loader = $loader; } /** * Lazy loader method and getter for * the $_loader property. * * @return Loader */ public static function getLoader() { if (is_null(self::$_loader)) { self::$_loader = self::getDefaultLoader(); } return self::$_loader; } /** * Gets an EvalLoader to be used as default. * * @return EvalLoader */ public static function getDefaultLoader() { return new EvalLoader(); } /** * Set the container. * * @param \Mockery\Container $container * * @return \Mockery\Container */ public static function setContainer(Mockery\Container $container) { return self::$_container = $container; } /** * Reset the container to null. * * @return void */ public static function resetContainer() { self::$_container = null; } /** * Return instance of ANY matcher. * * @return \Mockery\Matcher\Any */ public static function any() { return new \Mockery\Matcher\Any(); } /** * Return instance of AndAnyOtherArgs matcher. * * An alternative name to `andAnyOtherArgs` so * the API stays closer to `any` as well. * * @return \Mockery\Matcher\AndAnyOtherArgs */ public static function andAnyOthers() { return new \Mockery\Matcher\AndAnyOtherArgs(); } /** * Return instance of AndAnyOtherArgs matcher. * * @return \Mockery\Matcher\AndAnyOtherArgs */ public static function andAnyOtherArgs() { return new \Mockery\Matcher\AndAnyOtherArgs(); } /** * Return instance of TYPE matcher. * * @param mixed $expected * * @return \Mockery\Matcher\Type */ public static function type($expected) { return new \Mockery\Matcher\Type($expected); } /** * Return instance of DUCKTYPE matcher. * * @param array ...$args * * @return \Mockery\Matcher\Ducktype */ public static function ducktype(...$args) { return new \Mockery\Matcher\Ducktype($args); } /** * Return instance of SUBSET matcher. * * @param array $part * @param bool $strict - (Optional) True for strict comparison, false for loose * * @return \Mockery\Matcher\Subset */ public static function subset(array $part, $strict = true) { return new \Mockery\Matcher\Subset($part, $strict); } /** * Return instance of CONTAINS matcher. * * @param mixed $args * * @return \Mockery\Matcher\Contains */ public static function contains(...$args) { return new \Mockery\Matcher\Contains($args); } /** * Return instance of HASKEY matcher. * * @param mixed $key * * @return \Mockery\Matcher\HasKey */ public static function hasKey($key) { return new \Mockery\Matcher\HasKey($key); } /** * Return instance of HASVALUE matcher. * * @param mixed $val * * @return \Mockery\Matcher\HasValue */ public static function hasValue($val) { return new \Mockery\Matcher\HasValue($val); } /** * Return instance of CLOSURE matcher. * * @param $reference * * @return \Mockery\Matcher\Closure */ public static function capture(&$reference) { $closure = function ($argument) use (&$reference) { $reference = $argument; return true; }; return new \Mockery\Matcher\Closure($closure); } /** * Return instance of CLOSURE matcher. * * @param mixed $closure * * @return \Mockery\Matcher\Closure */ public static function on($closure) { return new \Mockery\Matcher\Closure($closure); } /** * Return instance of MUSTBE matcher. * * @param mixed $expected * * @return \Mockery\Matcher\MustBe */ public static function mustBe($expected) { return new \Mockery\Matcher\MustBe($expected); } /** * Return instance of NOT matcher. * * @param mixed $expected * * @return \Mockery\Matcher\Not */ public static function not($expected) { return new \Mockery\Matcher\Not($expected); } /** * Return instance of ANYOF matcher. * * @param array ...$args * * @return \Mockery\Matcher\AnyOf */ public static function anyOf(...$args) { return new \Mockery\Matcher\AnyOf($args); } /** * Return instance of NOTANYOF matcher. * * @param array ...$args * * @return \Mockery\Matcher\NotAnyOf */ public static function notAnyOf(...$args) { return new \Mockery\Matcher\NotAnyOf($args); } /** * Return instance of PATTERN matcher. * * @param mixed $expected * * @return \Mockery\Matcher\Pattern */ public static function pattern($expected) { return new \Mockery\Matcher\Pattern($expected); } /** * Lazy loader and Getter for the global * configuration container. * * @return \Mockery\Configuration */ public static function getConfiguration() { if (is_null(self::$_config)) { self::$_config = new \Mockery\Configuration(); } return self::$_config; } /** * Utility method to format method name and arguments into a string. * * @param string $method * @param array $arguments * * @return string */ public static function formatArgs($method, array $arguments = null) { if (is_null($arguments)) { return $method . '()'; } $formattedArguments = array(); foreach ($arguments as $argument) { $formattedArguments[] = self::formatArgument($argument); } return $method . '(' . implode(', ', $formattedArguments) . ')'; } /** * Gets the string representation * of any passed argument. * * @param mixed $argument * @param int $depth * * @return mixed */ private static function formatArgument($argument, $depth = 0) { if ($argument instanceof MatcherAbstract) { return (string) $argument; } if (is_object($argument)) { return 'object(' . get_class($argument) . ')'; } if (is_int($argument) || is_float($argument)) { return $argument; } if (is_array($argument)) { if ($depth === 1) { $argument = '[...]'; } else { $sample = array(); foreach ($argument as $key => $value) { $key = is_int($key) ? $key : "'$key'"; $value = self::formatArgument($value, $depth + 1); $sample[] = "$key => $value"; } $argument = "[" . implode(", ", $sample) . "]"; } return ((strlen($argument) > 1000) ? substr($argument, 0, 1000) . '...]' : $argument); } if (is_bool($argument)) { return $argument ? 'true' : 'false'; } if (is_resource($argument)) { return 'resource(...)'; } if (is_null($argument)) { return 'NULL'; } return "'" . (string) $argument . "'"; } /** * Utility function to format objects to printable arrays. * * @param array $objects * * @return string */ public static function formatObjects(array $objects = null) { static $formatting; if ($formatting) { return '[Recursion]'; } if (is_null($objects)) { return ''; } $objects = array_filter($objects, 'is_object'); if (empty($objects)) { return ''; } $formatting = true; $parts = array(); foreach ($objects as $object) { $parts[get_class($object)] = self::objectToArray($object); } $formatting = false; return 'Objects: ( ' . var_export($parts, true) . ')'; } /** * Utility function to turn public properties and public get* and is* method values into an array. * * @param object $object * @param int $nesting * * @return array */ private static function objectToArray($object, $nesting = 3) { if ($nesting == 0) { return array('...'); } $defaultFormatter = function ($object, $nesting) { return array('properties' => self::extractInstancePublicProperties($object, $nesting)); }; $class = get_class($object); $formatter = self::getConfiguration()->getObjectFormatter($class, $defaultFormatter); $array = array( 'class' => $class, 'identity' => '#' . md5(spl_object_hash($object)) ); $array = array_merge($array, $formatter($object, $nesting)); return $array; } /** * Returns all public instance properties. * * @param mixed $object * @param int $nesting * * @return array */ private static function extractInstancePublicProperties($object, $nesting) { $reflection = new \ReflectionClass(get_class($object)); $properties = $reflection->getProperties(\ReflectionProperty::IS_PUBLIC); $cleanedProperties = array(); foreach ($properties as $publicProperty) { if (!$publicProperty->isStatic()) { $name = $publicProperty->getName(); try { $cleanedProperties[$name] = self::cleanupNesting($object->$name, $nesting); } catch (\Exception $exception) { $cleanedProperties[$name] = $exception->getMessage(); } } } return $cleanedProperties; } /** * Utility method used for recursively generating * an object or array representation. * * @param mixed $argument * @param int $nesting * * @return mixed */ private static function cleanupNesting($argument, $nesting) { if (is_object($argument)) { $object = self::objectToArray($argument, $nesting - 1); $object['class'] = get_class($argument); return $object; } if (is_array($argument)) { return self::cleanupArray($argument, $nesting - 1); } return $argument; } /** * Utility method for recursively * gerating a representation * of the given array. * * @param array $argument * @param int $nesting * * @return mixed */ private static function cleanupArray($argument, $nesting = 3) { if ($nesting == 0) { return '...'; } foreach ($argument as $key => $value) { if (is_array($value)) { $argument[$key] = self::cleanupArray($value, $nesting - 1); } elseif (is_object($value)) { $argument[$key] = self::objectToArray($value, $nesting - 1); } } return $argument; } /** * Utility function to parse shouldReceive() arguments and generate * expectations from such as needed. * * @param Mockery\LegacyMockInterface $mock * @param array ...$args * @param callable $add * @return \Mockery\CompositeExpectation */ public static function parseShouldReturnArgs(\Mockery\LegacyMockInterface $mock, $args, $add) { $composite = new \Mockery\CompositeExpectation(); foreach ($args as $arg) { if (is_array($arg)) { foreach ($arg as $k => $v) { $expectation = self::buildDemeterChain($mock, $k, $add)->andReturn($v); $composite->add($expectation); } } elseif (is_string($arg)) { $expectation = self::buildDemeterChain($mock, $arg, $add); $composite->add($expectation); } } return $composite; } /** * Sets up expectations on the members of the CompositeExpectation and * builds up any demeter chain that was passed to shouldReceive. * * @param \Mockery\LegacyMockInterface $mock * @param string $arg * @param callable $add * @throws Mockery\Exception * @return \Mockery\ExpectationInterface */ protected static function buildDemeterChain(\Mockery\LegacyMockInterface $mock, $arg, $add) { /** @var Mockery\Container $container */ $container = $mock->mockery_getContainer(); $methodNames = explode('->', $arg); reset($methodNames); if (!\Mockery::getConfiguration()->mockingNonExistentMethodsAllowed() && !$mock->mockery_isAnonymous() && !in_array(current($methodNames), $mock->mockery_getMockableMethods()) ) { throw new \Mockery\Exception( 'Mockery\'s configuration currently forbids mocking the method ' . current($methodNames) . ' as it does not exist on the class or object ' . 'being mocked' ); } /** @var ExpectationInterface|null $expectations */ $expectations = null; /** @var Callable $nextExp */ $nextExp = function ($method) use ($add) { return $add($method); }; $parent = get_class($mock); while (true) { $method = array_shift($methodNames); $expectations = $mock->mockery_getExpectationsFor($method); if (is_null($expectations) || self::noMoreElementsInChain($methodNames)) { $expectations = $nextExp($method); if (self::noMoreElementsInChain($methodNames)) { break; } $mock = self::getNewDemeterMock($container, $parent, $method, $expectations); } else { $demeterMockKey = $container->getKeyOfDemeterMockFor($method, $parent); if ($demeterMockKey) { $mock = self::getExistingDemeterMock($container, $demeterMockKey); } } $parent .= '->' . $method; $nextExp = function ($n) use ($mock) { return $mock->shouldReceive($n); }; } return $expectations; } /** * Gets a new demeter configured * mock from the container. * * @param \Mockery\Container $container * @param string $parent * @param string $method * @param Mockery\ExpectationInterface $exp * * @return \Mockery\Mock */ private static function getNewDemeterMock( Mockery\Container $container, $parent, $method, Mockery\ExpectationInterface $exp ) { $newMockName = 'demeter_' . md5($parent) . '_' . $method; $parRef = null; $parRefMethod = null; $parRefMethodRetType = null; $parentMock = $exp->getMock(); if ($parentMock !== null) { $parRef = new ReflectionObject($parentMock); } if ($parRef !== null && $parRef->hasMethod($method)) { $parRefMethod = $parRef->getMethod($method); $parRefMethodRetType = Reflector::getReturnType($parRefMethod, true); if ($parRefMethodRetType !== null && $parRefMethodRetType !== 'mixed') { $nameBuilder = new MockNameBuilder(); $nameBuilder->addPart('\\' . $newMockName); $mock = self::namedMock($nameBuilder->build(), $parRefMethodRetType); $exp->andReturn($mock); return $mock; } } $mock = $container->mock($newMockName); $exp->andReturn($mock); return $mock; } /** * Gets an specific demeter mock from * the ones kept by the container. * * @param \Mockery\Container $container * @param string $demeterMockKey * * @return mixed */ private static function getExistingDemeterMock( Mockery\Container $container, $demeterMockKey ) { $mocks = $container->getMocks(); $mock = $mocks[$demeterMockKey]; return $mock; } /** * Checks if the passed array representing a demeter * chain with the method names is empty. * * @param array $methodNames * * @return bool */ private static function noMoreElementsInChain(array $methodNames) { return empty($methodNames); } public static function declareClass($fqn) { return static::declareType($fqn, "class"); } public static function declareInterface($fqn) { return static::declareType($fqn, "interface"); } private static function declareType($fqn, $type) { $targetCode = " tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'MockeryDocsdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ ('index', 'MockeryDocs.tex', u'Mockery Docs Documentation', u'Pádraic Brady, Dave Marshall, Wouter, Graham Campbell', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'mockerydocs', u'Mockery Docs Documentation', [u'Pádraic Brady, Dave Marshall, Wouter, Graham Campbell'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'MockeryDocs', u'Mockery Docs Documentation', u'Pádraic Brady, Dave Marshall, Wouter, Graham Campbell', 'MockeryDocs', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False #on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org on_rtd = os.environ.get('READTHEDOCS', None) == 'True' if not on_rtd: # only import and set the theme if we're building docs locally import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] print sphinx_rtd_theme.get_html_theme_path() # load PhpLexer from sphinx.highlighting import lexers from pygments.lexers.web import PhpLexer # enable highlighting for PHP code not between by default lexers['php'] = PhpLexer(startinline=True) lexers['php-annotations'] = PhpLexer(startinline=True) docs/cookbook/big_parent_class.rst000064400000003210150031475740013335 0ustar00.. index:: single: Cookbook; Big Parent Class Big Parent Class ================ In some application code, especially older legacy code, we can come across some classes that extend a "big parent class" - a parent class that knows and does too much: .. code-block:: php class BigParentClass { public function doesEverything() { // sets up database connections // writes to log files } } class ChildClass extends BigParentClass { public function doesOneThing() { // but calls on BigParentClass methods $result = $this->doesEverything(); // does something with $result return $result; } } We want to test our ``ChildClass`` and its ``doesOneThing`` method, but the problem is that it calls on ``BigParentClass::doesEverything()``. One way to handle this would be to mock out **all** of the dependencies ``BigParentClass`` has and needs, and then finally actually test our ``doesOneThing`` method. It's an awful lot of work to do that. What we can do, is to do something... unconventional. We can create a runtime partial test double of the ``ChildClass`` itself and mock only the parent's ``doesEverything()`` method: .. code-block:: php $childClass = \Mockery::mock('ChildClass')->makePartial(); $childClass->shouldReceive('doesEverything') ->andReturn('some result from parent'); $childClass->doesOneThing(); // string("some result from parent"); With this approach we mock out only the ``doesEverything()`` method, and all the unmocked methods are called on the actual ``ChildClass`` instance. docs/cookbook/mocking_class_within_class.rst000064400000010475150031475740015434 0ustar00.. index:: single: Cookbook; Mocking class within class .. _mocking-class-within-class: Mocking class within class ========================== Imagine a case where you need to create an instance of a class and use it within the same method: .. code-block:: php // Point.php setPoint($x1, $y1); $b = new Point(); $b->setPoint($x2, $y1); $c = new Point(); $c->setPoint($x2, $y2); $d = new Point(); $d->setPoint($x1, $y2); $this->draw([$a, $b, $c, $d]); } public function draw($points) { echo "Do something with the points"; } } And that you want to test that a logic in ``Rectangle->create()`` calls properly each used thing - in this case calls ``Point->setPoint()``, but ``Rectangle->draw()`` does some graphical stuff that you want to avoid calling. You set the mocks for ``App\Point`` and ``App\Rectangle``: .. code-block:: php shouldReceive("setPoint")->andThrow(Exception::class); $rect = Mockery::mock("App\Rectangle")->makePartial(); $rect->shouldReceive("draw"); $rect->create(0, 0, 100, 100); // does not throw exception Mockery::close(); } } and the test does not work. Why? The mocking relies on the class not being present yet, but the class is autoloaded therefore the mock alone for ``App\Point`` is useless which you can see with ``echo`` being executed. Mocks however work for the first class in the order of loading i.e. ``App\Rectangle``, which loads the ``App\Point`` class. In more complex example that would be a single point that initiates the whole loading (``use Class``) such as:: A // main loading initiator |- B // another loading initiator | |-E | +-G | |- C // another loading initiator | +-F | +- D That basically means that the loading prevents mocking and for each such a loading initiator there needs to be implemented a workaround. Overloading is one approach, however it pollutes the global state. In this case we try to completely avoid the global state pollution with custom ``new Class()`` behavior per loading initiator and that can be mocked easily in few critical places. That being said, although we can't stop loading, we can return mocks. Let's look at ``Rectangle->create()`` method: .. code-block:: php class Rectangle { public function newPoint() { return new Point(); } public function create($x1, $y1, $x2, $y2) { $a = $this->newPoint(); $a->setPoint($x1, $y1); ... } ... } We create a custom function to encapsulate ``new`` keyword that would otherwise just use the autoloaded class ``App\Point`` and in our test we mock that function so that it returns our mock: .. code-block:: php shouldReceive("setPoint")->andThrow(Exception::class); $rect = Mockery::mock("App\Rectangle")->makePartial(); $rect->shouldReceive("draw"); // pass the App\Point mock into App\Rectangle as an alternative // to using new App\Point() in-place. $rect->shouldReceive("newPoint")->andReturn($point); $this->expectException(Exception::class); $rect->create(0, 0, 100, 100); Mockery::close(); } } If we run this test now, it should pass. For more complex cases we'd find the next loader in the program flow and proceed with wrapping and passing mock instances with predefined behavior into already existing classes. docs/cookbook/map.rst.inc000064400000000423150031475740011366 0ustar00* :doc:`/cookbook/default_expectations` * :doc:`/cookbook/detecting_mock_objects` * :doc:`/cookbook/not_calling_the_constructor` * :doc:`/cookbook/mocking_hard_dependencies` * :doc:`/cookbook/class_constants` * :doc:`/cookbook/big_parent_class` * :doc:`/cookbook/mockery_on` docs/cookbook/detecting_mock_objects.rst000064400000000612150031475740014531 0ustar00.. index:: single: Cookbook; Detecting Mock Objects Detecting Mock Objects ====================== Users may find it useful to check whether a given object is a real object or a simulated Mock Object. All Mockery mocks implement the ``\Mockery\MockInterface`` interface which can be used in a type check. .. code-block:: php assert($mightBeMocked instanceof \Mockery\MockInterface); docs/cookbook/mocking_hard_dependencies.rst000064400000010570150031475740015200 0ustar00.. index:: single: Cookbook; Mocking Hard Dependencies Mocking Hard Dependencies (new Keyword) ======================================= One prerequisite to mock hard dependencies is that the code we are trying to test uses autoloading. Let's take the following code for an example: .. code-block:: php sendSomething($param); return $externalService->getSomething(); } } The way we can test this without doing any changes to the code itself is by creating :doc:`instance mocks ` by using the ``overload`` prefix. .. code-block:: php shouldReceive('sendSomething') ->once() ->with($param); $externalMock->shouldReceive('getSomething') ->once() ->andReturn('Tested!'); $service = new \App\Service(); $result = $service->callExternalService($param); $this->assertSame('Tested!', $result); } } If we run this test now, it should pass. Mockery does its job and our ``App\Service`` will use the mocked external service instead of the real one. The problem with this is when we want to, for example, test the ``App\Service\External`` itself, or if we use that class somewhere else in our tests. When Mockery overloads a class, because of how PHP works with files, that overloaded class file must not be included otherwise Mockery will throw a "class already exists" exception. This is where autoloading kicks in and makes our job a lot easier. To make this possible, we'll tell PHPUnit to run the tests that have overloaded classes in separate processes and to not preserve global state. That way we'll avoid having the overloaded class included more than once. Of course this has its downsides as these tests will run slower. Our test example from above now becomes: .. code-block:: php shouldReceive('sendSomething') ->once() ->with($param); $externalMock->shouldReceive('getSomething') ->once() ->andReturn('Tested!'); $service = new \App\Service(); $result = $service->callExternalService($param); $this->assertSame('Tested!', $result); } } Testing the constructor arguments of hard Dependencies ------------------------------------------------------ Sometimes we might want to ensure that the hard dependency is instantiated with particular arguments. With overloaded mocks, we can set up expectations on the constructor. .. code-block:: php allows('sendSomething'); $externalMock->shouldReceive('__construct') ->once() ->with(5); $service = new \App\Service(); $result = $service->callExternalService($param); } } .. note:: For more straightforward and single-process tests oriented way check :ref:`mocking-class-within-class`. .. note:: This cookbook entry is an adaption of the blog post titled `"Mocking hard dependencies with Mockery" `_, published by Robert Basic on his blog. docs/cookbook/mockery_on.rst000064400000005753150031475740012221 0ustar00.. index:: single: Cookbook; Complex Argument Matching With Mockery::on Complex Argument Matching With Mockery::on ========================================== When we need to do a more complex argument matching for an expected method call, the ``\Mockery::on()`` matcher comes in really handy. It accepts a closure as an argument and that closure in turn receives the argument passed in to the method, when called. If the closure returns ``true``, Mockery will consider that the argument has passed the expectation. If the closure returns ``false``, or a "falsey" value, the expectation will not pass. The ``\Mockery::on()`` matcher can be used in various scenarios — validating an array argument based on multiple keys and values, complex string matching... Say, for example, we have the following code. It doesn't do much; publishes a post by setting the ``published`` flag in the database to ``1`` and sets the ``published_at`` to the current date and time: .. code-block:: php model = $model; } public function publishPost($id) { $saveData = [ 'post_id' => $id, 'published' => 1, 'published_at' => gmdate('Y-m-d H:i:s'), ]; $this->model->save($saveData); } } In a test we would mock the model and set some expectations on the call of the ``save()`` method: .. code-block:: php shouldReceive('save') ->once() ->with(\Mockery::on(function ($argument) use ($postId) { $postIdIsSet = isset($argument['post_id']) && $argument['post_id'] === $postId; $publishedFlagIsSet = isset($argument['published']) && $argument['published'] === 1; $publishedAtIsSet = isset($argument['published_at']); return $postIdIsSet && $publishedFlagIsSet && $publishedAtIsSet; })); $service = new \Service\Post($modelMock); $service->publishPost($postId); \Mockery::close(); The important part of the example is inside the closure we pass to the ``\Mockery::on()`` matcher. The ``$argument`` is actually the ``$saveData`` argument the ``save()`` method gets when it is called. We check for a couple of things in this argument: * the post ID is set, and is same as the post ID we passed in to the ``publishPost()`` method, * the ``published`` flag is set, and is ``1``, and * the ``published_at`` key is present. If any of these requirements is not satisfied, the closure will return ``false``, the method call expectation will not be met, and Mockery will throw a ``NoMatchingExpectationException``. .. note:: This cookbook entry is an adaption of the blog post titled `"Complex argument matching in Mockery" `_, published by Robert Basic on his blog. docs/cookbook/index.rst000064400000000421150031475740011146 0ustar00Cookbook ======== .. toctree:: :hidden: default_expectations detecting_mock_objects not_calling_the_constructor mocking_hard_dependencies class_constants big_parent_class mockery_on mocking_class_within_class .. include:: map.rst.inc docs/cookbook/not_calling_the_constructor.rst000064400000004150150031475740015640 0ustar00.. index:: single: Cookbook; Not Calling the Original Constructor Not Calling the Original Constructor ==================================== When creating generated partial test doubles, Mockery mocks out only the method which we specifically told it to. This means that the original constructor of the class we are mocking will be called. In some cases this is not a desired behavior, as the constructor might issue calls to other methods, or other object collaborators, and as such, can create undesired side-effects in the application's environment when running the tests. If this happens, we need to use runtime partial test doubles, as they don't call the original constructor. .. code-block:: php class MyClass { public function __construct() { echo "Original constructor called." . PHP_EOL; // Other side-effects can happen... } } // This will print "Original constructor called." $mock = \Mockery::mock('MyClass[foo]'); A better approach is to use runtime partial doubles: .. code-block:: php class MyClass { public function __construct() { echo "Original constructor called." . PHP_EOL; // Other side-effects can happen... } } // This will not print anything $mock = \Mockery::mock('MyClass')->makePartial(); $mock->shouldReceive('foo'); This is one of the reason why we don't recommend using generated partial test doubles, but if possible, always use the runtime partials. Read more about :ref:`creating-test-doubles-partial-test-doubles`. .. note:: The way generated partial test doubles work, is a BC break. If you use a really old version of Mockery, it might behave in a way that the constructor is not being called for these generated partials. In the case if you upgrade to a more recent version of Mockery, you'll probably have to change your tests to use runtime partials, instead of generated ones. This change was introduced in early 2013, so it is highly unlikely that you are using a Mockery from before that, so this should not be an issue. docs/cookbook/default_expectations.rst000064400000001365150031475740014261 0ustar00.. index:: single: Cookbook; Default Mock Expectations Default Mock Expectations ========================= Often in unit testing, we end up with sets of tests which use the same object dependency over and over again. Rather than mocking this class/object within every single unit test (requiring a mountain of duplicate code), we can instead define reusable default mocks within the test case's ``setup()`` method. This even works where unit tests use varying expectations on the same or similar mock object. How this works, is that you can define mocks with default expectations. Then, in a later unit test, you can add or fine-tune expectations for that specific test. Any expectation can be set as a default using the ``byDefault()`` declaration. docs/cookbook/class_constants.rst000064400000011104150031475740013240 0ustar00.. index:: single: Cookbook; Class Constants Class Constants =============== When creating a test double for a class, Mockery does not create stubs out of any class constants defined in the class we are mocking. Sometimes though, the non-existence of these class constants, setup of the test, and the application code itself, it can lead to undesired behavior, and even a PHP error: ``PHP Fatal error: Uncaught Error: Undefined class constant 'FOO' in ...`` While supporting class constants in Mockery would be possible, it does require an awful lot of work, for a small number of use cases. Named Mocks ----------- We can, however, deal with these constants in a way supported by Mockery - by using :ref:`creating-test-doubles-named-mocks`. A named mock is a test double that has a name of the class we want to mock, but under it is a stubbed out class that mimics the real class with canned responses. Lets look at the following made up, but not impossible scenario: .. code-block:: php class Fetcher { const SUCCESS = 0; const FAILURE = 1; public static function fetch() { // Fetcher gets something for us from somewhere... return self::SUCCESS; } } class MyClass { public function doFetching() { $response = Fetcher::fetch(); if ($response == Fetcher::SUCCESS) { echo "Thanks!" . PHP_EOL; } else { echo "Try again!" . PHP_EOL; } } } Our ``MyClass`` calls a ``Fetcher`` that fetches some resource from somewhere - maybe it downloads a file from a remote web service. Our ``MyClass`` prints out a response message depending on the response from the ``Fetcher::fetch()`` call. When testing ``MyClass`` we don't really want ``Fetcher`` to go and download random stuff from the internet every time we run our test suite. So we mock it out: .. code-block:: php // Using alias: because fetch is called statically! \Mockery::mock('alias:Fetcher') ->shouldReceive('fetch') ->andReturn(0); $myClass = new MyClass(); $myClass->doFetching(); If we run this, our test will error out with a nasty ``PHP Fatal error: Uncaught Error: Undefined class constant 'SUCCESS' in ..``. Here's how a ``namedMock()`` can help us in a situation like this. We create a stub for the ``Fetcher`` class, stubbing out the class constants, and then use ``namedMock()`` to create a mock named ``Fetcher`` based on our stub: .. code-block:: php class FetcherStub { const SUCCESS = 0; const FAILURE = 1; } \Mockery::namedMock('Fetcher', 'FetcherStub') ->shouldReceive('fetch') ->andReturn(0); $myClass = new MyClass(); $myClass->doFetching(); This works because under the hood, Mockery creates a class called ``Fetcher`` that extends ``FetcherStub``. The same approach will work even if ``Fetcher::fetch()`` is not a static dependency: .. code-block:: php class Fetcher { const SUCCESS = 0; const FAILURE = 1; public function fetch() { // Fetcher gets something for us from somewhere... return self::SUCCESS; } } class MyClass { public function doFetching($fetcher) { $response = $fetcher->fetch(); if ($response == Fetcher::SUCCESS) { echo "Thanks!" . PHP_EOL; } else { echo "Try again!" . PHP_EOL; } } } And the test will have something like this: .. code-block:: php class FetcherStub { const SUCCESS = 0; const FAILURE = 1; } $mock = \Mockery::mock('Fetcher', 'FetcherStub') $mock->shouldReceive('fetch') ->andReturn(0); $myClass = new MyClass(); $myClass->doFetching($mock); Constants Map ------------- Another way of mocking class constants can be with the use of the constants map configuration. Given a class with constants: .. code-block:: php class Fetcher { const SUCCESS = 0; const FAILURE = 1; public function fetch() { // Fetcher gets something for us from somewhere... return self::SUCCESS; } } It can be mocked with: .. code-block:: php \Mockery::getConfiguration()->setConstantsMap([ 'Fetcher' => [ 'SUCCESS' => 'success', 'FAILURE' => 'fail', ] ]); $mock = \Mockery::mock('Fetcher'); var_dump($mock::SUCCESS); // (string) 'success' var_dump($mock::FAILURE); // (string) 'fail' docs/reference/public_static_properties.rst000064400000001275150031475740015300 0ustar00.. index:: single: Mocking; Public Static Methods Mocking Public Static Methods ============================= Static methods are not called on real objects, so normal mock objects can't mock them. Mockery supports class aliased mocks, mocks representing a class name which would normally be loaded (via autoloading or a require statement) in the system under test. These aliases block that loading (unless via a require statement - so please use autoloading!) and allow Mockery to intercept static method calls and add expectations for them. See the :ref:`creating-test-doubles-aliasing` section for more information on creating aliased mocks, for the purpose of mocking public static methods. docs/reference/alternative_should_receive_syntax.rst000064400000004515150031475740017203 0ustar00.. index:: single: Alternative shouldReceive Syntax Alternative shouldReceive Syntax ================================ As of Mockery 1.0.0, we support calling methods as we would call any PHP method, and not as string arguments to Mockery ``should*`` methods. The two Mockery methods that enable this are ``allows()`` and ``expects()``. Allows ------ We use ``allows()`` when we create stubs for methods that return a predefined return value, but for these method stubs we don't care how many times, or if at all, were they called. .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->allows([ 'name_of_method_1' => 'return value', 'name_of_method_2' => 'return value', ]); This is equivalent with the following ``shouldReceive`` syntax: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive([ 'name_of_method_1' => 'return value', 'name_of_method_2' => 'return value', ]); Note that with this format, we also tell Mockery that we don't care about the arguments to the stubbed methods. If we do care about the arguments, we would do it like so: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->allows() ->name_of_method_1($arg1) ->andReturn('return value'); This is equivalent with the following ``shouldReceive`` syntax: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method_1') ->with($arg1) ->andReturn('return value'); Expects ------- We use ``expects()`` when we want to verify that a particular method was called: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->expects() ->name_of_method_1($arg1) ->andReturn('return value'); This is equivalent with the following ``shouldReceive`` syntax: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method_1') ->once() ->with($arg1) ->andReturn('return value'); By default ``expects()`` sets up an expectation that the method should be called once and once only. If we expect more than one call to the method, we can change that expectation: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->expects() ->name_of_method_1($arg1) ->twice() ->andReturn('return value'); docs/reference/creating_test_doubles.rst000064400000034175150031475740014554 0ustar00.. index:: single: Reference; Creating Test Doubles Creating Test Doubles ===================== Mockery's main goal is to help us create test doubles. It can create stubs, mocks, and spies. Stubs and mocks are created the same. The difference between the two is that a stub only returns a preset result when called, while a mock needs to have expectations set on the method calls it expects to receive. Spies are a type of test doubles that keep track of the calls they received, and allow us to inspect these calls after the fact. When creating a test double object, we can pass in an identifier as a name for our test double. If we pass it no identifier, the test double name will be unknown. Furthermore, the identifier does not have to be a class name. It is a good practice, and our recommendation, to always name the test doubles with the same name as the underlying class we are creating test doubles for. If the identifier we use for our test double is a name of an existing class, the test double will inherit the type of the class (via inheritance), i.e. the mock object will pass type hints or ``instanceof`` evaluations for the existing class. This is useful when a test double must be of a specific type, to satisfy the expectations our code has. Stubs and mocks --------------- Stubs and mocks are created by calling the ``\Mockery::mock()`` method. The following example shows how to create a stub, or a mock, object named "foo": .. code-block:: php $mock = \Mockery::mock('foo'); The mock object created like this is the loosest form of mocks possible, and is an instance of ``\Mockery\MockInterface``. .. note:: All test doubles created with Mockery are an instance of ``\Mockery\MockInterface``, regardless are they a stub, mock or a spy. To create a stub or a mock object with no name, we can call the ``mock()`` method with no parameters: .. code-block:: php $mock = \Mockery::mock(); As we stated earlier, we don't recommend creating stub or mock objects without a name. Classes, abstracts, interfaces ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The recommended way to create a stub or a mock object is by using a name of an existing class we want to create a test double of: .. code-block:: php $mock = \Mockery::mock('MyClass'); This stub or mock object will have the type of ``MyClass``, through inheritance. Stub or mock objects can be based on any concrete class, abstract class or even an interface. The primary purpose is to ensure the mock object inherits a specific type for type hinting. .. code-block:: php $mock = \Mockery::mock('MyInterface'); This stub or mock object will implement the ``MyInterface`` interface. .. note:: Classes marked final, or classes that have methods marked final cannot be mocked fully. Mockery supports creating partial mocks for these cases. Partial mocks will be explained later in the documentation. Mockery also supports creating stub or mock objects based on a single existing class, which must implement one or more interfaces. We can do this by providing a comma-separated list of the class and interfaces as the first argument to the ``\Mockery::mock()`` method: .. code-block:: php $mock = \Mockery::mock('MyClass, MyInterface, OtherInterface'); This stub or mock object will now be of type ``MyClass`` and implement the ``MyInterface`` and ``OtherInterface`` interfaces. .. note:: The class name doesn't need to be the first member of the list but it's a friendly convention to use for readability. We can tell a mock to implement the desired interfaces by passing the list of interfaces as the second argument: .. code-block:: php $mock = \Mockery::mock('MyClass', 'MyInterface, OtherInterface'); For all intents and purposes, this is the same as the previous example. Spies ----- The third type of test doubles Mockery supports are spies. The main difference between spies and mock objects is that with spies we verify the calls made against our test double after the calls were made. We would use a spy when we don't necessarily care about all of the calls that are going to be made to an object. A spy will return ``null`` for all method calls it receives. It is not possible to tell a spy what will be the return value of a method call. If we do that, then we would deal with a mock object, and not with a spy. We create a spy by calling the ``\Mockery::spy()`` method: .. code-block:: php $spy = \Mockery::spy('MyClass'); Just as with stubs or mocks, we can tell Mockery to base a spy on any concrete or abstract class, or to implement any number of interfaces: .. code-block:: php $spy = \Mockery::spy('MyClass, MyInterface, OtherInterface'); This spy will now be of type ``MyClass`` and implement the ``MyInterface`` and ``OtherInterface`` interfaces. .. note:: The ``\Mockery::spy()`` method call is actually a shorthand for calling ``\Mockery::mock()->shouldIgnoreMissing()``. The ``shouldIgnoreMissing`` method is a "behaviour modifier". We'll discuss them a bit later. Mocks vs. Spies --------------- Let's try and illustrate the difference between mocks and spies with the following example: .. code-block:: php $mock = \Mockery::mock('MyClass'); $spy = \Mockery::spy('MyClass'); $mock->shouldReceive('foo')->andReturn(42); $mockResult = $mock->foo(); $spyResult = $spy->foo(); $spy->shouldHaveReceived()->foo(); var_dump($mockResult); // int(42) var_dump($spyResult); // null As we can see from this example, with a mock object we set the call expectations before the call itself, and we get the return result we expect it to return. With a spy object on the other hand, we verify the call has happened after the fact. The return result of a method call against a spy is always ``null``. We also have a dedicated chapter to :doc:`spies` only. .. _creating-test-doubles-partial-test-doubles: Partial Test Doubles -------------------- Partial doubles are useful when we want to stub out, set expectations for, or spy on *some* methods of a class, but run the actual code for other methods. We differentiate between three types of partial test doubles: * runtime partial test doubles, * generated partial test doubles, and * proxied partial test doubles. Runtime partial test doubles ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ What we call a runtime partial, involves creating a test double and then telling it to make itself partial. Any method calls that the double hasn't been told to allow or expect, will act as they would on a normal instance of the object. .. code-block:: php class Foo { function foo() { return 123; } function bar() { return $this->foo(); } } $foo = mock(Foo::class)->makePartial(); $foo->foo(); // int(123); We can then tell the test double to allow or expect calls as with any other Mockery double. .. code-block:: php $foo->shouldReceive('foo')->andReturn(456); $foo->bar(); // int(456) See the cookbook entry on :doc:`../cookbook/big_parent_class` for an example usage of runtime partial test doubles. Generated partial test doubles ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The second type of partial double we can create is what we call a generated partial. With generated partials, we specifically tell Mockery which methods we want to be able to allow or expect calls to. All other methods will run the actual code *directly*, so stubs and expectations on these methods will not work. .. code-block:: php class Foo { function foo() { return 123; } function bar() { return $this->foo(); } } $foo = mock("Foo[foo]"); $foo->foo(); // error, no expectation set $foo->shouldReceive('foo')->andReturn(456); $foo->foo(); // int(456) // setting an expectation for this has no effect $foo->shouldReceive('bar')->andReturn(999); $foo->bar(); // int(456) It's also possible to specify explicitly which methods to run directly using the `!method` syntax: .. code-block:: php class Foo { function foo() { return 123; } function bar() { return $this->foo(); } } $foo = mock("Foo[!foo]"); $foo->foo(); // int(123) $foo->bar(); // error, no expectation set .. note:: Even though we support generated partial test doubles, we do not recommend using them. One of the reasons why is because a generated partial will call the original constructor of the mocked class. This can have unwanted side-effects during testing application code. See :doc:`../cookbook/not_calling_the_constructor` for more details. Proxied partial test doubles ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ A proxied partial mock is a partial of last resort. We may encounter a class which is simply not capable of being mocked because it has been marked as final. Similarly, we may find a class with methods marked as final. In such a scenario, we cannot simply extend the class and override methods to mock - we need to get creative. .. code-block:: php $mock = \Mockery::mock(new MyClass); Yes, the new mock is a Proxy. It intercepts calls and reroutes them to the proxied object (which we construct and pass in) for methods which are not subject to any expectations. Indirectly, this allows us to mock methods marked final since the Proxy is not subject to those limitations. The tradeoff should be obvious - a proxied partial will fail any typehint checks for the class being mocked since it cannot extend that class. .. _creating-test-doubles-aliasing: Aliasing -------- Prefixing the valid name of a class (which is NOT currently loaded) with "alias:" will generate an "alias mock". Alias mocks create a class alias with the given classname to stdClass and are generally used to enable the mocking of public static methods. Expectations set on the new mock object which refer to static methods will be used by all static calls to this class. .. code-block:: php $mock = \Mockery::mock('alias:MyClass'); .. note:: Even though aliasing classes is supported, we do not recommend it. Overloading ----------- Prefixing the valid name of a class (which is NOT currently loaded) with "overload:" will generate an alias mock (as with "alias:") except that created new instances of that class will import any expectations set on the origin mock (``$mock``). The origin mock is never verified since it's used an expectation store for new instances. For this purpose we use the term "instance mock" to differentiate it from the simpler "alias mock". In other words, an instance mock will "intercept" when a new instance of the mocked class is created, then the mock will be used instead. This is useful especially when mocking hard dependencies which will be discussed later. .. code-block:: php $mock = \Mockery::mock('overload:MyClass'); .. note:: Using alias/instance mocks across more than one test will generate a fatal error since we can't have two classes of the same name. To avoid this, run each test of this kind in a separate PHP process (which is supported out of the box by both PHPUnit and PHPT). .. _creating-test-doubles-named-mocks: Named Mocks ----------- The ``namedMock()`` method will generate a class called by the first argument, so in this example ``MyClassName``. The rest of the arguments are treated in the same way as the ``mock`` method: .. code-block:: php $mock = \Mockery::namedMock('MyClassName', 'DateTime'); This example would create a class called ``MyClassName`` that extends ``DateTime``. Named mocks are quite an edge case, but they can be useful when code depends on the ``__CLASS__`` magic constant, or when we need two derivatives of an abstract type, that are actually different classes. See the cookbook entry on :doc:`../cookbook/class_constants` for an example usage of named mocks. .. note:: We can only create a named mock once, any subsequent calls to ``namedMock``, with different arguments are likely to cause exceptions. .. _creating-test-doubles-constructor-arguments: Constructor Arguments --------------------- Sometimes the mocked class has required constructor arguments. We can pass these to Mockery as an indexed array, as the 2nd argument: .. code-block:: php $mock = \Mockery::mock('MyClass', [$constructorArg1, $constructorArg2]); or if we need the ``MyClass`` to implement an interface as well, as the 3rd argument: .. code-block:: php $mock = \Mockery::mock('MyClass', 'MyInterface', [$constructorArg1, $constructorArg2]); Mockery now knows to pass in ``$constructorArg1`` and ``$constructorArg2`` as arguments to the constructor. .. _creating-test-doubles-behavior-modifiers: Behavior Modifiers ------------------ When creating a mock object, we may wish to use some commonly preferred behaviours that are not the default in Mockery. The use of the ``shouldIgnoreMissing()`` behaviour modifier will label this mock object as a Passive Mock: .. code-block:: php \Mockery::mock('MyClass')->shouldIgnoreMissing(); In such a mock object, calls to methods which are not covered by expectations will return ``null`` instead of the usual error about there being no expectation matching the call. On PHP >= 7.0.0, methods with missing expectations that have a return type will return either a mock of the object (if return type is a class) or a "falsy" primitive value, e.g. empty string, empty array, zero for ints and floats, false for bools, or empty closures. On PHP >= 7.1.0, methods with missing expectations and nullable return type will return null. We can optionally prefer to return an object of type ``\Mockery\Undefined`` (i.e. a ``null`` object) (which was the 0.7.2 behaviour) by using an additional modifier: .. code-block:: php \Mockery::mock('MyClass')->shouldIgnoreMissing()->asUndefined(); The returned object is nothing more than a placeholder so if, by some act of fate, it's erroneously used somewhere it shouldn't it will likely not pass a logic check. We have encountered the ``makePartial()`` method before, as it is the method we use to create runtime partial test doubles: .. code-block:: php \Mockery::mock('MyClass')->makePartial(); This form of mock object will defer all methods not subject to an expectation to the parent class of the mock, i.e. ``MyClass``. Whereas the previous ``shouldIgnoreMissing()`` returned ``null``, this behaviour simply calls the parent's matching method. docs/reference/instance_mocking.rst000064400000001445150031475740013511 0ustar00.. index:: single: Mocking; Instance Instance Mocking ================ Instance mocking means that a statement like: .. code-block:: php $obj = new \MyNamespace\Foo; ...will actually generate a mock object. This is done by replacing the real class with an instance mock (similar to an alias mock), as with mocking public methods. The alias will import its expectations from the original mock of that type (note that the original is never verified and should be ignored after its expectations are setup). This lets you intercept instantiation where you can't simply inject a replacement object. As before, this does not prevent a require statement from including the real class and triggering a fatal PHP error. It's intended for use where autoloading is the primary class loading mechanism. docs/reference/map.rst.inc000064400000001046150031475740011520 0ustar00* :doc:`/reference/creating_test_doubles` * :doc:`/reference/expectations` * :doc:`/reference/argument_validation` * :doc:`/reference/alternative_should_receive_syntax` * :doc:`/reference/spies` * :doc:`/reference/partial_mocks` * :doc:`/reference/protected_methods` * :doc:`/reference/public_properties` * :doc:`/reference/public_static_properties` * :doc:`/reference/pass_by_reference_behaviours` * :doc:`/reference/demeter_chains` * :doc:`/reference/final_methods_classes` * :doc:`/reference/magic_methods` * :doc:`/reference/phpunit_integration` docs/reference/phpunit_integration.rst000064400000011365150031475740014272 0ustar00.. index:: single: PHPUnit Integration PHPUnit Integration =================== Mockery was designed as a simple-to-use *standalone* mock object framework, so its need for integration with any testing framework is entirely optional. To integrate Mockery, we need to define a ``tearDown()`` method for our tests containing the following (we may use a shorter ``\Mockery`` namespace alias): .. code-block:: php public function tearDown() { \Mockery::close(); } This static call cleans up the Mockery container used by the current test, and run any verification tasks needed for our expectations. For some added brevity when it comes to using Mockery, we can also explicitly use the Mockery namespace with a shorter alias. For example: .. code-block:: php use \Mockery as m; class SimpleTest extends \PHPUnit\Framework\TestCase { public function testSimpleMock() { $mock = m::mock('simplemock'); $mock->shouldReceive('foo')->with(5, m::any())->once()->andReturn(10); $this->assertEquals(10, $mock->foo(5)); } public function tearDown() { m::close(); } } Mockery ships with an autoloader so we don't need to litter our tests with ``require_once()`` calls. To use it, ensure Mockery is on our ``include_path`` and add the following to our test suite's ``Bootstrap.php`` or ``TestHelper.php`` file: .. code-block:: php require_once 'Mockery/Loader.php'; require_once 'Hamcrest/Hamcrest.php'; $loader = new \Mockery\Loader; $loader->register(); If we are using Composer, we can simplify this to including the Composer generated autoloader file: .. code-block:: php require __DIR__ . '/../vendor/autoload.php'; // assuming vendor is one directory up .. caution:: Prior to Hamcrest 1.0.0, the ``Hamcrest.php`` file name had a small "h" (i.e. ``hamcrest.php``). If upgrading Hamcrest to 1.0.0 remember to check the file name is updated for all your projects.) To integrate Mockery into PHPUnit and avoid having to call the close method and have Mockery remove itself from code coverage reports, have your test case extends the ``\Mockery\Adapter\Phpunit\MockeryTestCase``: .. code-block:: php class MyTest extends \Mockery\Adapter\Phpunit\MockeryTestCase { } An alternative is to use the supplied trait: .. code-block:: php class MyTest extends \PHPUnit\Framework\TestCase { use \Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration; } Extending ``MockeryTestCase`` or using the ``MockeryPHPUnitIntegration`` trait is **the recommended way** of integrating Mockery with PHPUnit, since Mockery 1.0.0. PHPUnit listener ---------------- Before the 1.0.0 release, Mockery provided a PHPUnit listener that would call ``Mockery::close()`` for us at the end of a test. This has changed significantly since the 1.0.0 version. Now, Mockery provides a PHPUnit listener that makes tests fail if ``Mockery::close()`` has not been called. It can help identify tests where we've forgotten to include the trait or extend the ``MockeryTestCase``. If we are using PHPUnit's XML configuration approach, we can include the following to load the ``TestListener``: .. code-block:: xml Make sure Composer's or Mockery's autoloader is present in the bootstrap file or we will need to also define a "file" attribute pointing to the file of the ``TestListener`` class. If we are creating the test suite programmatically we may add the listener like this: .. code-block:: php // Create the suite. $suite = new PHPUnit\Framework\TestSuite(); // Create the listener and add it to the suite. $result = new PHPUnit\Framework\TestResult(); $result->addListener(new \Mockery\Adapter\Phpunit\TestListener()); // Run the tests. $suite->run($result); .. caution:: PHPUnit provides a functionality that allows `tests to run in a separated process `_, to ensure better isolation. Mockery verifies the mocks expectations using the ``Mockery::close()`` method, and provides a PHPUnit listener, that automatically calls this method for us after every test. However, this listener is not called in the right process when using PHPUnit's process isolation, resulting in expectations that might not be respected, but without raising any ``Mockery\Exception``. To avoid this, we cannot rely on the supplied Mockery PHPUnit ``TestListener``, and we need to explicitly call ``Mockery::close``. The easiest solution to include this call in the ``tearDown()`` method, as explained previously. docs/reference/demeter_chains.rst000064400000003147150031475740013151 0ustar00.. index:: single: Mocking; Demeter Chains Mocking Demeter Chains And Fluent Interfaces ============================================ Both of these terms refer to the growing practice of invoking statements similar to: .. code-block:: php $object->foo()->bar()->zebra()->alpha()->selfDestruct(); The long chain of method calls isn't necessarily a bad thing, assuming they each link back to a local object the calling class knows. As a fun example, Mockery's long chains (after the first ``shouldReceive()`` method) all call to the same instance of ``\Mockery\Expectation``. However, sometimes this is not the case and the chain is constantly crossing object boundaries. In either case, mocking such a chain can be a horrible task. To make it easier Mockery supports demeter chain mocking. Essentially, we shortcut through the chain and return a defined value from the final call. For example, let's assume ``selfDestruct()`` returns the string "Ten!" to $object (an instance of ``CaptainsConsole``). Here's how we could mock it. .. code-block:: php $mock = \Mockery::mock('CaptainsConsole'); $mock->shouldReceive('foo->bar->zebra->alpha->selfDestruct')->andReturn('Ten!'); The above expectation can follow any previously seen format or expectation, except that the method name is simply the string of all expected chain calls separated by ``->``. Mockery will automatically setup the chain of expected calls with its final return values, regardless of whatever intermediary object might be used in the real implementation. Arguments to all members of the chain (except the final call) are ignored in this process. docs/reference/partial_mocks.rst000064400000010276150031475740013030 0ustar00.. index:: single: Mocking; Partial Mocks Creating Partial Mocks ====================== Partial mocks are useful when we only need to mock several methods of an object leaving the remainder free to respond to calls normally (i.e. as implemented). Mockery implements three distinct strategies for creating partials. Each has specific advantages and disadvantages so which strategy we use will depend on our own preferences and the source code in need of mocking. We have previously talked a bit about :ref:`creating-test-doubles-partial-test-doubles`, but we'd like to expand on the subject a bit here. #. Runtime partial test doubles #. Generated partial test doubles #. Proxied Partial Mock Runtime partial test doubles ---------------------------- A runtime partial test double, also known as a passive partial mock, is a kind of a default state of being for a mocked object. .. code-block:: php $mock = \Mockery::mock('MyClass')->makePartial(); With a runtime partial, we assume that all methods will simply defer to the parent class (``MyClass``) original methods unless a method call matches a known expectation. If we have no matching expectation for a specific method call, that call is deferred to the class being mocked. Since the division between mocked and unmocked calls depends entirely on the expectations we define, there is no need to define which methods to mock in advance. See the cookbook entry on :doc:`../cookbook/big_parent_class` for an example usage of runtime partial test doubles. Generated Partial Test Doubles ------------------------------ A generated partial test double, also known as a traditional partial mock, defines ahead of time which methods of a class are to be mocked and which are to be left unmocked (i.e. callable as normal). The syntax for creating traditional mocks is: .. code-block:: php $mock = \Mockery::mock('MyClass[foo,bar]'); In the above example, the ``foo()`` and ``bar()`` methods of MyClass will be mocked but no other MyClass methods are touched. We will need to define expectations for the ``foo()`` and ``bar()`` methods to dictate their mocked behaviour. Don't forget that we can pass in constructor arguments since unmocked methods may rely on those! .. code-block:: php $mock = \Mockery::mock('MyNamespace\MyClass[foo]', array($arg1, $arg2)); See the :ref:`creating-test-doubles-constructor-arguments` section to read up on them. .. note:: Even though we support generated partial test doubles, we do not recommend using them. Proxied Partial Mock -------------------- A proxied partial mock is a partial of last resort. We may encounter a class which is simply not capable of being mocked because it has been marked as final. Similarly, we may find a class with methods marked as final. In such a scenario, we cannot simply extend the class and override methods to mock - we need to get creative. .. code-block:: php $mock = \Mockery::mock(new MyClass); Yes, the new mock is a Proxy. It intercepts calls and reroutes them to the proxied object (which we construct and pass in) for methods which are not subject to any expectations. Indirectly, this allows us to mock methods marked final since the Proxy is not subject to those limitations. The tradeoff should be obvious - a proxied partial will fail any typehint checks for the class being mocked since it cannot extend that class. Special Internal Cases ---------------------- All mock objects, with the exception of Proxied Partials, allows us to make any expectation call to the underlying real class method using the ``passthru()`` expectation call. This will return values from the real call and bypass any mocked return queue (which can simply be omitted obviously). There is a fourth kind of partial mock reserved for internal use. This is automatically generated when we attempt to mock a class containing methods marked final. Since we cannot override such methods, they are simply left unmocked. Typically, we don't need to worry about this but if we really really must mock a final method, the only possible means is through a Proxied Partial Mock. SplFileInfo, for example, is a common class subject to this form of automatic internal partial since it contains public final methods used internally. docs/reference/public_properties.rst000064400000001465150031475740013732 0ustar00.. index:: single: Mocking; Public Properties Mocking Public Properties ========================= Mockery allows us to mock properties in several ways. One way is that we can set a public property and its value on any mock object. The second is that we can use the expectation methods ``set()`` and ``andSet()`` to set property values if that expectation is ever met. You can read more about :ref:`expectations-setting-public-properties`. .. note:: In general, Mockery does not support mocking any magic methods since these are generally not considered a public API (and besides it is a bit difficult to differentiate them when you badly need them for mocking!). So please mock virtual properties (those relying on ``__get()`` and ``__set()``) as if they were actually declared on the class. docs/reference/index.rst000064400000000620150031475740011277 0ustar00Reference ========= .. toctree:: :hidden: creating_test_doubles expectations argument_validation alternative_should_receive_syntax spies partial_mocks protected_methods public_properties public_static_properties pass_by_reference_behaviours demeter_chains final_methods_classes magic_methods phpunit_integration .. include:: map.rst.inc docs/reference/expectations.rst000064400000037113150031475740012705 0ustar00.. index:: single: Expectations Expectation Declarations ======================== .. note:: In order for our expectations to work we MUST call ``Mockery::close()``, preferably in a callback method such as ``tearDown`` or ``_after`` (depending on whether or not we're integrating Mockery with another framework). This static call cleans up the Mockery container used by the current test, and run any verification tasks needed for our expectations. Once we have created a mock object, we'll often want to start defining how exactly it should behave (and how it should be called). This is where the Mockery expectation declarations take over. Declaring Method Call Expectations ---------------------------------- To tell our test double to expect a call for a method with a given name, we use the ``shouldReceive`` method: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method'); This is the starting expectation upon which all other expectations and constraints are appended. We can declare more than one method call to be expected: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method_1', 'name_of_method_2'); All of these will adopt any chained expectations or constraints. It is possible to declare the expectations for the method calls, along with their return values: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive([ 'name_of_method_1' => 'return value 1', 'name_of_method_2' => 'return value 2', ]); There's also a shorthand way of setting up method call expectations and their return values: .. code-block:: php $mock = \Mockery::mock('MyClass', ['name_of_method_1' => 'return value 1', 'name_of_method_2' => 'return value 2']); All of these will adopt any additional chained expectations or constraints. We can declare that a test double should not expect a call to the given method name: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldNotReceive('name_of_method'); This method is a convenience method for calling ``shouldReceive()->never()``. Declaring Method Argument Expectations -------------------------------------- For every method we declare expectation for, we can add constraints that the defined expectations apply only to the method calls that match the expected argument list: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->with($arg1, $arg2, ...); // or $mock->shouldReceive('name_of_method') ->withArgs([$arg1, $arg2, ...]); We can add a lot more flexibility to argument matching using the built in matcher classes (see later). For example, ``\Mockery::any()`` matches any argument passed to that position in the ``with()`` parameter list. Mockery also allows Hamcrest library matchers - for example, the Hamcrest function ``anything()`` is equivalent to ``\Mockery::any()``. It's important to note that this means all expectations attached only apply to the given method when it is called with these exact arguments: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo')->with('Hello'); $mock->foo('Goodbye'); // throws a NoMatchingExpectationException This allows for setting up differing expectations based on the arguments provided to expected calls. Argument matching with closures ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Instead of providing a built-in matcher for each argument, we can provide a closure that matches all passed arguments at once: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->withArgs(closure); The given closure receives all the arguments passed in the call to the expected method. In this way, this expectation only applies to method calls where passed arguments make the closure evaluate to true: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo')->withArgs(function ($arg) { if ($arg % 2 == 0) { return true; } return false; }); $mock->foo(4); // matches the expectation $mock->foo(3); // throws a NoMatchingExpectationException Argument matching with some of given values ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ We can provide expected arguments that match passed arguments when mocked method is called. .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->withSomeOfArgs(arg1, arg2, arg3, ...); The given expected arguments order doesn't matter. Check if expected values are included or not, but type should be matched: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->withSomeOfArgs(1, 2); $mock->foo(1, 2, 3); // matches the expectation $mock->foo(3, 2, 1); // matches the expectation (passed order doesn't matter) $mock->foo('1', '2'); // throws a NoMatchingExpectationException (type should be matched) $mock->foo(3); // throws a NoMatchingExpectationException Any, or no arguments ^^^^^^^^^^^^^^^^^^^^ We can declare that the expectation matches a method call regardless of what arguments are passed: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->withAnyArgs(); This is set by default unless otherwise specified. We can declare that the expectation matches method calls with zero arguments: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->withNoArgs(); Declaring Return Value Expectations ----------------------------------- For mock objects, we can tell Mockery what return values to return from the expected method calls. For that we can use the ``andReturn()`` method: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->andReturn($value); This sets a value to be returned from the expected method call. It is possible to set up expectation for multiple return values. By providing a sequence of return values, we tell Mockery what value to return on every subsequent call to the method: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->andReturn($value1, $value2, ...) The first call will return ``$value1`` and the second call will return ``$value2``. If we call the method more times than the number of return values we declared, Mockery will return the final value for any subsequent method call: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo')->andReturn(1, 2, 3); $mock->foo(); // int(1) $mock->foo(); // int(2) $mock->foo(); // int(3) $mock->foo(); // int(3) The same can be achieved using the alternative syntax: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->andReturnValues([$value1, $value2, ...]) It accepts a simple array instead of a list of parameters. The order of return is determined by the numerical index of the given array with the last array member being returned on all calls once previous return values are exhausted. The following two options are primarily for communication with test readers: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->andReturnNull(); // or $mock->shouldReceive('name_of_method') ->andReturn([null]); They mark the mock object method call as returning ``null`` or nothing. Sometimes we want to calculate the return results of the method calls, based on the arguments passed to the method. We can do that with the ``andReturnUsing()`` method which accepts one or more closure: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->andReturnUsing(closure, ...); Closures can be queued by passing them as extra parameters as for ``andReturn()``. Occasionally, it can be useful to echo back one of the arguments that a method is called with. In this case we can use the ``andReturnArg()`` method; the argument to be returned is specified by its index in the arguments list: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->andReturnArg(1); This returns the second argument (index #1) from the list of arguments when the method is called. .. note:: We cannot currently mix ``andReturnUsing()`` or ``andReturnArg`` with ``andReturn()``. If we are mocking fluid interfaces, the following method will be helpful: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->andReturnSelf(); It sets the return value to the mocked class name. Throwing Exceptions ------------------- We can tell the method of mock objects to throw exceptions: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->andThrow(new Exception); It will throw the given ``Exception`` object when called. Rather than an object, we can pass in the ``Exception`` class, message and/or code to use when throwing an ``Exception`` from the mocked method: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->andThrow('exception_name', 'message', 123456789); .. _expectations-setting-public-properties: Setting Public Properties ------------------------- Used with an expectation so that when a matching method is called, we can cause a mock object's public property to be set to a specified value, by using ``andSet()`` or ``set()``: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->andSet($property, $value); // or $mock->shouldReceive('name_of_method') ->set($property, $value); In cases where we want to call the real method of the class that was mocked and return its result, the ``passthru()`` method tells the expectation to bypass a return queue: .. code-block:: php passthru() It allows expectation matching and call count validation to be applied against real methods while still calling the real class method with the expected arguments. Declaring Call Count Expectations --------------------------------- Besides setting expectations on the arguments of the method calls, and the return values of those same calls, we can set expectations on how many times should any method be called. When a call count expectation is not met, a ``\Mockery\Expectation\InvalidCountException`` will be thrown. .. note:: It is absolutely required to call ``\Mockery::close()`` at the end of our tests, for example in the ``tearDown()`` method of PHPUnit. Otherwise Mockery will not verify the calls made against our mock objects. We can declare that the expected method may be called zero or more times: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->zeroOrMoreTimes(); This is the default for all methods unless otherwise set. To tell Mockery to expect an exact number of calls to a method, we can use the following: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->times($n); where ``$n`` is the number of times the method should be called. A couple of most common cases got their shorthand methods. To declare that the expected method must be called one time only: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->once(); To declare that the expected method must be called two times: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->twice(); To declare that the expected method must never be called: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->never(); Call count modifiers ^^^^^^^^^^^^^^^^^^^^ The call count expectations can have modifiers set. If we want to tell Mockery the minimum number of times a method should be called, we use ``atLeast()``: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->atLeast() ->times(3); ``atLeast()->times(3)`` means the call must be called at least three times (given matching method args) but never less than three times. Similarly, we can tell Mockery the maximum number of times a method should be called, using ``atMost()``: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->atMost() ->times(3); ``atMost()->times(3)`` means the call must be called no more than three times. If the method gets no calls at all, the expectation will still be met. We can also set a range of call counts, using ``between()``: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method') ->between($min, $max); This is actually identical to using ``atLeast()->times($min)->atMost()->times($max)`` but is provided as a shorthand. It may be followed by a ``times()`` call with no parameter to preserve the APIs natural language readability. Multiple Calls with Different Expectations ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If a method is expected to get called multiple times with different arguments and/or return values we can simply repeat the expectations. The same of course also works if we expect multiple calls to different methods. .. code-block:: php $mock = \Mockery::mock('MyClass'); // Expectations for the 1st call $mock->shouldReceive('name_of_method'); ->once() ->with('arg1') ->andReturn($value1) // 2nd call to same method ->shouldReceive('name_of_method') ->once() ->with('arg2') ->andReturn($value2) // final call to another method ->shouldReceive('other_method') ->once() ->with('other') ->andReturn($value_other); Expectation Declaration Utilities --------------------------------- Declares that this method is expected to be called in a specific order in relation to similarly marked methods. .. code-block:: php ordered() The order is dictated by the order in which this modifier is actually used when setting up mocks. Declares the method as belonging to an order group (which can be named or numbered). Methods within a group can be called in any order, but the ordered calls from outside the group are ordered in relation to the group: .. code-block:: php ordered(group) We can set up so that method1 is called before group1 which is in turn called before method2. When called prior to ``ordered()`` or ``ordered(group)``, it declares this ordering to apply across all mock objects (not just the current mock): .. code-block:: php globally() This allows for dictating order expectations across multiple mocks. The ``byDefault()`` marks an expectation as a default. Default expectations are applied unless a non-default expectation is created: .. code-block:: php byDefault() These later expectations immediately replace the previously defined default. This is useful so we can setup default mocks in our unit test ``setup()`` and later tweak them in specific tests as needed. Returns the current mock object from an expectation chain: .. code-block:: php getMock() Useful where we prefer to keep mock setups as a single statement, e.g.: .. code-block:: php $mock = \Mockery::mock('foo')->shouldReceive('foo')->andReturn(1)->getMock(); docs/reference/pass_by_reference_behaviours.rst000064400000010342150031475740016077 0ustar00.. index:: single: Pass-By-Reference Method Parameter Behaviour Preserving Pass-By-Reference Method Parameter Behaviour ======================================================= PHP Class method may accept parameters by reference. In this case, changes made to the parameter (a reference to the original variable passed to the method) are reflected in the original variable. An example: .. code-block:: php class Foo { public function bar(&$a) { $a++; } } $baz = 1; $foo = new Foo; $foo->bar($baz); echo $baz; // will echo the integer 2 In the example above, the variable ``$baz`` is passed by reference to ``Foo::bar()`` (notice the ``&`` symbol in front of the parameter?). Any change ``bar()`` makes to the parameter reference is reflected in the original variable, ``$baz``. Mockery handles references correctly for all methods where it can analyse the parameter (using ``Reflection``) to see if it is passed by reference. To mock how a reference is manipulated by the class method, we can use a closure argument matcher to manipulate it, i.e. ``\Mockery::on()`` - see the :ref:`argument-validation-complex-argument-validation` chapter. There is an exception for internal PHP classes where Mockery cannot analyse method parameters using ``Reflection`` (a limitation in PHP). To work around this, we can explicitly declare method parameters for an internal class using ``\Mockery\Configuration::setInternalClassMethodParamMap()``. Here's an example using ``MongoCollection::insert()``. ``MongoCollection`` is an internal class offered by the mongo extension from PECL. Its ``insert()`` method accepts an array of data as the first parameter, and an optional options array as the second parameter. The original data array is updated (i.e. when a ``insert()`` pass-by-reference parameter) to include a new ``_id`` field. We can mock this behaviour using a configured parameter map (to tell Mockery to expect a pass by reference parameter) and a ``Closure`` attached to the expected method parameter to be updated. Here's a PHPUnit unit test verifying that this pass-by-reference behaviour is preserved: .. code-block:: php public function testCanOverrideExpectedParametersOfInternalPHPClassesToPreserveRefs() { \Mockery::getConfiguration()->setInternalClassMethodParamMap( 'MongoCollection', 'insert', array('&$data', '$options = array()') ); $m = \Mockery::mock('MongoCollection'); $m->shouldReceive('insert')->with( \Mockery::on(function(&$data) { if (!is_array($data)) return false; $data['_id'] = 123; return true; }), \Mockery::any() ); $data = array('a'=>1,'b'=>2); $m->insert($data); $this->assertTrue(isset($data['_id'])); $this->assertEquals(123, $data['_id']); \Mockery::resetContainer(); } Protected Methods ----------------- When dealing with protected methods, and trying to preserve pass by reference behavior for them, a different approach is required. .. code-block:: php class Model { public function test(&$data) { return $this->doTest($data); } protected function doTest(&$data) { $data['something'] = 'wrong'; return $this; } } class Test extends \PHPUnit\Framework\TestCase { public function testModel() { $mock = \Mockery::mock('Model[test]')->shouldAllowMockingProtectedMethods(); $mock->shouldReceive('test') ->with(\Mockery::on(function(&$data) { $data['something'] = 'wrong'; return true; })); $data = array('foo' => 'bar'); $mock->test($data); $this->assertTrue(isset($data['something'])); $this->assertEquals('wrong', $data['something']); } } This is quite an edge case, so we need to change the original code a little bit, by creating a public method that will call our protected method, and then mock that, instead of the protected method. This new public method will act as a proxy to our protected method. docs/reference/protected_methods.rst000064400000001234150031475740013706 0ustar00.. index:: single: Mocking; Protected Methods Mocking Protected Methods ========================= By default, Mockery does not allow mocking protected methods. We do not recommend mocking protected methods, but there are cases when there is no other solution. For those cases we have the ``shouldAllowMockingProtectedMethods()`` method. It instructs Mockery to specifically allow mocking of protected methods, for that one class only: .. code-block:: php class MyClass { protected function foo() { } } $mock = \Mockery::mock('MyClass') ->shouldAllowMockingProtectedMethods(); $mock->shouldReceive('foo'); docs/reference/argument_validation.rst000064400000024771150031475740014241 0ustar00.. index:: single: Argument Validation Argument Validation =================== The arguments passed to the ``with()`` declaration when setting up an expectation determine the criteria for matching method calls to expectations. Thus, we can setup up many expectations for a single method, each differentiated by the expected arguments. Such argument matching is done on a "best fit" basis. This ensures explicit matches take precedence over generalised matches. An explicit match is merely where the expected argument and the actual argument are easily equated (i.e. using ``===`` or ``==``). More generalised matches are possible using regular expressions, class hinting and the available generic matchers. The purpose of generalised matchers is to allow arguments be defined in non-explicit terms, e.g. ``Mockery::any()`` passed to ``with()`` will match **any** argument in that position. Mockery's generic matchers do not cover all possibilities but offers optional support for the Hamcrest library of matchers. Hamcrest is a PHP port of the similarly named Java library (which has been ported also to Python, Erlang, etc). By using Hamcrest, Mockery does not need to duplicate Hamcrest's already impressive utility which itself promotes a natural English DSL. The examples below show Mockery matchers and their Hamcrest equivalent, if there is one. Hamcrest uses functions (no namespacing). .. note:: If you don't wish to use the global Hamcrest functions, they are all exposed through the ``\Hamcrest\Matchers`` class as well, as static methods. Thus, ``identicalTo($arg)`` is the same as ``\Hamcrest\Matchers::identicalTo($arg)`` The most common matcher is the ``with()`` matcher: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->with(1): It tells mockery that it should receive a call to the ``foo`` method with the integer ``1`` as an argument. In cases like this, Mockery first tries to match the arguments using ``===`` (identical) comparison operator. If the argument is a primitive, and if it fails the identical comparison, Mockery does a fallback to the ``==`` (equals) comparison operator. When matching objects as arguments, Mockery only does the strict ``===`` comparison, which means only the same ``$object`` will match: .. code-block:: php $object = new stdClass(); $mock = \Mockery::mock('MyClass'); $mock->shouldReceive("foo") ->with($object); // Hamcrest equivalent $mock->shouldReceive("foo") ->with(identicalTo($object)); A different instance of ``stdClass`` will **not** match. .. note:: The ``Mockery\Matcher\MustBe`` matcher has been deprecated. If we need a loose comparison of objects, we can do that using Hamcrest's ``equalTo`` matcher: .. code-block:: php $mock->shouldReceive("foo") ->with(equalTo(new stdClass)); In cases when we don't care about the type, or the value of an argument, just that any argument is present, we use ``any()``: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive("foo") ->with(\Mockery::any()); // Hamcrest equivalent $mock->shouldReceive("foo") ->with(anything()) Anything and everything passed in this argument slot is passed unconstrained. Validating Types and Resources ------------------------------ The ``type()`` matcher accepts any string which can be attached to ``is_`` to form a valid type check. To match any PHP resource, we could do the following: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive("foo") ->with(\Mockery::type('resource')); // Hamcrest equivalents $mock->shouldReceive("foo") ->with(resourceValue()); $mock->shouldReceive("foo") ->with(typeOf('resource')); It will return a ``true`` from an ``is_resource()`` call, if the provided argument to the method is a PHP resource. For example, ``\Mockery::type('float')`` or Hamcrest's ``floatValue()`` and ``typeOf('float')`` checks use ``is_float()``, and ``\Mockery::type('callable')`` or Hamcrest's ``callable()`` uses ``is_callable()``. The ``type()`` matcher also accepts a class or interface name to be used in an ``instanceof`` evaluation of the actual argument. Hamcrest uses ``anInstanceOf()``. A full list of the type checkers is available at `php.net `_ or browse Hamcrest's function list in `the Hamcrest code `_. .. _argument-validation-complex-argument-validation: Complex Argument Validation --------------------------- If we want to perform a complex argument validation, the ``on()`` matcher is invaluable. It accepts a closure (anonymous function) to which the actual argument will be passed. .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive("foo") ->with(\Mockery::on(closure)); If the closure evaluates to (i.e. returns) boolean ``true`` then the argument is assumed to have matched the expectation. .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->with(\Mockery::on(function ($argument) { if ($argument % 2 == 0) { return true; } return false; })); $mock->foo(4); // matches the expectation $mock->foo(3); // throws a NoMatchingExpectationException .. note:: There is no Hamcrest version of the ``on()`` matcher. We can also perform argument validation by passing a closure to ``withArgs()`` method. The closure will receive all arguments passed in the call to the expected method and if it evaluates (i.e. returns) to boolean ``true``, then the list of arguments is assumed to have matched the expectation: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive("foo") ->withArgs(closure); The closure can also handle optional parameters, so if an optional parameter is missing in the call to the expected method, it doesn't necessary means that the list of arguments doesn't match the expectation. .. code-block:: php $closure = function ($odd, $even, $sum = null) { $result = ($odd % 2 != 0) && ($even % 2 == 0); if (!is_null($sum)) { return $result && ($odd + $even == $sum); } return $result; }; $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo')->withArgs($closure); $mock->foo(1, 2); // It matches the expectation: the optional argument is not needed $mock->foo(1, 2, 3); // It also matches the expectation: the optional argument pass the validation $mock->foo(1, 2, 4); // It doesn't match the expectation: the optional doesn't pass the validation .. note:: In previous versions, Mockery's ``with()`` would attempt to do a pattern matching against the arguments, attempting to use the argument as a regular expression. Over time this proved to be not such a great idea, so we removed this functionality, and have introduced ``Mockery::pattern()`` instead. If we would like to match an argument against a regular expression, we can use the ``\Mockery::pattern()``: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->with(\Mockery::pattern('/^foo/')); // Hamcrest equivalent $mock->shouldReceive('foo') ->with(matchesPattern('/^foo/')); The ``ducktype()`` matcher is an alternative to matching by class type: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->with(\Mockery::ducktype('foo', 'bar')); It matches any argument which is an object containing the provided list of methods to call. .. note:: There is no Hamcrest version of the ``ducktype()`` matcher. Capturing Arguments ------------------- If we want to perform multiple validations on a single argument, the ``capture`` matcher provides a streamlined alternative to using the ``on()`` matcher. It accepts a variable which the actual argument will be assigned. .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive("foo") ->with(\Mockery::capture($bar)); This will assign *any* argument passed to ``foo`` to the local ``$bar`` variable to then perform additional validation using assertions. .. note:: The ``capture`` matcher always evaluates to ``true``. As such, we should always perform additional argument validation. Additional Argument Matchers ---------------------------- The ``not()`` matcher matches any argument which is not equal or identical to the matcher's parameter: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->with(\Mockery::not(2)); // Hamcrest equivalent $mock->shouldReceive('foo') ->with(not(2)); ``anyOf()`` matches any argument which equals any one of the given parameters: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->with(\Mockery::anyOf(1, 2)); // Hamcrest equivalent $mock->shouldReceive('foo') ->with(anyOf(1,2)); ``notAnyOf()`` matches any argument which is not equal or identical to any of the given parameters: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->with(\Mockery::notAnyOf(1, 2)); .. note:: There is no Hamcrest version of the ``notAnyOf()`` matcher. ``subset()`` matches any argument which is any array containing the given array subset: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->with(\Mockery::subset(array(0 => 'foo'))); This enforces both key naming and values, i.e. both the key and value of each actual element is compared. .. note:: There is no Hamcrest version of this functionality, though Hamcrest can check a single entry using ``hasEntry()`` or ``hasKeyValuePair()``. ``contains()`` matches any argument which is an array containing the listed values: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->with(\Mockery::contains(value1, value2)); The naming of keys is ignored. ``hasKey()`` matches any argument which is an array containing the given key name: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->with(\Mockery::hasKey(key)); ``hasValue()`` matches any argument which is an array containing the given value: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->with(\Mockery::hasValue(value)); docs/reference/final_methods_classes.rst000064400000002507150031475740014527 0ustar00.. index:: single: Mocking; Final Classes/Methods Dealing with Final Classes/Methods ================================== One of the primary restrictions of mock objects in PHP, is that mocking classes or methods marked final is hard. The final keyword prevents methods so marked from being replaced in subclasses (subclassing is how mock objects can inherit the type of the class or object being mocked). The simplest solution is to implement an interface in your final class and typehint against / mock this. However this may not be possible in some third party libraries. Mockery does allow creating "proxy mocks" from classes marked final, or from classes with methods marked final. This offers all the usual mock object goodness but the resulting mock will not inherit the class type of the object being mocked, i.e. it will not pass any instanceof comparison. Methods marked as final will be proxied to the original method, i.e., final methods can't be mocked. We can create a proxy mock by passing the instantiated object we wish to mock into ``\Mockery::mock()``, i.e. Mockery will then generate a Proxy to the real object and selectively intercept method calls for the purposes of setting and meeting expectations. See the :ref:`creating-test-doubles-partial-test-doubles` chapter, the subsection about proxied partial test doubles. docs/reference/spies.rst000064400000011201150031475740011310 0ustar00.. index:: single: Reference; Spies Spies ===== Spies are a type of test doubles, but they differ from stubs or mocks in that, that the spies record any interaction between the spy and the System Under Test (SUT), and allow us to make assertions against those interactions after the fact. Creating a spy means we don't have to set up expectations for every method call the double might receive during the test, some of which may not be relevant to the current test. A spy allows us to make assertions about the calls we care about for this test only, reducing the chances of over-specification and making our tests more clear. Spies also allow us to follow the more familiar Arrange-Act-Assert or Given-When-Then style within our tests. With mocks, we have to follow a less familiar style, something along the lines of Arrange-Expect-Act-Assert, where we have to tell our mocks what to expect before we act on the SUT, then assert that those expectations where met: .. code-block:: php // arrange $mock = \Mockery::mock('MyDependency'); $sut = new MyClass($mock); // expect $mock->shouldReceive('foo') ->once() ->with('bar'); // act $sut->callFoo(); // assert \Mockery::close(); Spies allow us to skip the expect part and move the assertion to after we have acted on the SUT, usually making our tests more readable: .. code-block:: php // arrange $spy = \Mockery::spy('MyDependency'); $sut = new MyClass($spy); // act $sut->callFoo(); // assert $spy->shouldHaveReceived() ->foo() ->with('bar'); On the other hand, spies are far less restrictive than mocks, meaning tests are usually less precise, as they let us get away with more. This is usually a good thing, they should only be as precise as they need to be, but while spies make our tests more intent-revealing, they do tend to reveal less about the design of the SUT. If we're having to setup lots of expectations for a mock, in lots of different tests, our tests are trying to tell us something - the SUT is doing too much and probably should be refactored. We don't get this with spies, they simply ignore the calls that aren't relevant to them. Another downside to using spies is debugging. When a mock receives a call that it wasn't expecting, it immediately throws an exception (failing fast), giving us a nice stack trace or possibly even invoking our debugger. With spies, we're simply asserting calls were made after the fact, so if the wrong calls were made, we don't have quite the same just in time context we have with the mocks. Finally, if we need to define a return value for our test double, we can't do that with a spy, only with a mock object. .. note:: This documentation page is an adaption of the blog post titled `"Mockery Spies" `_, published by Dave Marshall on his blog. Dave is the original author of spies in Mockery. Spies Reference --------------- To verify that a method was called on a spy, we use the ``shouldHaveReceived()`` method: .. code-block:: php $spy->shouldHaveReceived('foo'); To verify that a method was **not** called on a spy, we use the ``shouldNotHaveReceived()`` method: .. code-block:: php $spy->shouldNotHaveReceived('foo'); We can also do argument matching with spies: .. code-block:: php $spy->shouldHaveReceived('foo') ->with('bar'); Argument matching is also possible by passing in an array of arguments to match: .. code-block:: php $spy->shouldHaveReceived('foo', ['bar']); Although when verifying a method was not called, the argument matching can only be done by supplying the array of arguments as the 2nd argument to the ``shouldNotHaveReceived()`` method: .. code-block:: php $spy->shouldNotHaveReceived('foo', ['bar']); This is due to Mockery's internals. Finally, when expecting calls that should have been received, we can also verify the number of calls: .. code-block:: php $spy->shouldHaveReceived('foo') ->with('bar') ->twice(); Alternative shouldReceive syntax ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ As of Mockery 1.0.0, we support calling methods as we would call any PHP method, and not as string arguments to Mockery ``should*`` methods. In cases of spies, this only applies to the ``shouldHaveReceived()`` method: .. code-block:: php $spy->shouldHaveReceived() ->foo('bar'); We can set expectation on number of calls as well: .. code-block:: php $spy->shouldHaveReceived() ->foo('bar') ->twice(); Unfortunately, due to limitations we can't support the same syntax for the ``shouldNotHaveReceived()`` method. docs/reference/magic_methods.rst000064400000001257150031475740013002 0ustar00.. index:: single: Mocking; Magic Methods PHP Magic Methods ================= PHP magic methods which are prefixed with a double underscore, e.g. ``__set()``, pose a particular problem in mocking and unit testing in general. It is strongly recommended that unit tests and mock objects do not directly refer to magic methods. Instead, refer only to the virtual methods and properties these magic methods simulate. Following this piece of advice will ensure we are testing the real API of classes and also ensures there is no conflict should Mockery override these magic methods, which it will inevitably do in order to support its role in intercepting method calls and properties. docs/index.rst000064400000003672150031475740007353 0ustar00Mockery ======= Mockery is a simple yet flexible PHP mock object framework for use in unit testing with PHPUnit, PHPSpec or any other testing framework. Its core goal is to offer a test double framework with a succinct API capable of clearly defining all possible object operations and interactions using a human readable Domain Specific Language (DSL). Designed as a drop in alternative to PHPUnit's phpunit-mock-objects library, Mockery is easy to integrate with PHPUnit and can operate alongside phpunit-mock-objects without the World ending. Mock Objects ------------ In unit tests, mock objects simulate the behaviour of real objects. They are commonly utilised to offer test isolation, to stand in for objects which do not yet exist, or to allow for the exploratory design of class APIs without requiring actual implementation up front. The benefits of a mock object framework are to allow for the flexible generation of such mock objects (and stubs). They allow the setting of expected method calls and return values using a flexible API which is capable of capturing every possible real object behaviour in way that is stated as close as possible to a natural language description. Getting Started --------------- Ready to dive into the Mockery framework? Then you can get started by reading the "Getting Started" section! .. toctree:: :hidden: getting_started/index .. include:: getting_started/map.rst.inc Reference --------- The reference contains a complete overview of all features of the Mockery framework. .. toctree:: :hidden: reference/index .. include:: reference/map.rst.inc Mockery ------- Learn about Mockery's configuration, reserved method names, exceptions... .. toctree:: :hidden: mockery/index .. include:: mockery/map.rst.inc Cookbook -------- Want to learn some easy tips and tricks? Take a look at the cookbook articles! .. toctree:: :hidden: cookbook/index .. include:: cookbook/map.rst.inc docs/README.md000064400000000124150031475740006756 0ustar00mockery-docs ============ Document for the PHP Mockery framework on readthedocs.orgdocs/getting_started/map.rst.inc000064400000000236150031475740012751 0ustar00* :doc:`/getting_started/installation` * :doc:`/getting_started/upgrading` * :doc:`/getting_started/simple_example` * :doc:`/getting_started/quick_reference` docs/getting_started/installation.rst000064400000002642150031475740014130 0ustar00.. index:: single: Installation Installation ============ Mockery can be installed using Composer or by cloning it from its GitHub repository. These two options are outlined below. Composer -------- You can read more about Composer on `getcomposer.org `_. To install Mockery using Composer, first install Composer for your project using the instructions on the `Composer download page `_. You can then define your development dependency on Mockery using the suggested parameters below. While every effort is made to keep the master branch stable, you may prefer to use the current stable version tag instead (use the ``@stable`` tag). .. code-block:: json { "require-dev": { "mockery/mockery": "dev-master" } } To install, you then may call: .. code-block:: bash php composer.phar update This will install Mockery as a development dependency, meaning it won't be installed when using ``php composer.phar update --no-dev`` in production. Other way to install is directly from composer command line, as below. .. code-block:: bash php composer.phar require --dev mockery/mockery Git --- The Git repository hosts the development version in its master branch. You can install this using Composer by referencing ``dev-master`` as your preferred version in your project's ``composer.json`` file as the earlier example shows. docs/getting_started/index.rst000064400000000234150031475740012531 0ustar00Getting Started =============== .. toctree:: :hidden: installation upgrading simple_example quick_reference .. include:: map.rst.inc docs/getting_started/simple_example.rst000064400000004103150031475740014425 0ustar00.. index:: single: Getting Started; Simple Example Simple Example ============== Imagine we have a ``Temperature`` class which samples the temperature of a locale before reporting an average temperature. The data could come from a web service or any other data source, but we do not have such a class at present. We can, however, assume some basic interactions with such a class based on its interaction with the ``Temperature`` class: .. code-block:: php class Temperature { private $service; public function __construct($service) { $this->service = $service; } public function average() { $total = 0; for ($i=0; $i<3; $i++) { $total += $this->service->readTemp(); } return $total/3; } } Even without an actual service class, we can see how we expect it to operate. When writing a test for the ``Temperature`` class, we can now substitute a mock object for the real service which allows us to test the behaviour of the ``Temperature`` class without actually needing a concrete service instance. .. code-block:: php use \Mockery; class TemperatureTest extends \PHPUnit\Framework\TestCase { public function tearDown() { Mockery::close(); } public function testGetsAverageTemperatureFromThreeServiceReadings() { $service = Mockery::mock('service'); $service->shouldReceive('readTemp') ->times(3) ->andReturn(10, 12, 14); $temperature = new Temperature($service); $this->assertEquals(12, $temperature->average()); } } We create a mock object which our ``Temperature`` class will use and set some expectations for that mock — that it should receive three calls to the ``readTemp`` method, and these calls will return 10, 12, and 14 as results. .. note:: PHPUnit integration can remove the need for a ``tearDown()`` method. See ":doc:`/reference/phpunit_integration`" for more information. docs/getting_started/quick_reference.rst000064400000012020150031475740014550 0ustar00.. index:: single: Quick Reference Quick Reference =============== The purpose of this page is to give a quick and short overview of some of the most common Mockery features. Do read the :doc:`../reference/index` to learn about all the Mockery features. Integrate Mockery with PHPUnit, either by extending the ``MockeryTestCase``: .. code-block:: php use \Mockery\Adapter\Phpunit\MockeryTestCase; class MyTest extends MockeryTestCase { } or by using the ``MockeryPHPUnitIntegration`` trait: .. code-block:: php use \PHPUnit\Framework\TestCase; use \Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration; class MyTest extends TestCase { use MockeryPHPUnitIntegration; } Creating a test double: .. code-block:: php $testDouble = \Mockery::mock('MyClass'); Creating a test double that implements a certain interface: .. code-block:: php $testDouble = \Mockery::mock('MyClass, MyInterface'); Expecting a method to be called on a test double: .. code-block:: php $testDouble = \Mockery::mock('MyClass'); $testDouble->shouldReceive('foo'); Expecting a method to **not** be called on a test double: .. code-block:: php $testDouble = \Mockery::mock('MyClass'); $testDouble->shouldNotReceive('foo'); Expecting a method to be called on a test double, once, with a certain argument, and to return a value: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->once() ->with($arg) ->andReturn($returnValue); Expecting a method to be called on a test double and to return a different value for each successive call: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('foo') ->andReturn(1, 2, 3); $mock->foo(); // int(1); $mock->foo(); // int(2); $mock->foo(); // int(3); $mock->foo(); // int(3); Creating a runtime partial test double: .. code-block:: php $mock = \Mockery::mock('MyClass')->makePartial(); Creating a spy: .. code-block:: php $spy = \Mockery::spy('MyClass'); Expecting that a spy should have received a method call: .. code-block:: php $spy = \Mockery::spy('MyClass'); $spy->foo(); $spy->shouldHaveReceived()->foo(); Not so simple examples ^^^^^^^^^^^^^^^^^^^^^^ Creating a mock object to return a sequence of values from a set of method calls: .. code-block:: php use \Mockery\Adapter\Phpunit\MockeryTestCase; class SimpleTest extends MockeryTestCase { public function testSimpleMock() { $mock = \Mockery::mock(array('pi' => 3.1416, 'e' => 2.71)); $this->assertEquals(3.1416, $mock->pi()); $this->assertEquals(2.71, $mock->e()); } } Creating a mock object which returns a self-chaining Undefined object for a method call: .. code-block:: php use \Mockery\Adapter\Phpunit\MockeryTestCase; class UndefinedTest extends MockeryTestCase { public function testUndefinedValues() { $mock = \Mockery::mock('mymock'); $mock->shouldReceive('divideBy')->with(0)->andReturnUndefined(); $this->assertTrue($mock->divideBy(0) instanceof \Mockery\Undefined); } } Creating a mock object with multiple query calls and a single update call: .. code-block:: php use \Mockery\Adapter\Phpunit\MockeryTestCase; class DbTest extends MockeryTestCase { public function testDbAdapter() { $mock = \Mockery::mock('db'); $mock->shouldReceive('query')->andReturn(1, 2, 3); $mock->shouldReceive('update')->with(5)->andReturn(NULL)->once(); // ... test code here using the mock } } Expecting all queries to be executed before any updates: .. code-block:: php use \Mockery\Adapter\Phpunit\MockeryTestCase; class DbTest extends MockeryTestCase { public function testQueryAndUpdateOrder() { $mock = \Mockery::mock('db'); $mock->shouldReceive('query')->andReturn(1, 2, 3)->ordered(); $mock->shouldReceive('update')->andReturn(NULL)->once()->ordered(); // ... test code here using the mock } } Creating a mock object where all queries occur after startup, but before finish, and where queries are expected with several different params: .. code-block:: php use \Mockery\Adapter\Phpunit\MockeryTestCase; class DbTest extends MockeryTestCase { public function testOrderedQueries() { $db = \Mockery::mock('db'); $db->shouldReceive('startup')->once()->ordered(); $db->shouldReceive('query')->with('CPWR')->andReturn(12.3)->once()->ordered('queries'); $db->shouldReceive('query')->with('MSFT')->andReturn(10.0)->once()->ordered('queries'); $db->shouldReceive('query')->with(\Mockery::pattern("/^....$/"))->andReturn(3.3)->atLeast()->once()->ordered('queries'); $db->shouldReceive('finish')->once()->ordered(); // ... test code here using the mock } } docs/getting_started/upgrading.rst000064400000005663150031475740013415 0ustar00.. index:: single: Upgrading Upgrading ========= Upgrading to 1.0.0 ------------------ Minimum PHP version +++++++++++++++++++ As of Mockery 1.0.0 the minimum PHP version required is 5.6. Using Mockery with PHPUnit ++++++++++++++++++++++++++ In the "old days", 0.9.x and older, the way Mockery was integrated with PHPUnit was through a PHPUnit listener. That listener would in turn call the ``\Mockery::close()`` method for us. As of 1.0.0, PHPUnit test cases where we want to use Mockery, should either use the ``\Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration`` trait, or extend the ``\Mockery\Adapter\Phpunit\MockeryTestCase`` test case. This will in turn call the ``\Mockery::close()`` method for us. Read the documentation for a detailed overview of ":doc:`/reference/phpunit_integration`". ``\Mockery\Matcher\MustBe`` is deprecated +++++++++++++++++++++++++++++++++++++++++ As of 1.0.0 the ``\Mockery\Matcher\MustBe`` matcher is deprecated and will be removed in Mockery 2.0.0. We recommend instead to use the PHPUnit or Hamcrest equivalents of the MustBe matcher. ``allows`` and ``expects`` ++++++++++++++++++++++++++ As of 1.0.0, Mockery has two new methods to set up expectations: ``allows`` and ``expects``. This means that these methods names are now "reserved" for Mockery, or in other words classes you want to mock with Mockery, can't have methods called ``allows`` or ``expects``. Read more in the documentation about this ":doc:`/reference/alternative_should_receive_syntax`". No more implicit regex matching for string arguments ++++++++++++++++++++++++++++++++++++++++++++++++++++ When setting up string arguments in method expectations, Mockery 0.9.x and older, would try to match arguments using a regular expression in a "last attempt" scenario. As of 1.0.0, Mockery will no longer attempt to do this regex matching, but will only try first the identical operator ``===``, and failing that, the equals operator ``==``. If you want to match an argument using regular expressions, please use the new ``\Mockery\Matcher\Pattern`` matcher. Read more in the documentation about this pattern matcher in the ":doc:`/reference/argument_validation`" section. ``andThrow`` ``\Throwable`` +++++++++++++++++++++++++++ As of 1.0.0, the ``andThrow`` can now throw any ``\Throwable``. Upgrading to 0.9 ---------------- The generator was completely rewritten, so any code with a deep integration to mockery will need evaluating. Upgrading to 0.8 ---------------- Since the release of 0.8.0 the following behaviours were altered: 1. The ``shouldIgnoreMissing()`` behaviour optionally applied to mock objects returned an instance of ``\Mockery\Undefined`` when methods called did not match a known expectation. Since 0.8.0, this behaviour was switched to returning ``null`` instead. You can restore the 0.7.2 behaviour by using the following: .. code-block:: php $mock = \Mockery::mock('stdClass')->shouldIgnoreMissing()->asUndefined(); docs/mockery/map.rst.inc000064400000000177150031475740011237 0ustar00* :doc:`/mockery/configuration` * :doc:`/mockery/exceptions` * :doc:`/mockery/reserved_method_names` * :doc:`/mockery/gotchas` docs/mockery/index.rst000064400000000215150031475740011012 0ustar00Mockery ======= .. toctree:: :hidden: configuration exceptions reserved_method_names gotchas .. include:: map.rst.inc docs/mockery/exceptions.rst000064400000005157150031475740012076 0ustar00.. index:: single: Mockery; Exceptions Mockery Exceptions ================== Mockery throws three types of exceptions when it cannot verify a mock object. #. ``\Mockery\Exception\InvalidCountException`` #. ``\Mockery\Exception\InvalidOrderException`` #. ``\Mockery\Exception\NoMatchingExpectationException`` You can capture any of these exceptions in a try...catch block to query them for specific information which is also passed along in the exception message but is provided separately from getters should they be useful when logging or reformatting output. \Mockery\Exception\InvalidCountException ---------------------------------------- The exception class is used when a method is called too many (or too few) times and offers the following methods: * ``getMock()`` - return actual mock object * ``getMockName()`` - return the name of the mock object * ``getMethodName()`` - return the name of the method the failing expectation is attached to * ``getExpectedCount()`` - return expected calls * ``getExpectedCountComparative()`` - returns a string, e.g. ``<=`` used to compare to actual count * ``getActualCount()`` - return actual calls made with given argument constraints \Mockery\Exception\InvalidOrderException ---------------------------------------- The exception class is used when a method is called outside the expected order set using the ``ordered()`` and ``globally()`` expectation modifiers. It offers the following methods: * ``getMock()`` - return actual mock object * ``getMockName()`` - return the name of the mock object * ``getMethodName()`` - return the name of the method the failing expectation is attached to * ``getExpectedOrder()`` - returns an integer represented the expected index for which this call was expected * ``getActualOrder()`` - return the actual index at which this method call occurred. \Mockery\Exception\NoMatchingExpectationException ------------------------------------------------- The exception class is used when a method call does not match any known expectation. All expectations are uniquely identified in a mock object by the method name and the list of expected arguments. You can disable this exception and opt for returning NULL from all unexpected method calls by using the earlier mentioned shouldIgnoreMissing() behaviour modifier. This exception class offers the following methods: * ``getMock()`` - return actual mock object * ``getMockName()`` - return the name of the mock object * ``getMethodName()`` - return the name of the method the failing expectation is attached to * ``getActualArguments()`` - return actual arguments used to search for a matching expectation docs/mockery/reserved_method_names.rst000064400000002125150031475740014247 0ustar00.. index:: single: Reserved Method Names Reserved Method Names ===================== As you may have noticed, Mockery uses a number of methods called directly on all mock objects, for example ``shouldReceive()``. Such methods are necessary in order to setup expectations on the given mock, and so they cannot be implemented on the classes or objects being mocked without creating a method name collision (reported as a PHP fatal error). The methods reserved by Mockery are: * ``shouldReceive()`` * ``shouldNotReceive()`` * ``allows()`` * ``expects()`` * ``shouldAllowMockingMethod()`` * ``shouldIgnoreMissing()`` * ``asUndefined()`` * ``shouldAllowMockingProtectedMethods()`` * ``makePartial()`` * ``byDefault()`` * ``shouldHaveReceived()`` * ``shouldHaveBeenCalled()`` * ``shouldNotHaveReceived()`` * ``shouldNotHaveBeenCalled()`` In addition, all mocks utilise a set of added methods and protected properties which cannot exist on the class or object being mocked. These are far less likely to cause collisions. All properties are prefixed with ``_mockery`` and all method names with ``mockery_``. docs/mockery/configuration.rst000064400000007636150031475740012570 0ustar00.. index:: single: Mockery; Configuration Mockery Global Configuration ============================ To allow for a degree of fine-tuning, Mockery utilises a singleton configuration object to store a small subset of core behaviours. The three currently present include: * Option to allow/disallow the mocking of methods which do not actually exist fulfilled (i.e. unused) * Setter/Getter for added a parameter map for internal PHP class methods (``Reflection`` cannot detect these automatically) * Option to drive if quick definitions should define a stub or a mock with an 'at least once' expectation. By default, the first behaviour is enabled. Of course, there are situations where this can lead to unintended consequences. The mocking of non-existent methods may allow mocks based on real classes/objects to fall out of sync with the actual implementations, especially when some degree of integration testing (testing of object wiring) is not being performed. You may allow or disallow this behaviour (whether for whole test suites or just select tests) by using the following call: .. code-block:: php \Mockery::getConfiguration()->allowMockingNonExistentMethods(bool); Passing a true allows the behaviour, false disallows it. It takes effect immediately until switched back. If the behaviour is detected when not allowed, it will result in an Exception being thrown at that point. Note that disallowing this behaviour should be carefully considered since it necessarily removes at least some of Mockery's flexibility. The other two methods are: .. code-block:: php \Mockery::getConfiguration()->setInternalClassMethodParamMap($class, $method, array $paramMap) \Mockery::getConfiguration()->getInternalClassMethodParamMap($class, $method) These are used to define parameters (i.e. the signature string of each) for the methods of internal PHP classes (e.g. SPL, or PECL extension classes like ext/mongo's MongoCollection. Reflection cannot analyse the parameters of internal classes. Most of the time, you never need to do this. It's mainly needed where an internal class method uses pass-by-reference for a parameter - you MUST in such cases ensure the parameter signature includes the ``&`` symbol correctly as Mockery won't correctly add it automatically for internal classes. Note that internal class parameter overriding is not available in PHP 8. This is because incompatible signatures have been reclassified as fatal errors. Finally there is the possibility to change what a quick definition produces. By default quick definitions create stubs but you can change this behaviour by asking Mockery to use 'at least once' expectations. .. code-block:: php \Mockery::getConfiguration()->getQuickDefinitions()->shouldBeCalledAtLeastOnce(bool) Passing a true allows the behaviour, false disallows it. It takes effect immediately until switched back. By doing so you can avoid the proliferating of quick definitions that accumulate overtime in your code since the test would fail in case the 'at least once' expectation is not fulfilled. Disabling reflection caching ---------------------------- Mockery heavily uses `"reflection" `_ to do it's job. To speed up things, Mockery caches internally the information it gathers via reflection. In some cases, this caching can cause problems. The **only** known situation when this occurs is when PHPUnit's ``--static-backup`` option is used. If you use ``--static-backup`` and you get an error that looks like the following: .. code-block:: php Error: Internal error: Failed to retrieve the reflection object We suggest turning off the reflection cache as so: .. code-block:: php \Mockery::getConfiguration()->disableReflectionCache(); Turning it back on can be done like so: .. code-block:: php \Mockery::getConfiguration()->enableReflectionCache(); In no other situation should you be required turn this reflection cache off. docs/mockery/gotchas.rst000064400000004637150031475740011347 0ustar00.. index:: single: Mockery; Gotchas Gotchas! ======== Mocking objects in PHP has its limitations and gotchas. Some functionality can't be mocked or can't be mocked YET! If you locate such a circumstance, please please (pretty please with sugar on top) create a new issue on GitHub so it can be documented and resolved where possible. Here is a list to note: 1. Classes containing public ``__wakeup()`` methods can be mocked but the mocked ``__wakeup()`` method will perform no actions and cannot have expectations set for it. This is necessary since Mockery must serialize and unserialize objects to avoid some ``__construct()`` insanity and attempting to mock a ``__wakeup()`` method as normal leads to a ``BadMethodCallException`` being thrown. 2. Mockery has two scenarios where real classes are replaced: Instance mocks and alias mocks. Both will generate PHP fatal errors if the real class is loaded, usually via a require or include statement. Only use these two mock types where autoloading is in place and where classes are not explicitly loaded on a per-file basis using ``require()``, ``require_once()``, etc. 3. Internal PHP classes are not entirely capable of being fully analysed using ``Reflection``. For example, ``Reflection`` cannot reveal details of expected parameters to the methods of such internal classes. As a result, there will be problems where a method parameter is defined to accept a value by reference (Mockery cannot detect this condition and will assume a pass by value on scalars and arrays). If references as internal class method parameters are needed, you should use the ``\Mockery\Configuration::setInternalClassMethodParamMap()`` method. Note, however that internal class parameter overriding is not available in PHP 8 since incompatible signatures have been reclassified as fatal errors. 4. Creating a mock implementing a certain interface with incorrect case in the interface name, and then creating a second mock implementing the same interface, but this time with the correct case, will have undefined behavior due to PHP's ``class_exists`` and related functions being case insensitive. Using the ``::class`` keyword in PHP can help you avoid these mistakes. The gotchas noted above are largely down to PHP's architecture and are assumed to be unavoidable. But - if you figure out a solution (or a better one than what may exist), let us know! README.md000064400000023714150031475740006040 0ustar00Mockery ======= [![Build Status](https://github.com/mockery/mockery/actions/workflows/tests.yml/badge.svg)](https://github.com/mockery/mockery/actions) [![Latest Stable Version](https://poser.pugx.org/mockery/mockery/v/stable.svg)](https://packagist.org/packages/mockery/mockery) [![Total Downloads](https://poser.pugx.org/mockery/mockery/downloads.svg)](https://packagist.org/packages/mockery/mockery) Mockery is a simple yet flexible PHP mock object framework for use in unit testing with PHPUnit, PHPSpec or any other testing framework. Its core goal is to offer a test double framework with a succinct API capable of clearly defining all possible object operations and interactions using a human readable Domain Specific Language (DSL). Designed as a drop in alternative to PHPUnit's phpunit-mock-objects library, Mockery is easy to integrate with PHPUnit and can operate alongside phpunit-mock-objects without the World ending. Mockery is released under a New BSD License. ## Installation To install Mockery, run the command below and you will get the latest version ```sh composer require --dev mockery/mockery ``` ## Documentation In older versions, this README file was the documentation for Mockery. Over time we have improved this, and have created an extensive documentation for you. Please use this README file as a starting point for Mockery, but do read the documentation to learn how to use Mockery. The current version can be seen at [docs.mockery.io](http://docs.mockery.io). ## PHPUnit Integration Mockery ships with some helpers if you are using PHPUnit. You can extend the [`Mockery\Adapter\Phpunit\MockeryTestCase`](library/Mockery/Adapter/Phpunit/MockeryTestCase.php) class instead of `PHPUnit\Framework\TestCase`, or if you are already using a custom base class for your tests, take a look at the traits available in the [`Mockery\Adapter\Phpunit`](library/Mockery/Adapter/Phpunit) namespace. ## Test Doubles Test doubles (often called mocks) simulate the behaviour of real objects. They are commonly utilised to offer test isolation, to stand in for objects which do not yet exist, or to allow for the exploratory design of class APIs without requiring actual implementation up front. The benefits of a test double framework are to allow for the flexible generation and configuration of test doubles. They allow the setting of expected method calls and/or return values using a flexible API which is capable of capturing every possible real object behaviour in way that is stated as close as possible to a natural language description. Use the `Mockery::mock` method to create a test double. ``` php $double = Mockery::mock(); ``` If you need Mockery to create a test double to satisfy a particular type hint, you can pass the type to the `mock` method. ``` php class Book {} interface BookRepository { function find($id): Book; function findAll(): array; function add(Book $book): void; } $double = Mockery::mock(BookRepository::class); ``` A detailed explanation of creating and working with test doubles is given in the documentation, [Creating test doubles](http://docs.mockery.io/en/latest/reference/creating_test_doubles.html) section. ## Method Stubs 🎫 A method stub is a mechanism for having your test double return canned responses to certain method calls. With stubs, you don't care how many times, if at all, the method is called. Stubs are used to provide indirect input to the system under test. ``` php $double->allows()->find(123)->andReturns(new Book()); $book = $double->find(123); ``` If you have used Mockery before, you might see something new in the example above — we created a method stub using `allows`, instead of the "old" `shouldReceive` syntax. This is a new feature of Mockery v1, but fear not, the trusty ol' `shouldReceive` is still here. For new users of Mockery, the above example can also be written as: ``` php $double->shouldReceive('find')->with(123)->andReturn(new Book()); $book = $double->find(123); ``` If your stub doesn't require specific arguments, you can also use this shortcut for setting up multiple calls at once: ``` php $double->allows([ "findAll" => [new Book(), new Book()], ]); ``` or ``` php $double->shouldReceive('findAll') ->andReturn([new Book(), new Book()]); ``` You can also use this shortcut, which creates a double and sets up some stubs in one call: ``` php $double = Mockery::mock(BookRepository::class, [ "findAll" => [new Book(), new Book()], ]); ``` ## Method Call Expectations 📲 A Method call expectation is a mechanism to allow you to verify that a particular method has been called. You can specify the parameters and you can also specify how many times you expect it to be called. Method call expectations are used to verify indirect output of the system under test. ``` php $book = new Book(); $double = Mockery::mock(BookRepository::class); $double->expects()->add($book); ``` During the test, Mockery accept calls to the `add` method as prescribed. After you have finished exercising the system under test, you need to tell Mockery to check that the method was called as expected, using the `Mockery::close` method. One way to do that is to add it to your `tearDown` method in PHPUnit. ``` php public function tearDown() { Mockery::close(); } ``` The `expects()` method automatically sets up an expectation that the method call (and matching parameters) is called **once and once only**. You can choose to change this if you are expecting more calls. ``` php $double->expects()->add($book)->twice(); ``` If you have used Mockery before, you might see something new in the example above — we created a method expectation using `expects`, instead of the "old" `shouldReceive` syntax. This is a new feature of Mockery v1, but same as with `accepts` in the previous section, it can be written in the "old" style. For new users of Mockery, the above example can also be written as: ``` php $double->shouldReceive('find') ->with(123) ->once() ->andReturn(new Book()); $book = $double->find(123); ``` A detailed explanation of declaring expectations on method calls, please read the documentation, the [Expectation declarations](http://docs.mockery.io/en/latest/reference/expectations.html) section. After that, you can also learn about the new `allows` and `expects` methods in the [Alternative shouldReceive syntax](http://docs.mockery.io/en/latest/reference/alternative_should_receive_syntax.html) section. It is worth mentioning that one way of setting up expectations is no better or worse than the other. Under the hood, `allows` and `expects` are doing the same thing as `shouldReceive`, at times in "less words", and as such it comes to a personal preference of the programmer which way to use. ## Test Spies 🕵️ By default, all test doubles created with the `Mockery::mock` method will only accept calls that they have been configured to `allow` or `expect` (or in other words, calls that they `shouldReceive`). Sometimes we don't necessarily care about all of the calls that are going to be made to an object. To facilitate this, we can tell Mockery to ignore any calls it has not been told to expect or allow. To do so, we can tell a test double `shouldIgnoreMissing`, or we can create the double using the `Mocker::spy` shortcut. ``` php // $double = Mockery::mock()->shouldIgnoreMissing(); $double = Mockery::spy(); $double->foo(); // null $double->bar(); // null ``` Further to this, sometimes we want to have the object accept any call during the test execution and then verify the calls afterwards. For these purposes, we need our test double to act as a Spy. All mockery test doubles record the calls that are made to them for verification afterwards by default: ``` php $double->baz(123); $double->shouldHaveReceived()->baz(123); // null $double->shouldHaveReceived()->baz(12345); // Uncaught Exception Mockery\Exception\InvalidCountException... ``` Please refer to the [Spies](http://docs.mockery.io/en/latest/reference/spies.html) section of the documentation to learn more about the spies. ## Utilities 🔌 ### Global Helpers Mockery ships with a handful of global helper methods, you just need to ask Mockery to declare them. ``` php Mockery::globalHelpers(); $mock = mock(Some::class); $spy = spy(Some::class); $spy->shouldHaveReceived() ->foo(anyArgs()); ``` All of the global helpers are wrapped in a `!function_exists` call to avoid conflicts. So if you already have a global function called `spy`, Mockery will silently skip the declaring its own `spy` function. ### Testing Traits As Mockery ships with code generation capabilities, it was trivial to add functionality allowing users to create objects on the fly that use particular traits. Any abstract methods defined by the trait will be created and can have expectations or stubs configured like normal Test Doubles. ``` php trait Foo { function foo() { return $this->doFoo(); } abstract function doFoo(); } $double = Mockery::mock(Foo::class); $double->allows()->doFoo()->andReturns(123); $double->foo(); // int(123) ``` ## Versioning The Mockery team attempts to adhere to [Semantic Versioning](http://semver.org), however, some of Mockery's internals are considered private and will be open to change at any time. Just because a class isn't final, or a method isn't marked private, does not mean it constitutes part of the API we guarantee under the versioning scheme. ### Alternative Runtimes Mockery 1.3 was the last version to support HHVM 3 and PHP 5. There is no support for HHVM 4+. ## A new home for Mockery ⚠️️ Update your remotes! Mockery has transferred to a new location. While it was once at `padraic/mockery`, it is now at `mockery/mockery`. While your existing repositories will redirect transparently for any operations, take some time to transition to the new URL. ```sh $ git remote set-url upstream https://github.com/mockery/mockery.git ``` Replace `upstream` with the name of the remote you use locally; `upstream` is commonly used but you may be using something else. Run `git remote -v` to see what you're actually using. composer.json000064400000002615150031475740007300 0ustar00{ "name": "mockery/mockery", "description": "Mockery is a simple yet flexible PHP mock object framework", "scripts": { "docs": "phpdoc -d library -t docs/api" }, "keywords": [ "bdd", "library", "mock", "mock objects", "mockery", "stub", "tdd", "test", "test double", "testing" ], "homepage": "https://github.com/mockery/mockery", "license": "BSD-3-Clause", "authors": [ { "name": "Pádraic Brady", "email": "padraic.brady@gmail.com", "homepage": "http://blog.astrumfutura.com" }, { "name": "Dave Marshall", "email": "dave.marshall@atstsolutions.co.uk", "homepage": "http://davedevelopment.co.uk" } ], "require": { "php": "^7.3 || ^8.0", "lib-pcre": ">=7.0", "hamcrest/hamcrest-php": "^2.0.1" }, "require-dev": { "phpunit/phpunit": "^8.5 || ^9.3" }, "conflict": { "phpunit/phpunit": "<8.0" }, "autoload": { "psr-0": { "Mockery": "library/" } }, "autoload-dev": { "psr-4": { "test\\": "tests/" } }, "config": { "preferred-install": "dist" }, "extra": { "branch-alias": { "dev-master": "1.4.x-dev" } } } .phpstorm.meta.php000064400000000536150031475740010146 0ustar00 "@"])); override(\Mockery::spy(0), map(["" => "@"])); override(\Mockery::namedMock(0), map(["" => "@"])); override(\Mockery::instanceMock(0), map(["" => "@"])); override(\mock(0), map(["" => "@"])); override(\spy(0), map(["" => "@"])); override(\namedMock(0), map(["" => "@"]));