Issue 4548 - Split out Safari and add Edge release automation

releaseAutomation.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 os
 import re
 import codecs
 import subprocess
 import tarfile
 import json
 
+from packager import readMetadata, getDefaultFileName
 
 def get_dependencies(prefix, repos):
     from ensure_dependencies import read_deps, safe_join
     repo = repos[prefix]
     deps = read_deps(repo)
     if deps:
         for subpath in deps:
             if subpath.startswith('_'):
                 continue
             depprefix = prefix + subpath + '/'
@@ skipping 14 matching lines @@
                         if os.path.basename(fileinfo.name) in ('.hgtags', '.hgignore'):
                             continue
                         filedata = repoarchive.extractfile(fileinfo)
                         fileinfo.name = re.sub(r'^[^/]+/', prefix, fileinfo.name)
                         archive.addfile(fileinfo, filedata)
             finally:
                 process.stdout.close()
                 process.wait()
 
 
-def run(baseDir, type, version, keyFiles, downloadsRepo):
+def run(baseDir, type, version, keyFile, downloadsRepo):
     if type == 'gecko':
         import buildtools.packagerGecko as packager
     elif type == 'safari':
         import buildtools.packagerSafari as packager
     elif type == 'edge':
         import buildtools.packagerEdge as packager
     elif type == 'chrome':
         import buildtools.packagerChrome as packager
 
     # Replace version number in metadata file "manually", ConfigParser will mess
     # up the order of lines.
-    metadata = packager.readMetadata(baseDir, type)
+    metadata = readMetadata(baseDir, type)
     with open(metadata.option_source('general', 'version'), 'r+b') as file:
         rawMetadata = file.read()
         rawMetadata = re.sub(
             r'^(\s*version\s*=\s*).*', r'\g<1>%s' % version,
             rawMetadata, flags=re.I | re.M
         )
 
         file.seek(0)
         file.write(rawMetadata)
         file.truncate()
 
     # Read extension name from locale data
     import buildtools.packagerGecko as packagerGecko
     if type == 'gecko':
         locales_base = baseDir
     else:
         # This is somewhat of a hack but reading out locale import config here would be too much
         locales_base = os.path.join(baseDir, 'adblockplus')
 
     locales = packagerGecko.readLocaleMetadata(locales_base, [packagerGecko.defaultLocale])
     extensionName = locales[packagerGecko.defaultLocale]['name']
 
     # Now commit the change and tag it
     subprocess.check_call(['hg', 'commit', '-R', baseDir, '-m', 'Releasing %s %s' % (extensionName, version)])
-    subprocess.check_call(['hg', 'tag', '-R', baseDir, '-f', version])
+    tag_name = version
+    if type in {'safari', 'edge'}:
+        tag_name = '{}-{}'.format(tag_name, type)
+    subprocess.check_call(['hg', 'tag', '-R', baseDir, '-f', tag_name])
 
     # Create a release build
     downloads = []
     if type == 'gecko':
-        keyFile = keyFiles[0] if keyFiles else None
-        metadata = packager.readMetadata(baseDir, type)

[Wladimir Palant, 2016/10/20 10:03:08]

This statement is unnecessary - here and in all the other branches. We already
read metadata above.

[kzar, 2016/10/20 12:09:36]

Done.

-        buildPath = os.path.join(downloadsRepo, packager.getDefaultFileName(metadata, version, 'xpi'))
-        packager.createBuild(baseDir, type=type, outFile=buildPath, releaseBuild=True, keyFile=keyFile)

[Wladimir Palant, 2016/10/20 10:03:08]

While at it, could you remove the keyFile parameter here? packagerGecko no
longer supports signing, it seems that we missed this in
https://issues.adblockplus.org/ticket/4336.

[kzar, 2016/10/20 12:09:36]

Done.

+        buildPath = os.path.join(downloadsRepo, getDefaultFileName(metadata, version, 'xpi'))
+        packager.createBuild(baseDir, type=type, outFile=buildPath, releaseBuild=True)
         downloads.append(buildPath)
     elif type == 'chrome':
         # Create both signed and unsigned Chrome builds (the latter for Chrome Web Store).
