Issue 5383 - Add tests for the Chrome and Firefox packagers

tests/test_packagerWebExt.py

 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
+import difflib
+import json
 import os
+import re
 import shutil
 import zipfile
-import json
-import re
+from xml.etree import ElementTree
 from struct import unpack
-import difflib
 
 import pytest
+from Crypto.Signature import PKCS1_v1_5
+from Crypto.PublicKey import RSA
 from Crypto.Hash import SHA
-from Crypto.PublicKey import RSA
-from Crypto.Signature import PKCS1_v1_5
-from xml.etree import ElementTree

[Vasily Kuznetsov, 2017/10/21 17:41:10]

The imports should be sorted+grouped in the following order: stdlib, 3rd party
libraries, local imports [1].

[1] PEP-8 section on imports: https://www.python.org/dev/peps/pep-0008/#imports.

[tlucas, 2017/10/22 11:19:13]

Done.

 
 from buildtools import packager
 from buildtools.packagerChrome import defaultLocale
 from buildtools.build import processArgs
 
 LOCALES_MODULE = {
     'test.Foobar': {
         'message': 'Ensuring dict-copy from modules for $domain$',
         'description': 'test description',
         'placeholders': {'content': '$1', 'example': 'www.adblockplus.org'}
@@ skipping 205 matching lines @@
     files['ext/c.js'] = 'var this_is_c;'
 
     tmpdir.mkdir('lib').join('b.js').write(files['lib/b.js'])
     ext_dir = tmpdir.mkdir('ext')
     ext_dir.join('a.js').write(files['ext/a.js'])
     ext_dir.join('c.js').write(files['ext/c.js'])
 
     return files
 
 
 def comparable_xml(xml):

[Vasily Kuznetsov, 2017/10/21 17:41:11]

I suppose it doesn't matter for the purposes of this test suite, but you might
want to note that this function is not quite bullet proof in terms of false
positives. For example, take the following two XML files:

[a.xml]
<a>
  <b><c/></b>
  <b><d/></b>
</a>

[b.xml]
<a>
  <b/>
  <b><c/><d/></b>
</a>

I don't think anybody would say that they are equivalent: clearly their
structure is rather different and it's not only about the order of the tags.
However, both a.xml and b.xml convert to:

a|None|None
a|None|None__b|None|None
a|None|None__b|None|None
a|None|None__b|None|None__c|None|None
a|None|None__b|None|None__d|None|None

[tlucas, 2017/10/22 11:19:12]

I adjusted the docstring to clarify this limitation (the refactoring will be
done in a separate review)

-    """Create a nonambiguous representation of a given XML tree."""
+    """Create a nonambiguous representation of a given XML tree.
+
+    Note that this function is not safe against ambiguous tags
+    containing differently distributed children, e.g.:
+
+    '<a><b><c/></b><b><d/></b></a>'
+    vs.
+    '<a><b/><b><c/><d/></b></a>'
+
+    This is irrelevant for comparing the XML used by the tests of this
+    module.
+    """
     def get_leafs_string(tree):
         """Recursively build a string representing all xml leaf-nodes."""
         root_str = '{}|{}|{}'.format(tree.tag, tree.tail, tree.text).strip()
         result = []
 
         if len(tree) > 0:
             for subtree in tree:
                 for leaf in get_leafs_string(subtree):
                     result.append('{}__{}'.format(root_str, leaf))
         for k, v in tree.attrib.items():
@@ skipping 210 matching lines @@
             expected = os.path.join(
                 os.path.dirname(__file__),
                 'expecteddata',
                 filename.format(name, ext),
             )
 
             assert_manifest_content(
                 package.read(os.path.join(folder, '{}.{}'.format(name, ext))),
                 expected,
             )