* * 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 PHPUnit\Framework\TestCase; use Symfony\Component\Console\Application; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Tester\CommandTester; use Symfony\Component\Translation\Command\XliffLintCommand; /** * Tests the XliffLintCommand. * * @author Javier Eguiluz */ class XliffLintCommandTest extends TestCase { private $files; public function testLintCorrectFile() { $tester = $this->createCommandTester(); $filename = $this->createFile(); $tester->execute( ['filename' => $filename], ['verbosity' => OutputInterface::VERBOSITY_VERBOSE, 'decorated' => false] ); $this->assertEquals(0, $tester->getStatusCode(), 'Returns 0 in case of success'); $this->assertContains('OK', trim($tester->getDisplay())); } public function testLintCorrectFiles() { $tester = $this->createCommandTester(); $filename1 = $this->createFile(); $filename2 = $this->createFile(); $tester->execute( ['filename' => [$filename1, $filename2]], ['verbosity' => OutputInterface::VERBOSITY_VERBOSE, 'decorated' => false] ); $this->assertEquals(0, $tester->getStatusCode(), 'Returns 0 in case of success'); $this->assertContains('OK', trim($tester->getDisplay())); } /** * @dataProvider provideStrictFilenames */ public function testStrictFilenames($requireStrictFileNames, $fileNamePattern, $targetLanguage, $mustFail) { $tester = $this->createCommandTester($requireStrictFileNames); $filename = $this->createFile('note', $targetLanguage, $fileNamePattern); $tester->execute( ['filename' => $filename], ['verbosity' => OutputInterface::VERBOSITY_VERBOSE, 'decorated' => false] ); $this->assertEquals($mustFail ? 1 : 0, $tester->getStatusCode()); $this->assertContains($mustFail ? '[WARNING] 0 XLIFF files have valid syntax and 1 contain errors.' : '[OK] All 1 XLIFF files contain valid syntax.', $tester->getDisplay()); } public function testLintIncorrectXmlSyntax() { $tester = $this->createCommandTester(); $filename = $this->createFile('note '); $tester->execute(['filename' => $filename], ['decorated' => false]); $this->assertEquals(1, $tester->getStatusCode(), 'Returns 1 in case of error'); $this->assertContains('Opening and ending tag mismatch: target line 6 and source', trim($tester->getDisplay())); } public function testLintIncorrectTargetLanguage() { $tester = $this->createCommandTester(); $filename = $this->createFile('note', 'es'); $tester->execute(['filename' => $filename], ['decorated' => false]); $this->assertEquals(1, $tester->getStatusCode(), 'Returns 1 in case of error'); $this->assertContains('There is a mismatch between the language included in the file name ("messages.en.xlf") and the "es" value used in the "target-language" attribute of the file.', trim($tester->getDisplay())); } /** * @expectedException \RuntimeException */ public function testLintFileNotReadable() { $tester = $this->createCommandTester(); $filename = $this->createFile(); unlink($filename); $tester->execute(['filename' => $filename], ['decorated' => false]); } public function testGetHelp() { $command = new XliffLintCommand(); $expected = <<%command.name% command lints a XLIFF file and outputs to STDOUT the first encountered syntax error. You can validates XLIFF contents passed from STDIN: cat filename | php %command.full_name% You can also validate the syntax of a file: php %command.full_name% filename Or of a whole directory: php %command.full_name% dirname php %command.full_name% dirname --format=json EOF; $this->assertEquals($expected, $command->getHelp()); } /** * @return string Path to the new file */ private function createFile($sourceContent = 'note', $targetLanguage = 'en', $fileNamePattern = 'messages.%locale%.xlf') { $xliffContent = << $sourceContent NOTE XLIFF; $filename = sprintf('%s/translation-xliff-lint-test/%s', sys_get_temp_dir(), str_replace('%locale%', 'en', $fileNamePattern)); file_put_contents($filename, $xliffContent); $this->files[] = $filename; return $filename; } /** * @return CommandTester */ private function createCommandTester($requireStrictFileNames = true, $application = null) { if (!$application) { $application = new Application(); $application->add(new XliffLintCommand(null, null, null, $requireStrictFileNames)); } $command = $application->find('lint:xliff'); if ($application) { $command->setApplication($application); } return new CommandTester($command); } protected function setUp() { $this->files = []; @mkdir(sys_get_temp_dir().'/translation-xliff-lint-test'); } protected function tearDown() { foreach ($this->files as $file) { if (file_exists($file)) { unlink($file); } } rmdir(sys_get_temp_dir().'/translation-xliff-lint-test'); } public function provideStrictFilenames() { yield [false, 'messages.%locale%.xlf', 'en', false]; yield [false, 'messages.%locale%.xlf', 'es', true]; yield [false, '%locale%.messages.xlf', 'en', false]; yield [false, '%locale%.messages.xlf', 'es', true]; yield [true, 'messages.%locale%.xlf', 'en', false]; yield [true, 'messages.%locale%.xlf', 'es', true]; yield [true, '%locale%.messages.xlf', 'en', true]; yield [true, '%locale%.messages.xlf', 'es', true]; } }