mirror of
https://github.com/symfony/framework-bundle.git
synced 2026-03-24 01:12:20 +01:00
c4f373cbc4
* 8.0: [Serializer] Fix handling of constructor enum denormalization errors [Console] ProgressIndicator console helper display with multiple processes [HttpFoundation] Handle empty session data in updateTimestamp() to fix compat with PHP 8.6 [Console] Fix arguments set via #[Ask] wrongly considered null in profiler [Cache] Wrap `DoctrineDbalAdapter::doSave()` in savepoint to prevent transaction poisoning Update security-1.0.xsd with missing oauth2 element [Console] Silence shell_exec warning in hasSttyAvailable [Validator] Sync validators.pt.xlf Minor: Review and finalize Latvian translations for validators streamline ini settings in phpunit.xml.dist files stop using with*() without expects() stop using with*() without expects() TypeContextFactory::collectTemplates now also works with @phpstan-template and @psalm-template
313 lines
14 KiB
PHP
313 lines
14 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Bundle\FrameworkBundle\Tests\Command;
|
|
|
|
use PHPUnit\Framework\Attributes\DataProvider;
|
|
use PHPUnit\Framework\TestCase;
|
|
use Symfony\Bundle\FrameworkBundle\Command\TranslationExtractCommand;
|
|
use Symfony\Bundle\FrameworkBundle\Console\Application;
|
|
use Symfony\Component\Console\Tester\CommandTester;
|
|
use Symfony\Component\DependencyInjection\Container;
|
|
use Symfony\Component\Filesystem\Filesystem;
|
|
use Symfony\Component\HttpKernel\Bundle\BundleInterface;
|
|
use Symfony\Component\HttpKernel\KernelInterface;
|
|
use Symfony\Component\Translation\Extractor\ExtractorInterface;
|
|
use Symfony\Component\Translation\MessageCatalogue;
|
|
use Symfony\Component\Translation\MessageCatalogueInterface;
|
|
use Symfony\Component\Translation\Reader\TranslationReader;
|
|
use Symfony\Component\Translation\Translator;
|
|
use Symfony\Component\Translation\Writer\TranslationWriter;
|
|
|
|
class TranslationExtractCommandTest extends TestCase
|
|
{
|
|
private Filesystem $fs;
|
|
private string $translationDir;
|
|
|
|
public function testDumpMessagesAndClean()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo']]);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', 'bundle' => 'foo', '--dump-messages' => true, '--clean' => true]);
|
|
$this->assertMatchesRegularExpression('/foo/', $tester->getDisplay());
|
|
$this->assertMatchesRegularExpression('/1 message was successfully extracted/', $tester->getDisplay());
|
|
}
|
|
|
|
public function testDumpMessagesAsTreeAndClean()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo']]);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', 'bundle' => 'foo', '--dump-messages' => true, '--clean' => true, '--as-tree' => 1]);
|
|
$this->assertMatchesRegularExpression('/foo/', $tester->getDisplay());
|
|
$this->assertMatchesRegularExpression('/1 message was successfully extracted/', $tester->getDisplay());
|
|
}
|
|
|
|
public function testDumpSortedMessagesAndClean()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo', 'test' => 'test', 'bar' => 'bar']]);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', 'bundle' => 'foo', '--dump-messages' => true, '--clean' => true, '--sort' => 'asc']);
|
|
$this->assertMatchesRegularExpression("/\*bar\*foo\*test/", preg_replace('/\s+/', '', $tester->getDisplay()));
|
|
$this->assertMatchesRegularExpression('/3 messages were successfully extracted/', $tester->getDisplay());
|
|
}
|
|
|
|
public function testDumpReverseSortedMessagesAndClean()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo', 'test' => 'test', 'bar' => 'bar']]);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', 'bundle' => 'foo', '--dump-messages' => true, '--clean' => true, '--sort' => 'desc']);
|
|
$this->assertMatchesRegularExpression("/\*test\*foo\*bar/", preg_replace('/\s+/', '', $tester->getDisplay()));
|
|
$this->assertMatchesRegularExpression('/3 messages were successfully extracted/', $tester->getDisplay());
|
|
}
|
|
|
|
public function testDumpSortWithoutValueAndClean()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo', 'test' => 'test', 'bar' => 'bar']]);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', 'bundle' => 'foo', '--dump-messages' => true, '--clean' => true, '--sort']);
|
|
$this->assertMatchesRegularExpression("/\*bar\*foo\*test/", preg_replace('/\s+/', '', $tester->getDisplay()));
|
|
$this->assertMatchesRegularExpression('/3 messages were successfully extracted/', $tester->getDisplay());
|
|
}
|
|
|
|
public function testDumpWrongSortAndClean()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo', 'test' => 'test', 'bar' => 'bar']]);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', 'bundle' => 'foo', '--dump-messages' => true, '--clean' => true, '--sort' => 'test']);
|
|
$this->assertMatchesRegularExpression('/\[ERROR\] Wrong sort order/', $tester->getDisplay());
|
|
}
|
|
|
|
public function testDumpMessagesAndCleanInRootDirectory()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo']], [], null, [$this->translationDir.'/trans'], [$this->translationDir.'/views']);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', '--dump-messages' => true, '--clean' => true]);
|
|
$this->assertMatchesRegularExpression('/foo/', $tester->getDisplay());
|
|
$this->assertMatchesRegularExpression('/1 message was successfully extracted/', $tester->getDisplay());
|
|
}
|
|
|
|
public function testDumpTwoMessagesAndClean()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo', 'bar' => 'bar']]);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', 'bundle' => 'foo', '--dump-messages' => true, '--clean' => true]);
|
|
$this->assertMatchesRegularExpression('/foo/', $tester->getDisplay());
|
|
$this->assertMatchesRegularExpression('/bar/', $tester->getDisplay());
|
|
$this->assertMatchesRegularExpression('/2 messages were successfully extracted/', $tester->getDisplay());
|
|
}
|
|
|
|
public function testDumpMessagesForSpecificDomain()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo'], 'mydomain' => ['bar' => 'bar']]);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', 'bundle' => 'foo', '--dump-messages' => true, '--clean' => true, '--domain' => 'mydomain']);
|
|
$this->assertMatchesRegularExpression('/bar/', $tester->getDisplay());
|
|
$this->assertMatchesRegularExpression('/1 message was successfully extracted/', $tester->getDisplay());
|
|
}
|
|
|
|
public function testWriteMessages()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo', 'test' => 'test', 'bar' => 'bar']], writerMessages: ['foo', 'test', 'bar']);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', 'bundle' => 'foo', '--force' => true]);
|
|
$this->assertMatchesRegularExpression('/Translation files were successfully updated./', $tester->getDisplay());
|
|
}
|
|
|
|
public function testWriteSortMessages()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo', 'test' => 'test', 'bar' => 'bar']], writerMessages: ['bar', 'foo', 'test']);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', 'bundle' => 'foo', '--force' => true, '--sort' => 'asc']);
|
|
$this->assertMatchesRegularExpression('/Translation files were successfully updated./', $tester->getDisplay());
|
|
}
|
|
|
|
public function testWriteReverseSortedMessages()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo', 'test' => 'test', 'bar' => 'bar']], writerMessages: ['test', 'foo', 'bar']);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', 'bundle' => 'foo', '--force' => true, '--sort' => 'desc']);
|
|
$this->assertMatchesRegularExpression('/Translation files were successfully updated./', $tester->getDisplay());
|
|
}
|
|
|
|
public function testWriteMessagesInRootDirectory()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo']]);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', '--force' => true]);
|
|
$this->assertMatchesRegularExpression('/Translation files were successfully updated./', $tester->getDisplay());
|
|
}
|
|
|
|
public function testWriteMessagesForSpecificDomain()
|
|
{
|
|
$tester = $this->createCommandTester(['messages' => ['foo' => 'foo'], 'mydomain' => ['bar' => 'bar']]);
|
|
$tester->execute(['command' => 'translation:extract', 'locale' => 'en', 'bundle' => 'foo', '--force' => true, '--domain' => 'mydomain']);
|
|
$this->assertMatchesRegularExpression('/Translation files were successfully updated./', $tester->getDisplay());
|
|
}
|
|
|
|
public function testFilterDuplicateTransPaths()
|
|
{
|
|
$transPaths = [
|
|
$this->translationDir.'/a/test/folder/with/a/subfolder',
|
|
$this->translationDir.'/a/test/folder/',
|
|
$this->translationDir.'/a/test/folder/with/a/subfolder/and/a/file.txt',
|
|
$this->translationDir.'/a/different/test/folder',
|
|
];
|
|
|
|
foreach ($transPaths as $transPath) {
|
|
if (realpath($transPath)) {
|
|
continue;
|
|
}
|
|
|
|
if (preg_match('/\.[a-z]+$/', $transPath)) {
|
|
if (!realpath(\dirname($transPath))) {
|
|
mkdir(\dirname($transPath), 0o777, true);
|
|
}
|
|
|
|
touch($transPath);
|
|
} else {
|
|
mkdir($transPath, 0o777, true);
|
|
}
|
|
}
|
|
|
|
$command = $this->createStub(TranslationExtractCommand::class);
|
|
|
|
$method = new \ReflectionMethod(TranslationExtractCommand::class, 'filterDuplicateTransPaths');
|
|
|
|
$filteredTransPaths = $method->invoke($command, $transPaths);
|
|
|
|
$expectedPaths = [
|
|
realpath($this->translationDir.'/a/different/test/folder'),
|
|
realpath($this->translationDir.'/a/test/folder'),
|
|
];
|
|
|
|
$this->assertEquals($expectedPaths, $filteredTransPaths);
|
|
}
|
|
|
|
#[DataProvider('removeNoFillProvider')]
|
|
public function testRemoveNoFillTranslationsMethod($noFillCounter, $messages)
|
|
{
|
|
// Preparing mock
|
|
$operation = $this->createMock(MessageCatalogueInterface::class);
|
|
$operation
|
|
->method('all')
|
|
->willReturnMap([
|
|
['messages', $messages],
|
|
]);
|
|
$operation
|
|
->expects($this->exactly($noFillCounter))
|
|
->method('set');
|
|
|
|
// Calling private method
|
|
$translationUpdate = $this->createStub(TranslationExtractCommand::class);
|
|
$reflection = new \ReflectionObject($translationUpdate);
|
|
$method = $reflection->getMethod('removeNoFillTranslations');
|
|
$method->invokeArgs($translationUpdate, [$operation]);
|
|
}
|
|
|
|
public static function removeNoFillProvider(): array
|
|
{
|
|
return [
|
|
[0, []],
|
|
[0, ['foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz']],
|
|
[0, ['foo' => "\0foo"]],
|
|
[0, ['foo' => "foo\0NoFill\0"]],
|
|
[0, ['foo' => "f\0NoFill\000"]],
|
|
[0, ['foo' => 'foo', 'bar' => 'bar']],
|
|
[1, ['foo' => "\0NoFill\0foo"]],
|
|
[1, ['foo' => "\0NoFill\0foo", 'bar' => 'bar']],
|
|
[1, ['foo' => 'foo', 'bar' => "\0NoFill\0bar"]],
|
|
[2, ['foo' => "\0NoFill\0foo", 'bar' => "\0NoFill\0bar"]],
|
|
[3, ['foo' => "\0NoFill\0foo", 'bar' => "\0NoFill\0bar", 'baz' => "\0NoFill\0baz"]],
|
|
];
|
|
}
|
|
|
|
protected function setUp(): void
|
|
{
|
|
$this->fs = new Filesystem();
|
|
$this->translationDir = tempnam(sys_get_temp_dir(), 'sf_translation_');
|
|
$this->fs->remove($this->translationDir);
|
|
$this->fs->mkdir($this->translationDir.'/translations');
|
|
$this->fs->mkdir($this->translationDir.'/templates');
|
|
}
|
|
|
|
protected function tearDown(): void
|
|
{
|
|
$this->fs->remove($this->translationDir);
|
|
}
|
|
|
|
private function createCommandTester($extractedMessages = [], $loadedMessages = [], ?KernelInterface $kernel = null, array $transPaths = [], array $codePaths = [], ?array $writerMessages = null): CommandTester
|
|
{
|
|
$translator = new Translator('fr');
|
|
$translator->setFallbackLocales(['en']);
|
|
|
|
$extractor = $this->createStub(ExtractorInterface::class);
|
|
$extractor
|
|
->method('extract')
|
|
->willReturnCallback(
|
|
static function ($path, $catalogue) use ($extractedMessages) {
|
|
foreach ($extractedMessages as $domain => $messages) {
|
|
$catalogue->add($messages, $domain);
|
|
}
|
|
}
|
|
);
|
|
|
|
$loader = $this->createStub(TranslationReader::class);
|
|
$loader
|
|
->method('read')
|
|
->willReturnCallback(
|
|
static function ($path, $catalogue) use ($loadedMessages) {
|
|
$catalogue->add($loadedMessages);
|
|
}
|
|
);
|
|
|
|
$writer = $this->createStub(TranslationWriter::class);
|
|
$writer
|
|
->method('getFormats')
|
|
->willReturn(
|
|
['xlf', 'yml', 'yaml']
|
|
);
|
|
if (null !== $writerMessages) {
|
|
$writer
|
|
->method('write')
|
|
->willReturnCallback(
|
|
function (MessageCatalogue $catalogue) use ($writerMessages) {
|
|
$this->assertSame($writerMessages, array_keys($catalogue->all()['messages']));
|
|
}
|
|
);
|
|
}
|
|
|
|
if (null === $kernel) {
|
|
$returnValues = [
|
|
['foo', $this->getBundle($this->translationDir)],
|
|
['test', $this->getBundle('test')],
|
|
];
|
|
$kernel = $this->createStub(KernelInterface::class);
|
|
$kernel
|
|
->method('getBundle')
|
|
->willReturnMap($returnValues);
|
|
}
|
|
|
|
$kernel
|
|
->method('getBundles')
|
|
->willReturn([]);
|
|
|
|
$container = new Container();
|
|
$kernel
|
|
->method('getContainer')
|
|
->willReturn($container);
|
|
|
|
$command = new TranslationExtractCommand($writer, $loader, $extractor, 'en', $this->translationDir.'/translations', $this->translationDir.'/templates', $transPaths, $codePaths);
|
|
|
|
$application = new Application($kernel);
|
|
$application->addCommand($command);
|
|
|
|
return new CommandTester($application->find('translation:extract'));
|
|
}
|
|
|
|
private function getBundle($path)
|
|
{
|
|
$bundle = $this->createStub(BundleInterface::class);
|
|
$bundle
|
|
->method('getPath')
|
|
->willReturn($path)
|
|
;
|
|
|
|
return $bundle;
|
|
}
|
|
}
|