Compare commits

..

No commits in common. "main" and "1.0.0.0" have entirely different histories.

8 changed files with 72 additions and 162 deletions

View File

@ -18,7 +18,6 @@ namespace D3\TestingTools\Tests\Unit\Development;
use D3\TestingTools\Development\CanAccessRestricted;
use D3\TestingTools\Tests\Unit\Development\HelperClasses\CanAccessRestrictedClass;
use Error;
use Generator;
use PHPUnit\Framework\TestCase;
use ReflectionException;
@ -27,7 +26,7 @@ class CanAccessRestrictedTest extends TestCase
use CanAccessRestricted;
/** @var CanAccessRestrictedClass */
public CanAccessRestrictedClass $class;
public $class;
public function setUp(): void
{
@ -82,12 +81,17 @@ class CanAccessRestrictedTest extends TestCase
);
}
public function canCallMethodDataProvider(): Generator
/**
* @return array
*/
public function canCallMethodDataProvider(): array
{
yield 'public method' => ['publicMethod', true];
yield 'protected method' => ['protectedMethod', false];
yield 'private method' => ['privateMethod', false];
yield 'final public method' => ['finalPublicMethod', true];
return [
'public method' => ['publicMethod', true],
'protected method' => ['protectedMethod', false],
'private method' => ['privateMethod', false],
'final public method' => ['finalPublicMethod', true],
];
}
/**
@ -141,11 +145,16 @@ class CanAccessRestrictedTest extends TestCase
);
}
public function canSetAndGetClassPropertiesDataProvider(): Generator
/**
* @return array
*/
public function canSetAndGetClassPropertiesDataProvider(): array
{
yield 'public property' => ['publicProperty', true];
yield 'protected property' => ['protectedProperty', false];
yield 'private property' => ['privateProperty', false];
return [
'public property' => ['publicProperty', true],
'protected property' => ['protectedProperty', false],
'private property' => ['privateProperty', false],
];
}
/**
@ -207,11 +216,16 @@ class CanAccessRestrictedTest extends TestCase
);
}
public function canSetAndGetMockedPropertiesDataProvider(): Generator
/**
* @return array
*/
public function canSetAndGetMockedPropertiesDataProvider(): array
{
yield 'public property' => ['publicProperty', true];
yield 'protected property' => ['protectedProperty', false];
yield 'private property' => ['privateProperty', true]; // because private properties not contained in mock
return [
'public property' => ['publicProperty', true],
'protected property' => ['protectedProperty', false],
'private property' => ['privateProperty', true], // because private properties not contained in mock
];
}
/**

View File

@ -18,13 +18,13 @@ namespace D3\TestingTools\Tests\Unit\Development\HelperClasses;
class CanAccessRestrictedClass
{
/** @var string */
public string $publicProperty = 'publicProperty';
public $publicProperty = 'publicProperty';
/** @var string */
protected string $protectedProperty = 'protectedProperty';
protected $protectedProperty = 'protectedProperty';
/** @var string */
private string $privateProperty = 'privateProperty';
private $privateProperty = 'privateProperty';
/**
* @param string $arg

View File

@ -28,10 +28,6 @@ class IsMockableClass extends IsMockableParent
*/
public function myMethod(string $arg): string
{
return 'currentClass::myMethod##'.$arg;
}
public function fakeMethod(): void
{
return 'currentClass::myMethod##.'.$arg;
}
}

View File

