Validate XLIFF translation files #17903

javiereguiluz · 2016-02-23T11:50:40Z

Q	A
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	-
License	MIT
Doc PR	-

In #17902 @stof proposed to add a simple test to validate .xlf files (to avoid issues like #17893).

This is a proposal for that test. My questions:

1) Do you agree displaying detailed error messages when the XML is not valid. Example output for the #17893 error:

Or is it enough displaying just the PHPUnit error message and let the user figure out the details?

2) How do I validate the translation files of the Security and Form components? Do I just copy+paste this test in those components?

linaori · 2016-02-23T11:58:06Z

You could add the tests to the phpunit bridge, imo the WebTestCase and KernelTestCase should go there too. Additionally any other TestCase files that are an extension point should be moved there or a special package for this.

nicolas-grekas · 2016-02-23T12:18:17Z

@javiereguiluz detailed error messages look the more useful to me

sstok · 2016-02-23T14:02:59Z

src/Symfony/Component/Validator/Tests/Resources/TranslationFilesTest.php

+
+namespace Symfony\Component\Validator\Tests\Resources;
+
+class ConstraintTest extends \PHPUnit_Framework_TestCase


Class name doesn't equal the filename TranslationFilesTest

Fixed. Thanks.

nicolas-grekas · 2016-02-23T14:18:08Z

src/Symfony/Component/Validator/Tests/Resources/TranslationFilesTest.php

