Skip to content

Refactor tests: move ReflectionProperty::setAccessible handling into helper method #3405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
arshidkv12 wants to merge 2 commits into from
Closed

Refactor tests: move ReflectionProperty::setAccessible handling into helper method #3405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bff2667
Refactor tests: move ReflectionProperty::setAccessible handling into …
Aug 23, 2025
c9ee18d
Merge branch '4.x' into remove_redundant_code
odan Nov 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions tests/AppTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -703,18 +703,18 @@ public function testAddRoutingMiddleware(): void

// Check that the routing middleware really has been added to the tip of the app middleware stack.
$middlewareDispatcherProperty = new ReflectionProperty(App::class, 'middlewareDispatcher');
$middlewareDispatcherProperty->setAccessible(true);
$this->setAccessible($middlewareDispatcherProperty);
/** @var MiddlewareDispatcher $middlewareDispatcher */
$middlewareDispatcher = $middlewareDispatcherProperty->getValue($app);

$tipProperty = new ReflectionProperty(MiddlewareDispatcher::class, 'tip');
$tipProperty->setAccessible(true);
$this->setAccessible($tipProperty);
/** @var RequestHandlerInterface $tip */
$tip = $tipProperty->getValue($middlewareDispatcher);

$reflection = new ReflectionClass($tip);
$middlewareProperty = $reflection->getProperty('middleware');
$middlewareProperty->setAccessible(true);
$this->setAccessible($middlewareProperty);

$this->assertSame($routingMiddleware, $middlewareProperty->getValue($tip));
$this->assertInstanceOf(RoutingMiddleware::class, $routingMiddleware);
Expand All @@ -736,18 +736,18 @@ public function testAddErrorMiddleware(): void

// Check that the error middleware really has been added to the tip of the app middleware stack.
$middlewareDispatcherProperty = new ReflectionProperty(App::class, 'middlewareDispatcher');
$middlewareDispatcherProperty->setAccessible(true);
$this->setAccessible($middlewareDispatcherProperty);
/** @var MiddlewareDispatcher $middlewareDispatcher */
$middlewareDispatcher = $middlewareDispatcherProperty->getValue($app);

$tipProperty = new ReflectionProperty(MiddlewareDispatcher::class, 'tip');
$tipProperty->setAccessible(true);
$this->setAccessible($tipProperty);
/** @var RequestHandlerInterface $tip */
$tip = $tipProperty->getValue($middlewareDispatcher);

$reflection = new ReflectionClass($tip);
$middlewareProperty = $reflection->getProperty('middleware');
$middlewareProperty->setAccessible(true);
$this->setAccessible($middlewareProperty);

$this->assertSame($errorMiddleware, $middlewareProperty->getValue($tip));
$this->assertInstanceOf(ErrorMiddleware::class, $errorMiddleware);
Expand All @@ -766,18 +766,18 @@ public function testAddBodyParsingMiddleware(): void

// Check that the body parsing middleware really has been added to the tip of the app middleware stack.
$middlewareDispatcherProperty = new ReflectionProperty(App::class, 'middlewareDispatcher');
$middlewareDispatcherProperty->setAccessible(true);
$this->setAccessible($middlewareDispatcherProperty);
/** @var MiddlewareDispatcher $middlewareDispatcher */
$middlewareDispatcher = $middlewareDispatcherProperty->getValue($app);

$tipProperty = new ReflectionProperty(MiddlewareDispatcher::class, 'tip');
$tipProperty->setAccessible(true);
$this->setAccessible($tipProperty);
/** @var RequestHandlerInterface $tip */
$tip = $tipProperty->getValue($middlewareDispatcher);

$reflection = new ReflectionClass($tip);
$middlewareProperty = $reflection->getProperty('middleware');
$middlewareProperty->setAccessible(true);
$this->setAccessible($middlewareProperty);

$this->assertSame($bodyParsingMiddleware, $middlewareProperty->getValue($tip));
$this->assertInstanceOf(BodyParsingMiddleware::class, $bodyParsingMiddleware);
Expand Down
8 changes: 4 additions & 4 deletions tests/Error/AbstractErrorRendererTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public function testHTMLErrorRendererRenderFragmentMethod()
$reflectionRenderer = new ReflectionClass(HtmlErrorRenderer::class);

$method = $reflectionRenderer->getMethod('renderExceptionFragment');
$method->setAccessible(true);
$this->setAccessible($method);
$output = $method->invoke($renderer, $exception);

