first commit

This commit is contained in:
2026-01-25 18:18:09 +08:00
commit 509312e604
8136 changed files with 2349298 additions and 0 deletions

View File

@ -0,0 +1,16 @@
<?php
declare(strict_types=1);
trait ResetMocks
{
protected function resetMockObjects()
{
$refl = new ReflectionObject($this);
while (!$refl->hasProperty('mockObjects')) {
$refl = $refl->getParentClass();
}
$prop = $refl->getProperty('mockObjects');
$prop->setValue($this, array());
}
}

View File

@ -0,0 +1,449 @@
<?php
declare(strict_types=1);
require_once __DIR__ .'/ResetMocks.php';
use Codeception\Stub;
use Codeception\Stub\StubMarshaler;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\MockObject\NoMoreReturnValuesConfiguredException;
use PHPUnit\Framework\TestCase;
use PHPUnit\Runner\Version as PHPUnitVersion;
final class StubTest extends TestCase
{
use ResetMocks;
protected DummyClass $dummy;
public function setUp(): void
{
require_once $file = __DIR__. '/_data/DummyAbstractClass.php';
require_once $file = __DIR__. '/_data/DummyOverloadableClass.php';
require_once $file = __DIR__. '/_data/DummyClass.php';
$this->dummy = new DummyClass(true);
}
public function testMakeEmpty()
{
$dummy = Stub::makeEmpty('DummyClass');
$this->assertInstanceOf('DummyClass', $dummy);
$this->assertTrue(method_exists($dummy, 'helloWorld'));
$this->assertNull($dummy->helloWorld());
}
public function testMakeEmptyMethodReplaced()
{
$dummy = Stub::makeEmpty('DummyClass', ['helloWorld' => fn(): string => 'good bye world']);
$this->assertMethodReplaced($dummy);
}
public function testMakeEmptyMethodSimplyReplaced()
{
$dummy = Stub::makeEmpty('DummyClass', ['helloWorld' => 'good bye world']);
$this->assertMethodReplaced($dummy);
}
public function testMakeEmptyExcept()
{
$dummy = Stub::makeEmptyExcept('DummyClass', 'helloWorld');
$this->assertEquals($this->dummy->helloWorld(), $dummy->helloWorld());
$this->assertNull($dummy->goodByeWorld());
}
public function testMakeEmptyExceptPropertyReplaced()
{
$dummy = Stub::makeEmptyExcept('DummyClass', 'getCheckMe', ['checkMe' => 'checked!']);
$this->assertEquals('checked!', $dummy->getCheckMe());
}
public function testMakeEmptyExceptMagicalPropertyReplaced()
{
$dummy = Stub::makeEmptyExcept('DummyClass', 'getCheckMeToo', ['checkMeToo' => 'checked!']);
$this->assertEquals('checked!', $dummy->getCheckMeToo());
}
public function testFactory()
{
$dummies = Stub::factory('DummyClass', 2);
$this->assertCount(2, $dummies);
$this->assertInstanceOf('DummyClass', $dummies[0]);
}
public function testMake()
{
$dummy = Stub::make('DummyClass', ['goodByeWorld' => fn(): string => 'hello world']);
$this->assertEquals($this->dummy->helloWorld(), $dummy->helloWorld());
$this->assertEquals("hello world", $dummy->goodByeWorld());
}
public function testMakeMethodReplaced()
{
$dummy = Stub::make('DummyClass', ['helloWorld' => fn(): string => 'good bye world']);
$this->assertMethodReplaced($dummy);
}
public function testMakeWithMagicalPropertiesReplaced()
{
$dummy = Stub::make('DummyClass', ['checkMeToo' => 'checked!']);
$this->assertEquals('checked!', $dummy->checkMeToo);
}
public function testMakeMethodSimplyReplaced()
{
$dummy = Stub::make('DummyClass', ['helloWorld' => 'good bye world']);
$this->assertMethodReplaced($dummy);
}
public function testCopy()
{
$dummy = Stub::copy($this->dummy, ['checkMe' => 'checked!']);
$this->assertEquals('checked!', $dummy->getCheckMe());
$dummy = Stub::copy($this->dummy, ['checkMeToo' => 'checked!']);
$this->assertEquals('checked!', $dummy->getCheckMeToo());
}
public function testConstruct()
{
$dummy = Stub::construct('DummyClass', ['checkMe' => 'checked!']);
$this->assertEquals('constructed: checked!', $dummy->getCheckMe());
$dummy = Stub::construct(
'DummyClass',
['checkMe' => 'checked!'],
['targetMethod' => fn(): bool => false]
);
$this->assertEquals('constructed: checked!', $dummy->getCheckMe());
$this->assertEquals(false, $dummy->targetMethod());
}
public function testConstructMethodReplaced()
{
$dummy = Stub::construct(
'DummyClass',
[],
['helloWorld' => fn(): string => 'good bye world']
);
$this->assertMethodReplaced($dummy);
}
public function testConstructMethodSimplyReplaced()
{
$dummy = Stub::make('DummyClass', ['helloWorld' => 'good bye world']);
$this->assertMethodReplaced($dummy);
}
public function testConstructEmpty()
{
$dummy = Stub::constructEmpty('DummyClass', ['checkMe' => 'checked!']);
$this->assertNull($dummy->getCheckMe());
}
public function testConstructEmptyExcept()
{
$dummy = Stub::constructEmptyExcept('DummyClass', 'getCheckMe', ['checkMe' => 'checked!']);
$this->assertNull($dummy->targetMethod());
$this->assertEquals('constructed: checked!', $dummy->getCheckMe());
}
public function testUpdate()
{
$dummy = Stub::construct('DummyClass');
Stub::update($dummy, ['checkMe' => 'done']);
$this->assertEquals('done', $dummy->getCheckMe());
Stub::update($dummy, ['checkMeToo' => 'done']);
$this->assertEquals('done', $dummy->getCheckMeToo());
}
public function testStubsFromObject()
{
$dummy = Stub::make(new DummyClass());
$this->assertInstanceOf(
MockObject::class,
$dummy
);
$dummy = Stub::make(new DummyOverloadableClass());
$this->assertSame(DummyOverloadableClass::class, get_parent_class($dummy));
$dummy = Stub::makeEmpty(new DummyClass());
$this->assertInstanceOf(
MockObject::class,
$dummy
);
$dummy = Stub::makeEmpty(new DummyOverloadableClass());
$this->assertSame(DummyOverloadableClass::class, get_parent_class($dummy));
$dummy = Stub::makeEmptyExcept(new DummyClass(), 'helloWorld');
$this->assertInstanceOf(
MockObject::class,
$dummy
);
$dummy = Stub::makeEmptyExcept(new DummyOverloadableClass(), 'helloWorld');
$this->assertSame(DummyOverloadableClass::class, get_parent_class($dummy));
$dummy = Stub::construct(new DummyClass());
$this->assertInstanceOf(
MockObject::class,
$dummy
);
$dummy = Stub::construct(new DummyOverloadableClass());
$this->assertSame(DummyOverloadableClass::class, get_parent_class($dummy));
$dummy = Stub::constructEmpty(new DummyClass());
$this->assertInstanceOf(
MockObject::class,
$dummy
);
$dummy = Stub::constructEmpty(new DummyOverloadableClass());
$this->assertSame(DummyOverloadableClass::class, get_parent_class($dummy));
$dummy = Stub::constructEmptyExcept(new DummyClass(), 'helloWorld');
$this->assertInstanceOf(
MockObject::class,
$dummy
);
$dummy = Stub::constructEmptyExcept(new DummyOverloadableClass(), 'helloWorld');
$this->assertSame(DummyOverloadableClass::class, get_parent_class($dummy));
}
protected function assertMethodReplaced($dummy)
{
$this->assertTrue(method_exists($dummy, 'helloWorld'));
$this->assertNotEquals($this->dummy->helloWorld(), $dummy->helloWorld());
$this->assertEquals($dummy->helloWorld(), 'good bye world');
}
/**
* @return array<int, array<string|StubMarshaler>>
*/
public static function matcherAndFailMessageProvider(): array
{
return [
[Stub\Expected::atLeastOnce(),
'Expected invocation at least once but it never'
],
[Stub\Expected::once(),
'Method was expected to be called 1 times, actually called 0 times.'
],
[Stub\Expected::exactly(1),
'Method was expected to be called 1 times, actually called 0 times.'
],
[Stub\Expected::exactly(3),
'Method was expected to be called 3 times, actually called 0 times.'
],
];
}
/**
* @dataProvider matcherAndFailMessageProvider
*/
#[DataProvider('matcherAndFailMessageProvider')]
public function testExpectedMethodIsCalledFail(StubMarshaler $stubMarshaler, string $failMessage)
{
$mock = Stub::makeEmptyExcept('DummyClass', 'call', ['targetMethod' => $stubMarshaler], $this);
$mock->goodByeWorld();
try {
$mock->__phpunit_verify();
$this->fail('Expected exception');
} catch (Exception $exception) {
$this->assertTrue(strpos($failMessage, $exception->getMessage()) >= 0, 'String contains');
}
$this->resetMockObjects();
}
public function testNeverExpectedMethodIsCalledFail()
{
$mock = Stub::makeEmptyExcept('DummyClass', 'call', ['targetMethod' => Stub\Expected::never()], $this);
$mock->goodByeWorld();
try {
$mock->call();
} catch (Exception $e) {
$this->assertTrue(strpos('was not expected to be called', $e->getMessage()) >= 0, 'String contains');
}
$this->resetMockObjects();
}
/**
* @return array<int, array<int|bool|StubMarshaler|string|null>>
*/
public static function matcherProvider(): array
{
return [
[0, Stub\Expected::never()],
[1, Stub\Expected::once()],
[2, Stub\Expected::atLeastOnce()],
[3, Stub\Expected::exactly(3)],
[1, Stub\Expected::once(fn(): bool => true)],
[2, Stub\Expected::atLeastOnce(fn(): array => [])],
[1, Stub\Expected::exactly(1, fn() => null)],
[1, Stub\Expected::exactly(1, fn(): string => 'hello world!')],
[1, Stub\Expected::exactly(1, 'hello world!')],
];
}
/**
* @dataProvider matcherProvider
*/
#[DataProvider('matcherProvider')]
public function testMethodMatcherWithMake(int $count, StubMarshaler $matcher, $expected = false)
{
$dummy = Stub::make('DummyClass', ['goodByeWorld' => $matcher], $this);
$this->repeatCall($count, [$dummy, 'goodByeWorld'], $expected);
}
/**
* @dataProvider matcherProvider
*/
#[DataProvider('matcherProvider')]
public function testMethodMatcherWithMakeEmpty(int $count, StubMarshaler $matcher)
{
$dummy = Stub::makeEmpty('DummyClass', ['goodByeWorld' => $matcher], $this);
$this->repeatCall($count, [$dummy, 'goodByeWorld']);
}
/**
* @dataProvider matcherProvider
*/
#[DataProvider('matcherProvider')]
public function testMethodMatcherWithMakeEmptyExcept(int $count, StubMarshaler $matcher)
{
$dummy = Stub::makeEmptyExcept('DummyClass', 'getCheckMe', ['goodByeWorld' => $matcher], $this);
$this->repeatCall($count, [$dummy, 'goodByeWorld']);
}
/**
* @dataProvider matcherProvider
*/
#[DataProvider('matcherProvider')]
public function testMethodMatcherWithConstruct(int $count, StubMarshaler $matcher)
{
$dummy = Stub::construct('DummyClass', [], ['goodByeWorld' => $matcher], $this);
$this->repeatCall($count, [$dummy, 'goodByeWorld']);
}
/**
* @dataProvider matcherProvider
*/
#[DataProvider('matcherProvider')]
public function testMethodMatcherWithConstructEmpty(int $count, StubMarshaler $matcher)
{
$dummy = Stub::constructEmpty('DummyClass', [], ['goodByeWorld' => $matcher], $this);
$this->repeatCall($count, [$dummy, 'goodByeWorld']);
}
/**
* @dataProvider matcherProvider
*/
#[DataProvider('matcherProvider')]
public function testMethodMatcherWithConstructEmptyExcept(int $count, StubMarshaler $matcher)
{
$dummy = Stub::constructEmptyExcept(
'DummyClass',
'getCheckMe',
[],
['goodByeWorld' => $matcher],
$this
);
$this->repeatCall($count, [$dummy, 'goodByeWorld']);
}
private function repeatCall($count, $callable, $expected = false)
{
for ($i = 0; $i < $count; ++$i) {
$actual = call_user_func($callable);
if ($expected) {
$this->assertEquals($expected, $actual);
}
}
}
public function testConsecutive()
{
$dummy = Stub::make('DummyClass', ['helloWorld' => Stub::consecutive('david', 'emma', 'sam', 'amy')]);
$this->assertEquals('david', $dummy->helloWorld());
$this->assertEquals('emma', $dummy->helloWorld());
$this->assertEquals('sam', $dummy->helloWorld());
$this->assertEquals('amy', $dummy->helloWorld());
// Expected null value when no more values
// For PHP 10.5.30 or higher an exception is thrown
// https://github.com/sebastianbergmann/phpunit/commit/490879817a1417fd5fa1149a47b6f2f1b70ada6a
if (version_compare(PHPUnitVersion::id(), '10.5.30', '>=')) {
$this->expectException(NoMoreReturnValuesConfiguredException::class);
$dummy->helloWorld();
} else {
$this->assertNull($dummy->helloWorld());
}
}
public function testStubPrivateProperties()
{
$tester = Stub::construct(
'MyClassWithPrivateProperties',
['name' => 'gamma'],
[
'randomName' => 'chicken',
't' => 'ticky2',
'getRandomName' => fn(): string => "randomstuff"
]
);
$this->assertEquals('gamma', $tester->getName());
$this->assertEquals('randomstuff', $tester->getRandomName());
$this->assertEquals('ticky2', $tester->getT());
}
public function testStubMakeEmptyInterface()
{
$stub = Stub::makeEmpty(Countable::class, ['count' => 5]);
$this->assertEquals(5, $stub->count());
}
public function testStubMakeEmptyAbstractClass()
{
if (version_compare(PHPUnitVersion::id(), '12', '>=')) {
$this->expectException(RuntimeException::class);
$this->expectExceptionMessage('PHPUnit 12 or greater does not allow to mock abstract classes anymore');
}
$stub = Stub::make('DummyAbstractClass');
$this->assertInstanceOf('DummyAbstractClass', $stub);
}
}
class MyClassWithPrivateProperties
{
private string $name = '';
private string $randomName = 'gaia';
private string $t = 'ticky';
public function __construct(string $name)
{
$this->name = $name;
}
public function getName(): string
{
return $this->name;
}
public function getRandomName(): string
{
return $this->randomName;
}
public function getT(): string
{
return $this->t;
}
}