-        metadata = packager.readMetadata(baseDir, type)
-        buildPath = os.path.join(downloadsRepo, packager.getDefaultFileName(metadata, version, 'crx'))
-        packager.createBuild(baseDir, type=type, outFile=buildPath, releaseBuild=True, keyFile=keyFiles[0])
+        buildPath = os.path.join(downloadsRepo, getDefaultFileName(metadata, version, 'crx'))
+        packager.createBuild(baseDir, type=type, outFile=buildPath, releaseBuild=True, keyFile=keyFile)
         downloads.append(buildPath)
 
-        buildPathUnsigned = os.path.join(baseDir, packager.getDefaultFileName(metadata, version, 'zip'))
+        buildPathUnsigned = os.path.join(baseDir, getDefaultFileName(metadata, version, 'zip'))
         packager.createBuild(baseDir, type=type, outFile=buildPathUnsigned, releaseBuild=True, keyFile=None)
     elif type == 'safari':
-        metadata = packager.readMetadata(baseDir, type)
-        buildPath = os.path.join(downloadsRepo, packager.getDefaultFileName(metadata, version, 'safariextz'))
-        packager.createBuild(baseDir, type='safari', outFile=buildPath, releaseBuild=True, keyFile=keyFiles[0])
+        buildPath = os.path.join(downloadsRepo, getDefaultFileName(metadata, version, 'safariextz'))
+        packager.createBuild(baseDir, type='safari', outFile=buildPath, releaseBuild=True, keyFile=keyFile)
         downloads.append(buildPath)
     elif type == 'edge':
         # We only offer the Edge extension for use through the Windows Store
-        metadata = packager.readMetadata(baseDir, type)
-        buildPath = os.path.join(downloadsRepo, packager.getDefaultFileName(metadata, version, 'appx'))
-        packager.createBuild(baseDir, type=type, outFile=buildPathUnsigned, releaseBuild=True, keyFile=None)

[Sebastian Noack, 2016/10/19 14:26:14]

I suppose the absence of downloads.append(...) means that we wouldn't add the
build to the downloads repository? I wonder whether we should still add it, even
though there are some issues when installing a build that isn't signed by
Microsoft. But it's not that we don't have similar issues with off-store
extensions for Chrome and Safari. And that way, QA can at least try compare
different versions.

Even better, if we could download the build with Microsoft's signature from the
Windows Store, after unsigned build has been uploaded, and archive it in our
downloads repository. But I guess that doesn't work the way the release
automation currently works.

[kzar, 2016/10/19 14:31:03]

That's the idea. I followed the example of the unsigned Chrome builds above, but
I don't have a strong opinion on this either way.

[Sebastian Noack, 2016/10/19 15:08:24]

Sure, I just thought that it might be useful to archive the unsigned builds at
least if we don't have a signed build for Microsoft Edge. But I start to wonder
how useful this would be after all.

[Wladimir Palant, 2016/10/20 10:03:08]

This file should definitely be added to the downloads repository. We don't offer
Chrome or Firefox builds for download from our site either, these wouldn't be
usable. But we need some place to look up what we've published there. Neither
Chrome Web Store nor Windows Store will let you download historical releases, in
fact Windows Store makes it ridiculously complicated even for the current
release.

[kzar, 2016/10/20 12:09:36]

Done.

-
+        buildPath = os.path.join(downloadsRepo, getDefaultFileName(metadata, version, 'appx'))
+        packager.createBuild(baseDir, type=type, outFile=buildPath, releaseBuild=True)
+        downloads.append(buildPath)
 
     # Create source archive
     archivePath = os.path.splitext(buildPath)[0] + '-source.tgz'
     create_sourcearchive(baseDir, archivePath)
     downloads.append(archivePath)
 
     # Now add the downloads and commit
     subprocess.check_call(['hg', 'add', '-R', downloadsRepo] + downloads)
     subprocess.check_call(['hg', 'commit', '-R', downloadsRepo, '-m', 'Releasing %s %s' % (extensionName, version)])
 
     # Push all changes
     subprocess.check_call(['hg', 'push', '-R', baseDir])
     subprocess.check_call(['hg', 'push', '-R', downloadsRepo])