Issue 6291 - add ManifoldJS packaging for Edge

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
@@ skipping 169 matching lines @@
 @pytest.fixture
 def locale_modules(tmpdir):
     mod_dir = tmpdir.mkdir('_modules')
     lang_dir = mod_dir.mkdir('en_US')
     lang_dir.join('module.json').write(json.dumps(LOCALES_MODULE))
 
 
 @pytest.fixture
 def icons(srcdir):
     icons_dir = srcdir.mkdir('icons')
-    for filename in ['abp-16.png', 'abp-19.png', 'abp-53.png']:
+    for name in ['abp-{}.png'.format(x) for x in [16, 19, 44, 50, 53, 150]]:
         shutil.copy(
-            os.path.join(os.path.dirname(__file__), filename),
-            os.path.join(str(icons_dir), filename),
+            os.path.join(os.path.dirname(__file__), name),
+            os.path.join(str(icons_dir), name),
         )
 
 
 @pytest.fixture
 def all_lang_locales(tmpdir):
     return locale_files(ALL_LANGUAGES, '_locales', tmpdir)
 
 
 @pytest.fixture
 def chrome_metadata(tmpdir):
@@ skipping 82 matching lines @@
             generated = comparable_xml(manifest)
             expected = comparable_xml(fp.read())
         else:
             generated = comparable_json(manifest)
             expected = comparable_json(fp.read())
 
     diff = list(difflib.unified_diff(generated, expected, n=0))
     assert len(diff) == 0, '\n'.join(diff)
 
 
-def assert_webpack_bundle(package, prefix, is_devbuild, excluded=False):
+def assert_webpack_bundle(package, prefix, is_devbuild, platform):
     libfoo = package.read(os.path.join(prefix, 'lib/foo.js'))
     libfoomap = package.read(os.path.join(prefix, 'lib/foo.js.map'))
 
     assert 'var bar;' in libfoo
     if is_devbuild:
         assert 'addonVersion = "1.2.3.1337";' in libfoo
     else:
         assert 'addonVersion = "1.2.3";' in libfoo
 
     assert 'webpack:///./ext/a.js' in libfoomap
 
     assert 'var this_is_c;' in libfoo
     assert 'webpack:///./ext/c.js' in libfoomap
 
-    if prefix:  # webpack 'resolve.alias' exposure
+    if platform is 'edge':  # webpack 'resolve.alias' exposure
         assert 'var this_is_edge;' in libfoo
         assert 'webpack:///./lib/edge.js' in libfoomap
     else:
         assert 'var this_is_mogo;' in libfoo
         assert 'webpack:///./lib/mogo.js' in libfoomap
 
-    assert ('var foo;' in libfoo) != excluded
-    assert ('webpack:///./lib/b.js' in libfoomap) != excluded
+    assert ('var foo;' in libfoo) != (platform is 'gecko')
+    assert ('webpack:///./lib/b.js' in libfoomap) != (platform is 'gecko')
 
 
 def assert_devenv_scripts(package, prefix, devenv):
     manifest = json.loads(package.read(os.path.join(prefix, 'manifest.json')))
     filenames = package.namelist()
     scripts = [
         'ext/common.js',
         'ext/background.js',
     ]
 
     assert (os.path.join(prefix, 'qunit/index.html') in filenames) == devenv
     assert (os.path.join(prefix, 'devenvPoller__.js') in filenames) == devenv
     assert (os.path.join(prefix, 'devenvVersion__') in filenames) == devenv
     assert (os.path.join(prefix, 'qunit/tests.js') in filenames) == devenv
     assert (os.path.join(prefix, 'qunit/tests.js.map') in filenames) == devenv
 
     if devenv:
         quint_index = package.read(os.path.join(prefix, 'qunit/index.html'))
         assert '../ext/common.js' in quint_index
         assert '../ext/background.js' in quint_index
 
         assert set(manifest['background']['scripts']) == set(
             scripts + ['devenvPoller__.js'],
         )
     else:
         assert set(manifest['background']['scripts']) == set(scripts)
 
 
