Issue 5383 - Add tests for the Chrome and Firefox packagers

tests/test_packagerEdge.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 ConfigParser
-import json
 import os
-import shutil
+import io
+
 import xml.etree.ElementTree as ET
 import zipfile
 
 import pytest
 
 from buildtools import packager, packagerEdge
-
-TEST_DIR = os.path.dirname(__file__)
-TEST_METADATA = os.path.join(TEST_DIR, 'metadata.edge')
-CHARS = b''.join(chr(i % 200 + 30) for i in range(500))
-MESSAGES_EN_US = json.dumps({
-    'name': {'message': 'Adblock Plus'},
-    'name_devbuild': {'message': 'devbuild-marker'},
-    'description': {
-        'message': 'Adblock Plus is the most popular ad blocker ever, '
-                   'and also supports websites by not blocking '
-                   'unobstrusive ads by default (configurable).'
-    },
-})
+from buildtools.tests.tools import copy_metadata
 
 
 @pytest.fixture
-def metadata():
-    """Loaded metadata config."""
-    conf_parser = ConfigParser.ConfigParser()
-    conf_parser.read(TEST_METADATA)
-    return conf_parser
+def edge_metadata(tmpdir):
+    filename = 'metadata.edge'
+    copy_metadata(filename, tmpdir)
 
-
-@pytest.fixture
-def files():
-    """Minimal Files() for testing manifest and blockmap."""
-    files = packager.Files(set(), set())
-    for size in ['44', '50', '150']:
-        files['Assets/logo_{}.png'.format(size)] = CHARS
-    files['Extension/_locales/en_US/messages.json'] = MESSAGES_EN_US
-    files['Extension/foo.xml'] = CHARS
-    files['Extension/bar.png'] = CHARS * 200
-    return files
-
-
-@pytest.fixture
-def srcdir(tmpdir):
-    """Source directory for building the package."""
-    srcdir = tmpdir.mkdir('src')
-    shutil.copy(TEST_METADATA, str(srcdir.join('metadata.edge')))
-    for size in ['44', '50', '150']:
-        path = srcdir.join('chrome', 'icons', 'abp-{}.png'.format(size))
-        path.write(size, ensure=True)
-    localedir = srcdir.mkdir('_locales')
-    en_us_dir = localedir.mkdir('en_US')
-    en_us_dir.join('messages.json').write(MESSAGES_EN_US)
-    return srcdir
+    return packager.readMetadata(str(tmpdir), 'edge')
 
 
 def blockmap2dict(xml_data):
     """Convert AppxBlockMap.xml to a dict of dicts easier to inspect."""
     return {
         file.get('Name'): {
             'size': file.get('Size'),
             'lfhsize': file.get('LfhSize'),
             'blocks': [b.get('Hash') for b in file]
         }
         for file in ET.fromstring(xml_data)
     }
 
 