$this->assertMatchesRegularExpression('/.*Type:*/', $output);
Expand Down Expand Up @@ -101,7 +101,7 @@ public function testJSONErrorRendererDisplaysErrorDetails()
$reflectionRenderer = new ReflectionClass(JsonErrorRenderer::class);

$method = $reflectionRenderer->getMethod('formatExceptionFragment');
$method->setAccessible(true);
$this->setAccessible($method);

$fragment = $method->invoke($renderer, $exception);
$output = json_encode(json_decode($renderer->__invoke($exception, true)));
Expand All @@ -128,7 +128,7 @@ public function testJSONErrorRendererDisplaysPreviousError()
$renderer = new JsonErrorRenderer();
$reflectionRenderer = new ReflectionClass(JsonErrorRenderer::class);
$method = $reflectionRenderer->getMethod('formatExceptionFragment');
$method->setAccessible(true);
$this->setAccessible($method);

$output = json_encode(json_decode($renderer->__invoke($exception, true)));

Expand Down Expand Up @@ -208,7 +208,7 @@ public function testPlainTextErrorRendererFormatFragmentMethod()
$reflectionRenderer = new ReflectionClass(PlainTextErrorRenderer::class);

$method = $reflectionRenderer->getMethod('formatExceptionFragment');
$method->setAccessible(true);
$this->setAccessible($method);
$output = $method->invoke($renderer, $exception);
$this->assertIsString($output);

Expand Down
4 changes: 2 additions & 2 deletions tests/Factory/AppFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ public function testCreateAppWithAllImplementations(string $psr17factory, string
$routeCollector = $app->getRouteCollector();

$responseFactoryProperty = new ReflectionProperty(RouteCollector::class, 'responseFactory');
$responseFactoryProperty->setAccessible(true);
$this->setAccessible($responseFactoryProperty);

$responseFactory = $responseFactoryProperty->getValue($routeCollector);

Expand Down Expand Up @@ -281,7 +281,7 @@ public function testResponseAndStreamFactoryIsBeingInjectedInDecoratedResponseFa
$response = $responseFactory->createResponse();

$streamFactoryProperty = new ReflectionProperty(DecoratedResponse::class, 'streamFactory');
$streamFactoryProperty->setAccessible(true);
$this->setAccessible($streamFactoryProperty);

$this->assertSame($streamFactoryProphecy->reveal(), $streamFactoryProperty->getValue($response));
}
Expand Down
4 changes: 2 additions & 2 deletions tests/Factory/Psr17/SlimHttpServerRequestCreatorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public function tearDown(): void
SlimHttpServerRequestCreator::class,
'serverRequestDecoratorClass'
);
$serverRequestDecoratorClassProperty->setAccessible(true);
$this->setAccessible($serverRequestDecoratorClassProperty);
$serverRequestDecoratorClassProperty->setValue($slimHttpServerRequestCreator, ServerRequest::class);
}

Expand Down Expand Up @@ -69,7 +69,7 @@ public function testCreateServerRequestFromGlobalsThrowsRuntimeException()
SlimHttpServerRequestCreator::class,
'serverRequestDecoratorClass'
);
$serverRequestDecoratorClassProperty->setAccessible(true);
$this->setAccessible($serverRequestDecoratorClassProperty);
$serverRequestDecoratorClassProperty->setValue($slimHttpServerRequestCreator, '');

$slimHttpServerRequestCreator->createServerRequestFromGlobals();
Expand Down
44 changes: 22 additions & 22 deletions tests/Handlers/ErrorHandlerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ public function testDetermineRenderer()
$class = new ReflectionClass(ErrorHandler::class);

$callableResolverProperty = $class->getProperty('callableResolver');
$callableResolverProperty->setAccessible(true);
$this->setAccessible($callableResolverProperty);
$callableResolverProperty->setValue($handler, $this->getCallableResolver());

$reflectionProperty = $class->getProperty('contentType');
$reflectionProperty->setAccessible(true);
$this->setAccessible($reflectionProperty);
$reflectionProperty->setValue($handler, 'application/json');

$method = $class->getMethod('determineRenderer');
$method->setAccessible(true);
$this->setAccessible($method);

$renderer = $method->invoke($handler);
$this->assertIsCallable($renderer);
Expand Down Expand Up @@ -78,15 +78,15 @@ public function testDetermineStatusCode()
$class = new ReflectionClass(ErrorHandler::class);

$reflectionProperty = $class->getProperty('responseFactory');
$reflectionProperty->setAccessible(true);
$this->setAccessible($reflectionProperty);
$reflectionProperty->setValue($handler, $this->getResponseFactory());

