Issue 4720 - Edge packager does not support devenv

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', 'chrome', 'safari', 'generic', 'edge')
+knownTypes = ('gecko', '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 149 matching lines @@
         }
 
 
 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'}:
             kwargs['buildNum'] = value
-            if type != 'gecko' and not kwargs['buildNum'].isdigit():
+            no_gecko_build = type not in {'gecko', 'gecko-webext'}
+            if no_gecko_build 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 == 'chrome':
+    elif 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):
@@ skipping 40 matching lines @@
 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',
             'target_platforms': {'gecko'},
             'default_locale': packager.defaultLocale
         }
-    elif type == 'chrome':
+    elif type in {'chrome', 'gecko-webext'}:
         import buildtools.packagerChrome as packager
         localeDir = os.path.join(baseDir, '_locales')
         localeConfig = {
             'name_format': 'ISO-15897',
             'file_format': 'chrome-json',
             'target_platforms': {'chrome'},
             'default_locale': packager.defaultLocale,
         }
     else:
         localeDir = os.path.join(
@@ skipping 135 matching lines @@
         return
     targetDir = args[0]
 
     source_dir = os.path.join(baseDir, 'lib')
     sources = [source_dir]
 
     # JSDoc struggles wih huge objects: https://github.com/jsdoc3/jsdoc/issues/976
     if type == 'chrome':
         sources = [os.path.join(source_dir, filename) for filename in os.listdir(source_dir) if filename != 'publicSuffixList.js']
 
-    config = os.path.join(os.path.dirname(__file__), 'jsdoc.conf')
-    command = ['jsdoc', '--destination', targetDir, '--configure', config] + sources
+    buildtools_path = os.path.dirname(__file__)
+    config = os.path.join(buildtools_path, 'jsdoc.conf')
+
+    command = ['npm', 'run-script', 'jsdoc', '--', '--destination', targetDir,
+               '--configure', config] + sources
     if any(opt in ('-q', '--quiet') for opt, _ in opts):
-        process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        process = subprocess.Popen(command, stdout=subprocess.PIPE,
+                                   stderr=subprocess.PIPE, cwd=buildtools_path)
         stderr = process.communicate()[1]
         retcode = process.poll()
         if retcode:
             sys.stderr.write(stderr)
             raise subprocess.CalledProcessError(command, retcode)
     else:
-        subprocess.check_call(command)
+        subprocess.check_call(command, cwd=buildtools_path)
 
 
 def runReleaseAutomation(baseDir, scriptName, opts, args, type):
     keyFile = None
     downloadsRepo = os.path.join(baseDir, '..', 'downloads')
     for option, value in opts:
         if option in ('-k', '--key'):
             keyFile = value
         elif option in ('-d', '--downloads'):
             downloadsRepo = value
@@ skipping 26 matching lines @@
 
 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', 'chrome', 'safari', 'edge')
+    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')
 
 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 = ('chrome', 'safari', 'edge')
+    command.supportedTypes = ('gecko-webext', 'chrome', 'safari', 'edge')
 
 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.'
@@ skipping 14 matching lines @@
 
 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. This operation requires JsDoc 3 to be installed.'
+    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')
 
 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>'
@@ skipping 70 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)