+    public function setUp()
+    {
+        libxml_use_internal_errors(true);
+        libxml_clear_errors();


shouldn't you do this in the foreach loop below ?
I'd suggest also to move libxml_use_internal_errors(true); in the test case

Done. Thank you.

stof · 2016-02-23T14:19:25Z

Additionally any other TestCase files that are an extension point should be moved there or a special package for this.

This is not always a good idea. For instance, we have a base test case for ConstraintValidator in the Validator component. Moving it to the bridge would be a pain, as the logic in the testcase depends on the version of the component. So I would vote against moving everything to the bridge.

nicolas-grekas · 2016-02-23T14:20:25Z

src/Symfony/Component/Validator/Tests/Resources/TranslationFilesTest.php

+    public function testXlfFilesAreValid()
+    {
+        $translationFiles = glob(__DIR__.'/../../Resources/translations/*.xlf');
+        foreach ($translationFiles as $filePath) {


in fact, would be much better with a data ~~collector~~ provider

I don't understand this suggestion.

I think he meant a data provider, not a data collector. And this is indeed a good idea as a failure in a file would not prevent validating subsequent files (as they would be separate tests)

nicolas-grekas · 2016-02-23T14:24:45Z

src/Symfony/Component/Validator/Tests/Resources/TranslationFilesTest.php

+                $this->renderErrors($errors);
+            }
+
+            $this->assertEmpty($errors, sprintf('The "%s" file is not a valid XML file.', realpath($filePath)));


I suggest to remove renderErrors, and replace $this->assertEmpty(...); by
$this->assertSame(array(), $errors); so that phpunit handles the output

stof · 2016-02-23T14:25:04Z

How do I validate the translation files of the Security and Form components? Do I just copy+paste this test in those components?

Copy-pasting is probably the easiest here, yes. Moving this to the bridge will mean exposing it as a part of our API, which does not seem useful yet.

a way to simplify the copy-pasted logic would be to use PHPUnit_Util_Xml::loadFile to perform the loading. When putting it in strict mode, it will throw a PHPUnit_Framework_Exception when the file is invalid, and include the errors in the exception message. You just have to catch this exception and use $this->fail($e->getMessage()) then.

javiereguiluz · 2016-02-23T14:38:55Z

Refactored as suggested by Nicolas and now I'm going to try @stof's idea.

javiereguiluz · 2016-02-23T14:49:04Z

@stof I've applied your ideas and the tests now look very simple. I've also copy+pasted the test in the 3 components. Thanks!

stof · 2016-02-23T14:55:52Z

src/Symfony/Component/Form/Tests/Resources/TranslationFilesTest.php

+    /**
+     * @dataProvider provideTranslationFiles
+     */
+    public function testTranslationFilesAreValid($filePath)


technically, this test concerns a single file, so you should use a singular in the test name (yeah, this is nit-picking 😄 )

Done the renaming.

stof · 2016-02-23T14:56:44Z

👍 for this. And we indeed don't need to extract this to the bridge, given how simple the logic is now.

javiereguiluz · 2016-02-23T15:02:09Z

I've removed the try ... catch and the test seems to work...

...and the output is reasonably good when there is an error:

nicolas-grekas · 2016-02-23T15:06:59Z

👍

stof · 2016-02-23T15:09:03Z

👍 (we may need the same test in one more places in Symfony 2.7+ in the Security component btw)

fabpot · 2016-02-23T18:12:54Z

Thank you @javiereguiluz.

@stof

This PR was squashed before being merged into the 2.3 branch (closes #17903). Discussion ---------- Validate XLIFF translation files | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - In #17902 @stof proposed to add a simple test to validate `.xlf` files (to avoid issues like #17893). This is a proposal for that test. My questions: **1)** Do you agree displaying detailed error messages when the XML is not valid. Example output for the #17893 error: ![error_log](https://cloud.githubusercontent.com/assets/73419/13250664/932d2f14-da2b-11e5-8ea0-ecb43f58feea.png) Or is it enough displaying just the PHPUnit error message and let the user figure out the details? ![simple_error](https://cloud.githubusercontent.com/assets/73419/13250671/a3b4bfd2-da2b-11e5-9277-454d0dd160b2.png) **2)** How do I validate the translation files of the Security and Form components? Do I just copy+paste this test in those components? Commits ------- db03055 Validate XLIFF translation files

Validate XLIFF translation files

720779a

javiereguiluz added Validator Enhancement labels Feb 23, 2016

carsonbot added the Status: Needs Review label Feb 23, 2016

sstok reviewed Feb 23, 2016
View reviewed changes

Fixed the name of the test

9a60ed2

nicolas-grekas reviewed Feb 23, 2016
View reviewed changes

javiereguiluz added 2 commits February 23, 2016 15:21

Minor refactor

e28ee89

Another minor refactor

93861ac

nicolas-grekas reviewed Feb 23, 2016
View reviewed changes

Refactored entirely

078fd02

javiereguiluz added 2 commits February 23, 2016 15:47

Final refactor

b56e9c2

Fixed a namespace

43b88b0

stof reviewed Feb 23, 2016
View reviewed changes

Minor rename and simplified tests

d324743

Use dirname() to produce better results when an error occurs

2e62442

fabpot closed this Feb 23, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Validate XLIFF translation files #17903

Validate XLIFF translation files #17903

javiereguiluz commented Feb 23, 2016

linaori commented Feb 23, 2016

nicolas-grekas commented Feb 23, 2016

sstok Feb 23, 2016

javiereguiluz Feb 23, 2016

nicolas-grekas Feb 23, 2016

javiereguiluz Feb 23, 2016

stof commented Feb 23, 2016

nicolas-grekas Feb 23, 2016

javiereguiluz Feb 23, 2016

stof Feb 23, 2016

nicolas-grekas Feb 23, 2016

stof commented Feb 23, 2016

javiereguiluz commented Feb 23, 2016

javiereguiluz commented Feb 23, 2016

stof Feb 23, 2016

javiereguiluz Feb 23, 2016

stof commented Feb 23, 2016

javiereguiluz commented Feb 23, 2016

nicolas-grekas commented Feb 23, 2016

stof commented Feb 23, 2016

fabpot commented Feb 23, 2016


		namespace Symfony\Component\Validator\Tests\Resources;

		class ConstraintTest extends \PHPUnit_Framework_TestCase

Validate XLIFF translation files #17903

Validate XLIFF translation files #17903

Conversation

javiereguiluz commented Feb 23, 2016

linaori commented Feb 23, 2016

nicolas-grekas commented Feb 23, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Feb 23, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Feb 23, 2016

javiereguiluz commented Feb 23, 2016

javiereguiluz commented Feb 23, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Feb 23, 2016

javiereguiluz commented Feb 23, 2016

nicolas-grekas commented Feb 23, 2016

stof commented Feb 23, 2016

fabpot commented Feb 23, 2016