$reflectionProperty = $class->getProperty('exception');
$reflectionProperty->setAccessible(true);
$this->setAccessible($reflectionProperty);
$reflectionProperty->setValue($handler, new HttpNotFoundException($request));

$method = $class->getMethod('determineStatusCode');
$method->setAccessible(true);
$this->setAccessible($method);

$statusCode = $method->invoke($handler);
$this->assertSame($statusCode, 404);
Expand Down Expand Up @@ -133,15 +133,15 @@ public function testHalfValidContentType()
$class = new ReflectionClass(ErrorHandler::class);

$reflectionProperty = $class->getProperty('responseFactory');
$reflectionProperty->setAccessible(true);
$this->setAccessible($reflectionProperty);
$reflectionProperty->setValue($handler, $this->getResponseFactory());

$reflectionProperty = $class->getProperty('errorRenderers');
$reflectionProperty->setAccessible(true);
$this->setAccessible($reflectionProperty);
$reflectionProperty->setValue($handler, $newErrorRenderers);

$method = $class->getMethod('determineContentType');
$method->setAccessible(true);
$this->setAccessible($method);

$contentType = $method->invoke($handler, $request);

Expand All @@ -165,15 +165,15 @@ public function testDetermineContentTypeTextPlainMultiAcceptHeader()
$class = new ReflectionClass(ErrorHandler::class);

$reflectionProperty = $class->getProperty('responseFactory');
$reflectionProperty->setAccessible(true);
$this->setAccessible($reflectionProperty);
$reflectionProperty->setValue($handler, $this->getResponseFactory());

$reflectionProperty = $class->getProperty('errorRenderers');
$reflectionProperty->setAccessible(true);
$this->setAccessible($reflectionProperty);
$reflectionProperty->setValue($handler, $errorRenderers);

$method = $class->getMethod('determineContentType');
$method->setAccessible(true);
$this->setAccessible($method);

$contentType = $method->invoke($handler, $request);

Expand All @@ -196,15 +196,15 @@ public function testDetermineContentTypeApplicationJsonOrXml()
$class = new ReflectionClass(ErrorHandler::class);

$reflectionProperty = $class->getProperty('responseFactory');
$reflectionProperty->setAccessible(true);
$this->setAccessible($reflectionProperty);
$reflectionProperty->setValue($handler, $this->getResponseFactory());

$reflectionProperty = $class->getProperty('errorRenderers');
$reflectionProperty->setAccessible(true);
$this->setAccessible($reflectionProperty);
$reflectionProperty->setValue($handler, $errorRenderers);

$method = $class->getMethod('determineContentType');
$method->setAccessible(true);
$this->setAccessible($method);

$contentType = $method->invoke($handler, $request);

Expand All @@ -224,7 +224,7 @@ public function testAcceptableMediaTypeIsNotFirstInList()
// provide access to the determineContentType() as it's a protected method
$class = new ReflectionClass(ErrorHandler::class);
$method = $class->getMethod('determineContentType');
$method->setAccessible(true);
$this->setAccessible($method);

// use a mock object here as ErrorHandler cannot be directly instantiated
$handler = $this->createMock(ErrorHandler::class);
Expand All @@ -242,7 +242,7 @@ public function testRegisterErrorRenderer()

$reflectionClass = new ReflectionClass(ErrorHandler::class);
$reflectionProperty = $reflectionClass->getProperty('errorRenderers');
$reflectionProperty->setAccessible(true);
$this->setAccessible($reflectionProperty);
$errorRenderers = $reflectionProperty->getValue($handler);

$this->assertArrayHasKey('application/slim', $errorRenderers);
Expand All @@ -255,11 +255,11 @@ public function testSetDefaultErrorRenderer()

$reflectionClass = new ReflectionClass(ErrorHandler::class);
$reflectionProperty = $reflectionClass->getProperty('defaultErrorRenderer');
$reflectionProperty->setAccessible(true);
$this->setAccessible($reflectionProperty);
$defaultErrorRenderer = $reflectionProperty->getValue($handler);

$defaultErrorRendererContentTypeProperty = $reflectionClass->getProperty('defaultErrorRendererContentType');
$defaultErrorRendererContentTypeProperty->setAccessible(true);
$this->setAccessible($defaultErrorRendererContentTypeProperty);
$defaultErrorRendererContentType = $defaultErrorRendererContentTypeProperty->getValue($handler);