View File

@ -0,0 +1,79 @@
<?php
declare(strict_types=1);
use Codeception\Stub\Expected;
use Codeception\Test\Feature\Stub;
use PHPUnit\Framework\TestCase;
require_once __DIR__ .'/ResetMocks.php';
final class StubTraitTest extends TestCase
{
use ResetMocks;
use Stub;
protected DummyClass $dummy;
public function setUp(): void
{
require_once $file = __DIR__. '/_data/DummyOverloadableClass.php';
require_once $file = __DIR__. '/_data/DummyClass.php';
$this->dummy = new DummyClass(true);
}
public function testMakeStubs()
{
$this->dummy = $this->make('DummyClass', ['helloWorld' => 'bye']);
$this->assertEquals('bye', $this->dummy->helloWorld());
$this->assertEquals('good bye', $this->dummy->goodByeWorld());
$this->dummy = $this->makeEmpty('DummyClass', ['helloWorld' => 'bye']);
$this->assertEquals('bye', $this->dummy->helloWorld());
$this->assertNull($this->dummy->goodByeWorld());
$this->dummy = $this->makeEmptyExcept('DummyClass', 'goodByeWorld', ['helloWorld' => 'bye']);
$this->assertEquals('bye', $this->dummy->helloWorld());
$this->assertEquals('good bye', $this->dummy->goodByeWorld());
$this->assertNull($this->dummy->exceptionalMethod());
}
public function testConstructStubs()
{
$this->dummy = $this->construct('DummyClass', ['!'], ['helloWorld' => 'bye']);
$this->assertEquals('constructed: !', $this->dummy->getCheckMe());
$this->assertEquals('bye', $this->dummy->helloWorld());
$this->assertEquals('good bye', $this->dummy->goodByeWorld());
$this->dummy = $this->constructEmpty('DummyClass', ['!'], ['helloWorld' => 'bye']);
$this->assertNull($this->dummy->getCheckMe());
$this->assertEquals('bye', $this->dummy->helloWorld());
$this->assertNull($this->dummy->goodByeWorld());
$this->dummy = $this->constructEmptyExcept('DummyClass', 'getCheckMe', ['!'], ['helloWorld' => 'bye']);
$this->assertEquals('constructed: !', $this->dummy->getCheckMe());
$this->assertEquals('bye', $this->dummy->helloWorld());
$this->assertNull($this->dummy->goodByeWorld());
$this->assertNull($this->dummy->exceptionalMethod());
}
public function testMakeMocks()
{
$this->dummy = $this->make('DummyClass', [
'helloWorld' => Expected::once()
]);
$this->dummy->helloWorld();
try {
$this->dummy->helloWorld();
} catch (Exception $exception) {
$this->assertTrue(
strpos('was not expected to be called more than once', $exception->getMessage()) >= 0,
'String contains'
);
$this->resetMockObjects();
return;
}
$this->fail('No exception thrown');
}
}

