console-helpers/prophecy-phpunit

Integrating the Prophecy mocking library in PHPUnit test cases

v2.2.0 2024-03-01 08:33 UTC

Requires

• php: ^7.3 || ^8
• phpspec/prophecy: ^1.18
• phpunit/phpunit: ^9.1 || ^10.1 || ^11.0

MIT

• Christophe Coevoet

• phpunit
• prophecy

README

Prophecy PhpUnit integrates the Prophecy mocking library with PHPUnit to provide an easier mocking in your testsuite.

Installation

Prerequisites

Prophecy PhpUnit requires PHP 5.6 or greater. Prophecy PhpUnit requires PHPUnit 5.0 or greater.

Setup through composer

composer require --dev phpspec/prophecy-phpunit

You can read more about Composer on its official webpage.

How to use it

The trait ProphecyTrait provides a method prophesize($classOrInterface = null) to use Prophecy. For the usage of the Prophecy doubles, please refer to the Prophecy documentation.

Below is a usage example:

<?php

namespace App;

use PHPUnit\Framework\TestCase;
use Prophecy\PhpUnit\ProphecyTrait;
use App\Security\Hasher;
use App\Entity\User;

class UserTest extends TestCase
{
    use ProphecyTrait;

    public function testPasswordHashing()
    {
        $hasher = $this->prophesize(Hasher::class);
        $user   = new User($hasher->reveal());

        $hasher->generateHash($user, 'qwerty')->willReturn('hashed_pass');

        $user->setPassword('qwerty');

        $this->assertEquals('hashed_pass', $user->getPassword());
    }
}