Dashboard

Editing: MockObjectTest.php

<?php
/*
 * This file is part of the PHPUnit_MockObject package.
 *
 * (c) Sebastian Bergmann <sebastian@phpunit.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

class Framework_MockObjectTest extends PHPUnit_Framework_TestCase
{
    public function testMockedMethodIsNeverCalled()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->never())
             ->method('doSomething');
    }

public function testMockedMethodIsNeverCalledWithParameter()
    {
        $mock = $this->getMockBuilder(SomeClass::class)
                     ->getMock();

$mock->expects($this->never())
             ->method('doSomething')
             ->with('someArg');
    }

/**
     * @doesNotPerformAssertions
     */
    public function testMockedMethodIsNotCalledWhenExpectsAnyWithParameter()
    {
        $mock = $this->getMockBuilder(SomeClass::class)
                     ->getMock();

$mock->expects($this->any())
             ->method('doSomethingElse')
             ->with('someArg');
    }

/**
     * @doesNotPerformAssertions
     */
    public function testMockedMethodIsNotCalledWhenMethodSpecifiedDirectlyWithParameter()
    {
        $mock = $this->getMockBuilder(SomeClass::class)
                     ->getMock();

$mock->method('doSomethingElse')
             ->with('someArg');
    }

public function testMockedMethodIsCalledAtLeastOnce()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->atLeastOnce())
             ->method('doSomething');

$mock->doSomething();
    }

public function testMockedMethodIsCalledAtLeastOnce2()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->atLeastOnce())
             ->method('doSomething');

$mock->doSomething();
        $mock->doSomething();
    }

public function testMockedMethodIsCalledAtLeastTwice()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->atLeast(2))
             ->method('doSomething');

$mock->doSomething();
        $mock->doSomething();
    }

public function testMockedMethodIsCalledAtLeastTwice2()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->atLeast(2))
             ->method('doSomething');

$mock->doSomething();
        $mock->doSomething();
        $mock->doSomething();
    }

public function testMockedMethodIsCalledAtMostTwice()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->atMost(2))
             ->method('doSomething');

$mock->doSomething();
        $mock->doSomething();
    }

public function testMockedMethodIsCalledAtMosttTwice2()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->atMost(2))
             ->method('doSomething');

$mock->doSomething();
    }

public function testMockedMethodIsCalledOnce()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->once())
             ->method('doSomething');

$mock->doSomething();
    }

public function testMockedMethodIsCalledOnceWithParameter()
    {
        $mock = $this->getMockBuilder(SomeClass::class)
                     ->getMock();

$mock->expects($this->once())
             ->method('doSomethingElse')
             ->with($this->equalTo('something'));

$mock->doSomethingElse('something');
    }

public function testMockedMethodIsCalledExactly()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->exactly(2))
             ->method('doSomething');

$mock->doSomething();
        $mock->doSomething();
    }

public function testStubbedException()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->any())
             ->method('doSomething')
             ->will($this->throwException(new Exception));

$this->expectException(Exception::class);

$mock->doSomething();
    }

public function testStubbedWillThrowException()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->any())
             ->method('doSomething')
             ->willThrowException(new Exception);

$this->expectException(Exception::class);

$mock->doSomething();
    }

public function testStubbedReturnValue()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->any())
             ->method('doSomething')
             ->will($this->returnValue('something'));

$this->assertEquals('something', $mock->doSomething());

$mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->any())
             ->method('doSomething')
             ->willReturn('something');

$this->assertEquals('something', $mock->doSomething());
    }

public function testStubbedReturnValueMap()
    {
        $map = [
            ['a', 'b', 'c', 'd'],
            ['e', 'f', 'g', 'h']
        ];

$mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->any())
             ->method('doSomething')
             ->will($this->returnValueMap($map));

$this->assertEquals('d', $mock->doSomething('a', 'b', 'c'));
        $this->assertEquals('h', $mock->doSomething('e', 'f', 'g'));
        $this->assertEquals(null, $mock->doSomething('foo', 'bar'));

$mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->any())
             ->method('doSomething')
             ->willReturnMap($map);

$this->assertEquals('d', $mock->doSomething('a', 'b', 'c'));
        $this->assertEquals('h', $mock->doSomething('e', 'f', 'g'));
        $this->assertEquals(null, $mock->doSomething('foo', 'bar'));
    }

public function testStubbedReturnArgument()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->any())
             ->method('doSomething')
             ->will($this->returnArgument(1));

$this->assertEquals('b', $mock->doSomething('a', 'b'));

$mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->any())
             ->method('doSomething')
             ->willReturnArgument(1);

$this->assertEquals('b', $mock->doSomething('a', 'b'));
    }

public function testFunctionCallback()
    {
        $mock = $this->getMockBuilder(SomeClass::class)
                     ->setMethods(['doSomething'])
                     ->getMock();

$mock->expects($this->once())
             ->method('doSomething')
             ->will($this->returnCallback('functionCallback'));

$this->assertEquals('pass', $mock->doSomething('foo', 'bar'));

$mock = $this->getMockBuilder(SomeClass::class)
                     ->setMethods(['doSomething'])
                     ->getMock();

$mock->expects($this->once())
             ->method('doSomething')
             ->willReturnCallback('functionCallback');

$this->assertEquals('pass', $mock->doSomething('foo', 'bar'));
    }

