[buildtools] Issue 4578 - Make uap3:AppExtension.Id configurable for Microsoft Edge builds

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
-from lxml import etree
 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({
@@ skipping 110 matching lines @@
 
 
 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',
     }
 
-    base = {
-        'count(//*)': 22.0,
-        'string(/ns:Package/ns:Identity/@Name)': 'EyeoGmbH.AdblockPlus',
-        'string(/ns:Package/ns:Identity/@Publisher)':
-            'CN=4F066043-8AFE-41C9-B762-6C15E77E3F88',
-        'string(/ns:Package/ns:Identity/@Version)': '1.2.3.0',
-        'string(/ns:Package/ns:Properties/ns:PublisherDisplayName)':
-            'Eyeo GmbH',
-        'string(/ns:Package/ns:Properties/ns:Logo)': 'Assets\\logo_50.png',
-        ('string(/ns:Package/ns:Dependencies/ns:TargetDeviceFamily/'
-            '@MinVersion)'): '10.0.14332.0',
-        ('string(/ns:Package/ns:Dependencies/ns:TargetDeviceFamily/'
-            '@MaxVersionTested)'): '12.0.0.0',
-        ('string(/ns:Package/ns:Applications/ns:Application/'
-            'uap:VisualElements/@Square150x150Logo)'): 'Assets\\logo_150.png',
-        ('string(/ns:Package/ns:Applications/ns:Application/'
-            'uap:VisualElements/@Square44x44Logo)'): 'Assets\\logo_44.png',
-        ('string(/ns:Package/ns:Applications/ns:Application/'
-            'uap:VisualElements/@Description)'):
-                'Adblock Plus is the most popular ad blocker ever, and also '
-                'supports websites by not blocking unobstrusive ads by '
-                'default (configurable).',
-        ('string(/ns:Package/ns:Applications/ns:Application/'
-            'uap:VisualElements/@BackgroundColor)'): 'red',
-    }
-
-    devbuild = base.copy()
-    devbuild.update({
-        'string(/ns:Package/ns:Properties/ns:DisplayName)': 'devbuild-marker',
-        'string(/ns:Package/ns:Applications/ns:Application/'
-        'uap:VisualElements/@DisplayName)': 'devbuild-marker',
-        ('string(/ns:Package/ns:Applications/ns:Application/ns:Extensions/'
-            'uap3:Extension/uap3:AppExtension/@Id)'): 'EdgeExtension',
-        'string(/ns:Package/ns:Applications/'
-        'ns:Application/ns:Extensions/uap3:Extension/'
-        'uap3:AppExtension/@DisplayName)': 'devbuild-marker',
-    })
-
-    release = base.copy()
-    release.update({
-        'string(/ns:Package/ns:Properties/ns:DisplayName)': 'Adblock Plus',
-        ('string(/ns:Package/ns:Applications/ns:Application/'
-            'uap:VisualElements/@DisplayName)'): 'Adblock Plus',
-        ('string(/ns:Package/ns:Applications/ns:Application/ns:Extensions/'
-            'uap3:Extension/uap3:AppExtension/@Id)'): '1.0',
-        ('string(/ns:Package/ns:Applications/ns:Application/ns:Extensions/'
-            'uap3:Extension/uap3:AppExtension/@DisplayName)'): 'Adblock Plus',
-    })
-
-    for release_build, pairs in [[False, devbuild], [True, release]]:

[Sebastian Noack, 2016/12/21 15:54:15]

Please use tuples for data that have structure (as opposed to order). There is a
great post on Stack Overflow, which explains that concept:
https://stackoverflow.com/questions/626759/whats-the-difference-between-lists...

It is also stated in our coding style guide:
https://adblockplus.org/coding-style#python

So according to this rule, the loop here should look like that:

  for release_build, pairs in [(False, devbuild), (True, release)]:
    ...

The outer container is a list because it has order as you iterate over it. You
could add, move or remove an item, and the code below processing that list would
still work as expected without any adaption.

However, the inner container should be a tuple as it has structure. It is
essential to the code processing it that there are exactly two items, while the
first one is processed entirely different from the second.

[wspee, 2017/01/02 14:16:19]

Done.

-        manifest = etree.fromstring(packagerEdge.create_appx_manifest(
-            {'metadata': metadata}, files, release_build=release_build))
-        for expression, value in pairs.items():
-            assert manifest.xpath(expression, namespaces=namespaces) == value
+    def first(elem):
+        return elem[0]
+
+    def text(elem):
+        return elem.text
+
+    def attr(attr):
+        def wrapper(elem):
+            return elem.attrib[attr]
+        return wrapper
+
+    base = [
+        ('.//*', [len], 21.0),
+        ('./ns:Identity', [first, attr('Name')], 'EyeoGmbH.AdblockPlus'),
+        ('./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: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: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
 
 
 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 'Extension/lib/info.js' 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')