README

...and a bit more ;)

Goals

easy mocking
make any changes revertible
revert changes automatically

Targets

There are several classes that will do the work:

To use with PHPUnit:
- MockedMethod to mock method "globally" and use PHPUnit's *Mockers - expects/willReturn/willReturnCallback/...
- MockedFunction
For class methods:
- MockedClassMethod to mock any class with closure
- UndefinedClassMethod to make method disappear
For class constants:
- MockedClassConstant
- UndefinedClassConstant
For global constants:
- MockedGlobalConstant
- UndefinedGlobalConstant
For functions (global or Namespaced):
- MockedFunction
- UndefinedFunction

Install

composer require --dev qratorlabs/smocky

MockedMethod

The main target is to make mocking static methods easy and feels-n-looks like using PHPUnit.

public function testSomeTest(): void {
    $methodMock = new MockedMethod($this, SomeClass::class, 'someMethod', once());
    $methodMock->getMocker()->willReturn(10);

    SomeClass::someMethod(); // will return `10`
    
    SomeClass::someMethod(); // will cause error (expectation - one call)
}

Note

There is a workaround that ensures that any (defined) children of class, which method is mocking, have its own method, defined by user or mocked (by Smocky - closure that calls parent).

Example for code that will fail without this workaround following code will end up with Segmentation fault: 11

class Base
{
    public static function methodName()
    {
        return 'something';
    }
}

class Child extends Base
{

}

// simulating PHPUnit test case
(new class('test') extends \PHPUnit\Framework\TestCase {

    public function test(): void
    {
        // child should instanced (or loaded any other way)
        $child = new Child();
        // mocking method of base class
        $method = new MockedClassMethod(Base::class, 'methodName');
        // at least one call should be made
        Base::methodName();
    }
})->run();

Trivia

Revertible changes

All changes are made revertible by using internal storage and __destruct methods.

qratorlabs / smocky

Maintainers

Details