public function testStubbedReturnSelf()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->any())
             ->method('doSomething')
             ->will($this->returnSelf());

$this->assertEquals($mock, $mock->doSomething());

$mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->any())
             ->method('doSomething')
             ->willReturnSelf();

$this->assertEquals($mock, $mock->doSomething());
    }

public function testStubbedReturnOnConsecutiveCalls()
    {
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->any())
             ->method('doSomething')
             ->will($this->onConsecutiveCalls('a', 'b', 'c'));

$this->assertEquals('a', $mock->doSomething());
        $this->assertEquals('b', $mock->doSomething());
        $this->assertEquals('c', $mock->doSomething());

$mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock->expects($this->any())
             ->method('doSomething')
             ->willReturnOnConsecutiveCalls('a', 'b', 'c');

$this->assertEquals('a', $mock->doSomething());
        $this->assertEquals('b', $mock->doSomething());
        $this->assertEquals('c', $mock->doSomething());
    }

public function testStaticMethodCallback()
    {
        $mock = $this->getMockBuilder(SomeClass::class)
                     ->setMethods(['doSomething'])
                     ->getMock();

$mock->expects($this->once())
             ->method('doSomething')
             ->will($this->returnCallback(['MethodCallback', 'staticCallback']));

$this->assertEquals('pass', $mock->doSomething('foo', 'bar'));
    }

public function testPublicMethodCallback()
    {
        $mock = $this->getMockBuilder(SomeClass::class)
                     ->setMethods(['doSomething'])
                     ->getMock();

$mock->expects($this->once())
             ->method('doSomething')
             ->will($this->returnCallback([new MethodCallback, 'nonStaticCallback']));

$this->assertEquals('pass', $mock->doSomething('foo', 'bar'));
    }

public function testMockClassOnlyGeneratedOnce()
    {
        $mock1 = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$mock2 = $this->getMockBuilder(AnInterface::class)
                     ->getMock();

$this->assertEquals(get_class($mock1), get_class($mock2));
    }

public function testMockClassDifferentForPartialMocks()
    {
        $mock1 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->getMock();

$mock2 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->setMethods(['doSomething'])
                      ->getMock();

$mock3 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->setMethods(['doSomething'])
                      ->getMock();

$mock4 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->setMethods(['doAnotherThing'])
                      ->getMock();

$mock5 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->setMethods(['doAnotherThing'])
                      ->getMock();

$this->assertNotEquals(get_class($mock1), get_class($mock2));
        $this->assertNotEquals(get_class($mock1), get_class($mock3));
        $this->assertNotEquals(get_class($mock1), get_class($mock4));
        $this->assertNotEquals(get_class($mock1), get_class($mock5));
        $this->assertEquals(get_class($mock2), get_class($mock3));
        $this->assertNotEquals(get_class($mock2), get_class($mock4));
        $this->assertNotEquals(get_class($mock2), get_class($mock5));
        $this->assertEquals(get_class($mock4), get_class($mock5));
    }

public function testMockClassStoreOverrulable()
    {
        $mock1 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->getMock();

$mock2 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->setMockClassName('MyMockClassNameForPartialMockTestClass1')
                      ->getMock();

$mock3 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->getMock();

$mock4 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->setMethods(['doSomething'])
                      ->setMockClassName('AnotherMockClassNameForPartialMockTestClass')
                      ->getMock();

$mock5 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->setMockClassName('MyMockClassNameForPartialMockTestClass2')
                      ->getMock();

$this->assertNotEquals(get_class($mock1), get_class($mock2));
        $this->assertEquals(get_class($mock1), get_class($mock3));
        $this->assertNotEquals(get_class($mock1), get_class($mock4));
        $this->assertNotEquals(get_class($mock2), get_class($mock3));
        $this->assertNotEquals(get_class($mock2), get_class($mock4));
        $this->assertNotEquals(get_class($mock2), get_class($mock5));
        $this->assertNotEquals(get_class($mock3), get_class($mock4));
        $this->assertNotEquals(get_class($mock3), get_class($mock5));
        $this->assertNotEquals(get_class($mock4), get_class($mock5));
    }

public function testGetMockWithFixedClassNameCanProduceTheSameMockTwice()
    {
        $mock = $this->getMockBuilder(stdClass::class)->setMockClassName('FixedName')->getMock();
        $mock = $this->getMockBuilder(stdClass::class)->setMockClassName('FixedName')->getMock();
        $this->assertInstanceOf(stdClass::class, $mock);
    }

public function testOriginalConstructorSettingConsidered()
    {
        $mock1 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->getMock();

$mock2 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->disableOriginalConstructor()
                      ->getMock();

$this->assertTrue($mock1->constructorCalled);
        $this->assertFalse($mock2->constructorCalled);
    }

