forked from translate/translate
/
test_xliff.py
512 lines (448 loc) · 20.2 KB
/
test_xliff.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
import pytest
import six
from lxml import etree
from translate.misc.xml_helpers import setXMLspace
from translate.storage import test_base, xliff
from translate.storage.placeables import StringElem
from translate.storage.placeables.xliff import G, X
class TestXLIFFUnit(test_base.TestTranslationUnit):
UnitClass = xliff.xliffunit
def test_markreview(self):
"""Tests if we can mark the unit to need review."""
unit = self.unit
# We have to explicitly set the target to nothing, otherwise xliff
# tests will fail.
# Can we make it default behavior for the UnitClass?
unit.target = ""
unit.addnote("Test note 1", origin="translator")
unit.addnote("Test note 2", origin="translator")
original_notes = unit.getnotes(origin="translator")
assert not unit.isreview()
unit.markreviewneeded()
assert unit.isreview()
unit.markreviewneeded(False)
assert not unit.isreview()
assert unit.getnotes(origin="translator") == original_notes
unit.markreviewneeded(explanation="Double check spelling.")
assert unit.isreview()
notes = unit.getnotes(origin="translator")
assert notes.count("Double check spelling.") == 1
def test_errors(self):
"""Tests that we can add and retrieve error messages for a unit."""
unit = self.unit
assert len(unit.geterrors()) == 0
unit.adderror(errorname='test1', errortext='Test error message 1.')
unit.adderror(errorname='test2', errortext='Test error message 2.')
unit.adderror(errorname='test3', errortext='Test error message 3.')
assert len(unit.geterrors()) == 3
assert unit.geterrors()['test1'] == 'Test error message 1.'
assert unit.geterrors()['test2'] == 'Test error message 2.'
assert unit.geterrors()['test3'] == 'Test error message 3.'
unit.adderror(errorname='test1', errortext='New error 1.')
assert unit.geterrors()['test1'] == 'New error 1.'
def test_accepted_control_chars(self):
"""Tests we can assign the accepted control chars.
Source: https://en.wikipedia.org/wiki/Valid_characters_in_XML#XML_1.0
"""
# Unicode Character 'CHARACTER TABULATION' (U+0009)
self.unit.target = u'Een\t'
assert self.unit.target == u'Een\t'
# Unicode Character 'LINE FEED (LF)' (U+000A)
self.unit.target = u'Een\n'
assert self.unit.target == u'Een\n'
# Unicode Character 'CARRIAGE RETURN (CR)' (U+000D)
self.unit.target = u'Een\r'
assert self.unit.target == u'Een\r'
def test_unaccepted_control_chars(self):
"""Tests we cannot assign the unaccepted control chars without escaping.
Source: https://en.wikipedia.org/wiki/Valid_characters_in_XML#XML_1.0
"""
exc_msg = ("All strings must be XML compatible: Unicode or ASCII, no "
"NULL bytes or control characters")
for code in xliff.ASCII_CONTROL_CODES:
self.unit.target = u'Een&#x%s;' % code.lstrip('0') or '0'
assert self.unit.target == u'Een%s' % six.unichr(int(code, 16))
self.unit.target = u'Een%s' % six.unichr(int(code, 16))
assert self.unit.target == u'Een%s' % six.unichr(int(code, 16))
def test_unaccepted_control_chars_escapes_roundtrip(self):
"""Test control characters go ok on escaping roundtrip."""
for code in xliff.ASCII_CONTROL_CODES:
special = u'Een%s' % six.unichr(int(code, 16))
self.unit.source = special
print("unit.source:", repr(self.unit.source))
print("special:", repr(special))
assert self.unit.source == special
class TestXLIFFfile(test_base.TestTranslationStore):
StoreClass = xliff.xlifffile
skeleton = '''<?xml version="1.0" encoding="utf-8"?>
<xliff version="1.1" xmlns="urn:oasis:names:tc:xliff:document:1.1">
<file original="doc.txt" source-language="en-US">
<body>
%s
</body>
</file>
</xliff>'''
def test_basic(self):
xlifffile = xliff.xlifffile()
assert xlifffile.units == []
xlifffile.addsourceunit("Bla")
assert len(xlifffile.units) == 1
newfile = xliff.xlifffile.parsestring(bytes(xlifffile))
print(bytes(xlifffile))
assert len(newfile.units) == 1
assert newfile.units[0].source == "Bla"
assert newfile.findunit("Bla").source == "Bla"
assert newfile.findunit("dit") is None
def test_namespace(self):
"""Check that we handle namespaces other than the default correctly."""
xlfsource = '''<?xml version="1.0" encoding="utf-8"?>
<xliff:xliff version="1.2" xmlns:xliff="urn:oasis:names:tc:xliff:document:1.2">
<xliff:file original="doc.txt" source-language="en-US">
<xliff:body>
<xliff:trans-unit id="1">
<xliff:source>File 1</xliff:source>
</xliff:trans-unit>
</xliff:body>
</xliff:file>
</xliff:xliff>'''
xlifffile = xliff.xlifffile.parsestring(xlfsource)
print(bytes(xlifffile))
assert xlifffile.units[0].source == "File 1"
def test_rich_source(self):
xlifffile = xliff.xlifffile()
xliffunit = xlifffile.addsourceunit(u'')
# Test 1
xliffunit.rich_source = [StringElem([u'foo', X(id='bar'), u'baz'])]
source_dom_node = xliffunit.getlanguageNode(None, 0)
x_placeable = source_dom_node[0]
assert source_dom_node.text == 'foo'
assert x_placeable.tag == u'x'
assert x_placeable.attrib['id'] == 'bar'
assert x_placeable.tail == 'baz'
xliffunit.rich_source[0].print_tree(2)
print(xliffunit.rich_source)
assert xliffunit.rich_source == [StringElem([StringElem(u'foo'), X(id='bar'), StringElem(u'baz')])]
# Test 2
xliffunit.rich_source = [StringElem([u'foo', u'baz', G(id='oof', sub=[G(id='zab', sub=[u'bar', u'rab'])])])]
source_dom_node = xliffunit.getlanguageNode(None, 0)
g_placeable = source_dom_node[0]
nested_g_placeable = g_placeable[0]
assert source_dom_node.text == u'foobaz'
assert g_placeable.tag == u'g'
assert g_placeable.text is None
assert g_placeable.attrib[u'id'] == u'oof'
assert g_placeable.tail is None
assert nested_g_placeable.tag == u'g'
assert nested_g_placeable.text == u'barrab'
assert nested_g_placeable.attrib[u'id'] == u'zab'
assert nested_g_placeable.tail is None
rich_source = xliffunit.rich_source
rich_source[0].print_tree(2)
assert rich_source == [StringElem([u'foobaz', G(id='oof', sub=[G(id='zab', sub=[u'barrab'])])])]
def test_rich_target(self):
xlifffile = xliff.xlifffile()
xliffunit = xlifffile.addsourceunit(u'')
# Test 1
xliffunit.set_rich_target([StringElem([u'foo', X(id='bar'), u'baz'])], u'fr')
target_dom_node = xliffunit.getlanguageNode(None, 1)
x_placeable = target_dom_node[0]
assert target_dom_node.text == 'foo'
assert x_placeable.tag == u'x'
assert x_placeable.attrib['id'] == 'bar'
assert x_placeable.tail == 'baz'
# Test 2
xliffunit.set_rich_target([StringElem([u'foo', u'baz', G(id='oof', sub=[G(id='zab', sub=[u'bar', u'rab'])])])], u'fr')
target_dom_node = xliffunit.getlanguageNode(None, 1)
g_placeable = target_dom_node[0]
nested_g_placeable = g_placeable[0]
assert target_dom_node.text == u'foobaz'
assert g_placeable.tag == u'g'
print('g_placeable.text: %s (%s)' % (g_placeable.text, type(g_placeable.text)))
assert g_placeable.text is None
assert g_placeable.attrib[u'id'] == u'oof'
assert g_placeable.tail is None
assert nested_g_placeable.tag == u'g'
assert nested_g_placeable.text == u'barrab'
assert nested_g_placeable.attrib[u'id'] == u'zab'
assert nested_g_placeable.tail is None
xliffunit.rich_target[0].print_tree(2)
assert xliffunit.rich_target == [StringElem([u'foobaz', G(id='oof', sub=[G(id='zab', sub=[u'barrab'])])])]
def test_source(self):
xlifffile = xliff.xlifffile()
xliffunit = xlifffile.addsourceunit("Concept")
xliffunit.source = "Term"
newfile = xliff.xlifffile.parsestring(bytes(xlifffile))
print(bytes(xlifffile))
assert newfile.findunit("Concept") is None
assert newfile.findunit("Term") is not None
def test_target(self):
xlifffile = xliff.xlifffile()
xliffunit = xlifffile.addsourceunit("Concept")
xliffunit.target = "Konsep"
newfile = xliff.xlifffile.parsestring(bytes(xlifffile))
print(bytes(xlifffile))
assert newfile.findunit("Concept").target == "Konsep"
def test_sourcelanguage(self):
xlifffile = xliff.xlifffile(sourcelanguage="xh")
xmltext = bytes(xlifffile).decode('utf-8')
print(xmltext)
assert xmltext.find('source-language="xh"') > 0
#TODO: test that it also works for new files.
def test_targetlanguage(self):
xlifffile = xliff.xlifffile(sourcelanguage="zu", targetlanguage="af")
xmltext = bytes(xlifffile).decode('utf-8')
print(xmltext)
assert xmltext.find('source-language="zu"') > 0
assert xmltext.find('target-language="af"') > 0
def test_notes(self):
xlifffile = xliff.xlifffile()
unit = xlifffile.addsourceunit("Concept")
# We don't want to add unnecessary notes
assert "note" not in bytes(xlifffile).decode('utf-8')
unit.addnote(None)
assert "note" not in bytes(xlifffile).decode('utf-8')
unit.addnote("")
assert "note" not in bytes(xlifffile).decode('utf-8')
unit.addnote("Please buy bread")
assert unit.getnotes() == "Please buy bread"
notenodes = unit.xmlelement.findall(".//%s" % unit.namespaced("note"))
assert len(notenodes) == 1
unit.addnote("Please buy milk", origin="Mom")
notenodes = unit.xmlelement.findall(".//%s" % unit.namespaced("note"))
assert len(notenodes) == 2
assert "from" not in notenodes[0].attrib
assert notenodes[1].get("from") == "Mom"
assert unit.getnotes(origin="Mom") == "Please buy milk"
unit.addnote("Don't forget the beer", origin="Dad")
notenodes = unit.xmlelement.findall(".//%s" % unit.namespaced("note"))
assert len(notenodes) == 3
assert notenodes[1].get("from") == "Mom"
assert notenodes[2].get("from") == "Dad"
assert unit.getnotes(origin="Dad") == "Don't forget the beer"
assert not unit.getnotes(origin="Bob") == "Please buy bread\nPlease buy milk\nDon't forget the beer"
assert not notenodes[2].get("from") == "Mom"
assert "from" not in notenodes[0].attrib
assert unit.getnotes() == "Please buy bread\nPlease buy milk\nDon't forget the beer"
assert unit.correctorigin(notenodes[2], "ad")
assert not unit.correctorigin(notenodes[2], "om")
def test_alttrans(self):
"""Test xliff <alt-trans> accessors"""
xlifffile = xliff.xlifffile()
unit = xlifffile.addsourceunit("Testing")
unit.addalttrans("ginmi")
unit.addalttrans("shikenki")
alternatives = unit.getalttrans()
assert alternatives[0].source == "Testing"
assert alternatives[0].target == "ginmi"
assert alternatives[1].target == "shikenki"
assert not unit.target
unit.addalttrans("Tasting", origin="bob", lang="eng")
alternatives = unit.getalttrans()
assert alternatives[2].target == "Tasting"
alternatives = unit.getalttrans(origin="bob")
assert alternatives[0].target == "Tasting"
unit.delalttrans(alternatives[0])
assert len(unit.getalttrans(origin="bob")) == 0
alternatives = unit.getalttrans()
assert len(alternatives) == 2
assert alternatives[0].target == "ginmi"
assert alternatives[1].target == "shikenki"
#clean up:
alternatives = unit.getalttrans()
for alt in alternatives:
unit.delalttrans(alt)
unit.addalttrans("targetx", sourcetxt="sourcex")
# test that the source node is before the target node:
alt = unit.getalttrans()[0]
altformat = etree.tostring(alt.xmlelement).decode('utf-8')
print(altformat)
assert altformat.find("<source") < altformat.find("<target")
# test that a new target is still before alt-trans (bug 1098)
unit.target = u"newester target"
unitformat = str(unit)
print(unitformat)
assert unitformat.find("<source") < unitformat.find("<target") < unitformat.find("<alt-trans")
def test_fuzzy(self):
xlifffile = xliff.xlifffile()
unit = xlifffile.addsourceunit("Concept")
unit.markfuzzy()
assert not unit.isfuzzy() # untranslated
unit.target = "Konsep"
assert not unit.isfuzzy() # translated
unit.markfuzzy()
assert unit.isfuzzy()
unit.markfuzzy(False)
assert not unit.isfuzzy()
unit.markfuzzy(True)
assert unit.isfuzzy()
#If there is no target, we can't really indicate fuzzyness, so we set
#approved to "no". If we want isfuzzy() to reflect that, the line can
#be uncommented
unit.target = None
assert unit.target is None
print(unit)
unit.markfuzzy(True)
assert 'approved="no"' in str(unit)
#assert unit.isfuzzy()
def test_xml_space(self):
"""Test for the correct handling of xml:space attributes."""
xlfsource = self.skeleton % (
'''<trans-unit id="1" xml:space="preserve">
<source> File 1 </source>
</trans-unit>''')
xlifffile = xliff.xlifffile.parsestring(xlfsource)
assert xlifffile.units[0].source == " File 1 "
root_node = xlifffile.document.getroot()
setXMLspace(root_node, "preserve")
assert xlifffile.units[0].source == " File 1 "
setXMLspace(root_node, "default")
assert xlifffile.units[0].source == " File 1 "
xlfsource = self.skeleton % (
'''<trans-unit id="1" xml:space="default">
<source> File 1 </source>
</trans-unit>''')
xlifffile = xliff.xlifffile.parsestring(xlfsource)
assert xlifffile.units[0].source == "File 1"
root_node = xlifffile.document.getroot()
setXMLspace(root_node, "preserve")
assert xlifffile.units[0].source == "File 1"
setXMLspace(root_node, "default")
assert xlifffile.units[0].source == "File 1"
xlfsource = self.skeleton % (
'''<trans-unit id="1">
<source> File 1 </source>
</trans-unit>''')
# we currently always normalize as default behaviour for xliff
xlifffile = xliff.xlifffile.parsestring(xlfsource)
assert xlifffile.units[0].source == "File 1"
root_node = xlifffile.document.getroot()
setXMLspace(root_node, "preserve")
assert xlifffile.units[0].source == "File 1"
setXMLspace(root_node, "default")
assert xlifffile.units[0].source == "File 1"
xlfsource = self.skeleton % (
'''<trans-unit id="1">
<source> File 1
</source>
</trans-unit>''')
# we currently always normalize as default behaviour for xliff
xlifffile = xliff.xlifffile.parsestring(xlfsource)
assert xlifffile.units[0].source == "File 1"
root_node = xlifffile.document.getroot()
setXMLspace(root_node, "preserve")
assert xlifffile.units[0].source == "File 1"
setXMLspace(root_node, "default")
assert xlifffile.units[0].source == "File 1"
def test_parsing(self):
xlfsource = self.skeleton \
% '''<trans-unit id="1" xml:space="preserve">
<source>File</source>
<target/>
</trans-unit>'''
xlifffile = xliff.xlifffile.parsestring(xlfsource)
assert xlifffile.units[0].istranslatable()
xlfsource = self.skeleton \
% '''<trans-unit id="1" xml:space="preserve" translate="no">
<source>File</source>
<target/>
</trans-unit>'''
xlifffile = xliff.xlifffile.parsestring(xlfsource)
assert not xlifffile.units[0].istranslatable()
xlfsource = self.skeleton \
% '''<trans-unit id="1" xml:space="preserve" translate="yes">
<source>File</source>
<target/>
</trans-unit>'''
xlifffile = xliff.xlifffile.parsestring(xlfsource)
assert xlifffile.units[0].istranslatable()
def test_entities(self):
xlfsource = '''<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE foo [ <!ELEMENT foo ANY > <!ENTITY xxe SYSTEM "file:///etc/passwd" >]>
<xliff version="1.1" xmlns="urn:oasis:names:tc:xliff:document:1.1">
<file original="doc.txt" source-language="en-US">
<body>
<trans-unit id="1" xml:space="preserve" translate="yes">
<source>&xxe;</source>
<target/>
</trans-unit>
<trans-unit id="2" xml:space="preserve" translate="yes">
<source>&</source>
<target/>
</trans-unit>
</body>
</file>
</xliff>'''
xlifffile = xliff.xlifffile.parsestring(xlfsource)
assert xlifffile.units[0].istranslatable()
assert xlifffile.units[0].source == ''
assert xlifffile.units[1].istranslatable()
assert xlifffile.units[1].source == '&'
def test_multiple_filenodes(self):
xlfsource = '''<?xml version="1.0" encoding="utf-8"?>
<xliff version="1.1" xmlns="urn:oasis:names:tc:xliff:document:1.1">
<file original="file0" source-language="en" datatype="plaintext">
<body>
<trans-unit id="hello" approved="yes">
<source>Hello</source>
</trans-unit>
</body>
</file>
<file original="file1" source-language="en" datatype="plaintext">
<body>
<trans-unit id="world" approved="yes">
<source>World</source>
</trans-unit>
</body>
</file>
</xliff>'''
xfile = xliff.xlifffile.parsestring(xlfsource)
assert len(xfile.units) == 2
assert xfile.units[0].getid() == "file0\x04hello"
assert xfile.units[1].getid() == "file1\x04world"
xunit = xliff.xlifffile.UnitClass(source="goodbye")
xunit.setid("file2\x04goodbye")
xfile.addunit(xunit)
assert xfile.units[2].getid() == "file2\x04goodbye"
# if there is no file set it will use the active context
xunit = xliff.xlifffile.UnitClass(source="lastfile")
xunit.setid("lastfile")
xfile.addunit(xunit)
assert xfile.units[3].getid() == "file2\x04lastfile"
newxfile = xliff.xlifffile()
newxfile.addunit(xfile.units[0])
newxfile.addunit(xfile.units[1])
assert newxfile.units[0].getid() == "file0\x04hello"
assert newxfile.units[1].getid() == "file1\x04world"
assert newxfile.getfilenode("file0") is not None
assert newxfile.getfilenode("file1") is not None
assert not newxfile.getfilenode("foo")
def test_indent(self):
xlfsource = b'''<?xml version='1.0' encoding='UTF-8'?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.1" version="1.1">
<file original="doc.txt" source-language="en-US">
<body>
<trans-unit id="1" xml:space="preserve">
<source>File</source>
<target/>
</trans-unit>
</body>
</file>
</xliff>
'''
xlfsourcenote = b'''<?xml version='1.0' encoding='UTF-8'?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.1" version="1.1">
<file original="doc.txt" source-language="en-US">
<body>
<trans-unit id="1" xml:space="preserve">
<source>File</source>
<target/>
<note>Test note</note>
</trans-unit>
</body>
</file>
</xliff>
'''
xfile = xliff.xlifffile.parsestring(xlfsource)
assert bytes(xfile) == xlfsource
xfile.units[0].addnote('Test note')
assert bytes(xfile) == xlfsourcenote