Page MenuHomeWickedGov Phorge
Files F4091930

SerializationTestUtils.php
No OneTemporary
Actions

Size
7 KB
Referenced Files
None
Subscribers
None

SerializationTestUtils.php
View Options

<?php
// phpcs:disable MediaWiki.Commenting.FunctionComment.ObjectTypeHintReturn
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Cache Parser
*/
namespace Wikimedia\Tests;
use InvalidArgumentException;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
/**
* Utilities for testing forward and backward compatibility serialized objects.
*/
class SerializationTestUtils {
/** @var string */
private $serializedDataPath;
/** @var string */
private $ext;
/** @var callable */
private $serializer;
/** @var callable */
private $deserializer;
/** @var array */
private $testInstances;
/** @var LoggerInterface */
private $logger;
/**
* @param string $serializedDataPath absolute path to the directory with serialized objects.
* @param array $testInstances map of test names to test objects.
* @param string $ext file extension for serialized instance files
* @param callable $serializer
* @param callable $deserializer
*/
public function __construct(
string $serializedDataPath,
array $testInstances,
string $ext,
callable $serializer,
callable $deserializer
) {
if ( !is_dir( $serializedDataPath ) ) {
throw new InvalidArgumentException( "{$serializedDataPath} does not exist" );
}
$this->serializedDataPath = $serializedDataPath;
$this->ext = $ext;
$this->serializer = $serializer;
$this->deserializer = $deserializer;
$this->testInstances = $testInstances;
$this->logger = new NullLogger();
}
public function setLogger( LoggerInterface $logger ): void {
$this->logger = $logger;
}
/**
* Get the files with stored serialized instances of $class with extension $ext.
* @param class-string $class
* @param string $ext
* @return array
*/
private function getMatchingFiles( string $class, string $ext ): array {
$classFile = self::classToFile( $class );
$glob = $this->serializedDataPath . "/*-{$classFile}-*.$ext";
$matches = glob( $glob );
if ( !$matches ) {
$this->log( 'No matches found for ' . $glob );
return [];
}
// File names should look something like this: "1.35-CacheTime-empty.serialized".
$pattern = '!/([^/-]+)-' . preg_quote( $classFile, '!' ) . '-([^/-]+)\.[^/]+$!';
$files = [];
foreach ( $matches as $path ) {
if ( !preg_match( $pattern, $path, $m ) ) {
$this->logger->warning( 'Skipping file with malformed name: ' . $path );
continue;
}
$version = $m[1];
$testCaseName = $m[2];
$files[] = $this->getStoredSerializedInstance( $class, $testCaseName, $version );
}
return $files;
}
/**
* Get an array of test instances for $class keyed with test case name.
* @return object[]
*/
public function getTestInstances(): array {
return $this->testInstances;
}
/**
* Get a test instance of $class for test case named $testCaseName.
* @param string $testCaseName
* @return object
*/
public function getTestInstanceForTestCase( string $testCaseName ): object {
$instances = $this->getTestInstances();
if ( !array_key_exists( $testCaseName, $instances ) ) {
throw new InvalidArgumentException(
"Test instance not found for test case {$testCaseName}"
);
}
return $instances[$testCaseName];
}
/**
* Get an array of instances of $class deserialized from
* files for different code versions, keyed by the test case name.
* @param class-string $class
* @return array
*/
private function getDeserializedInstances( string $class ): array {
return array_map( function ( $fileInfo ) {
$fileInfo->object = ( $this->deserializer )( $fileInfo->data );
return $fileInfo;
}, $this->getMatchingFiles( $class, $this->ext ) );
}
/**
* Get an array of serialization fixtures for $class stored in files
* for different MW versions, for test case name $testCaseName.
* @param class-string $class
* @param string $testCaseName
* @return array
*/
public function getFixturesForTestCase( string $class, string $testCaseName ): array {
return array_filter(
$this->getMatchingFiles( $class, $this->ext ),
static function ( $fileInfo ) use ( $testCaseName ) {
return $fileInfo->testCaseName === $testCaseName;
} );
}
/**
* Get an array of instances of $class deserialized from stored files
* for different MW versions, for test case named $testCaseName.
* @param class-string $class
* @param string $testCaseName
* @return array
*/
public function getDeserializedInstancesForTestCase( string $class, string $testCaseName ): array {
return array_filter( $this->getDeserializedInstances( $class ),
static function ( $fileInfo ) use ( $testCaseName ) {
return $fileInfo->testCaseName === $testCaseName;
}
);
}
/**
* Get test objects of $class, serialized using $serializer,
* keyed by test case name.
*/
public function getSerializedInstances(): array {
$instances = $this->getTestInstances();
return array_map( function ( $object ) {
return ( $this->serializer )( $object );
}, $instances );
}
/**
* Get the file info about a stored serialized instance of $class,
* for test case $testCaseName with extension $ext for $version of MW.
* @param class-string $class
* @param string $testCaseName
* @param string|null $version
* @return \stdClass
*/
public function getStoredSerializedInstance(
string $class,
string $testCaseName,
?string $version = null
) {
$classFile = self::classToFile( $class );
$curPath = "$this->serializedDataPath/{$this->getCurrentVersion()}-$classFile-$testCaseName.$this->ext";
if ( $version ) {
$path = "$this->serializedDataPath/$version-$classFile-$testCaseName.$this->ext";
} else {
// Find the latest version we have saved.
$savedFiles = glob( "$this->serializedDataPath/?.??*-$classFile-$testCaseName.$this->ext" );
if ( count( $savedFiles ) > 0 ) {
// swap _ and - to ensure that 1.43-foo sorts after 1.43_wmf...-foo
usort(
$savedFiles,
static fn ( $a, $b ) => strtr( $a, '-_', '_-' ) <=> strtr( $b, '-_', '_-' )
);
$path = end( $savedFiles );
} else {
// Handle creation of a new test case from scratch (no prior
// serialization file exists)
$path = $curPath;
}
}
return (object)[
'version' => $version,
'class' => $class,
'testCaseName' => $testCaseName,
'ext' => $this->ext,
'path' => $path,
'currentVersionPath' => $curPath,
'data' => is_file( $path ) ? file_get_contents( $path ) : null,
];
}
/**
* Returns the current version of MediaWiki in `1.xx` format.
*/
private function getCurrentVersion(): string {
return preg_replace( '/^(\d\.\d+).*$/', '$1', MW_VERSION );
}
/**
* Clean up the class name to make a filename.
*
* At the moment this strips the namespace prefix; in the future
* we might consider keeping it but replacing backslashes with
* dashes or some such.
*
* @param class-string $class
* @return string A cleaned-up filename
*/
private static function classToFile( string $class ): string {
$arr = explode( '\\', $class );
return end( $arr );
}
private function log( string $msg ) {
$this->logger->info( $msg );
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 18 2026, 11:59 (5 w, 5 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
80/79/1bd90f28c343856f326569a54f68
Default Alt Text
SerializationTestUtils.php (7 KB)

Event Timeline