-def assert_base_files(package, platform, prefix):
+def assert_base_files(package, platform, prefix, devenv):
     filenames = set(package.namelist())
 
     if platform == 'edge':
-        assert 'AppxManifest.xml' in filenames
-        assert 'AppxBlockMap.xml' in filenames
-        assert '[Content_Types].xml' in filenames
+        assert ('AppxManifest.xml' in filenames) is not devenv
+        assert ('AppxBlockMap.xml' in filenames) is not devenv
+        assert ('[Content_Types].xml' in filenames) is not devenv
 
-        assert package.read('Assets/logo_44.png') == '44'
-        assert package.read('Extension/icons/abp-44.png') == '44'
+        if not devenv:
+            assert package.read('Extension/icons/abp-44.png') == '44'
 
     assert os.path.join(prefix, 'bar.json') in filenames
     assert os.path.join(prefix, 'manifest.json') in filenames
     assert os.path.join(prefix, 'lib/foo.js') in filenames
     assert os.path.join(prefix, 'foo/logo_50.png') in filenames
     assert os.path.join(prefix, 'icons/logo_150.png') in filenames
 
 
 def assert_chrome_signature(filename, keyfile):
     with open(filename, 'r') as fp:
@@ skipping 54 matching lines @@
     devenv = command == 'devenv'
 
     if platform == 'chrome' and release:
         key = keyfile
     else:
         key = None
 
     manifests = {
         'gecko': [('', 'manifest', 'json')],
         'chrome': [('', 'manifest', 'json')],
-        'edge': [('', 'AppxManifest', 'xml'),
-                 ('Extension', 'manifest', 'json')],
     }
 
+    if not devenv:
+        manifests['edge'] = [
+            ('', 'AppxManifest', 'xml'),
+            ('Extension', 'manifest', 'json')]

[Sebastian Noack, 2018/08/08 19:19:04]

Nit: The closing square bracket go on a new line, and there should be a comma
after the last item (according to our coding style guide).

[tlucas, 2018/08/08 22:10:07]

Done.

+    else:
+        manifests['edge'] = [('', 'manifest', 'json')]
+
     filenames = {
         'gecko': 'adblockplusfirefox-1.2.3{}.xpi',
         'chrome': 'adblockpluschrome-1.2.3{{}}.{}'.format(
             {True: 'crx', False: 'zip'}[release],
         ),
         'edge': 'adblockplusedge-1.2.3{}.appx',
     }
 
-    if platform == 'edge':
+    if platform == 'edge' and not devenv:
         prefix = 'Extension'
     else:
         prefix = ''
 
     run_webext_build(platform, command, srcdir, keyfile=key)
 
     # The makeIcons() in packagerChrome.py should warn about non-square
     # icons via stderr.
     out, err = capsys.readouterr()
     assert 'icon should be square' in err
@@ skipping 12 matching lines @@
         out_file = filenames[platform].format(add_version)
 
         out_file_path = os.path.abspath(os.path.join(
             os.path.dirname(__file__), os.pardir, out_file))
         assert os.path.exists(out_file_path)
 
     if release and platform == 'chrome':
         assert_chrome_signature(out_file_path, keyfile)
 
     with content_class(out_file_path) as package:
-        assert_base_files(package, platform, prefix)
+        assert_base_files(package, platform, prefix, devenv)
         assert_all_locales_present(package, prefix)
         assert_webpack_bundle(package, prefix, not release and not devenv,
-                              platform == 'gecko')
+                              platform)
 
         if platform == 'chrome':
             assert_locale_upfix(package)
 
         assert_devenv_scripts(package, prefix, devenv)
 
         for folder, name, ext in manifests[platform]:
             filename = '{{}}_{}_{}.{{}}'.format(platform, command)
             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,
             )