* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Component\Translation\Tests\Command; use Symfony\Component\Console\Application; use Symfony\Component\Console\Tester\CommandTester; use Symfony\Component\Translation\Command\TranslationPullCommand; use Symfony\Component\Translation\Dumper\XliffFileDumper; use Symfony\Component\Translation\Loader\ArrayLoader; use Symfony\Component\Translation\Loader\XliffFileLoader; use Symfony\Component\Translation\Provider\ProviderInterface; use Symfony\Component\Translation\Reader\TranslationReader; use Symfony\Component\Translation\TranslatorBag; use Symfony\Component\Translation\Writer\TranslationWriter; /** * @author Mathieu Santostefano */ class TranslationPullCommandTest extends TranslationProviderTestCase { private $colSize; protected function setUp(): void { $this->colSize = getenv('COLUMNS'); putenv('COLUMNS='.(119 + \strlen(\PHP_EOL))); parent::setUp(); } protected function tearDown(): void { parent::tearDown(); putenv($this->colSize ? 'COLUMNS='.$this->colSize : 'COLUMNS'); } public function testPullNewXlf12Messages() { $arrayLoader = new ArrayLoader(); $filenameEn = $this->createFile(); $filenameEnIcu = $this->createFile(['say_hello' => 'Welcome, {firstname}!'], 'en', 'messages+intl-icu.%locale%.xlf'); $filenameFr = $this->createFile(['note' => 'NOTE'], 'fr'); $filenameFrIcu = $this->createFile(['say_hello' => 'Bonjour, {firstname}!'], 'fr', 'messages+intl-icu.%locale%.xlf'); $locales = ['en', 'fr']; $domains = ['messages', 'messages+intl-icu']; $providerReadTranslatorBag = new TranslatorBag(); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'note' => 'NOTE', 'new.foo' => 'newFoo', ], 'en')); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'say_hello' => 'Welcome, {firstname}!', ], 'en', 'messages+intl-icu')); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'note' => 'NOTE', 'new.foo' => 'nouveauFoo', ], 'fr')); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'say_hello' => 'Bonjour, {firstname}!', ], 'fr', 'messages+intl-icu')); $provider = $this->createMock(ProviderInterface::class); $provider->expects($this->once()) ->method('read') ->with($domains, $locales) ->willReturn($providerReadTranslatorBag); $provider->expects($this->once()) ->method('__toString') ->willReturn('null://default'); $tester = $this->createCommandTester($provider, $locales, $domains); $tester->execute(['--locales' => ['en', 'fr'], '--domains' => ['messages', 'messages+intl-icu']]); $this->assertStringContainsString('[OK] New translations from "null" has been written locally (for "en, fr" locale(s), and "messages, messages+intl-icu"', trim($tester->getDisplay())); $this->assertXmlStringEqualsXmlString(<<

new.foo newFoo note NOTE XLIFF , file_get_contents($filenameEn)); $this->assertXmlStringEqualsXmlString(<<

say_hello Welcome, {firstname}! XLIFF , file_get_contents($filenameEnIcu)); $this->assertXmlStringEqualsXmlString(<<

new.foo nouveauFoo note NOTE XLIFF , file_get_contents($filenameFr)); $this->assertXmlStringEqualsXmlString(<<

say_hello Bonjour, {firstname}! XLIFF , file_get_contents($filenameFrIcu)); } public function testPullNewXlf20Messages() { $arrayLoader = new ArrayLoader(); $filenameEn = $this->createFile(['note' => 'NOTE'], 'en', 'messages.%locale%.xlf', 'xlf20'); $filenameFr = $this->createFile(['note' => 'NOTE'], 'fr', 'messages.%locale%.xlf', 'xlf20'); $locales = ['en', 'fr']; $domains = ['messages']; $providerReadTranslatorBag = new TranslatorBag(); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'note' => 'NOTE', 'new.foo' => 'newFoo', ], 'en')); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'note' => 'NOTE', 'new.foo' => 'nouveauFoo', ], 'fr')); $provider = $this->createMock(ProviderInterface::class); $provider->expects($this->once()) ->method('read') ->with($domains, $locales) ->willReturn($providerReadTranslatorBag); $provider->expects($this->once()) ->method('__toString') ->willReturn('null://default'); $tester = $this->createCommandTester($provider, $locales, $domains); $tester->execute(['--locales' => ['en', 'fr'], '--domains' => ['messages'], '--format' => 'xlf20']); $this->assertStringContainsString('[OK] New translations from "null" has been written locally (for "en, fr" locale(s), and "messages" domain(s)).', trim($tester->getDisplay())); $this->assertXmlStringEqualsXmlString(<< new.foo newFoo note NOTE XLIFF , file_get_contents($filenameEn)); $this->assertXmlStringEqualsXmlString(<< new.foo nouveauFoo note NOTE XLIFF , file_get_contents($filenameFr)); } public function testPullForceMessages() { $arrayLoader = new ArrayLoader(); $filenameEn = $this->createFile(); $filenameFr = $this->createFile(['note' => 'NOTE'], 'fr'); $locales = ['en', 'fr']; $domains = ['messages']; $providerReadTranslatorBag = new TranslatorBag(); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'note' => 'UPDATED NOTE', 'new.foo' => 'newFoo', ], 'en')); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'note' => 'NOTE MISE À JOUR', 'new.foo' => 'nouveauFoo', ], 'fr')); $provider = $this->createMock(ProviderInterface::class); $provider->expects($this->once()) ->method('read') ->with($domains, $locales) ->willReturn($providerReadTranslatorBag); $provider->expects($this->once()) ->method('__toString') ->willReturn('null://default'); $tester = $this->createCommandTester($provider, $locales, $domains); $tester->execute(['--locales' => ['en', 'fr'], '--domains' => ['messages'], '--force' => true]); $this->assertStringContainsString('[OK] Local translations has been updated from "null" (for "en, fr" locale(s), and "messages" domain(s)).', trim($tester->getDisplay())); $this->assertXmlStringEqualsXmlString(<<

note UPDATED NOTE new.foo newFoo XLIFF , file_get_contents($filenameEn)); $this->assertXmlStringEqualsXmlString(<<

note NOTE MISE À JOUR new.foo nouveauFoo XLIFF , file_get_contents($filenameFr)); } /** * @requires extension intl */ public function testPullForceIntlIcuMessages() { $arrayLoader = new ArrayLoader(); $filenameEn = $this->createFile(['note' => 'NOTE'], 'en', 'messages+intl-icu.%locale%.xlf'); $filenameFr = $this->createFile(['note' => 'NOTE'], 'fr', 'messages+intl-icu.%locale%.xlf'); $locales = ['en', 'fr']; $domains = ['messages']; $providerReadTranslatorBag = new TranslatorBag(); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'note' => 'UPDATED NOTE', 'new.foo' => 'newFoo', ], 'en')); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'note' => 'NOTE MISE À JOUR', 'new.foo' => 'nouveauFoo', ], 'fr')); $provider = $this->createMock(ProviderInterface::class); $provider->expects($this->once()) ->method('read') ->with($domains, $locales) ->willReturn($providerReadTranslatorBag); $provider->expects($this->once()) ->method('__toString') ->willReturn('null://default'); $tester = $this->createCommandTester($provider, $locales, $domains); $tester->execute(['--locales' => ['en', 'fr'], '--domains' => ['messages'], '--force' => true, '--intl-icu' => true]); $this->assertStringContainsString('[OK] Local translations has been updated from "null" (for "en, fr" locale(s), and "messages" domain(s)).', trim($tester->getDisplay())); $this->assertXmlStringEqualsXmlString(<<

note UPDATED NOTE new.foo newFoo XLIFF , file_get_contents($filenameEn)); $this->assertXmlStringEqualsXmlString(<<

note NOTE MISE À JOUR new.foo nouveauFoo XLIFF , file_get_contents($filenameFr)); } public function testPullMessagesWithDefaultLocale() { $arrayLoader = new ArrayLoader(); $filenameFr = $this->createFile(['note' => 'NOTE'], 'fr'); $filenameEn = $this->createFile(['note' => 'NOTE']); $locales = ['en', 'fr']; $domains = ['messages']; $providerReadTranslatorBag = new TranslatorBag(); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'note' => 'NOTE', 'new.foo' => 'nouveauFoo', ], 'fr')); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'note' => 'NOTE', 'new.foo' => 'newFoo', ], 'en')); $provider = $this->createMock(ProviderInterface::class); $provider->expects($this->once()) ->method('read') ->with($domains, $locales) ->willReturn($providerReadTranslatorBag); $provider->expects($this->once()) ->method('__toString') ->willReturn('null://default'); $tester = $this->createCommandTester($provider, $locales, $domains, 'fr'); $tester->execute(['--locales' => ['en', 'fr'], '--domains' => ['messages']]); $this->assertStringContainsString('[OK] New translations from "null" has been written locally (for "en, fr" locale(s), and "messages" domain(s)).', trim($tester->getDisplay())); $this->assertXmlStringEqualsXmlString(<<

new.foo newFoo note NOTE XLIFF , file_get_contents($filenameEn)); $this->assertXmlStringEqualsXmlString(<<

new.foo nouveauFoo note NOTE XLIFF , file_get_contents($filenameFr)); } public function testPullMessagesMultipleDomains() { $arrayLoader = new ArrayLoader(); $filenameMessages = $this->createFile(['note' => 'NOTE']); $filenameDomain = $this->createFile(['note' => 'NOTE'], 'en', 'domain.%locale%.xlf'); $locales = ['en']; $domains = ['messages', 'domain']; $providerReadTranslatorBag = new TranslatorBag(); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'new.foo' => 'newFoo', ], 'en')); $providerReadTranslatorBag->addCatalogue($arrayLoader->load([ 'new.foo' => 'newFoo', ], 'en', 'domain' )); $provider = $this->createMock(ProviderInterface::class); $provider->expects($this->once()) ->method('read') ->with($domains, $locales) ->willReturn($providerReadTranslatorBag); $provider->expects($this->once()) ->method('__toString') ->willReturn('null://default'); $tester = $this->createCommandTester($provider, $locales, $domains, 'en'); $tester->execute(['--locales' => ['en'], '--domains' => ['messages', 'domain']]); $this->assertStringContainsString('[OK] New translations from "null" has been written locally (for "en" locale(s), and "messages, domain" domain(s)).', trim($tester->getDisplay())); $this->assertXmlStringEqualsXmlString(<<

new.foo newFoo note NOTE XLIFF , file_get_contents($filenameMessages)); $this->assertXmlStringEqualsXmlString(<<

new.foo newFoo note NOTE XLIFF , file_get_contents($filenameDomain)); } private function createCommandTester(ProviderInterface $provider, array $locales = ['en'], array $domains = ['messages'], $defaultLocale = 'en'): CommandTester { $writer = new TranslationWriter(); $writer->addDumper('xlf', new XliffFileDumper()); $reader = new TranslationReader(); $reader->addLoader('xlf', new XliffFileLoader()); $command = new TranslationPullCommand( $this->getProviderCollection($provider, $locales, $domains), $writer, $reader, $defaultLocale, [$this->translationAppDir.'/translations'] ); $application = new Application(); $application->add($command); return new CommandTester($application->find('translation:pull')); } }