Page MenuHomeWickedGov Phorge
Files F4099864

TestUtils.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

TestUtils.php
View Options

<?php
namespace MediaWiki\Tests\Session;
use MediaWiki\Session\PHPSessionHandler;
use MediaWiki\Session\Session;
use MediaWiki\Session\SessionBackend;
use MediaWiki\Session\SessionManager;
use PHPUnit\Framework\Assert;
use Psr\Log\LoggerInterface;
use ReflectionClass;
use TestLogger;
use Wikimedia\ScopedCallback;
use Wikimedia\TestingAccessWrapper;
/**
* Utility functions for Session unit tests
*/
class TestUtils {
/**
* Override the singleton for unit testing
* @param SessionManager|null $manager
* @return ScopedCallback|null
*/
public static function setSessionManagerSingleton( ?SessionManager $manager = null ) {
session_write_close();
$staticAccess = TestingAccessWrapper::newFromClass( SessionManager::class );
$oldInstance = $staticAccess->instance;
$reset = [
[ 'instance', $oldInstance ],
[ 'globalSession', $staticAccess->globalSession ],
[ 'globalSessionRequest', $staticAccess->globalSessionRequest ],
];
$staticAccess->instance = $manager;
$staticAccess->globalSession = null;
$staticAccess->globalSessionRequest = null;
if ( $manager && PHPSessionHandler::isInstalled() ) {
PHPSessionHandler::install( $manager );
}
return new ScopedCallback( static function () use ( $reset, $staticAccess, $oldInstance ) {
foreach ( $reset as [ $property, $oldValue ] ) {
$staticAccess->$property = $oldValue;
}
if ( $oldInstance && PHPSessionHandler::isInstalled() ) {
PHPSessionHandler::install( $oldInstance );
}
} );
}
/**
* If you need a SessionBackend for testing but don't want to create a real
* one, use this.
* @return SessionBackend Unconfigured! Use reflection to set any private
* fields necessary.
*/
public static function getDummySessionBackend() {
$rc = new ReflectionClass( SessionBackend::class );
if ( !method_exists( $rc, 'newInstanceWithoutConstructor' ) ) {
Assert::markTestSkipped(
'ReflectionClass::newInstanceWithoutConstructor isn\'t available'
);
}
$ret = $rc->newInstanceWithoutConstructor();
TestingAccessWrapper::newFromObject( $ret )->logger = new TestLogger;
return $ret;
}
/**
* If you need a Session for testing but don't want to create a backend to
* construct one, use this.
* @phpcs:ignore MediaWiki.Commenting.FunctionComment.ObjectTypeHintParam
* @param object|null $backend Object to serve as the SessionBackend
* @param int $index
* @param LoggerInterface|null $logger
* @return Session
*/
public static function getDummySession( $backend = null, $index = -1, $logger = null ) {
$rc = new ReflectionClass( Session::class );
$session = $rc->newInstanceWithoutConstructor();
$priv = TestingAccessWrapper::newFromObject( $session );
$priv->backend = $backend ?? new DummySessionBackend();
$priv->index = $index;
$priv->logger = $logger ?? new TestLogger();
return $session;
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 16:07 (3 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
c0/d9/27f606acde8ef1a8fb2cfae483a7
Default Alt Text
TestUtils.php (2 KB)

Event Timeline