$this->assertSame(PlainTextErrorRenderer::class, $defaultErrorRenderer);
Expand Down Expand Up @@ -396,16 +396,16 @@ public function testLogErrorRenderer()
$handler->setLogErrorRenderer('logErrorRenderer');

$displayErrorDetailsProperty = new ReflectionProperty($handler, 'displayErrorDetails');
$displayErrorDetailsProperty->setAccessible(true);
$this->setAccessible($displayErrorDetailsProperty);
$displayErrorDetailsProperty->setValue($handler, true);

$exception = new RuntimeException();
$exceptionProperty = new ReflectionProperty($handler, 'exception');
$exceptionProperty->setAccessible(true);
$this->setAccessible($exceptionProperty);
$exceptionProperty->setValue($handler, $exception);

$writeToErrorLogMethod = new ReflectionMethod($handler, 'writeToErrorLog');
$writeToErrorLogMethod->setAccessible(true);
$this->setAccessible($writeToErrorLogMethod);
$writeToErrorLogMethod->invoke($handler);
}
}
4 changes: 2 additions & 2 deletions tests/Middleware/OutputBufferingMiddlewareTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public function testStyleDefaultValid()
$middleware = new OutputBufferingMiddleware($this->getStreamFactory());

$reflectionProperty = new ReflectionProperty($middleware, 'style');
$reflectionProperty->setAccessible(true);
$this->setAccessible($reflectionProperty);
$value = $reflectionProperty->getValue($middleware);

$this->assertSame('append', $value);
Expand All @@ -37,7 +37,7 @@ public function testStyleCustomValid()
$middleware = new OutputBufferingMiddleware($this->getStreamFactory(), 'prepend');

$reflectionProperty = new ReflectionProperty($middleware, 'style');
$reflectionProperty->setAccessible(true);
$this->setAccessible($reflectionProperty);
$value = $reflectionProperty->getValue($middleware);

$this->assertSame('prepend', $value);
Expand Down
2 changes: 1 addition & 1 deletion tests/ResponseEmitterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ public function testWillHandleInvalidConnectionStatusWithAnIndeterminateBody():

$mirror = new ReflectionClass(ResponseEmitter::class);
$emitBodyMethod = $mirror->getMethod('emitBody');
$emitBodyMethod->setAccessible(true);
$this->setAccessible($emitBodyMethod);
$emitBodyMethod->invoke($responseEmitter, $response);

$this->expectOutputString("");
Expand Down
8 changes: 4 additions & 4 deletions tests/Routing/DispatcherTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public function testCreateDispatcher()
$dispatcher = new Dispatcher($routeCollector);

$method = new ReflectionMethod(Dispatcher::class, 'createDispatcher');
$method->setAccessible(true);
$this->setAccessible($method);

$this->assertInstanceOf(FastRouteDispatcher::class, $method->invoke($dispatcher));
}
Expand All @@ -57,7 +57,7 @@ public function testRouteCacheFileCanBeDispatched()
$routeCollector->setCacheFile($cacheFile);

$method = new ReflectionMethod(Dispatcher::class, 'createDispatcher');
$method->setAccessible(true);
$this->setAccessible($method);
$method->invoke($dispatcher);
$this->assertFileExists($cacheFile, 'cache file was not created');

Expand All @@ -66,7 +66,7 @@ public function testRouteCacheFileCanBeDispatched()
$dispatcher2 = new Dispatcher($routeCollector2);

$method = new ReflectionMethod(Dispatcher::class, 'createDispatcher');
$method->setAccessible(true);
$this->setAccessible($method);
$method->invoke($dispatcher2);

/** @var RoutingResults $result */
Expand All @@ -88,7 +88,7 @@ public function testCreateDispatcherReturnsSameDispatcherASecondTime()
$dispatcher = new Dispatcher($routeCollector);

$method = new ReflectionMethod(Dispatcher::class, 'createDispatcher');
$method->setAccessible(true);
$this->setAccessible($method);

$fastRouteDispatcher = $method->invoke($dispatcher);
$fastRouteDispatcher2 = $method->invoke($dispatcher);
Expand Down
10 changes: 10 additions & 0 deletions tests/TestCase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,14 @@ protected function createStream(string $contents = ''): StreamInterface
$psr7ObjectProvider = new PSR7ObjectProvider();
return $psr7ObjectProvider->createStream($contents);
}

/**
* @param ReflectionProperty|ReflectionMethod $property
*/
protected function setAccessible($property): void
{
if (PHP_VERSION_ID < 80100) {
$property->setAccessible(true);
}
}
}