-def test_create_appx_blockmap(files):
-    blockmap = blockmap2dict(packagerEdge.create_appx_blockmap(files))
+def test_create_appx_blockmap(base_files):
+    blockmap = blockmap2dict(packagerEdge.create_appx_blockmap(base_files))
     assert blockmap['Extension\\foo.xml'] == {
         'size': '500',
         'lfhsize': '47',
         'blocks': ['Vhwfmzss1Ney+j/ssR2QVISvFyMNBQeS2P+UjeE/di0=']
     }
     assert blockmap['Extension\\bar.png'] == {
         'size': '100000',
         'lfhsize': '47',
         'blocks': [
             'KPW2SxeEikUEGhoKmKxruUSexKun0bGXMppOqUFrX5E=',
@@ skipping 34 matching lines @@
         'otf': 'application/octet-stream',
         'png': 'image/png',
         'xml': 'application/xml'
     }
     assert ctm_dict['overrides'] == {
         '/AppxBlockMap.xml': 'application/vnd.ms-appx.blockmap+xml',
         '/AppxManifest.xml': 'application/vnd.ms-appx.manifest+xml'
     }
 
 
-def test_create_appx_manifest(metadata, files):
-    namespaces = {
-        'ns': 'http://schemas.microsoft.com/'
-              'appx/manifest/foundation/windows10',
-        'uap': 'http://schemas.microsoft.com/appx/manifest/uap/windows10',
-        'uap3': 'http://schemas.microsoft.com/appx/manifest/uap/windows10/3',
-    }
+@pytest.mark.parametrize('release_build', [True, False])
+def test_create_appx_manifest(base_files, srcdir, release_build,
+                              edge_metadata):
+    manifest = ET.fromstring(packagerEdge.create_appx_manifest(
+        {'metadata': edge_metadata},
+        base_files,
+        release_build=release_build))
 
-    def first(elem):
-        return elem[0]
+    xmlpath = os.path.join(
+        os.path.dirname(__file__),
+        'expecteddata',
+        'manifest_edge_{}.xml'.format(release_build)
+    )
 
-    def text(elem):
-        return elem.text
+    with io.open(xmlpath, 'r') as fp:
+        expected = ET.fromstring(fp.read())
 
-    def attr(attr):
-        def wrapper(elem):
-            return elem.attrib[attr]
-        return wrapper
-
-    base = [
-        ('.//*', [len], 21.0),
-        ('./ns:Identity', [first, attr('Publisher')],
-            'CN=4F066043-8AFE-41C9-B762-6C15E77E3F88'),
-        ('./ns:Identity', [first, attr('Version')], '1.2.3.0'),
-        ('./ns:Properties/ns:PublisherDisplayName', [first, text],
-            'Eyeo GmbH'),
-        ('./ns:Properties/ns:Logo', [first, text], 'Assets\\logo_50.png'),
-        ('./ns:Dependencies/ns:TargetDeviceFamily',
-            [first, attr('MinVersion')],
-            '10.0.14332.0'),
-        ('./ns:Dependencies/ns:TargetDeviceFamily',
-            [first, attr('MaxVersionTested')],
-            '12.0.0.0'),
-        ('./ns:Applications/ns:Application/uap:VisualElements',
-            [first, attr('Square150x150Logo')],
-            'Assets\\logo_150.png'),
-        ('./ns:Applications/ns:Application/uap:VisualElements',
-            [first, attr('Square44x44Logo')],
-            'Assets\\logo_44.png'),
-        ('./ns:Applications/ns:Application/uap:VisualElements',
-            [first, attr('Description')],
-            'Adblock Plus is the most popular ad blocker ever, and also '
-            'supports websites by not blocking unobstrusive ads by '
-            'default (configurable).'),
-        ('./ns:Applications/ns:Application/uap:VisualElements',
-            [first, attr('BackgroundColor')],
-            'red'),
-    ]
-
-    devbuild = base + [
-        ('./ns:Identity', [first, attr('Name')],
-            'EyeoGmbH.AdblockPlusdevelopmentbuild'),
-        ('./ns:Properties/ns:DisplayName', [first, text], 'devbuild-marker'),
-        ('./ns:Applications/ns:Application/uap:VisualElements',
-            [first, attr('DisplayName')],
-            'devbuild-marker'),
-        ('./ns:Applications/ns:Application/ns:Extensions/uap3:Extension/'
-            'uap3:AppExtension',
-            [first, attr('Id')],
-            'EdgeExtension'),
-        ('./ns:Applications/ns:Application/ns:Extensions/uap3:Extension/'
-            'uap3:AppExtension',
-            [first, attr('DisplayName')],
-            'devbuild-marker'),
-    ]
-
-    release = base + [
-        ('./ns:Identity', [first, attr('Name')], 'EyeoGmbH.AdblockPlus'),
-        ('./ns:Properties/ns:DisplayName', [first, text], 'Adblock Plus'),
-        ('./ns:Applications/ns:Application/uap:VisualElements',
-            [first, attr('DisplayName')],
-            'Adblock Plus'),
-        ('./ns:Applications/ns:Application/ns:Extensions/uap3:Extension/'
-            'uap3:AppExtension',
-            [first, attr('Id')],
-            '1.0'),
-        ('./ns:Applications/ns:Application/ns:Extensions/uap3:Extension/'
-            'uap3:AppExtension',
-            [first, attr('DisplayName')],
-            'Adblock Plus'),
-    ]
-
-    for release_build, pairs in [(False, devbuild), (True, release)]:
-        manifest = ET.fromstring(packagerEdge.create_appx_manifest(
-            {'metadata': metadata},
-            files,
-            release_build=release_build))
-        for expression, modifiers, value in pairs:
-            res = reduce(
-                lambda val, func: func(val),
-                modifiers,
-                manifest.findall(expression, namespaces=namespaces))
-            assert res == value
+    from buildtools.tests.tools import get_leafs_string
+    assert set(get_leafs_string(expected)) == set(get_leafs_string(manifest))
 
 
-def test_move_files_to_extension():
+def test_move_files_to_extension(str500chars):
     files = packager.Files(set(), set())
-    files['foo.xml'] = CHARS
-    files['foo/bar.xml'] = CHARS
-    files['Extension/foo.xml'] = CHARS
+    files['foo.xml'] = str500chars
+    files['foo/bar.xml'] = str500chars
+    files['Extension/foo.xml'] = str500chars
     packagerEdge.move_files_to_extension(files)
     assert set(files.keys()) == {
         'Extension/foo.xml',
         'Extension/foo/bar.xml',
         'Extension/Extension/foo.xml'
     }
 
 
+@pytest.mark.usefixtures('edge_metadata')
 def test_create_build(tmpdir, srcdir):
     out_file = str(tmpdir.join('abp.appx'))
     packagerEdge.createBuild(str(srcdir), outFile=out_file, releaseBuild=True)
     appx = zipfile.ZipFile(out_file)
 
     names = set(appx.namelist())
     assert 'AppxManifest.xml' in names
     assert 'AppxBlockMap.xml' in names
     assert '[Content_Types].xml' in names
 
     assert 'devbuild-marker' not in appx.read('AppxManifest.xml')
     assert appx.read('Assets/logo_44.png') == '44'
     assert appx.read('Extension/icons/abp-44.png') == '44'
 
 
+@pytest.mark.usefixtures('edge_metadata')
 def test_create_devbuild(tmpdir, srcdir):
     out_file = str(tmpdir.join('abp.appx'))
     packagerEdge.createBuild(str(srcdir), outFile=out_file, releaseBuild=False)
     appx = zipfile.ZipFile(out_file)
     assert 'devbuild-marker' in appx.read('AppxManifest.xml')