Issue 5751 - Removing legacy gecko support

build.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 sys
 import re
 import subprocess
 import shutil
 import buildtools
 from getopt import getopt, GetoptError
 from StringIO import StringIO
 from zipfile import ZipFile
 
-knownTypes = ('gecko', 'gecko-webext', 'chrome', 'safari', 'generic', 'edge')
+knownTypes = ('gecko-webext', 'chrome', 'safari', 'generic', 'edge')
 
 
 class Command(object):
     name = property(lambda self: self._name)
     shortDescription = property(
         lambda self: self._shortDescription,
         lambda self, value: self.__dict__.update({'_shortDescription': value})
     )
     description = property(
         lambda self: self._description,
@@ skipping 145 matching lines @@
             'name': command.name,
             'params': command.params,
             'description': description,
             'options': '\n'.join(options)
         }
 
 
 def runBuild(baseDir, scriptName, opts, args, type):
     kwargs = {}
     for option, value in opts:
-        if option in {'-l', '--locales'} and type == 'gecko':
-            kwargs['locales'] = value.split(',')
-        elif option in {'-b', '--build'}:
+        if option in {'-b', '--build'}:
             kwargs['buildNum'] = value
-            no_gecko_build = type not in {'gecko', 'gecko-webext'}
-            if no_gecko_build and not kwargs['buildNum'].isdigit():
+            if type != 'gecko-webext' and not kwargs['buildNum'].isdigit():
                 raise TypeError('Build number must be numerical')
         elif option in {'-k', '--key'}:
             kwargs['keyFile'] = value
-        elif option in {'-m', '--multi-compartment'} and type == 'gecko':
-            kwargs['multicompartment'] = True
         elif option in {'-r', '--release'}:
             kwargs['releaseBuild'] = True
     if len(args) > 0:
         kwargs['outFile'] = args[0]
 
-    if type == 'gecko':
-        import buildtools.packagerGecko as packager
-    elif type in {'chrome', 'gecko-webext'}:
+    if type in {'chrome', 'gecko-webext'}:
         import buildtools.packagerChrome as packager
     elif type == 'safari':
         import buildtools.packagerSafari as packager
     elif type == 'edge':
         import buildtools.packagerEdge as packager
 
     packager.createBuild(baseDir, type=type, **kwargs)
 
 
-def runAutoInstall(baseDir, scriptName, opts, args, type):
-    if len(args) == 0:
-        print 'Port of the Extension Auto-Installer needs to be specified'
-        usage(scriptName, type, 'autoinstall')
-        return
-
-    multicompartment = False
-    for option, value in opts:
-        if option in ('-m', '--multi-compartment'):
-            multicompartment = True
-
-    if ':' in args[0]:
-        host, port = args[0].rsplit(':', 1)
-    else:
-        host, port = ('localhost', args[0])
-
-    import buildtools.packagerGecko as packager
-    packager.autoInstall(baseDir, type, host, port, multicompartment=multicompartment)
-
-
 def createDevEnv(baseDir, scriptName, opts, args, type):
     if type == 'safari':
         import buildtools.packagerSafari as packager
     else:
         import buildtools.packagerChrome as packager
 
     file = StringIO()
     packager.createBuild(baseDir, type=type, outFile=file, devenv=True, releaseBuild=True)
 
     from buildtools.packager import getDevEnvPath
     devenv_dir = getDevEnvPath(baseDir, type)
 
     shutil.rmtree(devenv_dir, ignore_errors=True)
 
     file.seek(0)
     with ZipFile(file, 'r') as zip_file:
         zip_file.extractall(devenv_dir)
 
 
 def readLocaleConfig(baseDir, type, metadata):
-    if type == 'gecko':
-        import buildtools.packagerGecko as packager
-        localeDir = packager.getLocalesDir(baseDir)
-        localeConfig = {
-            'name_format': 'BCP-47',
-            'file_format': 'gecko-dtd',
-            'default_locale': packager.defaultLocale
-        }
-    elif type in {'chrome', 'gecko-webext'}:
+    if type != 'generic':
         import buildtools.packagerChrome as packager
         localeDir = os.path.join(baseDir, '_locales')
         localeConfig = {
-            'name_format': 'ISO-15897',
-            'file_format': 'chrome-json',
             'default_locale': packager.defaultLocale,
         }
     else:
         localeDir = os.path.join(
             baseDir, *metadata.get('locales', 'base_path').split('/')
         )
         localeConfig = {
-            'name_format': metadata.get('locales', 'name_format'),
-            'file_format': metadata.get('locales', 'file_format'),
             'default_locale': metadata.get('locales', 'default_locale')
         }
 
     localeConfig['base_path'] = localeDir
 