@ -18,12 +18,10 @@ namespace D3\TestingTools\Tests\Unit\Production;
use D3\TestingTools\Development\CanAccessRestricted;
use D3\TestingTools\Production\IsMockable;
use D3\TestingTools\Tests\Unit\Production\HelperClasses\IsMockableClass;
use D3\TestingTools\Tests\Unit\Production\HelperClasses\IsMockableParent;
use Generator;
use OxidEsales\Eshop\Application\Model\Article;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use ReflectionException;
use RuntimeException;
class IsMockableTest extends TestCase
{
@ -32,80 +30,44 @@ class IsMockableTest extends TestCase
/**
* @test
* @throws ReflectionException
* @covers \D3\TestingTools\Production\IsMockable::d3CallMockableFunction
*/
public function callMockableFunctionMissingFunction(): void
public function callMockableNoParent(): void
{
$methodName = $this->getRandomString();
$argument = $this->getRandomString();
$traitMock = $this->getObjectForTrait(IsMockable::class);
// argument #1 is not a valid callable
$this->expectError();
$this->expectException(RuntimeException::class);
$this->callMethod(
$traitMock,
'd3CallMockableFunction',
[[$traitMock, $methodName], [$argument]]
'd3CallMockableParent',
[$methodName, [$argument]]
);
}
/**
* @param string $fqClassName
* @param string $expected
*
* @throws ReflectionException
* @test
* @dataProvider callMockableFunctionFromClassDataProvider
* @covers \D3\TestingTools\Production\IsMockable::d3CallMockableFunction
* @throws ReflectionException
*/
public function callMockableFunctionFromClass(string $fqClassName, string $expected): void
public function callMockableParent(): void
{
$methodName = 'myMethod';
$argument = $this->getRandomString();
/** @var MockObject $mock */
$mock = new(IsMockableClass::class);
if ($fqClassName === 'mockObject') {
$fqClassName = $mock;
}
$mock = $this->getMockBuilder(IsMockableClass::class)
->getMock();
// method from mocked class will never call, run method from parent class only
$mock->expects($this->never())->method($methodName);
$this->assertSame(
$expected.$argument,
'ParentClass::myMethod##'.$argument,
$this->callMethod(
$mock,
'd3CallMockableFunction',
[[$fqClassName, $methodName], [$argument]]
)
);
}
public function callMockableFunctionFromClassDataProvider(): Generator
{
yield 'parent static method' => [IsMockableParent::class, 'ParentClass::myMethod##'];
yield 'current static method' => [IsMockableClass::class, 'currentClass::myMethod##'];
yield 'current object method' => ['mockObject', 'currentClass::myMethod##'];
}
/**
* @test
* @return void
* @throws ReflectionException
* @covers \D3\TestingTools\Production\IsMockable::d3GetMockableOxNewObject
*/
public function canGetMockableOxNewObject()
{
/** @var MockObject $mock */
$mock = new(IsMockableClass::class);
$this->assertInstanceOf(
Article::class,
$this->callMethod(
$mock,
'd3GetMockableOxNewObject',
[Article::class]
'd3CallMockableParent',
[$methodName, [$argument]]
)
);
}

View File

@ -25,7 +25,7 @@
"MIT"
],
"require": {
"php": "^8"
"php": "^7.1 || ^8"
},
"require-dev": {
"phpunit/phpunit" : "^9.5",
@ -39,9 +39,8 @@
}
},
"scripts": {
"runtests": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --bootstrap=source/bootstrap.php --config=vendor/d3/testingtools/",
"php-cs-fixer_audit": "./vendor/bin/php-cs-fixer list-files --config=./vendor/d3/testingtools/.php-cs-fixer.php",
"php-cs-fixer_fix": "./vendor/bin/php-cs-fixer fix --config=./vendor/d3/testingtools/.php-cs-fixer.php",
"phpstan": "./vendor/bin/phpstan analyse -c./vendor/d3/testingtools/phpstan.neon"
"runtests": "./vendor/bin/phpunit",
"csfixer": "./vendor/bin/php-cs-fixer fix",
"phpstan": "./vendor/bin/phpstan analyse src Tests"
}
}

View File

@ -1,12 +1,6 @@
parameters:
scanFiles:
- ../../oxid-esales/oxideshop-ce/source/bootstrap.php
- ../../oxid-esales/oxideshop-ce/source/oxfunctions.php
- ../../oxid-esales/oxideshop-ce/source/overridablefunctions.php
paths:
- .
level: 9
phpVersion: 80000
phpVersion: 70100
checkMissingIterableValueType: false
ignoreErrors:
- '#Property D3\\TestingTools\\Tests\\Unit\\Development\\HelperClasses\\CanAccessRestrictedClass::\$privateProperty is never read, only written.#'

View File

