php-mock-prophecy's Introduction

Mock PHP built-in functions with Prophecy

This package integrates the function mock library PHP-Mock with Prophecy.

Installation

composer require --dev php-mock/php-mock-prophecy

Usage

Build a new PHPProphet and create function prophecies for a given namespace with PHPProphet::prophesize():

namespace foo;

use phpmock\prophecy\PHPProphet;

$prophet = new PHPProphet();

$prophecy = $prophet->prophesize(__NAMESPACE__);
$prophecy->time()->willReturn(123);
$prophecy->reveal();

assert(123 == time());
$prophet->checkPredictions();

Restrictions

This library comes with the same restrictions as the underlying php-mock:

Only unqualified function calls in a namespace context can be prophesized. E.g. a call for time() in the namespace foo is prophesizable, a call for \time() is not.
The mock has to be defined before the first call to the unqualified function in the tested class. This is documented in Bug #68541. In most cases you can ignore this restriction. But if you happen to run into this issue you can call PHPProphet::define() before that first call. This would define a side effectless namespaced function.
Additionally it shares restrictions from Prophecy as well: Prophecy doesn't support pass-by-reference. If you need pass-by-reference in prophecies, consider using another framework (e.g. php-mock-phpunit).

License and authors

This project is free and under the WTFPL. Responsable for this project is Markus Malkusch [email protected].

Donations

If you like this project and feel generous donate a few Bitcoins here: 1335STSwu9hST4vcMRppEPgENMHD2r1REK

php-mock-prophecy's People

Contributors

Stargazers

Watchers

php-mock-prophecy's Issues

Allow mocking and subclassing of PHPProphet

Having the final declaration on the PHPProphet class means you cannot mock it in tests or extend the functionality. I suggest removing the final declaration and making the $prophet property protected.

Pull Request #2

Integrating with Symfony testing

Not really an issue, but I wondered how to integrate tests with Symfony and phpspec/phpspec with the extends of ObjectBehaviour ?

Tests become broken as optional parameters are required

After requiring this package in composer and running tests I noticed that many of them became broken as calls expectations changed. For example if I have a function
getFirstWhere($arg1, $arg2, $arg3 = []) and I set my expectation to $mock->getFirstWhere('arg', 'arg2') I get the error saying that expectation was not met because there was a call to $mock->getFirstWhere('arg', 'arg2', [])(notice the empty array at the end). Not sure what is the reason of that. Example log:

  39  - it returns list of sample messages
      method call:
        - getAllWhere("client_id", 5, [])
      on Double\ClientServicesRepository\ClientServicesRepository\P82 was not expected, expected calls were:
        - getAllWhere(exact("client_id"), exact(5))

So basically I call in my real code getAllWhere("client_id", 5) but somehow it takes the optional parameters into an account.