public function testOriginalCloneSettingConsidered()
    {
        $mock1 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->getMock();

$mock2 = $this->getMockBuilder(PartialMockTestClass::class)
                      ->disableOriginalClone()
                      ->getMock();

$this->assertNotEquals(get_class($mock1), get_class($mock2));
    }

public function testGetMockForAbstractClass()
    {
        $mock = $this->getMockBuilder(AbstractMockTestClass::class)
                     ->getMock();

$mock->expects($this->never())
             ->method('doSomething');
    }

/**
     * @dataProvider traversableProvider
     */
    public function testGetMockForTraversable($type)
    {
        $mock = $this->getMockBuilder($type)
                     ->getMock();

$this->assertInstanceOf(Traversable::class, $mock);
    }

public function testMultipleInterfacesCanBeMockedInSingleObject()
    {
        $mock = $this->getMockBuilder([AnInterface::class, AnotherInterface::class])
                     ->getMock();

$this->assertInstanceOf(AnInterface::class, $mock);
        $this->assertInstanceOf(AnotherInterface::class, $mock);
    }

public function testGetMockForTrait()
    {
        $mock = $this->getMockForTrait(AbstractTrait::class);

$mock->expects($this->never())
             ->method('doSomething');

$parent = get_parent_class($mock);
        $traits = class_uses($parent, false);

$this->assertContains(AbstractTrait::class, $traits);
    }

public function testClonedMockObjectShouldStillEqualTheOriginal()
    {
        $a = $this->getMockBuilder(stdClass::class)
                  ->getMock();

$b = clone $a;

$this->assertEquals($a, $b);
    }

public function testMockObjectsConstructedIndepentantlyShouldBeEqual()
    {
        $a = $this->getMockBuilder(stdClass::class)
                  ->getMock();

$b = $this->getMockBuilder(stdClass::class)
                  ->getMock();

$this->assertEquals($a, $b);
    }

public function testMockObjectsConstructedIndepentantlyShouldNotBeTheSame()
    {
        $a = $this->getMockBuilder(stdClass::class)
                  ->getMock();

$b = $this->getMockBuilder(stdClass::class)
                  ->getMock();

$this->assertNotSame($a, $b);
    }

public function testClonedMockObjectCanBeUsedInPlaceOfOriginalOne()
    {
        $x = $this->getMockBuilder(stdClass::class)
                  ->getMock();

$y = clone $x;

$mock = $this->getMockBuilder(stdClass::class)
                     ->setMethods(['foo'])
                     ->getMock();

$mock->expects($this->once())
             ->method('foo')
             ->with($this->equalTo($x));

$mock->foo($y);
    }

public function testClonedMockObjectIsNotIdenticalToOriginalOne()
    {
        $x = $this->getMockBuilder(stdClass::class)
                  ->getMock();

$y = clone $x;

$mock = $this->getMockBuilder(stdClass::class)
                     ->setMethods(['foo'])
                     ->getMock();

$mock->expects($this->once())
             ->method('foo')
             ->with($this->logicalNot($this->identicalTo($x)));

$mock->foo($y);
    }

public function testObjectMethodCallWithArgumentCloningEnabled()
    {
        $expectedObject = new stdClass;

$mock = $this->getMockBuilder('SomeClass')
                     ->setMethods(['doSomethingElse'])
                     ->enableArgumentCloning()
                     ->getMock();

$actualArguments = [];

$mock->expects($this->any())
             ->method('doSomethingElse')
             ->will(
                 $this->returnCallback(
                     function () use (&$actualArguments) {
                         $actualArguments = func_get_args();
                     }
                 )
             );

$mock->doSomethingElse($expectedObject);

$this->assertEquals(1, count($actualArguments));
        $this->assertEquals($expectedObject, $actualArguments[0]);
        $this->assertNotSame($expectedObject, $actualArguments[0]);
    }

public function testObjectMethodCallWithArgumentCloningDisabled()
    {
        $expectedObject = new stdClass;

$mock = $this->getMockBuilder('SomeClass')
                     ->setMethods(['doSomethingElse'])
                     ->disableArgumentCloning()
                     ->getMock();

$actualArguments = [];

$mock->doSomethingElse($expectedObject);

$this->assertEquals(1, count($actualArguments));
        $this->assertSame($expectedObject, $actualArguments[0]);
    }

public function testArgumentCloningOptionGeneratesUniqueMock()
    {
        $mockWithCloning = $this->getMockBuilder('SomeClass')
                                ->setMethods(['doSomethingElse'])
                                ->enableArgumentCloning()
                                ->getMock();

$mockWithoutCloning = $this->getMockBuilder('SomeClass')
                                   ->setMethods(['doSomethingElse'])
                                   ->disableArgumentCloning()
                                   ->getMock();

$this->assertNotEquals($mockWithCloning, $mockWithoutCloning);
    }

public function testVerificationOfMethodNameFailsWithoutParameters()
    {
        $mock = $this->getMockBuilder(SomeClass::class)
                     ->setMethods(['right', 'wrong'])
                     ->getMock();

$mock->expects($this->once())
             ->method('right');

$mock->wrong();