Issue 5997 - Avoid including qunit files in release builds

packagerChrome.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 errno
 import glob
 import io
 import json
 import os
 import re
@@ skipping 132 matching lines @@
     return manifest.encode('utf-8')
 
 
 def toJson(data):
     return json.dumps(
         data, ensure_ascii=False, sort_keys=True,
         indent=2, separators=(',', ': ')
     ).encode('utf-8') + '\n'
 
 
-def create_bundles(params, files):
+def create_bundles(params, files, bundle_tests):
     base_extension_path = params['baseDir']
     info_templates = {
         'chrome': 'chromeInfo.js.tmpl',
         'edge': 'edgeInfo.js.tmpl',
         'gecko': 'geckoInfo.js.tmpl'
     }
 
     # Historically we didn't use relative paths when requiring modules, so in
     # order for webpack to know where to find them we need to pass in a list of
     # resolve paths. Going forward we should always use relative paths, once we
@@ skipping 20 matching lines @@
 
         bundle_file = os.path.relpath(os.path.join(base_item_path, name),
                                       base_extension_path)
         entry_files = [os.path.join(base_item_path, module_path)
                        for module_path in value.split()]
         configuration['bundles'].append({
             'bundle_name': bundle_file,
             'entry_points': entry_files,
         })
 
+    if bundle_tests:
+        qunit_path = os.path.join(base_extension_path, 'qunit')
+        qunit_files = ([os.path.join(qunit_path, 'common.js')] +
+                       glob.glob(os.path.join(qunit_path, 'tests', '*.js')))
+        configuration['bundles'].append({
+            'bundle_name': 'qunit/tests.js',
+            'entry_points': qunit_files
+        })
+
     cmd = ['node', os.path.join(os.path.dirname(__file__), 'webpack_runner.js')]
     process = subprocess.Popen(cmd, stdout=subprocess.PIPE,
                                stdin=subprocess.PIPE)
     output = process.communicate(input=toJson(configuration))[0]
     if process.returncode != 0:
         raise subprocess.CalledProcessError(process.returncode, cmd=cmd)
     output = json.loads(output)
 
     # Clear the mapping for any files included in a bundle, to avoid them being
     # duplicated in the build.
@@ skipping 153 matching lines @@
     }
 
     mapped = metadata.items('mapping') if metadata.has_section('mapping') else []
     files = Files(getPackageFiles(params), getIgnoredFiles(params),
                   process=lambda path, data: processFile(path, data, params))
 
     files.readMappedFiles(mapped)
     files.read(baseDir, skip=[opt for opt, _ in mapped])
 
     if metadata.has_section('bundles'):
-        create_bundles(params, files)
+        bundle_tests = devenv and metadata.has_option('general', 'testScripts')
+        create_bundles(params, files, bundle_tests)
 
     if metadata.has_section('preprocess'):
         files.preprocess(
             [f for f, _ in metadata.items('preprocess')],
             {'needsExt': True}
         )
 
     if metadata.has_section('import_locales'):
         import_locales(params, files)
 
     files['manifest.json'] = createManifest(params, files)
     if type == 'chrome':
         fix_translations_for_chrome(files)
 
     if devenv:
         add_devenv_requirements(files, metadata, params)

[tlucas, 2017/11/08 12:08:51]

I wonder if this is/should be handled by webpack and/or if thisis also
responsible for the observed behavior - iirc, this was introduced by me parallel
to the webpack in #4720.

[kzar, 2017/11/09 15:33:16]

Well I agree it's kind of ugly how there are two separate checks for devenv. But
I don't think rendering the test page belongs in the code which creates the
webpack bundles, and I can't see how to add the metadata for the qunit bundle
outside of the create_bundles function. (I initially wanted to modify the
metadata from add_devenv_requirements to add the details about the qunit bundle
but it didn't look easily possible.)

[tlucas, 2017/11/09 16:29:49]

Acknowledged.

 
     zipdata = files.zipToString()
     signature = None
     pubkey = None
     if keyFile != None:
         signature = signBinary(zipdata, keyFile)
         pubkey = getPublicKey(keyFile)
     writePackage(outFile, pubkey, signature, zipdata)