michael@0: # This Source Code Form is subject to the terms of the Mozilla Public
michael@0: # License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0: # file, You can obtain one at http://mozilla.org/MPL/2.0/.
michael@0: 
michael@0: import os
michael@0: import unittest
michael@0: import zipfile
michael@0: import pprint
michael@0: import shutil
michael@0: 
michael@0: import simplejson as json
michael@0: from cuddlefish import xpi, packaging, manifest, buildJID
michael@0: from cuddlefish.tests import test_packaging
michael@0: from test_linker import up
michael@0: 
michael@0: import xml.etree.ElementTree as ElementTree
michael@0: 
michael@0: xpi_template_path = os.path.join(test_packaging.static_files_path,
michael@0:                                  'xpi-template')
michael@0: 
michael@0: fake_manifest = '<RDF><!-- Extension metadata is here. --></RDF>'
michael@0: 
michael@0: class PrefsTests(unittest.TestCase):
michael@0:     def makexpi(self, pkg_name):
michael@0:         self.xpiname = "%s.xpi" % pkg_name
michael@0:         create_xpi(self.xpiname, pkg_name, 'preferences-files')
michael@0:         self.xpi = zipfile.ZipFile(self.xpiname, 'r')
michael@0:         options = self.xpi.read('harness-options.json')
michael@0:         self.xpi_harness_options = json.loads(options)
michael@0: 
michael@0:     def setUp(self):
michael@0:         self.xpiname = None
michael@0:         self.xpi = None
michael@0: 
michael@0:     def tearDown(self):
michael@0:         if self.xpi:
michael@0:             self.xpi.close()
michael@0:         if self.xpiname and os.path.exists(self.xpiname):
michael@0:             os.remove(self.xpiname)
michael@0: 
michael@0:     def testPackageWithSimplePrefs(self):
michael@0:         self.makexpi('simple-prefs')
michael@0:         packageName = 'jid1-fZHqN9JfrDBa8A@jetpack'
michael@0:         self.failUnless('options.xul' in self.xpi.namelist())
michael@0:         optsxul = self.xpi.read('options.xul').decode("utf-8")
michael@0:         self.failUnlessEqual(self.xpi_harness_options["jetpackID"], packageName)
michael@0:         self.failUnlessEqual(self.xpi_harness_options["preferencesBranch"], packageName)
michael@0: 
michael@0:         root = ElementTree.XML(optsxul.encode('utf-8'))
michael@0: 
michael@0:         xulNamespacePrefix = \
michael@0:             "{http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul}"
michael@0: 
michael@0:         settings = root.findall(xulNamespacePrefix + 'setting')
michael@0: 
michael@0:         def assertPref(setting, name, prefType, title):
michael@0:             self.failUnlessEqual(setting.get('data-jetpack-id'), packageName)
michael@0:             self.failUnlessEqual(setting.get('pref'),
michael@0:                                  'extensions.' + packageName + '.' + name)
michael@0:             self.failUnlessEqual(setting.get('pref-name'), name)
michael@0:             self.failUnlessEqual(setting.get('type'), prefType)
michael@0:             self.failUnlessEqual(setting.get('title'), title)
michael@0: 
michael@0:         assertPref(settings[0], 'test', 'bool', u't\u00EBst')
michael@0:         assertPref(settings[1], 'test2', 'string', u't\u00EBst')
michael@0:         assertPref(settings[2], 'test3', 'menulist', '"><test')
michael@0:         assertPref(settings[3], 'test4', 'radio', u't\u00EBst')
michael@0: 
michael@0:         menuItems = settings[2].findall(
michael@0:             '%(0)smenulist/%(0)smenupopup/%(0)smenuitem' % { "0": xulNamespacePrefix })
michael@0:         radios = settings[3].findall(
michael@0:             '%(0)sradiogroup/%(0)sradio' % { "0": xulNamespacePrefix })
michael@0: 
michael@0:         def assertOption(option, value, label):
michael@0:             self.failUnlessEqual(option.get('value'), value)
michael@0:             self.failUnlessEqual(option.get('label'), label)
michael@0: 
michael@0:         assertOption(menuItems[0], "0", "label1")
michael@0:         assertOption(menuItems[1], "1", "label2")
michael@0:         assertOption(radios[0], "red", "rouge")
michael@0:         assertOption(radios[1], "blue", "bleu")
michael@0: 
michael@0:         prefsjs = self.xpi.read('defaults/preferences/prefs.js').decode("utf-8")
michael@0:         exp = [u'pref("extensions.jid1-fZHqN9JfrDBa8A@jetpack.test", false);',
michael@0:                u'pref("extensions.jid1-fZHqN9JfrDBa8A@jetpack.test2", "\u00FCnic\u00F8d\u00E9");',
michael@0:                u'pref("extensions.jid1-fZHqN9JfrDBa8A@jetpack.test3", "1");',
michael@0:                u'pref("extensions.jid1-fZHqN9JfrDBa8A@jetpack.test4", "red");',
michael@0:                ]
michael@0:         self.failUnlessEqual(prefsjs, "\n".join(exp)+"\n")
michael@0: 
michael@0:     def testPackageWithPreferencesBranch(self):
michael@0:         self.makexpi('preferences-branch')
michael@0:         self.failUnless('options.xul' in self.xpi.namelist())
michael@0:         optsxul = self.xpi.read('options.xul').decode("utf-8")
michael@0:         self.failUnlessEqual(self.xpi_harness_options["preferencesBranch"], 
michael@0:                              "human-readable")
michael@0: 
michael@0:         root = ElementTree.XML(optsxul.encode('utf-8'))
michael@0:         xulNamespacePrefix = \
michael@0:             "{http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul}"
michael@0:         
michael@0:         setting = root.find(xulNamespacePrefix + 'setting')
michael@0:         self.failUnlessEqual(setting.get('pref'),
michael@0:                              'extensions.human-readable.test42')
michael@0: 
michael@0:         prefsjs = self.xpi.read('defaults/preferences/prefs.js').decode("utf-8")
michael@0:         self.failUnlessEqual(prefsjs, 
michael@0:                             'pref("extensions.human-readable.test42", true);\n')
michael@0: 
michael@0:     def testPackageWithNoPrefs(self):
michael@0:         self.makexpi('no-prefs')
michael@0:         self.failIf('options.xul' in self.xpi.namelist())
michael@0:         self.failUnlessEqual(self.xpi_harness_options["jetpackID"],
michael@0:                              "jid1-fZHqN9JfrDBa8A@jetpack")
michael@0:         prefsjs = self.xpi.read('defaults/preferences/prefs.js').decode("utf-8")
michael@0:         self.failUnlessEqual(prefsjs, "")
michael@0: 
michael@0:     def testPackageWithInvalidPreferencesBranch(self):
michael@0:         self.makexpi('curly-id')
michael@0:         self.failIfEqual(self.xpi_harness_options["preferencesBranch"], 
michael@0:                          "invalid^branch*name")
michael@0:         self.failUnlessEqual(self.xpi_harness_options["preferencesBranch"], 
michael@0:                              "{34a1eae1-c20a-464f-9b0e-000000000000}")
michael@0: 
michael@0:     def testPackageWithCurlyID(self):
michael@0:         self.makexpi('curly-id')
michael@0:         self.failUnlessEqual(self.xpi_harness_options["jetpackID"], 
michael@0:                              "{34a1eae1-c20a-464f-9b0e-000000000000}")
michael@0: 
michael@0:         self.failUnless('options.xul' in self.xpi.namelist())
michael@0:         optsxul = self.xpi.read('options.xul').decode("utf-8")
michael@0: 
michael@0:         root = ElementTree.XML(optsxul.encode('utf-8'))
michael@0:         xulNamespacePrefix = \
michael@0:             "{http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul}"
michael@0:         
michael@0:         setting = root.find(xulNamespacePrefix + 'setting')
michael@0:         self.failUnlessEqual(setting.get('pref'),
michael@0:                              'extensions.{34a1eae1-c20a-464f-9b0e-000000000000}.test13')
michael@0: 
michael@0:         prefsjs = self.xpi.read('defaults/preferences/prefs.js').decode("utf-8")
michael@0:         self.failUnlessEqual(prefsjs, 
michael@0:                             'pref("extensions.{34a1eae1-c20a-464f-9b0e-000000000000}.test13", 26);\n')
michael@0: 
michael@0: 
michael@0: class Bug588119Tests(unittest.TestCase):
michael@0:     def makexpi(self, pkg_name):
michael@0:         self.xpiname = "%s.xpi" % pkg_name
michael@0:         create_xpi(self.xpiname, pkg_name, 'bug-588119-files')
michael@0:         self.xpi = zipfile.ZipFile(self.xpiname, 'r')
michael@0:         options = self.xpi.read('harness-options.json')
michael@0:         self.xpi_harness_options = json.loads(options)
michael@0: 
michael@0:     def setUp(self):
michael@0:         self.xpiname = None
michael@0:         self.xpi = None
michael@0: 
michael@0:     def tearDown(self):
michael@0:         if self.xpi:
michael@0:             self.xpi.close()
michael@0:         if self.xpiname and os.path.exists(self.xpiname):
michael@0:             os.remove(self.xpiname)
michael@0: 
michael@0:     def testPackageWithImplicitIcon(self):
michael@0:         self.makexpi('implicit-icon')
michael@0:         assert 'icon.png' in self.xpi.namelist()
michael@0: 
michael@0:     def testPackageWithImplicitIcon64(self):
michael@0:         self.makexpi('implicit-icon')
michael@0:         assert 'icon64.png' in self.xpi.namelist()
michael@0: 
michael@0:     def testPackageWithExplicitIcon(self):
michael@0:         self.makexpi('explicit-icon')
michael@0:         assert 'icon.png' in self.xpi.namelist()
michael@0: 
michael@0:     def testPackageWithExplicitIcon64(self):
michael@0:         self.makexpi('explicit-icon')
michael@0:         assert 'icon64.png' in self.xpi.namelist()
michael@0: 
michael@0:     def testPackageWithNoIcon(self):
michael@0:         self.makexpi('no-icon')
michael@0:         assert 'icon.png' not in self.xpi.namelist()
michael@0: 
michael@0:     def testIconPathNotInHarnessOptions(self):
michael@0:         self.makexpi('implicit-icon')
michael@0:         assert 'icon' not in self.xpi_harness_options
michael@0: 
michael@0:     def testIcon64PathNotInHarnessOptions(self):
michael@0:         self.makexpi('implicit-icon')
michael@0:         assert 'icon64' not in self.xpi_harness_options
michael@0: 
michael@0: class ExtraHarnessOptions(unittest.TestCase):
michael@0:     def setUp(self):
michael@0:         self.xpiname = None
michael@0:         self.xpi = None
michael@0: 
michael@0:     def tearDown(self):
michael@0:         if self.xpi:
michael@0:             self.xpi.close()
michael@0:         if self.xpiname and os.path.exists(self.xpiname):
michael@0:             os.remove(self.xpiname)
michael@0: 
michael@0:     def testOptions(self):
michael@0:         pkg_name = "extra-options"
michael@0:         self.xpiname = "%s.xpi" % pkg_name
michael@0:         create_xpi(self.xpiname, pkg_name, "bug-669274-files",
michael@0:                    extra_harness_options={"builderVersion": "futuristic"})
michael@0:         self.xpi = zipfile.ZipFile(self.xpiname, 'r')
michael@0:         options = self.xpi.read('harness-options.json')
michael@0:         hopts = json.loads(options)
michael@0:         self.failUnless("builderVersion" in hopts)
michael@0:         self.failUnlessEqual(hopts["builderVersion"], "futuristic")
michael@0: 
michael@0:     def testBadOptionName(self):
michael@0:         pkg_name = "extra-options"
michael@0:         self.xpiname = "%s.xpi" % pkg_name
michael@0:         self.failUnlessRaises(xpi.HarnessOptionAlreadyDefinedError,
michael@0:                               create_xpi,
michael@0:                               self.xpiname, pkg_name, "bug-669274-files",
michael@0:                               extra_harness_options={"main": "already in use"})
michael@0: 
michael@0: class SmallXPI(unittest.TestCase):
michael@0:     def setUp(self):
michael@0:         self.root = up(os.path.abspath(__file__), 4)
michael@0:     def get_linker_files_dir(self, name):
michael@0:         return os.path.join(up(os.path.abspath(__file__)), "linker-files", name)
michael@0:     def get_pkg(self, name):
michael@0:         d = self.get_linker_files_dir(name)
michael@0:         return packaging.get_config_in_dir(d)
michael@0: 
michael@0:     def get_basedir(self):
michael@0:         return os.path.join(".test_tmp", self.id())
michael@0:     def make_basedir(self):
michael@0:         basedir = self.get_basedir()
michael@0:         if os.path.isdir(basedir):
michael@0:             here = os.path.abspath(os.getcwd())
michael@0:             assert os.path.abspath(basedir).startswith(here) # safety
michael@0:             shutil.rmtree(basedir)
michael@0:         os.makedirs(basedir)
michael@0:         return basedir
michael@0: 
michael@0:     def test_contents(self):
michael@0:         target_cfg = self.get_pkg("three")
michael@0:         package_path = [self.get_linker_files_dir("three-deps")]
michael@0:         pkg_cfg = packaging.build_config(self.root, target_cfg,
michael@0:                                          packagepath=package_path)
michael@0:         deps = packaging.get_deps_for_targets(pkg_cfg,
michael@0:                                               [target_cfg.name, "addon-sdk"])
michael@0:         addon_sdk_dir = pkg_cfg.packages["addon-sdk"].lib[0]
michael@0:         m = manifest.build_manifest(target_cfg, pkg_cfg, deps, scan_tests=False)
michael@0:         used_files = list(m.get_used_files(True))
michael@0:         here = up(os.path.abspath(__file__))
michael@0:         def absify(*parts):
michael@0:             fn = os.path.join(here, "linker-files", *parts)
michael@0:             return os.path.abspath(fn)
michael@0:         expected = [absify(*parts) for parts in
michael@0:                     [("three", "lib", "main.js"),
michael@0:                      ("three-deps", "three-a", "lib", "main.js"),
michael@0:                      ("three-deps", "three-a", "lib", "subdir", "subfile.js"),
michael@0:                      ("three", "data", "msg.txt"),
michael@0:                      ("three", "data", "subdir", "submsg.txt"),
michael@0:                      ("three-deps", "three-b", "lib", "main.js"),
michael@0:                      ("three-deps", "three-c", "lib", "main.js"),
michael@0:                      ("three-deps", "three-c", "lib", "sub", "foo.js")
michael@0:                      ]]
michael@0: 
michael@0:         add_addon_sdk= lambda path: os.path.join(addon_sdk_dir, path)
michael@0:         expected.extend([add_addon_sdk(module) for module in [
michael@0:             os.path.join("sdk", "self.js"),
michael@0:             os.path.join("sdk", "core", "promise.js"),
michael@0:             os.path.join("sdk", "net", "url.js"),
michael@0:             os.path.join("sdk", "util", "object.js"),
michael@0:             os.path.join("sdk", "util", "array.js")
michael@0:             ]])
michael@0: 
michael@0:         missing = set(expected) - set(used_files)
michael@0:         extra = set(used_files) - set(expected)
michael@0: 
michael@0:         self.failUnlessEqual(list(missing), [])
michael@0:         self.failUnlessEqual(list(extra), [])
michael@0:         used_deps = m.get_used_packages()
michael@0: 
michael@0:         build = packaging.generate_build_for_target(pkg_cfg, target_cfg.name,
michael@0:                                                     used_deps,
michael@0:                                                     include_tests=False)
michael@0:         options = {'main': target_cfg.main}
michael@0:         options.update(build)
michael@0:         basedir = self.make_basedir()
michael@0:         xpi_name = os.path.join(basedir, "contents.xpi")
michael@0:         xpi.build_xpi(template_root_dir=xpi_template_path,
michael@0:                       manifest=fake_manifest,
michael@0:                       xpi_path=xpi_name,
michael@0:                       harness_options=options,
michael@0:                       limit_to=used_files)
michael@0:         x = zipfile.ZipFile(xpi_name, "r")
michael@0:         names = x.namelist()
michael@0:         expected = ["components/",
michael@0:                     "components/harness.js",
michael@0:                     # the real template also has 'bootstrap.js', but the fake
michael@0:                     # one in tests/static-files/xpi-template doesn't
michael@0:                     "harness-options.json",
michael@0:                     "install.rdf",
michael@0:                     "defaults/preferences/prefs.js",
michael@0:                     "resources/",
michael@0:                     "resources/addon-sdk/",
michael@0:                     "resources/addon-sdk/lib/",
michael@0:                     "resources/addon-sdk/lib/sdk/",
michael@0:                     "resources/addon-sdk/lib/sdk/self.js",
michael@0:                     "resources/addon-sdk/lib/sdk/core/",
michael@0:                     "resources/addon-sdk/lib/sdk/util/",
michael@0:                     "resources/addon-sdk/lib/sdk/net/",
michael@0:                     "resources/addon-sdk/lib/sdk/core/promise.js",
michael@0:                     "resources/addon-sdk/lib/sdk/util/object.js",
michael@0:                     "resources/addon-sdk/lib/sdk/util/array.js",
michael@0:                     "resources/addon-sdk/lib/sdk/net/url.js",
michael@0:                     "resources/three/",
michael@0:                     "resources/three/lib/",
michael@0:                     "resources/three/lib/main.js",
michael@0:                     "resources/three/data/",
michael@0:                     "resources/three/data/msg.txt",
michael@0:                     "resources/three/data/subdir/",
michael@0:                     "resources/three/data/subdir/submsg.txt",
michael@0:                     "resources/three-a/",
michael@0:                     "resources/three-a/lib/",
michael@0:                     "resources/three-a/lib/main.js",
michael@0:                     "resources/three-a/lib/subdir/",
michael@0:                     "resources/three-a/lib/subdir/subfile.js",
michael@0:                     "resources/three-b/",
michael@0:                     "resources/three-b/lib/",
michael@0:                     "resources/three-b/lib/main.js",
michael@0:                     "resources/three-c/",
michael@0:                     "resources/three-c/lib/",
michael@0:                     "resources/three-c/lib/main.js",
michael@0:                     "resources/three-c/lib/sub/",
michael@0:                     "resources/three-c/lib/sub/foo.js",
michael@0:                     # notably absent: three-a/lib/unused.js
michael@0:                     "locale/",
michael@0:                     "locale/fr-FR.json",
michael@0:                     "locales.json",
michael@0:                     ]
michael@0:         # showing deltas makes failures easier to investigate
michael@0:         missing = set(expected) - set(names)
michael@0:         extra = set(names) - set(expected)
michael@0:         self.failUnlessEqual((list(missing), list(extra)), ([], []))
michael@0:         self.failUnlessEqual(sorted(names), sorted(expected))
michael@0: 
michael@0:         # check locale files
michael@0:         localedata = json.loads(x.read("locales.json"))
michael@0:         self.failUnlessEqual(sorted(localedata["locales"]), sorted(["fr-FR"]))
michael@0:         content = x.read("locale/fr-FR.json")
michael@0:         locales = json.loads(content)
michael@0:         # Locale files are merged into one.
michael@0:         # Conflicts are silently resolved by taking last package translation,
michael@0:         # so that we get "No" translation from three-c instead of three-b one.
michael@0:         self.failUnlessEqual(locales, json.loads(u'''
michael@0:           {
michael@0:             "No": "Nein",
michael@0:             "one": "un",
michael@0:             "What?": "Quoi?",
michael@0:             "Yes": "Oui",
michael@0:             "plural": {
michael@0:               "other": "other",
michael@0:               "one": "one"
michael@0:             },
michael@0:             "uft8_value": "\u00e9"
michael@0:           }'''))
michael@0: 
michael@0:     def test_scantests(self):
michael@0:         target_cfg = self.get_pkg("three")
michael@0:         package_path = [self.get_linker_files_dir("three-deps")]
michael@0:         pkg_cfg = packaging.build_config(self.root, target_cfg,
michael@0:                                          packagepath=package_path)
michael@0: 
michael@0:         deps = packaging.get_deps_for_targets(pkg_cfg,
michael@0:                                               [target_cfg.name, "addon-sdk"])
michael@0:         m = manifest.build_manifest(target_cfg, pkg_cfg, deps, scan_tests=True)
michael@0:         self.failUnlessEqual(sorted(m.get_all_test_modules()),
michael@0:                              sorted(["three/tests/test-one", "three/tests/test-two"]))
michael@0:         # the current __init__.py code omits limit_to=used_files for 'cfx
michael@0:         # test', so all test files are included in the XPI. But the test
michael@0:         # runner will only execute the tests that m.get_all_test_modules()
michael@0:         # tells us about (which are put into the .allTestModules property of
michael@0:         # harness-options.json).
michael@0:         used_deps = m.get_used_packages()
michael@0: 
michael@0:         build = packaging.generate_build_for_target(pkg_cfg, target_cfg.name,
michael@0:                                                     used_deps,
michael@0:                                                     include_tests=True)
michael@0:         options = {'main': target_cfg.main}
michael@0:         options.update(build)
michael@0:         basedir = self.make_basedir()
michael@0:         xpi_name = os.path.join(basedir, "contents.xpi")
michael@0:         xpi.build_xpi(template_root_dir=xpi_template_path,
michael@0:                       manifest=fake_manifest,
michael@0:                       xpi_path=xpi_name,
michael@0:                       harness_options=options,
michael@0:                       limit_to=None)
michael@0:         x = zipfile.ZipFile(xpi_name, "r")
michael@0:         names = x.namelist()
michael@0:         self.failUnless("resources/addon-sdk/lib/sdk/deprecated/unit-test.js" in names, names)
michael@0:         self.failUnless("resources/addon-sdk/lib/sdk/deprecated/unit-test-finder.js" in names, names)
michael@0:         self.failUnless("resources/addon-sdk/lib/sdk/test/harness.js" in names, names)
michael@0:         self.failUnless("resources/addon-sdk/lib/sdk/test/runner.js" in names, names)
michael@0:         # all files are copied into the XPI, even the things that don't look
michael@0:         # like tests.
michael@0:         self.failUnless("resources/three/tests/test-one.js" in names, names)
michael@0:         self.failUnless("resources/three/tests/test-two.js" in names, names)
michael@0:         self.failUnless("resources/three/tests/nontest.js" in names, names)
michael@0: 
michael@0:     def test_scantests_filter(self):
michael@0:         target_cfg = self.get_pkg("three")
michael@0:         package_path = [self.get_linker_files_dir("three-deps")]
michael@0:         pkg_cfg = packaging.build_config(self.root, target_cfg,
michael@0:                                          packagepath=package_path)
michael@0:         deps = packaging.get_deps_for_targets(pkg_cfg,
michael@0:                                               [target_cfg.name, "addon-sdk"])
michael@0:         FILTER = ".*one.*"
michael@0:         m = manifest.build_manifest(target_cfg, pkg_cfg, deps, scan_tests=True,
michael@0:                                     test_filter_re=FILTER)
michael@0:         self.failUnlessEqual(sorted(m.get_all_test_modules()),
michael@0:                              sorted(["three/tests/test-one"]))
michael@0:         # the current __init__.py code omits limit_to=used_files for 'cfx
michael@0:         # test', so all test files are included in the XPI. But the test
michael@0:         # runner will only execute the tests that m.get_all_test_modules()
michael@0:         # tells us about (which are put into the .allTestModules property of
michael@0:         # harness-options.json).
michael@0:         used_deps = m.get_used_packages()
michael@0: 
michael@0:         build = packaging.generate_build_for_target(pkg_cfg, target_cfg.name,
michael@0:                                                     used_deps,
michael@0:                                                     include_tests=True)
michael@0:         options = {'main': target_cfg.main}
michael@0:         options.update(build)
michael@0:         basedir = self.make_basedir()
michael@0:         xpi_name = os.path.join(basedir, "contents.xpi")
michael@0:         xpi.build_xpi(template_root_dir=xpi_template_path,
michael@0:                       manifest=fake_manifest,
michael@0:                       xpi_path=xpi_name,
michael@0:                       harness_options=options,
michael@0:                       limit_to=None)
michael@0:         x = zipfile.ZipFile(xpi_name, "r")
michael@0:         names = x.namelist()
michael@0:         self.failUnless("resources/addon-sdk/lib/sdk/deprecated/unit-test.js" in names, names)
michael@0:         self.failUnless("resources/addon-sdk/lib/sdk/deprecated/unit-test-finder.js" in names, names)
michael@0:         self.failUnless("resources/addon-sdk/lib/sdk/test/harness.js" in names, names)
michael@0:         self.failUnless("resources/addon-sdk/lib/sdk/test/runner.js" in names, names)
michael@0:         # get_all_test_modules() respects the filter. But all files are still
michael@0:         # copied into the XPI.
michael@0:         self.failUnless("resources/three/tests/test-one.js" in names, names)
michael@0:         self.failUnless("resources/three/tests/test-two.js" in names, names)
michael@0:         self.failUnless("resources/three/tests/nontest.js" in names, names)
michael@0: 
michael@0: 
michael@0: def document_dir(name):
michael@0:     if name in ['packages', 'xpi-template']:
michael@0:         dirname = os.path.join(test_packaging.static_files_path, name)
michael@0:         document_dir_files(dirname)
michael@0:     elif name == 'xpi-output':
michael@0:         create_xpi('test-xpi.xpi')
michael@0:         document_zip_file('test-xpi.xpi')
michael@0:         os.remove('test-xpi.xpi')
michael@0:     else:
michael@0:         raise Exception('unknown dir: %s' % name)
michael@0: 
michael@0: def normpath(path):
michael@0:     """
michael@0:     Make a platform-specific relative path use '/' as a separator.
michael@0:     """
michael@0: 
michael@0:     return path.replace(os.path.sep, '/')
michael@0: 
michael@0: def document_zip_file(path):
michael@0:     zip = zipfile.ZipFile(path, 'r')
michael@0:     for name in sorted(zip.namelist()):
michael@0:         contents = zip.read(name)
michael@0:         lines = contents.splitlines()
michael@0:         if len(lines) == 1 and name.endswith('.json') and len(lines[0]) > 75:
michael@0:             # Ideally we would json-decode this, but it results
michael@0:             # in an annoying 'u' before every string literal,
michael@0:             # since json decoding makes all strings unicode.
michael@0:             contents = eval(contents)
michael@0:             contents = pprint.pformat(contents)
michael@0:             lines = contents.splitlines()
michael@0:         contents = "\n  ".join(lines)
michael@0:         print "%s:\n  %s" % (normpath(name), contents)
michael@0:     zip.close()
michael@0: 
michael@0: def document_dir_files(path):
michael@0:     filename_contents_tuples = []
michael@0:     for dirpath, dirnames, filenames in os.walk(path):
michael@0:         relpath = dirpath[len(path)+1:]
michael@0:         for filename in filenames:
michael@0:             abspath = os.path.join(dirpath, filename)
michael@0:             contents = open(abspath, 'r').read()
michael@0:             contents = "\n  ".join(contents.splitlines())
michael@0:             relfilename = os.path.join(relpath, filename)
michael@0:             filename_contents_tuples.append((normpath(relfilename), contents))
michael@0:     filename_contents_tuples.sort()
michael@0:     for filename, contents in filename_contents_tuples:
michael@0:         print "%s:" % filename
michael@0:         print "  %s" % contents
michael@0: 
michael@0: def create_xpi(xpiname, pkg_name='aardvark', dirname='static-files',
michael@0:                extra_harness_options={}):
michael@0:     configs = test_packaging.get_configs(pkg_name, dirname)
michael@0:     options = {'main': configs.target_cfg.main,
michael@0:                'jetpackID': buildJID(configs.target_cfg), }
michael@0:     options.update(configs.build)
michael@0:     xpi.build_xpi(template_root_dir=xpi_template_path,
michael@0:                   manifest=fake_manifest,
michael@0:                   xpi_path=xpiname,
michael@0:                   harness_options=options,
michael@0:                   extra_harness_options=extra_harness_options)
michael@0: 
michael@0: if __name__ == '__main__':
michael@0:     unittest.main()