View File

@ -0,0 +1,7 @@
<?php
declare(strict_types=1);
abstract class DummyAbstractClass
{
}

View File

@ -0,0 +1,94 @@
<?php
declare(strict_types=1);
class DummyClass
{
/**
* @var int|string
*/
protected $checkMe = 1;
protected array $properties = ['checkMeToo' => 1];
function __construct($checkMe = 1)
{
$this->checkMe = 'constructed: '.$checkMe;
}
/** @return string */
public function helloWorld()
{
return 'hello';
}
/** @return string */
public function goodByeWorld()
{
return 'good bye';
}
/** @return string */
protected function notYourBusinessWorld()
{
return 'goAway';
}
/** @return string */
public function getCheckMe()
{
return $this->checkMe;
}
public function getCheckMeToo()
{
return $this->checkMeToo;
}
/** @return bool */
public function call()
{
$this->targetMethod();
return true;
}
/** @return bool */
public function targetMethod()
{
return true;
}
/**
* @throws Exception
*/
public function exceptionalMethod()
{
throw new Exception('Catch it!');
}
public function __set($name, $value)
{
if ($this->isMagical($name)) {
$this->properties[$name] = $value;
}
}
public function __get($name)
{
if ($this->__isset($name)) {
return $this->properties[$name];
}
}
public function __isset($name)
{
return $this->isMagical($name) && isset($this->properties[$name]);
}
/** @return bool */
private function isMagical($name)
{
$reflectionClass = new ReflectionClass($this);
return !$reflectionClass->hasProperty($name);
}
}

