Page MenuHomeWickedGov Phorge
Files F4152780

ValidationRunnerTest.php
No OneTemporary
Actions

Size
7 KB
Referenced Files
None
Subscribers
None

ValidationRunnerTest.php
View Options

<?php
/**
* Tests for Message Validator and ValidatorResult.
*
* @file
* @author Abijeet Patro
* @license GPL-2.0-or-later
*/
use MediaWiki\Context\RequestContext;
use MediaWiki\Extension\Translate\MessageGroupProcessing\MessageGroups;
use MediaWiki\Extension\Translate\Validation\ValidationRunner;
/**
* @group Database
* @covers \MediaWiki\Extension\Translate\Validation\ValidationRunner
* @covers \MediaWiki\Extension\Translate\Validation\ValidationResult
*/
class ValidationRunnerTest extends MediaWikiIntegrationTestCase {
use MessageGroupTestTrait;
protected function setUp(): void {
parent::setUp();
$this->setupGroupTestEnvironmentWithGroups( $this, $this->getTestGroups() );
// Run with empty ignore list by default
$this->overrideConfigValue( 'TranslateValidationExclusionFile', false );
ValidationRunner::reloadIgnorePatterns();
}
public function getTestGroups() {
$messages = [
'translated' => 'bunny',
'untranslated' => 'fanny',
'testing-key' => 'test this!',
'regex-key-test' => 'regex test',
'non-matching-key' => 'non matching key',
'key-excluded' => '',
'regex-exclude' => '',
'wildcard-exclude' => ''
];
$list['test-group'] = new MockWikiValidationMessageGroup( 'test-group', $messages );
return $list;
}
public function testValidateMessage() {
$group = MessageGroups::getGroup( 'test-group' );
$collection = $group->initCollection( 'en-gb' );
$collection->loadTranslations();
$msgValidator = $group->getValidator();
$validationResult = $msgValidator->validateMessage(
$collection[ 'translated' ],
'en-gb'
);
$this->assertTrue(
$validationResult->hasErrors(),
'errors are correctly identified.'
);
$this->assertTrue(
$validationResult->hasWarnings(),
'warnings are correctly identified.'
);
$this->assertCount(
1,
$validationResult->getWarnings(),
'there is 1 warning returned as per the validator.'
);
$this->assertCount(
2,
$validationResult->getErrors(),
'there are 2 errors returned as per the validator.'
);
$validationResult = $msgValidator->validateMessage(
$collection[ 'translated' ],
'en-gb',
true // ignore warnings
);
$this->assertTrue(
$validationResult->hasErrors(),
'errors are correctly identified if ignore warnings is set.'
);
$this->assertFalse(
$validationResult->hasWarnings(),
'warnings are ignored if ignore warnings is set.'
);
}
public function testQuickValidate() {
$group = MessageGroups::getGroup( 'test-group' );
$collection = $group->initCollection( 'en-gb' );
$collection->loadTranslations();
$msgValidator = $group->getValidator();
$validationResult = $msgValidator->quickValidate( $collection[ 'translated' ], 'en-gb' );
$this->assertTrue(
$validationResult->hasIssues(),
'either errors or warnings are set.'
);
$this->assertFalse(
$validationResult->hasWarnings() && $validationResult->hasErrors(),
'either error or warnings are set, but not both.'
);
$this->assertCount(
1,
$validationResult->getIssues(),
'there is a single warning or error returned as per the validator.'
);
$validationResult = $msgValidator->quickValidate(
$collection[ 'translated' ],
'en-gb',
true // ignore warnings
);
$this->assertTrue(
$validationResult->hasErrors(),
'errors are identified if ignore warnings is set.'
);
$this->assertFalse(
$validationResult->hasWarnings(),
'warnings are not identified if ignore warnings is set.'
);
}
public function testDescriptiveMessage() {
$group = MessageGroups::getGroup( 'test-group' );
$collection = $group->initCollection( 'en-gb' );
$collection->loadTranslations();
$msgValidator = $group->getValidator();
$validationResult = $msgValidator->validateMessage( $collection[ 'translated' ], 'en-gb' );
$requestContext = new RequestContext();
$requestContext->setLanguage( 'en' );
$this->assertSameSize(
$validationResult->getErrors(),
$validationResult->getDescriptiveErrors( $requestContext ),
'the number of descriptive errors messages matches the number of errors.'
);
$this->assertSameSize(
$validationResult->getWarnings(),
$validationResult->getDescriptiveWarnings( $requestContext ),
'the number of descriptive warnings messages matches the number of warnings.'
);
$this->assertIsString(
$validationResult->getDescriptiveWarnings( $requestContext )[0],
'warning messages are of type string.'
);
$this->assertIsString(
$validationResult->getDescriptiveErrors( $requestContext )[0],
'error messages are of type string'
);
}
public function testIgnoreList() {
$this->overrideConfigValue( 'TranslateValidationExclusionFile',
__DIR__ . '/../data/validation-exclusion-list.php' );
$group = MessageGroups::getGroup( 'test-group' );
$collection = $group->initCollection( 'en-gb' );
$collection->loadTranslations();
$collectionFr = $group->initCollection( 'fr' );
$collectionFr->loadTranslations();
$msgValidator = $group->getValidator();
$msgValidator::reloadIgnorePatterns();
$validationResult = $msgValidator->validateMessage( $collection[ 'translated' ], 'en-gb' );
$this->assertCount(
1,
$validationResult->getIssues(),
'warnings or errors are filtered as per validation-exclusion-list.'
);
$validationResult = $msgValidator->validateMessage( $collectionFr[ 'translated' ], 'fr' );
$this->assertGreaterThan(
1,
count( $validationResult->getIssues() ),
'warnings or errors are filtered as per validation-exclusion-list only for specific language code.'
);
$validationResult = $msgValidator->quickValidate( $collection['translated'], 'en-gb' );
$this->assertCount(
1,
$validationResult->getIssues(),
'warnings or errors are filtered as per validation-exclusion-list.'
);
$validationResult = $msgValidator->quickValidate( $collectionFr[ 'translated' ], 'fr' );
$this->assertCount(
1,
$validationResult->getIssues(),
'warnings or errors are filtered as per validation-exclusion-list only for specific language code.'
);
$validationResult = $msgValidator->validateMessage( $collectionFr['regex-key-test'], 'fr' );
$this->assertCount(
0,
$validationResult->getIssues(),
'warnings or errors are filtered as per validation-exclusion-list for specific message key.'
);
}
public function testKeyInclusion() {
$group = MessageGroups::getGroup( 'test-group' );
$collection = $group->initCollection( 'en-gb' );
$collection->loadTranslations();
$msgValidator = $group->getValidator();
$validationResult = $msgValidator->validateMessage( $collection['testing-key'], 'en-gb' );
$this->assertCount(
0,
$validationResult->getErrors(),
'no errors are raised for a non matching key!'
);
$validationResult = $msgValidator->validateMessage( $collection['regex-key-test'], 'en-gb' );
$this->assertCount(
2,
$validationResult->getErrors(),
'errors are raised for a matching key matched via regex!'
);
$validationResult = $msgValidator->validateMessage( $collection['translated'], 'en-gb' );
$this->assertCount(
2,
$validationResult->getErrors(),
'errors are raised for a matching key matched via a direct match!'
);
}
public function testKeyExclusion() {
$group = MessageGroups::getGroup( 'test-group' );
$collection = $group->initCollection( 'en-gb' );
$collection->loadTranslations();
$msgValidator = $group->getValidator();
$validationResult = $msgValidator->validateMessage( $collection['regex-key-test'], 'en-gb' );
$this->assertGreaterThan(
0,
count( $validationResult->getErrors() ),
'errors are raised for a matching key matched via regex!'
);
$excludedKeys = [
'key-excluded',
'regex-exclude',
'wildcard-exclude'
];
foreach ( $excludedKeys as $key ) {
$validationResult = $msgValidator->validateMessage( $collection[$key], 'en-gb' );
$this->assertCount(
0,
$validationResult->getErrors(),
'errors are not raised for an excluded key: ' . $key
);
}
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 19 2026, 20:29 (7 w, 4 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
40/e1/5f1b36da720dbbe2d5085e3b7a92
Default Alt Text
ValidationRunnerTest.php (7 KB)

Event Timeline