-    locales = [(locale, os.path.join(localeDir, locale))
+    locales = [(locale.replace('_', '-'), os.path.join(localeDir, locale))
                for locale in os.listdir(localeDir)]
-    if localeConfig['name_format'] == 'ISO-15897':
-        locales = [(locale.replace('_', '-'), localePath)
-                   for locale, localePath in locales]
     localeConfig['locales'] = dict(locales)
 
     return localeConfig
 
 
 def setupTranslations(baseDir, scriptName, opts, args, type):
     if len(args) < 1:
         print 'Project key is required to update translation master files.'
         usage(scriptName, type, 'setuptrans')
         return
@@ skipping 41 matching lines @@
     key = args[0]
 
     from buildtools.packager import readMetadata
     metadata = readMetadata(baseDir, type)
 
     basename = metadata.get('general', 'basename')
     localeConfig = readLocaleConfig(baseDir, type, metadata)
 
     import buildtools.localeTools as localeTools
     for locale, localeDir in localeConfig['locales'].iteritems():
         if locale != localeConfig['default_locale'].replace('_', '-'):

[tlucas, 2017/10/05 10:10:30]

Note: result of rebasing

             localeTools.uploadTranslations(localeConfig, metadata, localeDir, locale,
                                            basename, key)
 
 
 def getTranslations(baseDir, scriptName, opts, args, type):
     if len(args) < 1:
         print 'Project key is required to update translation master files.'
         usage(scriptName, type, 'translate')
         return
 
     key = args[0]
 
     from buildtools.packager import readMetadata
     metadata = readMetadata(baseDir, type)
 
     basename = metadata.get('general', 'basename')
     localeConfig = readLocaleConfig(baseDir, type, metadata)
 
     import buildtools.localeTools as localeTools
     localeTools.getTranslations(localeConfig, basename, key)
 
 
-def showDescriptions(baseDir, scriptName, opts, args, type):
-    locales = None
-    for option, value in opts:
-        if option in ('-l', '--locales'):
-            locales = value.split(',')
-
-    import buildtools.packagerGecko as packager
-    if locales == None:
-        locales = packager.getLocales(baseDir)
-    elif locales == 'all':
-        locales = packager.getLocales(baseDir, True)
-
-    data = packager.readLocaleMetadata(baseDir, locales)
-    localeCodes = data.keys()
-    localeCodes.sort()
-    for localeCode in localeCodes:
-        locale = data[localeCode]
-        print ('''%s
-%s
-%s
-%s
-%s
-''' % (localeCode,
-            locale['name'] if 'name' in locale else 'None',
-            locale['description'] if 'description' in locale else 'None',
-            locale['description.short'] if 'description.short' in locale else 'None',
-            locale['description.long'] if 'description.long' in locale else 'None',
-       )).encode('utf-8')
-
-
 def generateDocs(baseDir, scriptName, opts, args, type):
     if len(args) == 0:
         print 'No target directory specified for the documentation'
         usage(scriptName, type, 'docs')
         return
     targetDir = args[0]
 
     source_dir = os.path.join(baseDir, 'lib')
     sources = [source_dir]
 
@@ skipping 50 matching lines @@
     import buildtools.publicSuffixListUpdater as publicSuffixListUpdater
     publicSuffixListUpdater.updatePSL(baseDir)
 
 with addCommand(lambda baseDir, scriptName, opts, args, type: usage(scriptName, type), ('help', '-h', '--help')) as command:
     command.shortDescription = 'Show this message'
 
 with addCommand(runBuild, 'build') as command:
     command.shortDescription = 'Create a build'
     command.description = 'Creates an extension build with given file name. If output_file is missing a default name will be chosen.'
     command.params = '[options] [output_file]'
-    command.addOption('Only include the given locales (if omitted: all locales not marked as incomplete)', short='l', long='locales', value='l1,l2,l3', types=('gecko'))
     command.addOption('Use given build number (if omitted the build number will be retrieved from Mercurial)', short='b', long='build', value='num')
     command.addOption('File containing private key and certificates required to sign the package', short='k', long='key', value='file', types=('chrome', 'safari'))
-    command.addOption('Create a build for leak testing', short='m', long='multi-compartment', types=('gecko'))
     command.addOption('Create a release build', short='r', long='release')
-    command.supportedTypes = ('gecko', 'gecko-webext', 'chrome', 'safari', 'edge')
-
-with addCommand(runAutoInstall, 'autoinstall') as command:
-    command.shortDescription = 'Install extension automatically'
-    command.description = 'Will automatically install the extension in a browser running Extension Auto-Installer. If host parameter is omitted assumes that the browser runs on localhost.'
-    command.params = '[<host>:]<port>'
-    command.addOption('Create a build for leak testing', short='m', long='multi-compartment')
-    command.supportedTypes = ('gecko')
+    command.supportedTypes = ('gecko-webext', 'chrome', 'safari', 'edge')
 
 with addCommand(createDevEnv, 'devenv') as command:
     command.shortDescription = 'Set up a development environment'
     command.description = 'Will set up or update the devenv folder as an unpacked extension folder for development.'
     command.supportedTypes = ('gecko-webext', 'chrome', 'safari')
 
 with addCommand(setupTranslations, 'setuptrans') as command:
     command.shortDescription = 'Sets up translation languages'
     command.description = 'Sets up translation languages for the project on crowdin.net.'
     command.params = '[options] project-key'
-    command.supportedTypes = ('gecko', 'chrome', 'generic')
 
 with addCommand(updateTranslationMaster, 'translate') as command:
     command.shortDescription = 'Updates translation master files'
     command.description = 'Updates the translation master files in the project on crowdin.net.'
     command.params = '[options] project-key'
-    command.supportedTypes = ('gecko', 'chrome', 'generic')
 
 with addCommand(uploadTranslations, 'uploadtrans') as command:
     command.shortDescription = 'Uploads existing translations'
     command.description = 'Uploads already existing translations to the project on crowdin.net.'
     command.params = '[options] project-key'
-    command.supportedTypes = ('gecko', 'chrome', 'generic')
 
 with addCommand(getTranslations, 'gettranslations') as command:
     command.shortDescription = 'Downloads translation updates'
     command.description = 'Downloads updated translations from crowdin.net.'
     command.params = '[options] project-key'
-    command.supportedTypes = ('gecko', 'chrome', 'generic')
-
-with addCommand(showDescriptions, 'showdesc') as command:
-    command.shortDescription = 'Print description strings for all locales'
-    command.description = 'Display description strings for all locales as specified in the corresponding meta.properties files.'
-    command.addOption('Only include the given locales', short='l', long='locales', value='l1,l2,l3')
-    command.params = '[options]'
-    command.supportedTypes = ('gecko')
 
 with addCommand(generateDocs, 'docs') as command:
     command.shortDescription = 'Generate documentation (requires node.js)'
     command.description = ('Generate documentation files and write them into '
                            'the specified directory.')
     command.addOption('Suppress JsDoc output', short='q', long='quiet')
     command.params = '[options] <directory>'
-    command.supportedTypes = ('gecko', 'chrome')
+    command.supportedTypes = ('chrome')

[Vasily Kuznetsov, 2017/10/05 20:58:11]

Even though we did have strings instead of tuples in `command.supportedTypes`
before, it seems like this breaks the logic of `Command.isSupported`. When
`supportedTypes` is a string, we look up a substring in a string instead of
element in a tuple.

Even though this wouldn't break anything in real life usage at this time, I
would still advise to keep the type of `command.supportedTypes` always a tuple,
just to keep the code cleaner and avoid bugs being introduced in the future.

[tlucas, 2017/10/06 09:06:49]

Done.

 
 with addCommand(runReleaseAutomation, 'release') as command:
     command.shortDescription = 'Run release automation'
     command.description = 'Note: If you are not the project owner then you '        "probably don't want to run this!\n\n"        'Runs release automation: creates downloads for the new version, tags '        'source code repository as well as downloads and buildtools repository.'
     command.addOption('File containing private key and certificates required to sign the release.', short='k', long='key', value='file', types=('chrome', 'safari', 'edge'))
     command.addOption('Directory containing downloads repository (if omitted ../downloads is assumed)', short='d', long='downloads', value='dir')
     command.params = '[options] <version>'
-    command.supportedTypes = ('gecko', 'chrome', 'safari', 'edge')
+    command.supportedTypes = ('chrome', 'safari', 'edge')
 
 with addCommand(updatePSL, 'updatepsl') as command:
     command.shortDescription = 'Updates Public Suffix List'
     command.description = 'Downloads Public Suffix List (see http://publicsuffix.org/) and generates lib/publicSuffixList.js from it.'
     command.supportedTypes = ('chrome',)
 
 
 def getType(baseDir, scriptName, args):
     # Look for an explicit type parameter (has to be the first parameter)
     if len(args) >= 2 and args[0] == '-t':
@@ skipping 59 matching lines @@
                 if option in ('-h', '--help'):
                     usage(scriptName, type, command)
                     sys.exit()
             commands[command](baseDir, scriptName, opts, args, type)
         else:
             print 'Command %s is not supported for this application type' % command
             usage(scriptName, type)
     else:
         print 'Command %s is unrecognized' % command
         usage(scriptName, type)