@ -23,33 +23,32 @@ use ReflectionProperty;
trait CanAccessRestricted
{
/**
* Calls a public, private or protected object method.
* Calls a private or protected object method.
*
* @param object $object
* @param string $methodName
* @param array $arguments
* @param array $arguments
*
* @return mixed
* @throws ReflectionException
*/
public function callMethod(object $object, string $methodName, array $arguments = []): mixed
public function callMethod($object, string $methodName, array $arguments = [])
{
$class = new ReflectionClass($object);
$class = new ReflectionClass($object);
$method = $class->getMethod($methodName);
$method->setAccessible(true);
return $method->invokeArgs($object, $arguments);
}
/**
* Sets a public, private or protected property in class instance
* Sets a private or protected property in defined class instance
*
* @param object $object
* @param string $valueName
* @param mixed $value
* @throws ReflectionException
*/
public function setValue(object $object, string $valueName, mixed $value): void
public function setValue($object, string $valueName, $value): void
{
$reflection = new ReflectionClass($object);
$property = $reflection->getProperty($valueName);
@ -58,14 +57,14 @@ trait CanAccessRestricted
}
/**
* get a public, private or protected property from class instance
* get a private or protected property from defined class instance
*
* @param object $object
* @param string $valueName
* @return mixed
* @throws ReflectionException
*/
public function getValue(object $object, string $valueName): mixed
public function getValue($object, string $valueName)
{
$reflection = new ReflectionClass($object);
$property = $reflection->getProperty($valueName);
@ -74,7 +73,7 @@ trait CanAccessRestricted
}
/**
* Sets a public, private or protected property in mocked class instance based on original class
* Sets a private or protected property in mocked class instance based on original class
* (required for e.g. final properties, which aren't contained in mock, but in original class)
* @param string $mockedClassName * FQNS of original class
* @param MockObject $object * mock object
@ -83,7 +82,7 @@ trait CanAccessRestricted
*
* @throws ReflectionException
*/
public function setMockedClassValue(string $mockedClassName, MockObject $object, string $valueName, mixed $value): void
public function setMockedClassValue(string $mockedClassName, MockObject $object, string $valueName, $value): void
{
$property = new ReflectionProperty($mockedClassName, $valueName);
$property->setAccessible(true);
@ -101,7 +100,7 @@ trait CanAccessRestricted
* @return mixed
* @throws ReflectionException
*/
public function getMockedClassValue(string $mockedClassName, MockObject $object, string $valueName): mixed
public function getMockedClassValue(string $mockedClassName, MockObject $object, string $valueName)
{
$property = new ReflectionProperty($mockedClassName, $valueName);
$property->setAccessible(true);

View File

@ -15,80 +15,26 @@ declare(strict_types=1);
namespace D3\TestingTools\Production;
use OxidEsales\Eshop\Core\Registry;
use Psr\Log\LoggerInterface;
use RuntimeException as RuntimeExceptionAlias;
trait IsMockable
{
/**
* mockable wrapper for uncertain parent calls
*
* @param callable $callable
* @param string $methodName
* @param array $arguments
*
* @return false|mixed
*/
protected function d3CallMockableFunction(callable $callable, array $arguments = []): mixed
protected function d3CallMockableParent(string $methodName, array $arguments = [])
{
return call_user_func_array($callable, $arguments);
}
if (get_parent_class($this)) {
/** @var callable $callable */
$callable = [ parent::class, $methodName ];
return call_user_func_array($callable, $arguments);
}
/**
* for mocking use callback:
*
* $object->method('d3GetMockableOxNewObject')->willReturnCallback(
* function () use ($manufacturerMock) {
* $args = func_get_args();
* switch ($args[0]) {
* case Article::class:
* return $manufacturerMock;
* default:
* return call_user_func_array("oxNew", $args);
* }
* }
* );
*
* @template T
* @param class-string<T> $className
* @param mixed ...$args constructor arguments
*
* @return T
*/
protected function d3GetMockableOxNewObject(string $className, mixed ...$args)
{
$arguments = func_get_args();
return call_user_func_array("oxNew", $arguments);
}
/**
* for mocking use callback:
*
* $object->method('d3GetMockableRegistryObject')->willReturnCallback(
* function () use ($utilsServerMock) {
* $args = func_get_args();
* switch ($args[0]) {
* case UtilsServer::class:
* return $utilsServerMock;
* default:
* return Registry::get($args[0]);
* }
* }
*
* @template T
* @param class-string<T> $className
*
* @return T
*/
protected function d3GetMockableRegistryObject(string $className)
{
return Registry::get($className);
}
/**
* @return LoggerInterface
*/
public function d3GetMockableLogger(): LoggerInterface
{
return Registry::getLogger();
throw new RuntimeExceptionAlias('Cannot use "parent" when current class scope has no parent');
}
}