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 xml.etree.ElementTree as ET
-import zipfile
-
 import pytest
 
-from buildtools import packager, packagerEdge
+import xml.etree.ElementTree as ET
 
-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 run_webext_build

[Vasily Kuznetsov, 2017/09/11 12:50:06]

You can combine all the imports from `buildtools.tests.tools` like this:

    from buildtools.tests.tools import (run_webext_build, locale_files,
                                        copy_metadata, ...)

or like this:

    from buildtools.tests.tools import (
        run_webext_build,
        locale_files,
        copy_metadata,
        ...
    )

The first one is more compact and less cluttered, the second one is even more
readable -- choose your favorite :)

[tlucas, 2017/09/12 11:32:10]

Acknowledged.

[tlucas, 2017/09/13 13:43:24]

Done.

+from buildtools.tests.tools import locale_files
+from buildtools.tests.tools import copy_metadata
+from buildtools.tests.tools import ZipContent
+from buildtools.tests.tools import assert_manifest_content
+from buildtools.tests.tools import assert_all_locales_present
+from buildtools.tests.conftest import ALL_LANGUAGES
+from buildtools import packager
+from buildtools import packagerEdge
 
 
 @pytest.fixture
-def metadata():
-    """Loaded metadata config."""
-    conf_parser = ConfigParser.ConfigParser()
-    conf_parser.read(TEST_METADATA)
-    return conf_parser
+def locale_files_edge(tmpdir):
+    return locale_files(ALL_LANGUAGES, '_locales', tmpdir)
+
+
+@pytest.fixture
+def edge_metadata(tmpdir):
+    filename = 'metadata.edge'
+    copy_metadata(filename, tmpdir)
+
+    return packager.readMetadata(str(tmpdir), 'edge')
 
 
 @pytest.fixture
 def files():
-    """Minimal Files() for testing manifest and blockmap."""
+    """Minimal Files() for testing blockmap."""
+    str500 = b''.join(chr(i % 200 + 30) for i in range(500))
     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
+    files['Extension/foo.xml'] = str500
+    files['Extension/bar.png'] = str500 * 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
+def js_extensions(srcdir):
+    srcdir.mkdir('ext').join('foo.js').write('var foo;')
+    srcdir.join('bar.js').write('var bar;')
 
 
 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]
         }
@@ skipping 50 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.usefixtures('locale_files_edge', 'js_extensions')
+@pytest.mark.parametrize('build_release', ['release', 'build'])
+def test_build_edge(build_release, tmpdir, srcdir, edge_metadata):
+    from buildtools import packagerEdge
+    release = build_release == 'release'
 
-    def first(elem):
-        return elem[0]
+    run_webext_build('edge', build_release, srcdir, packagerEdge)
 
-    def text(elem):
-        return elem.text
+    if release:
+        out_file = 'adblockplusedge-1.2.3.appx'
+    else:
+        out_file = 'adblockplusedge-1.2.3.0.appx'
 
-    def attr(attr):
-        def wrapper(elem):
-            return elem.attrib[attr]
-        return wrapper
+    with ZipContent(out_file) as package:
+        filenames = set(package.namelist())
 
-    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'),
-    ]
+        assert_all_locales_present(package, 'Extension/_locales')
 
-    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'),
-    ]
+        assert 'AppxManifest.xml' in filenames
+        assert 'AppxBlockMap.xml' in filenames
+        assert '[Content_Types].xml' in filenames
 
-    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'),
-    ]
+        assert 'Extension/ext/foo.js' in filenames
+        assert 'Extension/bar.js' in filenames
 
-    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
+        assert package.read('Assets/logo_44.png') == '44'
+        assert package.read('Extension/icons/abp-44.png') == '44'
 
+        if release:
+            filename = 'manifest_edge_True.xml'
+        else:
+            filename = 'manifest_edge_False.xml'
 
-def test_move_files_to_extension():
-    files = packager.Files(set(), set())
-    files['foo.xml'] = CHARS
-    files['foo/bar.xml'] = CHARS
-    files['Extension/foo.xml'] = CHARS
-    packagerEdge.move_files_to_extension(files)
-    assert set(files.keys()) == {
-        'Extension/foo.xml',
-        'Extension/foo/bar.xml',
-        'Extension/Extension/foo.xml'
-    }
-
-
-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'
-
-
-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')
+        expected = os.path.join(
+            os.path.dirname(__file__),
+            'expecteddata',
+            filename,
+        )
+        assert_manifest_content(package.read('AppxManifest.xml'), expected)