Page MenuHomeWickedGov Phorge

UserAgentClientHintsFormatterTest.php
No OneTemporary

Size
4 KB
Referenced Files
None
Subscribers
None

UserAgentClientHintsFormatterTest.php

<?php
namespace MediaWiki\CheckUser\Tests\Integration\Services;
use MediaWiki\CheckUser\ClientHints\ClientHintsData;
use MediaWiki\CheckUser\Services\UserAgentClientHintsFormatter;
use MediaWiki\CheckUser\Tests\CheckUserClientHintsCommonTraitTest;
use MediaWikiIntegrationTestCase;
use Wikimedia\TestingAccessWrapper;
/**
* @group Database
* @group CheckUser
*
* @covers \MediaWiki\CheckUser\Services\UserAgentClientHintsFormatter
*/
class UserAgentClientHintsFormatterTest extends MediaWikiIntegrationTestCase {
use CheckUserClientHintsCommonTraitTest;
/** @dataProvider provideFormatClientHintsDataObject */
public function testFormatClientHintsDataObject( $clientHintsData, $expectedFormattedString ) {
$this->overrideConfigValues( [
'CheckUserClientHintsForDisplay' => [
"model",
"fullVersionList",
"platformVersion",
"platform",
"userAgent",
"brands",
"formFactor",
"architecture",
"mobile",
"bitness",
"woW64"
],
'CheckUserClientHintsValuesToHide' => [
"architecture" => [ "x86" ],
"bitness" => [ "64" ],
"woW64" => [ false ]
],
] );
/** @var UserAgentClientHintsFormatter $objectUnderTest */
$objectUnderTest = $this->getServiceContainer()->get( 'UserAgentClientHintsFormatter' );
$this->assertSame(
$expectedFormattedString,
$objectUnderTest->formatClientHintsDataObject( $clientHintsData ),
'Returned string from ::formatClientHintsDataObject was not as expected.'
);
}
public static function provideFormatClientHintsDataObject() {
return [
'Empty Client Hints data object' => [
ClientHintsData::newFromJsApi( [] ),
''
],
'Example Client Hints data object for Windows PC using Chrome' => [
new ClientHintsData(
"x86",
"64",
[
[ "brand" => "Not.A/Brand", "version" => "99" ],
[ "brand" => "Google Chrome", "version" => "115" ],
[ "brand" => "Chromium", "version" => "115" ],
],
null,
[
[ "brand" => "Not.A/Brand", "version" => "99.0.0.0" ],
[ "brand" => "Google Chrome", "version" => "115.0.5790.171" ],
[ "brand" => "Chromium", "version" => "115.0.5790.171" ],
],
false,
"",
"Windows",
"15.0.0",
null,
false
),
'Brand: Not.A/Brand 99.0.0.0, Brand: Google Chrome 115.0.5790.171, Brand: Chromium 115.0.5790.171, ' .
'Platform: Windows 15.0.0, Mobile: No'
],
'Example Client Hints data object for Mobile using Chrome' => [
new ClientHintsData(
"",
"32",
[
[ "brand" => "Not/A)Brand", "version" => "99" ],
[ "brand" => "Google Chrome", "version" => "115" ],
[ "brand" => "Chromium", "version" => "115" ],
],
null,
[
[ "brand" => "Not/A)Brand", "version" => "99.0.0.0" ],
[ "brand" => "Google Chrome", "version" => "115.0.5790.171" ],
[ "brand" => "Chromium", "version" => "115.0.5790.171" ],
],
true,
"SM-G965U",
"Android",
"10.0.0",
'',
false
),
'Model: SM-G965U, Brand: Not/A)Brand 99.0.0.0, Brand: Google Chrome 115.0.5790.171, Brand: ' .
'Chromium 115.0.5790.171, Platform: Android 10.0.0, Mobile: Yes, Bitness: 32'
],
];
}
/** @dataProvider provideGenerateMsgCache */
public function testGenerateMsgCache( $expectedMessageKeys ) {
/** @var UserAgentClientHintsFormatter $objectUnderTest */
$objectUnderTest = $this->getServiceContainer()->get( 'UserAgentClientHintsFormatter' );
$objectUnderTest = TestingAccessWrapper::newFromObject( $objectUnderTest );
// ::generateMsgCache should be called in the constructor for the service, so no need to call it again.
$this->assertArrayEquals(
$expectedMessageKeys,
array_keys( $objectUnderTest->msgCache ),
false,
false,
'::generateMsgCache has not generated the msgCache property with the expected array keys.'
);
foreach ( $expectedMessageKeys as $key ) {
$this->assertSame(
wfMessage( $key )->escaped(),
$objectUnderTest->msgCache[$key],
"::generateMsgCache did not cache the correct text for message with key '$key'."
);
}
}
public static function provideGenerateMsgCache() {
return [
'All message keys to be cached' => [ [
'checkuser-clienthints-value-yes', 'checkuser-clienthints-value-no',
...array_unique( array_values( UserAgentClientHintsFormatter::NAME_TO_MESSAGE_KEY ) )
] ]
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Nov 21, 22:52 (1 d, 23 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
78/07/e577cd9c73f9c828886aa6f01569
Default Alt Text
UserAgentClientHintsFormatterTest.php (4 KB)

Event Timeline