View File

@ -0,0 +1,93 @@
<?php
declare(strict_types=1);
class DummyOverloadableClass
{
/**
* @var int|string
*/
protected $checkMe = 1;
protected array $properties = ['checkMeToo' => 1];
function __construct($checkMe = 1)
{
$this->checkMe = 'constructed: '.$checkMe;
}
/** @return string */
public function helloWorld()
{
return 'hello';
}
/** @return string */
public function goodByeWorld()
{
return 'good bye';
}
/** @return string */
protected function notYourBusinessWorld()
{
return 'goAway';
}
/** @return string */
public function getCheckMe()
{
return $this->checkMe;
}
public function getCheckMeToo()
{
return $this->checkMeToo;
}
/** @return bool */
public function call()
{
$this->targetMethod();
return true;
}
/** @return bool */
public function targetMethod()
{
return true;
}
/**
* @throws Exception
*/
public function exceptionalMethod()
{
throw new Exception('Catch it!');
}
public function __get($name)
{
//seeing as we're not implementing __set here, add check for __mocked
$return = null;
if ($name === '__mocked') {
$return = property_exists($this, '__mocked') && $this->__mocked !== null ? $this->__mocked : null;
} elseif ($this->__isset($name)) {
$return = $this->properties[$name];
}
return $return;
}
public function __isset($name)
{
return $this->isMagical($name) && isset($this->properties[$name]);
}
/** @return bool */
private function isMagical($name)
{
$reflectionClass = new ReflectionClass($this);
return !$reflectionClass->hasProperty($name);
}
}