def testTitle(self):
basedir = os.path.join(test_dir, 'bug-906359-files')
for n in ['title', 'fullName', 'none']:
cfg = packaging.get_config_in_dir(os.path.join(basedir, n))
m = rdf.gen_manifest(template_dir, cfg, jid='JID')
self.failUnlessEqual(m.get('em:name'), 'a long ' + n)
self.failUnlessIn('<em:name>a long ' + n + '</em:name>', str(m), n)
def testTitle(self):
basedir = os.path.join(test_dir, 'bug-906359-files')
for n in ['title', 'fullName', 'none']:
cfg = packaging.get_config_in_dir(os.path.join(basedir, n))
m = rdf.gen_manifest(template_dir, cfg, jid='JID')
self.failUnlessEqual(m.get('em:name'), 'a long ' + n)
self.failUnlessIn('<em:name>a long ' + n + '</em:name>', str(m), n)
def testUnpack(self):
basedir = os.path.join(test_dir, "bug-715340-files")
for n in ["pkg-1-pack", "pkg-2-unpack", "pkg-3-pack"]:
cfg = packaging.get_config_in_dir(os.path.join(basedir, n))
m = rdf.gen_manifest(template_dir, cfg, jid="JID")
if n.endswith("-pack"):
# these ones should remain packed
self.failUnlessEqual(m.get("em:unpack"), "false")
self.failUnlessIn("<em:unpack>false</em:unpack>", str(m), n)
else:
# and these should be unpacked
self.failUnlessEqual(m.get("em:unpack"), "true")
self.failUnlessIn("<em:unpack>true</em:unpack>", str(m), n)
def testUnpack(self):
basedir = os.path.join(test_dir, "bug-715340-files")
for n in ["pkg-1-pack", "pkg-2-unpack", "pkg-3-pack"]:
cfg = packaging.get_config_in_dir(os.path.join(basedir, n))
m = rdf.gen_manifest(template_dir, cfg, jid="JID")
if n.endswith("-pack"):
# these ones should remain packed
self.failUnlessEqual(m.get("em:unpack"), "false")
self.failUnlessIn("<em:unpack>false</em:unpack>", str(m), n)
else:
# and these should be unpacked
self.failUnlessEqual(m.get("em:unpack"), "true")
self.failUnlessIn("<em:unpack>true</em:unpack>", str(m), n)
def testLocalization(self):
# addon_title -> <em:name>
# addon_author -> <em:creator>
# addon_description -> <em:description>
# addon_homepageURL -> <em:homepageURL>
localizable_in = ["title", "author", "description", "homepage"]
localized_out = ["name", "creator", "description", "homepageURL"]
basedir = os.path.join(test_dir, "bug-661083-files/packages")
for n in ["noLocalization", "twoLanguages"]:
harness_options = { "locale" : {} }
pkgdir = os.path.join(basedir, n)
localedir = os.path.join(pkgdir, "locale")
files = os.listdir(localedir)
for file in files:
filepath = os.path.join(localedir, file)
if os.path.isfile(filepath) and file.endswith(".properties"):
language = file[:-len(".properties")]
try:
parsed_file = property_parser.parse_file(filepath)
except property_parser.MalformedLocaleFileError, msg:
self.fail(msg)
harness_options["locale"][language] = parsed_file
cfg = packaging.get_config_in_dir(pkgdir)
m = rdf.gen_manifest(template_dir, cfg, 'JID', harness_options)
if n == "noLocalization":
self.failIf("<em:locale>" in str(m))
continue
for lang in harness_options["locale"]:
rdfstr = str(m)
node = "<em:locale>" + lang + "</em:locale>"
self.failUnlessIn(node, rdfstr, n)
for value_in in localizable_in:
key_in = "addon_" + value_in
tag_out = localized_out[localizable_in.index(value_in)]
if key_in in harness_options["locale"][lang]:
# E.g. "<em:creator>author-en-US</em:creator>"
node = "<em:" + tag_out + ">" + value_in + "-" + lang \
+ "</em:" + tag_out + ">"
self.failUnlessIn(node , rdfstr, n)
def testLocalization(self):
# addon_title -> <em:name>
# addon_author -> <em:creator>
# addon_description -> <em:description>
# addon_homepageURL -> <em:homepageURL>
localizable_in = ["title", "author", "description", "homepage"]
localized_out = ["name", "creator", "description", "homepageURL"]
basedir = os.path.join(test_dir, "bug-661083-files/packages")
for n in ["noLocalization", "twoLanguages"]:
harness_options = {"locale": {}}
pkgdir = os.path.join(basedir, n)
localedir = os.path.join(pkgdir, "locale")
files = os.listdir(localedir)
for file in files:
filepath = os.path.join(localedir, file)
if os.path.isfile(filepath) and file.endswith(".properties"):
language = file[:-len(".properties")]
try:
parsed_file = property_parser.parse_file(filepath)
except property_parser.MalformedLocaleFileError, msg:
self.fail(msg)
harness_options["locale"][language] = parsed_file
cfg = packaging.get_config_in_dir(pkgdir)
m = rdf.gen_manifest(template_dir, cfg, 'JID', harness_options)
if n == "noLocalization":
self.failIf("<em:locale>" in str(m))
continue
for lang in harness_options["locale"]:
rdfstr = str(m)
node = "<em:locale>" + lang + "</em:locale>"
self.failUnlessIn(node, rdfstr, n)
for value_in in localizable_in:
key_in = "extensions." + m.get('em:id') + "." + value_in
tag_out = localized_out[localizable_in.index(value_in)]
if key_in in harness_options["locale"][lang]:
# E.g. "<em:creator>author-en-US</em:creator>"
node = "<em:" + tag_out + ">" + value_in + "-" + lang \
+ "</em:" + tag_out + ">"
self.failUnlessIn(node, rdfstr, n)
"can't be used at the same time.")
sys.exit(1)
# Pass a flag in order to force using sdk modules shipped in the xpi
harness_options['force-use-bundled-sdk'] = True
# Pass the list of absolute path for all test modules
if command == "test":
harness_options['allTestModules'] = manifest.get_all_test_modules()
if len(harness_options['allTestModules']) == 0:
sys.exit(0)
from cuddlefish.rdf import gen_manifest, RDFUpdate
manifest_rdf = gen_manifest(template_root_dir=app_extension_dir,
target_cfg=target_cfg,
jid=jid,
update_url=options.update_url,
bootstrap=True,
enable_mobile=options.enable_mobile)
if command == "xpi" and options.update_link:
if not options.update_link.startswith("https"):
raise optparse.OptionValueError(
"--update-link must start with 'https': %s" %
options.update_link)
rdf_name = UPDATE_RDF_FILENAME % target_cfg.name
print >> stdout, "Exporting update description to %s." % rdf_name
update = RDFUpdate()
update.add(manifest_rdf, options.update_link)
open(rdf_name, "w").write(str(update))
# ask the manifest what files were used, so we can construct an XPI
else:
mydir = os.path.dirname(os.path.abspath(__file__))
app_extension_dir = os.path.join(mydir, "app-extension")
if target_cfg.get('preferences'):
harness_options['preferences'] = target_cfg.get('preferences')
harness_options['manifest'] = manifest.get_harness_options_manifest()
harness_options['allTestModules'] = manifest.get_all_test_modules()
from cuddlefish.rdf import gen_manifest, RDFUpdate
manifest_rdf = gen_manifest(template_root_dir=app_extension_dir,
target_cfg=target_cfg,
jid=jid,
update_url=options.update_url,
bootstrap=True,
enable_mobile=options.enable_mobile)
if command == "xpi" and options.update_link:
rdf_name = UPDATE_RDF_FILENAME % target_cfg.name
print >>stdout, "Exporting update description to %s." % rdf_name
update = RDFUpdate()
update.add(manifest_rdf, options.update_link)
open(rdf_name, "w").write(str(update))
# ask the manifest what files were used, so we can construct an XPI
# without the rest. This will include the loader (and everything it
# uses) because of the "loader_modules" starting points we passed to
# build_manifest earlier
used_files = None
def run(arguments=sys.argv[1:], target_cfg=None, pkg_cfg=None,
defaults=None, env_root=os.environ.get('CUDDLEFISH_ROOT')):
parser_kwargs = dict(arguments=arguments,
global_options=global_options,
parser_groups=parser_groups,
usage=usage,
defaults=defaults)
(options, args) = parse_args(**parser_kwargs)
config_args = get_config_args(options.config, env_root);
# reparse configs with arguments from local.json
if config_args:
parser_kwargs['arguments'] += config_args
(options, args) = parse_args(**parser_kwargs)
command = args[0]
if command == "init":
initializer(env_root, args)
return
if command == "develop":
run_development_mode(env_root, defaults=options.__dict__)
return
if command == "testpkgs":
test_all_packages(env_root, defaults=options.__dict__)
return
elif command == "testex":
test_all_examples(env_root, defaults=options.__dict__)
return
elif command == "testall":
test_all(env_root, defaults=options.__dict__)
return
elif command == "testcfx":
test_cfx(env_root, options.verbose)
return
elif command == "docs":
import subprocess
import time
import cuddlefish.server
print "One moment."
popen = subprocess.Popen([sys.executable,
cuddlefish.server.__file__,
'daemonic'])
# TODO: See if there's actually a way to block on
# a particular event occurring, rather than this
# relatively arbitrary/generous amount.
time.sleep(cuddlefish.server.IDLE_WEBPAGE_TIMEOUT * 2)
return
elif command == "sdocs":
import cuddlefish.server
# TODO: Allow user to change this filename via cmd line.
filename = 'addon-sdk-docs.tgz'
cuddlefish.server.generate_static_docs(env_root, filename, options.baseurl)
print "Wrote %s." % filename
return
target_cfg_json = None
if not target_cfg:
if not options.pkgdir:
options.pkgdir = find_parent_package(os.getcwd())
if not options.pkgdir:
print >>sys.stderr, ("cannot find 'package.json' in the"
" current directory or any parent.")
sys.exit(1)
else:
options.pkgdir = os.path.abspath(options.pkgdir)
if not os.path.exists(os.path.join(options.pkgdir, 'package.json')):
print >>sys.stderr, ("cannot find 'package.json' in"
" %s." % options.pkgdir)
sys.exit(1)
target_cfg_json = os.path.join(options.pkgdir, 'package.json')
target_cfg = packaging.get_config_in_dir(options.pkgdir)
# At this point, we're either building an XPI or running Jetpack code in
# a Mozilla application (which includes running tests).
use_main = False
timeout = None
inherited_options = ['verbose', 'enable_e10s']
if command == "xpi":
use_main = True
elif command == "test":
if 'tests' not in target_cfg:
target_cfg['tests'] = []
timeout = TEST_RUN_TIMEOUT
inherited_options.extend(['iterations', 'filter', 'profileMemory'])
elif command == "run":
use_main = True
else:
print >>sys.stderr, "Unknown command: %s" % command
print >>sys.stderr, "Try using '--help' for assistance."
sys.exit(1)
if use_main and 'main' not in target_cfg:
# If the user supplies a template dir, then the main
# program may be contained in the template.
if not options.templatedir:
print >>sys.stderr, "package.json does not have a 'main' entry."
sys.exit(1)
if not pkg_cfg:
pkg_cfg = packaging.build_config(env_root, target_cfg, options.packagepath)
target = target_cfg.name
# the harness_guid is used for an XPCOM class ID. We use the
# JetpackID for the add-on ID and the XPCOM contract ID.
if "harnessClassID" in target_cfg:
# For the sake of non-bootstrapped extensions, we allow to specify the
# classID of harness' XPCOM component in package.json. This makes it
# possible to register the component using a static chrome.manifest file
harness_guid = target_cfg["harnessClassID"]
else:
import uuid
harness_guid = str(uuid.uuid4())
# TODO: Consider keeping a cache of dynamic UUIDs, based
# on absolute filesystem pathname, in the root directory
# or something.
if command in ('xpi', 'run'):
from cuddlefish.preflight import preflight_config
if target_cfg_json:
config_was_ok, modified = preflight_config(target_cfg,
target_cfg_json)
if not config_was_ok:
if modified:
# we need to re-read package.json . The safest approach
# is to re-run the "cfx xpi"/"cfx run" command.
print >>sys.stderr, ("package.json modified: please re-run"
" 'cfx %s'" % command)
else:
print >>sys.stderr, ("package.json needs modification:"
" please update it and then re-run"
" 'cfx %s'" % command)
sys.exit(1)
# if we make it this far, we have a JID
else:
assert command == "test"
if "id" in target_cfg:
jid = target_cfg["id"]
assert not jid.endswith("@jetpack")
unique_prefix = '%s-' % jid # used for resource: URLs
else:
# The Jetpack ID is not required for cfx test, in which case we have to
# make one up based on the GUID.
if options.use_server:
# The harness' contractID (hence also the jid and the harness_guid)
# need to be static in the "development mode", so that bootstrap.js
# can unload the previous version of the package being developed.
harness_guid = '2974c5b5-b671-46f8-a4bb-63c6eca6261b'
unique_prefix = '%s-' % target
jid = harness_guid
assert not jid.endswith("@jetpack")
if ( jid.startswith("jid0-")
or jid.startswith("jid1-")
or jid.startswith("anonid0-") ):
bundle_id = jid + "@jetpack"
# Don't append "@jetpack" to old-style IDs, as they should be exactly
# as specified by the addon author so AMO and Firefox continue to treat
# their addon bundles as representing the same addon (and also because
# they may already have an @ sign in them, and there can be only one).
else:
bundle_id = jid
# the resource: URL's prefix is treated too much like a DNS hostname
unique_prefix = unique_prefix.lower()
unique_prefix = unique_prefix.replace("@", "-at-")
unique_prefix = unique_prefix.replace(".", "-dot-")
targets = [target]
if command == "test":
targets.append(options.test_runner_pkg)
if options.extra_packages:
targets.extend(options.extra_packages.split(","))
deps = packaging.get_deps_for_targets(pkg_cfg, targets)
build = packaging.generate_build_for_target(
pkg_cfg, target, deps,
prefix=unique_prefix, # used to create resource: URLs
include_dep_tests=options.dep_tests
)
if 'resources' in build:
resources = build.resources
for name in resources:
resources[name] = os.path.abspath(resources[name])
harness_contract_id = ('@mozilla.org/harness-service;1?id=%s' % jid)
harness_options = {
'bootstrap': {
'contractID': harness_contract_id,
'classID': '{%s}' % harness_guid
},
'jetpackID': jid,
'bundleID': bundle_id,
'staticArgs': options.static_args,
'name': target,
}
harness_options.update(build)
if command == "test":
# This should be contained in the test runner package.
harness_options['main'] = 'run-tests'
else:
harness_options['main'] = target_cfg.get('main')
for option in inherited_options:
harness_options[option] = getattr(options, option)
harness_options['metadata'] = packaging.get_metadata(pkg_cfg, deps)
sdk_version = get_version(env_root)
harness_options['sdkVersion'] = sdk_version
packaging.call_plugins(pkg_cfg, deps)
retval = 0
if options.templatedir:
app_extension_dir = os.path.abspath(options.templatedir)
else:
mydir = os.path.dirname(os.path.abspath(__file__))
if sys.platform == "darwin":
# If we're on OS X, at least point into the XULRunner
# app dir so we run as a proper app if using XULRunner.
app_extension_dir = os.path.join(mydir, "Test App.app",
"Contents", "Resources")
else:
app_extension_dir = os.path.join(mydir, "app-extension")
from cuddlefish.manifest import build_manifest
uri_prefix = "resource://%s" % unique_prefix
include_tests = False #bool(command=="test")
manifest = build_manifest(target_cfg, pkg_cfg, deps, uri_prefix, include_tests)
harness_options['manifest'] = manifest.get_harness_options_manifest(uri_prefix)
if command == 'xpi':
from cuddlefish.xpi import build_xpi
from cuddlefish.rdf import gen_manifest, RDFUpdate
manifest_rdf = gen_manifest(template_root_dir=app_extension_dir,
target_cfg=target_cfg,
bundle_id=bundle_id,
update_url=options.update_url,
bootstrap=True)
if options.update_link:
rdf_name = UPDATE_RDF_FILENAME % target_cfg.name
print "Exporting update description to %s." % rdf_name
update = RDFUpdate()
update.add(manifest_rdf, options.update_link)
open(rdf_name, "w").write(str(update))
xpi_name = XPI_FILENAME % target_cfg.name
print "Exporting extension to %s." % xpi_name
build_xpi(template_root_dir=app_extension_dir,
manifest=manifest_rdf,
xpi_name=xpi_name,
harness_options=harness_options)
else:
if options.use_server:
from cuddlefish.server import run_app
else:
from cuddlefish.runner import run_app
if options.profiledir:
options.profiledir = os.path.expanduser(options.profiledir)
options.profiledir = os.path.abspath(options.profiledir)
if options.addons is not None:
options.addons = options.addons.split(",")
try:
retval = run_app(harness_root_dir=app_extension_dir,
harness_options=harness_options,
app_type=options.app,
binary=options.binary,
profiledir=options.profiledir,
verbose=options.verbose,
timeout=timeout,
logfile=options.logfile,
addons=options.addons,
args=options.cmdargs,
norun=options.no_run)
except Exception, e:
if str(e).startswith(MOZRUNNER_BIN_NOT_FOUND):
print >>sys.stderr, MOZRUNNER_BIN_NOT_FOUND_HELP.strip()
retval = -1
else:
raise
def run(arguments=sys.argv[1:],
target_cfg=None,
pkg_cfg=None,
defaults=None,
env_root=os.environ.get('CUDDLEFISH_ROOT')):
parser_kwargs = dict(arguments=arguments,
parser_options=parser_options,
parser_groups=parser_groups,
usage=usage,
defaults=defaults)
(options, args) = parse_args(**parser_kwargs)
config_args = get_config_args(options.config, env_root)
# reparse configs with arguments from local.json
if config_args:
parser_kwargs['arguments'] += config_args
(options, args) = parse_args(**parser_kwargs)
command = args[0]
if command == "develop":
run_development_mode(env_root, defaults=options.__dict__)
return
if command == "testpkgs":
test_all_packages(env_root, defaults=options.__dict__)
return
elif command == "testex":
test_all_examples(env_root, defaults=options.__dict__)
return
elif command == "testall":
test_all(env_root, defaults=options.__dict__)
return
elif command == "testcfx":
test_cfx(env_root, options.verbose)
return
elif command == "docs":
import subprocess
import time
import cuddlefish.server
print "One moment."
popen = subprocess.Popen(
[sys.executable, cuddlefish.server.__file__, 'daemonic'])
# TODO: See if there's actually a way to block on
# a particular event occurring, rather than this
# relatively arbitrary/generous amount.
time.sleep(cuddlefish.server.IDLE_WEBPAGE_TIMEOUT * 2)
return
elif command == "sdocs":
import cuddlefish.server
# TODO: Allow user to change this filename via cmd line.
filename = 'jetpack-sdk-docs.tgz'
cuddlefish.server.generate_static_docs(env_root, filename)
print "Wrote %s." % filename
return
target_cfg_json = None
if not target_cfg:
if not options.pkgdir:
options.pkgdir = find_parent_package(os.getcwd())
if not options.pkgdir:
print >> sys.stderr, ("cannot find 'package.json' in the"
" current directory or any parent.")
sys.exit(1)
else:
options.pkgdir = os.path.abspath(options.pkgdir)
if not os.path.exists(os.path.join(options.pkgdir, 'package.json')):
print >> sys.stderr, ("cannot find 'package.json' in"
" %s." % options.pkgdir)
sys.exit(1)
target_cfg_json = os.path.join(options.pkgdir, 'package.json')
target_cfg = packaging.get_config_in_dir(options.pkgdir)
use_main = False
if command == "xpcom":
if 'xpcom' not in target_cfg:
print >> sys.stderr, "package.json does not have a 'xpcom' entry."
sys.exit(1)
if not (options.moz_srcdir and options.moz_objdir):
print >> sys.stderr, "srcdir and objdir not specified."
sys.exit(1)
options.moz_srcdir = os.path.expanduser(options.moz_srcdir)
options.moz_objdir = os.path.expanduser(options.moz_objdir)
xpcom = target_cfg.xpcom
from cuddlefish.xpcom import build_xpcom_components
if 'typelibs' in xpcom:
xpt_output_dir = packaging.resolve_dir(target_cfg, xpcom.typelibs)
else:
xpt_output_dir = None
build_xpcom_components(
comp_src_dir=packaging.resolve_dir(target_cfg, xpcom.src),
moz_srcdir=options.moz_srcdir,
moz_objdir=options.moz_objdir,
base_output_dir=packaging.resolve_dir(target_cfg, xpcom.dest),
xpt_output_dir=xpt_output_dir,
module_name=xpcom.module)
sys.exit(0)
elif command == "xpi":
use_main = True
elif command == "test":
if 'tests' not in target_cfg:
target_cfg['tests'] = []
elif command == "run":
use_main = True
else:
print >> sys.stderr, "Unknown command: %s" % command
print >> sys.stderr, "Try using '--help' for assistance."
sys.exit(1)
if use_main and 'main' not in target_cfg:
# If the user supplies a template dir, then the main
# program may be contained in the template.
if not options.templatedir:
print >> sys.stderr, "package.json does not have a 'main' entry."
sys.exit(1)
if not pkg_cfg:
pkg_cfg = packaging.build_config(env_root, target_cfg)
target = target_cfg.name
# TODO: Consider keeping a cache of dynamic UUIDs, based
# on absolute filesystem pathname, in the root directory
# or something.
if command in ('xpi', 'run'):
from cuddlefish.preflight import preflight_config
if target_cfg_json:
config_was_ok, modified = preflight_config(
target_cfg,
target_cfg_json,
keydir=options.keydir,
err_if_privkey_not_found=False)
if not config_was_ok:
if modified:
# we need to re-read package.json . The safest approach
# is to re-run the "cfx xpi"/"cfx run" command.
print >> sys.stderr, (
"package.json modified: please re-run"
" 'cfx %s'" % command)
else:
print >> sys.stderr, ("package.json needs modification:"
" please update it and then re-run"
" 'cfx %s'" % command)
sys.exit(1)
# if we make it this far, we have a JID
jid = target_cfg["id"]
assert not jid.endswith("@jetpack")
unique_prefix = '%s-' % jid # used for resource: URLs
# the harness_guid is used for an XPCOM class ID. We use the
# JetpackID for the add-on ID and the XPCOM contract ID.
import uuid
harness_guid = str(uuid.uuid4())
else:
if options.use_server:
harness_guid = '2974c5b5-b671-46f8-a4bb-63c6eca6261b'
else:
harness_guid = '6724fc1b-3ec4-40e2-8583-8061088b3185'
unique_prefix = '%s-' % target
jid = harness_guid
assert not jid.endswith("@jetpack")
bundle_id = jid + "@jetpack"
# the resource: URLs prefix is treated too much like a DNS hostname
unique_prefix = unique_prefix.lower()
assert "@" not in unique_prefix
assert "." not in unique_prefix
timeout = None
targets = [target]
if not use_main:
timeout = TEST_RUN_TIMEOUT
targets.append(options.test_runner_pkg)
if options.extra_packages:
targets.extend(options.extra_packages.split(","))
deps = packaging.get_deps_for_targets(pkg_cfg, targets)
build = packaging.generate_build_for_target(
pkg_cfg,
target,
deps,
prefix=unique_prefix, # used to create resource: URLs
include_dep_tests=options.dep_tests)
if 'resources' in build:
resources = build.resources
for name in resources:
resources[name] = os.path.abspath(resources[name])
dep_xpt_dirs = []
for dep in deps:
dep_cfg = pkg_cfg.packages[dep]
if 'xpcom' in dep_cfg and 'typelibs' in dep_cfg.xpcom:
abspath = packaging.resolve_dir(dep_cfg, dep_cfg.xpcom.typelibs)
dep_xpt_dirs.append(abspath)
xpts = get_xpts(dep_xpt_dirs)
harness_contract_id = ('@mozilla.org/harness-service;1?id=%s' % jid)
harness_options = {
'bootstrap': {
'contractID': harness_contract_id,
'classID': '{%s}' % harness_guid
},
'jetpackID': jid,
'bundleID': bundle_id,
}
harness_options.update(build)
inherited_options = ['verbose']
if use_main:
harness_options['main'] = target_cfg.get('main')
else:
harness_options['main'] = "run-tests"
inherited_options.extend(['iterations', 'filter', 'profileMemory'])
for option in inherited_options:
harness_options[option] = getattr(options, option)
harness_options['metadata'] = packaging.get_metadata(pkg_cfg, deps)
packaging.call_plugins(pkg_cfg, deps)
retval = 0
if options.templatedir:
app_extension_dir = os.path.abspath(options.templatedir)
else:
mydir = os.path.dirname(os.path.abspath(__file__))
if sys.platform == "darwin":
# If we're on OS X, at least point into the XULRunner
# app dir so we run as a proper app if using XULRunner.
app_extension_dir = os.path.join(mydir, "Test App.app", "Contents",
"Resources")
else:
app_extension_dir = os.path.join(mydir, "app-extension")
if command == 'xpi':
from cuddlefish.xpi import build_xpi
from cuddlefish.rdf import gen_manifest, RDFUpdate
manifest = gen_manifest(template_root_dir=app_extension_dir,
target_cfg=target_cfg,
bundle_id=bundle_id,
update_url=options.update_url,
bootstrap=True)
if options.update_link:
rdf_name = UPDATE_RDF_FILENAME % target_cfg.name
print "Exporting update description to %s." % rdf_name
update = RDFUpdate()
update.add(manifest, options.update_link)
open(rdf_name, "w").write(str(update))
xpi_name = XPI_FILENAME % target_cfg.name
print "Exporting extension to %s." % xpi_name
build_xpi(template_root_dir=app_extension_dir,
manifest=manifest,
xpi_name=xpi_name,
harness_options=harness_options,
xpts=xpts)
else:
if options.use_server:
from cuddlefish.server import run_app
else:
from cuddlefish.runner import run_app
if options.profiledir:
options.profiledir = os.path.expanduser(options.profiledir)
options.profiledir = os.path.abspath(options.profiledir)
if options.addons is not None:
options.addons = options.addons.split(",")
try:
retval = run_app(harness_root_dir=app_extension_dir,
harness_options=harness_options,
xpts=xpts,
app_type=options.app,
binary=options.binary,
profiledir=options.profiledir,
verbose=options.verbose,
timeout=timeout,
logfile=options.logfile,
addons=options.addons)
except Exception, e:
if e.message.startswith(MOZRUNNER_BIN_NOT_FOUND):
print >> sys.stderr, MOZRUNNER_BIN_NOT_FOUND_HELP.strip()
retval = -1
else:
raise
def run(arguments=sys.argv[1:],
target_cfg=None,
pkg_cfg=None,
defaults=None,
env_root=os.environ.get('CUDDLEFISH_ROOT')):
parser_kwargs = dict(arguments=arguments,
global_options=global_options,
parser_groups=parser_groups,
usage=usage,
defaults=defaults)
(options, args) = parse_args(**parser_kwargs)
config_args = get_config_args(options.config, env_root)
# reparse configs with arguments from local.json
if config_args:
parser_kwargs['arguments'] += config_args
(options, args) = parse_args(**parser_kwargs)
command = args[0]
if command == "init":
initializer(env_root, args)
return
if command == "develop":
run_development_mode(env_root, defaults=options.__dict__)
return
if command == "testpkgs":
test_all_packages(env_root, defaults=options.__dict__)
return
elif command == "testex":
test_all_examples(env_root, defaults=options.__dict__)
return
elif command == "testall":
test_all(env_root, defaults=options.__dict__)
return
elif command == "testcfx":
test_cfx(env_root, options.verbose)
return
elif command == "docs":
import subprocess
import time
import cuddlefish.server
print "One moment."
popen = subprocess.Popen(
[sys.executable, cuddlefish.server.__file__, 'daemonic'])
# TODO: See if there's actually a way to block on
# a particular event occurring, rather than this
# relatively arbitrary/generous amount.
time.sleep(cuddlefish.server.IDLE_WEBPAGE_TIMEOUT * 2)
return
elif command == "sdocs":
import cuddlefish.server
# TODO: Allow user to change this filename via cmd line.
filename = 'addon-sdk-docs.tgz'
cuddlefish.server.generate_static_docs(env_root, filename,
options.baseurl)
print "Wrote %s." % filename
return
target_cfg_json = None
if not target_cfg:
if not options.pkgdir:
options.pkgdir = find_parent_package(os.getcwd())
if not options.pkgdir:
print >> sys.stderr, ("cannot find 'package.json' in the"
" current directory or any parent.")
sys.exit(1)
else:
options.pkgdir = os.path.abspath(options.pkgdir)
if not os.path.exists(os.path.join(options.pkgdir, 'package.json')):
print >> sys.stderr, ("cannot find 'package.json' in"
" %s." % options.pkgdir)
sys.exit(1)
target_cfg_json = os.path.join(options.pkgdir, 'package.json')
target_cfg = packaging.get_config_in_dir(options.pkgdir)
# At this point, we're either building an XPI or running Jetpack code in
# a Mozilla application (which includes running tests).
use_main = False
timeout = None
inherited_options = ['verbose', 'enable_e10s']
if command == "xpi":
use_main = True
elif command == "test":
if 'tests' not in target_cfg:
target_cfg['tests'] = []
timeout = TEST_RUN_TIMEOUT
inherited_options.extend(['iterations', 'filter', 'profileMemory'])
elif command == "run":
use_main = True
else:
print >> sys.stderr, "Unknown command: %s" % command
print >> sys.stderr, "Try using '--help' for assistance."
sys.exit(1)
if use_main and 'main' not in target_cfg:
# If the user supplies a template dir, then the main
# program may be contained in the template.
if not options.templatedir:
print >> sys.stderr, "package.json does not have a 'main' entry."
sys.exit(1)
if not pkg_cfg:
pkg_cfg = packaging.build_config(env_root, target_cfg)
target = target_cfg.name
# the harness_guid is used for an XPCOM class ID. We use the
# JetpackID for the add-on ID and the XPCOM contract ID.
if "harnessClassID" in target_cfg:
# For the sake of non-bootstrapped extensions, we allow to specify the
# classID of harness' XPCOM component in package.json. This makes it
# possible to register the component using a static chrome.manifest file
harness_guid = target_cfg["harnessClassID"]
else:
import uuid
harness_guid = str(uuid.uuid4())
# TODO: Consider keeping a cache of dynamic UUIDs, based
# on absolute filesystem pathname, in the root directory
# or something.
if command in ('xpi', 'run'):
from cuddlefish.preflight import preflight_config
if target_cfg_json:
config_was_ok, modified = preflight_config(
target_cfg,
target_cfg_json,
keydir=options.keydir,
err_if_privkey_not_found=False)
if not config_was_ok:
if modified:
# we need to re-read package.json . The safest approach
# is to re-run the "cfx xpi"/"cfx run" command.
print >> sys.stderr, (
"package.json modified: please re-run"
" 'cfx %s'" % command)
else:
print >> sys.stderr, ("package.json needs modification:"
" please update it and then re-run"
" 'cfx %s'" % command)
sys.exit(1)
# if we make it this far, we have a JID
else:
assert command == "test"
if "id" in target_cfg:
jid = target_cfg["id"]
assert not jid.endswith("@jetpack")
unique_prefix = '%s-' % jid # used for resource: URLs
else:
# The Jetpack ID is not required for cfx test, in which case we have to
# make one up based on the GUID.
if options.use_server:
# The harness' contractID (hence also the jid and the harness_guid)
# need to be static in the "development mode", so that bootstrap.js
# can unload the previous version of the package being developed.
harness_guid = '2974c5b5-b671-46f8-a4bb-63c6eca6261b'
unique_prefix = '%s-' % target
jid = harness_guid
assert not jid.endswith("@jetpack")
if (jid.startswith("jid0-") or jid.startswith("anonid0-")):
bundle_id = jid + "@jetpack"
# Don't append "@jetpack" to old-style IDs, as they should be exactly
# as specified by the addon author so AMO and Firefox continue to treat
# their addon bundles as representing the same addon (and also because
# they may already have an @ sign in them, and there can be only one).
else:
bundle_id = jid
# the resource: URL's prefix is treated too much like a DNS hostname
unique_prefix = unique_prefix.lower()
unique_prefix = unique_prefix.replace("@", "-at-")
unique_prefix = unique_prefix.replace(".", "-dot-")
targets = [target]
if command == "test":
targets.append(options.test_runner_pkg)
if options.extra_packages:
targets.extend(options.extra_packages.split(","))
deps = packaging.get_deps_for_targets(pkg_cfg, targets)
build = packaging.generate_build_for_target(
pkg_cfg,
target,
deps,
prefix=unique_prefix, # used to create resource: URLs
include_dep_tests=options.dep_tests)
if 'resources' in build:
resources = build.resources
for name in resources:
resources[name] = os.path.abspath(resources[name])
harness_contract_id = ('@mozilla.org/harness-service;1?id=%s' % jid)
harness_options = {
'bootstrap': {
'contractID': harness_contract_id,
'classID': '{%s}' % harness_guid
},
'jetpackID': jid,
'bundleID': bundle_id,
'staticArgs': options.static_args,
'name': target,
}
harness_options.update(build)
if command == "test":
# This should be contained in the test runner package.
harness_options['main'] = 'run-tests'
else:
harness_options['main'] = target_cfg.get('main')
for option in inherited_options:
harness_options[option] = getattr(options, option)
harness_options['metadata'] = packaging.get_metadata(pkg_cfg, deps)
sdk_version = get_version(env_root)
harness_options['sdkVersion'] = sdk_version
packaging.call_plugins(pkg_cfg, deps)
retval = 0
if options.templatedir:
app_extension_dir = os.path.abspath(options.templatedir)
else:
mydir = os.path.dirname(os.path.abspath(__file__))
if sys.platform == "darwin":
# If we're on OS X, at least point into the XULRunner
# app dir so we run as a proper app if using XULRunner.
app_extension_dir = os.path.join(mydir, "Test App.app", "Contents",
"Resources")
else:
app_extension_dir = os.path.join(mydir, "app-extension")
if command == 'xpi':
from cuddlefish.xpi import build_xpi
from cuddlefish.rdf import gen_manifest, RDFUpdate
manifest = gen_manifest(template_root_dir=app_extension_dir,
target_cfg=target_cfg,
bundle_id=bundle_id,
update_url=options.update_url,
bootstrap=True)
if options.update_link:
rdf_name = UPDATE_RDF_FILENAME % target_cfg.name
print "Exporting update description to %s." % rdf_name
update = RDFUpdate()
update.add(manifest, options.update_link)
open(rdf_name, "w").write(str(update))
xpi_name = XPI_FILENAME % target_cfg.name
print "Exporting extension to %s." % xpi_name
build_xpi(template_root_dir=app_extension_dir,
manifest=manifest,
xpi_name=xpi_name,
harness_options=harness_options)
else:
if options.use_server:
from cuddlefish.server import run_app
else:
from cuddlefish.runner import run_app
if options.profiledir:
options.profiledir = os.path.expanduser(options.profiledir)
options.profiledir = os.path.abspath(options.profiledir)
if options.addons is not None:
options.addons = options.addons.split(",")
try:
retval = run_app(harness_root_dir=app_extension_dir,
harness_options=harness_options,
app_type=options.app,
binary=options.binary,
profiledir=options.profiledir,
verbose=options.verbose,
timeout=timeout,
logfile=options.logfile,
addons=options.addons)
except Exception, e:
if str(e).startswith(MOZRUNNER_BIN_NOT_FOUND):
print >> sys.stderr, MOZRUNNER_BIN_NOT_FOUND_HELP.strip()
retval = -1
else:
raise
def run(
arguments=sys.argv[1:], target_cfg=None, pkg_cfg=None, defaults=None, env_root=os.environ.get("CUDDLEFISH_ROOT")
):
parser_kwargs = dict(
arguments=arguments, parser_options=parser_options, parser_groups=parser_groups, usage=usage, defaults=defaults
)
(options, args) = parse_args(**parser_kwargs)
config_args = get_config_args(options.config, env_root)
# reparse configs with arguments from local.json
if config_args:
parser_kwargs["arguments"] += config_args
(options, args) = parse_args(**parser_kwargs)
command = args[0]
if command == "develop":
run_development_mode(env_root, defaults=options.__dict__)
return
if command == "testpkgs":
test_all_packages(env_root, defaults=options.__dict__)
return
elif command == "testex":
test_all_examples(env_root, defaults=options.__dict__)
return
elif command == "testall":
test_all(env_root, defaults=options.__dict__)
return
elif command == "testcfx":
test_cfx(env_root, options.verbose)
return
elif command == "docs":
import subprocess
import time
import cuddlefish.server
print "One moment."
popen = subprocess.Popen([sys.executable, cuddlefish.server.__file__, "daemonic"])
# TODO: See if there's actually a way to block on
# a particular event occurring, rather than this
# relatively arbitrary/generous amount.
time.sleep(cuddlefish.server.IDLE_WEBPAGE_TIMEOUT * 2)
return
elif command == "sdocs":
import cuddlefish.server
# TODO: Allow user to change this filename via cmd line.
filename = "jetpack-sdk-docs.tgz"
cuddlefish.server.generate_static_docs(env_root, filename)
print "Wrote %s." % filename
return
target_cfg_json = None
if not target_cfg:
if not options.pkgdir:
options.pkgdir = find_parent_package(os.getcwd())
if not options.pkgdir:
print >> sys.stderr, ("cannot find 'package.json' in the" " current directory or any parent.")
sys.exit(1)
else:
options.pkgdir = os.path.abspath(options.pkgdir)
if not os.path.exists(os.path.join(options.pkgdir, "package.json")):
print >> sys.stderr, ("cannot find 'package.json' in" " %s." % options.pkgdir)
sys.exit(1)
target_cfg_json = os.path.join(options.pkgdir, "package.json")
target_cfg = packaging.get_config_in_dir(options.pkgdir)
use_main = False
if command == "xpcom":
if "xpcom" not in target_cfg:
print >> sys.stderr, "package.json does not have a 'xpcom' entry."
sys.exit(1)
if not (options.moz_srcdir and options.moz_objdir):
print >> sys.stderr, "srcdir and objdir not specified."
sys.exit(1)
options.moz_srcdir = os.path.expanduser(options.moz_srcdir)
options.moz_objdir = os.path.expanduser(options.moz_objdir)
xpcom = target_cfg.xpcom
from cuddlefish.xpcom import build_xpcom_components
if "typelibs" in xpcom:
xpt_output_dir = packaging.resolve_dir(target_cfg, xpcom.typelibs)
else:
xpt_output_dir = None
build_xpcom_components(
comp_src_dir=packaging.resolve_dir(target_cfg, xpcom.src),
moz_srcdir=options.moz_srcdir,
moz_objdir=options.moz_objdir,
base_output_dir=packaging.resolve_dir(target_cfg, xpcom.dest),
xpt_output_dir=xpt_output_dir,
module_name=xpcom.module,
)
sys.exit(0)
elif command == "xpi":
use_main = True
elif command == "test":
if "tests" not in target_cfg:
target_cfg["tests"] = []
elif command == "run":
use_main = True
else:
print >> sys.stderr, "Unknown command: %s" % command
print >> sys.stderr, "Try using '--help' for assistance."
sys.exit(1)
if use_main and "main" not in target_cfg:
# If the user supplies a template dir, then the main
# program may be contained in the template.
if not options.templatedir:
print >> sys.stderr, "package.json does not have a 'main' entry."
sys.exit(1)
if not pkg_cfg:
pkg_cfg = packaging.build_config(env_root, target_cfg)
target = target_cfg.name
# TODO: Consider keeping a cache of dynamic UUIDs, based
# on absolute filesystem pathname, in the root directory
# or something.
if command in ("xpi", "run"):
from cuddlefish.preflight import preflight_config
if target_cfg_json:
config_was_ok, modified = preflight_config(
target_cfg, target_cfg_json, keydir=options.keydir, err_if_privkey_not_found=False
)
if not config_was_ok:
if modified:
# we need to re-read package.json . The safest approach
# is to re-run the "cfx xpi"/"cfx run" command.
print >> sys.stderr, ("package.json modified: please re-run" " 'cfx %s'" % command)
else:
print >> sys.stderr, (
"package.json needs modification:" " please update it and then re-run" " 'cfx %s'" % command
)
sys.exit(1)
# if we make it this far, we have a JID
jid = target_cfg["id"]
assert not jid.endswith("@jetpack")
unique_prefix = "%s-" % jid # used for resource: URLs
# the harness_guid is used for an XPCOM class ID. We use the
# JetpackID for the add-on ID and the XPCOM contract ID.
import uuid
harness_guid = str(uuid.uuid4())
else:
if options.use_server:
harness_guid = "2974c5b5-b671-46f8-a4bb-63c6eca6261b"
else:
harness_guid = "6724fc1b-3ec4-40e2-8583-8061088b3185"
unique_prefix = "%s-" % target
jid = harness_guid
assert not jid.endswith("@jetpack")
bundle_id = jid + "@jetpack"
# the resource: URLs prefix is treated too much like a DNS hostname
unique_prefix = unique_prefix.lower()
assert "@" not in unique_prefix
assert "." not in unique_prefix
timeout = None
targets = [target]
if not use_main:
timeout = TEST_RUN_TIMEOUT
targets.append(options.test_runner_pkg)
if options.extra_packages:
targets.extend(options.extra_packages.split(","))
deps = packaging.get_deps_for_targets(pkg_cfg, targets)
build = packaging.generate_build_for_target(
pkg_cfg,
target,
deps,
prefix=unique_prefix, # used to create resource: URLs
include_dep_tests=options.dep_tests,
)
if "resources" in build:
resources = build.resources
for name in resources:
resources[name] = os.path.abspath(resources[name])
dep_xpt_dirs = []
for dep in deps:
dep_cfg = pkg_cfg.packages[dep]
if "xpcom" in dep_cfg and "typelibs" in dep_cfg.xpcom:
abspath = packaging.resolve_dir(dep_cfg, dep_cfg.xpcom.typelibs)
dep_xpt_dirs.append(abspath)
xpts = get_xpts(dep_xpt_dirs)
harness_contract_id = "@mozilla.org/harness-service;1?id=%s" % jid
harness_options = {
"bootstrap": {"contractID": harness_contract_id, "classID": "{%s}" % harness_guid},
"jetpackID": jid,
"bundleID": bundle_id,
}
harness_options.update(build)
inherited_options = ["verbose"]
if use_main:
harness_options["main"] = target_cfg.get("main")
else:
harness_options["main"] = "run-tests"
inherited_options.extend(["iterations", "filter", "profileMemory"])
for option in inherited_options:
harness_options[option] = getattr(options, option)
harness_options["metadata"] = packaging.get_metadata(pkg_cfg, deps)
packaging.call_plugins(pkg_cfg, deps)
retval = 0
if options.templatedir:
app_extension_dir = os.path.abspath(options.templatedir)
else:
mydir = os.path.dirname(os.path.abspath(__file__))
if sys.platform == "darwin":
# If we're on OS X, at least point into the XULRunner
# app dir so we run as a proper app if using XULRunner.
app_extension_dir = os.path.join(mydir, "Test App.app", "Contents", "Resources")
else:
app_extension_dir = os.path.join(mydir, "app-extension")
if command == "xpi":
from cuddlefish.xpi import build_xpi
from cuddlefish.rdf import gen_manifest, RDFUpdate
manifest = gen_manifest(
template_root_dir=app_extension_dir,
target_cfg=target_cfg,
bundle_id=bundle_id,
update_url=options.update_url,
bootstrap=True,
)
if options.update_link:
rdf_name = UPDATE_RDF_FILENAME % target_cfg.name
print "Exporting update description to %s." % rdf_name
update = RDFUpdate()
update.add(manifest, options.update_link)
open(rdf_name, "w").write(str(update))
xpi_name = XPI_FILENAME % target_cfg.name
print "Exporting extension to %s." % xpi_name
build_xpi(
template_root_dir=app_extension_dir,
manifest=manifest,
xpi_name=xpi_name,
harness_options=harness_options,
xpts=xpts,
)
else:
if options.use_server:
from cuddlefish.server import run_app
else:
from cuddlefish.runner import run_app
if options.profiledir:
options.profiledir = os.path.expanduser(options.profiledir)
options.profiledir = os.path.abspath(options.profiledir)
if options.addons is not None:
options.addons = options.addons.split(",")
try:
retval = run_app(
harness_root_dir=app_extension_dir,
harness_options=harness_options,
xpts=xpts,
app_type=options.app,
binary=options.binary,
profiledir=options.profiledir,
verbose=options.verbose,
timeout=timeout,
logfile=options.logfile,
addons=options.addons,
)
except Exception, e:
if e.message.startswith(MOZRUNNER_BIN_NOT_FOUND):
print >> sys.stderr, MOZRUNNER_BIN_NOT_FOUND_HELP.strip()
retval = -1
else:
raise
def run(
arguments=sys.argv[1:], target_cfg=None, pkg_cfg=None, defaults=None, env_root=os.environ.get("CUDDLEFISH_ROOT")
):
parser_kwargs = dict(
arguments=arguments, parser_options=parser_options, parser_groups=parser_groups, usage=usage, defaults=defaults
)
(options, args) = parse_args(**parser_kwargs)
if options.config:
parser_kwargs["arguments"] += get_config_args(options.config, env_root)
(options, args) = parse_args(**parser_kwargs)
command = args[0]
if command == "testall":
test_all_packages(env_root, defaults=options.__dict__)
return
elif command == "docs":
import subprocess
import time
import cuddlefish.server
print "One moment."
popen = subprocess.Popen([sys.executable, cuddlefish.server.__file__, "daemonic"])
# TODO: See if there's actually a way to block on
# a particular event occurring, rather than this
# relatively arbitrary/generous amount.
time.sleep(cuddlefish.server.IDLE_WEBPAGE_TIMEOUT * 2)
return
if not target_cfg:
if not options.pkgdir:
options.pkgdir = find_parent_package(os.getcwd())
if not options.pkgdir:
print ("cannot find 'package.json' in the current " "directory or any parent.")
sys.exit(1)
else:
options.pkgdir = os.path.abspath(options.pkgdir)
if not os.path.exists(os.path.join(options.pkgdir, "package.json")):
print "cannot find 'package.json' in %s." % options.pkgdir
sys.exit(1)
target_cfg = packaging.get_config_in_dir(options.pkgdir)
use_main = False
if command == "xpcom":
if "xpcom" not in target_cfg:
print "package.json does not have a 'xpcom' entry."
sys.exit(1)
if not (options.moz_srcdir and options.moz_objdir):
print "srcdir and objdir not specified."
sys.exit(1)
options.moz_srcdir = os.path.expanduser(options.moz_srcdir)
options.moz_objdir = os.path.expanduser(options.moz_objdir)
xpcom = target_cfg.xpcom
from cuddlefish.xpcom import build_xpcom_components
if "typelibs" in xpcom:
xpt_output_dir = packaging.resolve_dir(target_cfg, xpcom.typelibs)
else:
xpt_output_dir = None
build_xpcom_components(
comp_src_dir=packaging.resolve_dir(target_cfg, xpcom.src),
moz_srcdir=options.moz_srcdir,
moz_objdir=options.moz_objdir,
base_output_dir=packaging.resolve_dir(target_cfg, xpcom.dest),
xpt_output_dir=xpt_output_dir,
module_name=xpcom.module,
)
sys.exit(0)
elif command == "xpi":
use_main = True
elif command == "test":
if "tests" not in target_cfg:
target_cfg["tests"] = []
elif command == "run":
use_main = True
else:
print "Unknown command: %s" % command
print "Try using '--help' for assistance."
sys.exit(1)
if use_main and "main" not in target_cfg:
# If the user supplies a template dir, then the main
# program may be contained in the template.
if not options.templatedir:
print "package.json does not have a 'main' entry."
sys.exit(1)
if not pkg_cfg:
pkg_cfg = packaging.build_config(env_root, target_cfg)
target = target_cfg.name
# TODO: Consider keeping a cache of dynamic UUIDs, based
# on absolute filesystem pathname, in the root directory
# or something.
if command == "xpi":
import uuid
harness_guid = str(uuid.uuid4())
unique_prefix = "%s-" % harness_guid
else:
if options.use_server:
harness_guid = "2974c5b5-b671-46f8-a4bb-63c6eca6261b"
else:
harness_guid = "6724fc1b-3ec4-40e2-8583-8061088b3185"
unique_prefix = "%s-" % target
identifier = target_cfg.get("id", "{%s}" % harness_guid)
timeout = None
targets = [target]
if not use_main:
timeout = TEST_RUN_TIMEOUT
targets.append("test-harness")
if options.extra_packages:
targets.extend(options.extra_packages.split(","))
deps = packaging.get_deps_for_targets(pkg_cfg, targets)
build = packaging.generate_build_for_target(
pkg_cfg, target, deps, prefix=unique_prefix, include_dep_tests=options.dep_tests
)
if "resources" in build:
resources = build.resources
for name in resources:
resources[name] = os.path.abspath(resources[name])
dep_xpt_dirs = []
for dep in deps:
dep_cfg = pkg_cfg.packages[dep]
if "xpcom" in dep_cfg and "typelibs" in dep_cfg.xpcom:
abspath = packaging.resolve_dir(dep_cfg, dep_cfg.xpcom.typelibs)
dep_xpt_dirs.append(abspath)
xpts = get_xpts(dep_xpt_dirs)
harness_contract_id = "@mozilla.org/harness-service;1?id=%s" % identifier
harness_options = {"bootstrap": {"contractID": harness_contract_id, "classID": "{%s}" % harness_guid}}
harness_options.update(build)
inherited_options = ["verbose"]
if use_main:
harness_options["main"] = target_cfg.get("main")
else:
harness_options["main"] = "run-tests"
inherited_options.extend(["iterations"])
for option in inherited_options:
harness_options[option] = getattr(options, option)
harness_options["metadata"] = packaging.get_metadata(pkg_cfg, deps)
packaging.call_plugins(pkg_cfg, deps)
retval = 0
if options.templatedir:
app_extension_dir = os.path.abspath(options.templatedir)
else:
app_extension_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), "app-extension")
if command == "xpi":
from cuddlefish.xpi import build_xpi
from cuddlefish.rdf import gen_manifest, RDFUpdate
manifest = gen_manifest(
template_root_dir=app_extension_dir,
target_cfg=target_cfg,
default_id=identifier,
update_url=options.update_url,
)
if options.update_link:
rdf_name = UPDATE_RDF_FILENAME % target_cfg.name
print "Exporting update description to %s." % rdf_name
update = RDFUpdate()
update.add(manifest, options.update_link)
open(rdf_name, "w").write(str(update))
xpi_name = XPI_FILENAME % target_cfg.name
print "Exporting extension to %s." % xpi_name
build_xpi(
template_root_dir=app_extension_dir,
manifest=manifest,
xpi_name=xpi_name,
harness_options=harness_options,
xpts=xpts,
)
else:
if options.use_server:
from cuddlefish.server import run_app
else:
from cuddlefish.runner import run_app
retval = run_app(
harness_root_dir=app_extension_dir,
harness_options=harness_options,
xpts=xpts,
app_type=options.app,
binary=options.binary,
verbose=options.verbose,
no_quit=options.no_quit,
timeout=timeout,
)
sys.exit(retval)
def run(
arguments=sys.argv[1:],
target_cfg=None,
pkg_cfg=None,
defaults=None,
env_root=os.environ.get("CUDDLEFISH_ROOT"),
stdout=sys.stdout,
):
parser_kwargs = dict(
arguments=arguments, global_options=global_options, parser_groups=parser_groups, usage=usage, defaults=defaults
)
(options, args) = parse_args(**parser_kwargs)
config_args = get_config_args(options.config, env_root)
# reparse configs with arguments from local.json
if config_args:
parser_kwargs["arguments"] += config_args
(options, args) = parse_args(**parser_kwargs)
command = args[0]
if command == "init":
initializer(env_root, args)
return
if command == "develop":
run_development_mode(env_root, defaults=options.__dict__)
return
if command == "testpkgs":
test_all_packages(env_root, defaults=options.__dict__)
return
elif command == "testex":
test_all_examples(env_root, defaults=options.__dict__)
return
elif command == "testall":
test_all(env_root, defaults=options.__dict__)
return
elif command == "testcfx":
test_cfx(env_root, options.verbose)
return
elif command == "docs":
import subprocess
import time
import cuddlefish.server
print >> stdout, "One moment."
popen = subprocess.Popen([sys.executable, cuddlefish.server.__file__, "daemonic"])
# TODO: See if there's actually a way to block on
# a particular event occurring, rather than this
# relatively arbitrary/generous amount.
time.sleep(cuddlefish.server.IDLE_WEBPAGE_TIMEOUT * 2)
return
elif command == "sdocs":
import cuddlefish.server
# TODO: Allow user to change this filename via cmd line.
filename = "addon-sdk-docs.tgz"
cuddlefish.server.generate_static_docs(env_root, filename, options.baseurl)
print >> stdout, "Wrote %s." % filename
return
target_cfg_json = None
if not target_cfg:
if not options.pkgdir:
options.pkgdir = find_parent_package(os.getcwd())
if not options.pkgdir:
print >> sys.stderr, ("cannot find 'package.json' in the" " current directory or any parent.")
sys.exit(1)
else:
options.pkgdir = os.path.abspath(options.pkgdir)
if not os.path.exists(os.path.join(options.pkgdir, "package.json")):
print >> sys.stderr, ("cannot find 'package.json' in" " %s." % options.pkgdir)
sys.exit(1)
target_cfg_json = os.path.join(options.pkgdir, "package.json")
target_cfg = packaging.get_config_in_dir(options.pkgdir)
# At this point, we're either building an XPI or running Jetpack code in
# a Mozilla application (which includes running tests).
use_main = False
timeout = None
inherited_options = ["verbose", "enable_e10s"]
if command == "xpi":
use_main = True
elif command == "test":
if "tests" not in target_cfg:
target_cfg["tests"] = []
timeout = TEST_RUN_TIMEOUT
inherited_options.extend(["iterations", "filter", "profileMemory"])
elif command == "run":
use_main = True
else:
print >> sys.stderr, "Unknown command: %s" % command
print >> sys.stderr, "Try using '--help' for assistance."
sys.exit(1)
if use_main and "main" not in target_cfg:
# If the user supplies a template dir, then the main
# program may be contained in the template.
if not options.templatedir:
print >> sys.stderr, "package.json does not have a 'main' entry."
sys.exit(1)
if not pkg_cfg:
pkg_cfg = packaging.build_config(env_root, target_cfg, options.packagepath)
target = target_cfg.name
# the harness_guid is used for an XPCOM class ID. We use the
# JetpackID for the add-on ID and the XPCOM contract ID.
if "harnessClassID" in target_cfg:
# For the sake of non-bootstrapped extensions, we allow to specify the
# classID of harness' XPCOM component in package.json. This makes it
# possible to register the component using a static chrome.manifest file
harness_guid = target_cfg["harnessClassID"]
else:
import uuid
harness_guid = str(uuid.uuid4())
# TODO: Consider keeping a cache of dynamic UUIDs, based
# on absolute filesystem pathname, in the root directory
# or something.
if command in ("xpi", "run"):
from cuddlefish.preflight import preflight_config
if target_cfg_json:
config_was_ok, modified = preflight_config(target_cfg, target_cfg_json)
if not config_was_ok:
if modified:
# we need to re-read package.json . The safest approach
# is to re-run the "cfx xpi"/"cfx run" command.
print >> sys.stderr, ("package.json modified: please re-run" " 'cfx %s'" % command)
else:
print >> sys.stderr, (
"package.json needs modification:" " please update it and then re-run" " 'cfx %s'" % command
)
sys.exit(1)
# if we make it this far, we have a JID
else:
assert command == "test"
if "id" in target_cfg:
jid = target_cfg["id"]
if not ("@" in jid or jid.startswith("{")):
jid = jid + "@jetpack"
unique_prefix = "%s-" % jid # used for resource: URLs
else:
# The Jetpack ID is not required for cfx test, in which case we have to
# make one up based on the GUID.
if options.use_server:
# The harness' contractID (hence also the jid and the harness_guid)
# need to be static in the "development mode", so that bootstrap.js
# can unload the previous version of the package being developed.
harness_guid = "2974c5b5-b671-46f8-a4bb-63c6eca6261b"
unique_prefix = "%s-" % target
jid = harness_guid
bundle_id = jid
# the resource: URL's prefix is treated too much like a DNS hostname
unique_prefix = unique_prefix.lower()
unique_prefix = unique_prefix.replace("@", "-at-")
unique_prefix = unique_prefix.replace(".", "-dot-")
targets = [target]
if command == "test":
targets.append(options.test_runner_pkg)
extra_packages = []
if options.extra_packages:
extra_packages = options.extra_packages.split(",")
if extra_packages:
targets.extend(extra_packages)
target_cfg.extra_dependencies = extra_packages
deps = packaging.get_deps_for_targets(pkg_cfg, targets)
from cuddlefish.manifest import build_manifest
uri_prefix = "resource://%s" % unique_prefix
# Figure out what loader files should be scanned. This is normally
# computed inside packaging.generate_build_for_target(), by the first
# dependent package that defines a "loader" property in its package.json.
# This property is interpreted as a filename relative to the top of that
# file, and stored as a URI in build.loader . generate_build_for_target()
# cannot be called yet (it needs the list of used_deps that
# build_manifest() computes, but build_manifest() needs the list of
# loader files that it computes). We could duplicate or factor out this
# build.loader logic, but that would be messy, so instead we hard-code
# the choice of loader for manifest-generation purposes. In practice,
# this means that alternative loaders probably won't work with
# --strip-xpi.
assert packaging.DEFAULT_LOADER == "api-utils"
assert pkg_cfg.packages["api-utils"].loader == "lib/cuddlefish.js"
cuddlefish_js_path = os.path.join(pkg_cfg.packages["api-utils"].root_dir, "lib", "cuddlefish.js")
loader_modules = [("api-utils", "lib", "cuddlefish", cuddlefish_js_path)]
manifest = build_manifest(target_cfg, pkg_cfg, deps, uri_prefix, False, loader_modules)
used_deps = manifest.get_used_packages()
if command == "test":
# The test runner doesn't appear to link against any actual packages,
# because it loads everything at runtime (invisible to the linker).
# If we believe that, we won't set up URI mappings for anything, and
# tests won't be able to run.
used_deps = deps
for xp in extra_packages:
if xp not in used_deps:
used_deps.append(xp)
build = packaging.generate_build_for_target(
pkg_cfg,
target,
used_deps,
prefix=unique_prefix, # used to create resource: URLs
include_dep_tests=options.dep_tests,
)
if "resources" in build:
resources = build.resources
for name in resources:
resources[name] = os.path.abspath(resources[name])
harness_contract_id = "@mozilla.org/harness-service;1?id=%s" % jid
harness_options = {
"bootstrap": {"contractID": harness_contract_id, "classID": "{%s}" % harness_guid},
"jetpackID": jid,
"bundleID": bundle_id,
"uriPrefix": uri_prefix,
"staticArgs": options.static_args,
"name": target,
}
harness_options.update(build)
if command == "test":
# This should be contained in the test runner package.
harness_options["main"] = "run-tests"
else:
harness_options["main"] = target_cfg.get("main")
for option in inherited_options:
harness_options[option] = getattr(options, option)
harness_options["metadata"] = packaging.get_metadata(pkg_cfg, used_deps)
sdk_version = get_version(env_root)
harness_options["sdkVersion"] = sdk_version
packaging.call_plugins(pkg_cfg, used_deps)
retval = 0
if options.templatedir:
app_extension_dir = os.path.abspath(options.templatedir)
else:
mydir = os.path.dirname(os.path.abspath(__file__))
if sys.platform == "darwin":
# If we're on OS X, at least point into the XULRunner
# app dir so we run as a proper app if using XULRunner.
app_extension_dir = os.path.join(mydir, "Test App.app", "Contents", "Resources")
else:
app_extension_dir = os.path.join(mydir, "app-extension")
harness_options["manifest"] = manifest.get_harness_options_manifest(uri_prefix)
if command == "xpi":
from cuddlefish.xpi import build_xpi
from cuddlefish.rdf import gen_manifest, RDFUpdate
manifest_rdf = gen_manifest(
template_root_dir=app_extension_dir,
target_cfg=target_cfg,
bundle_id=bundle_id,
update_url=options.update_url,
bootstrap=True,
)
if options.update_link:
rdf_name = UPDATE_RDF_FILENAME % target_cfg.name
print >> stdout, "Exporting update description to %s." % rdf_name
update = RDFUpdate()
update.add(manifest_rdf, options.update_link)
open(rdf_name, "w").write(str(update))
# ask the manifest what files were used, so we can construct an XPI
# without the rest. This will include the loader (and everything it
# uses) because of the "loader_modules" starting points we passed to
# build_manifest earlier
used_files = set(manifest.get_used_files())
if not options.strip_xpi:
used_files = None # disables the filter
xpi_name = XPI_FILENAME % target_cfg.name
print >> stdout, "Exporting extension to %s." % xpi_name
build_xpi(
template_root_dir=app_extension_dir,
manifest=manifest_rdf,
xpi_name=xpi_name,
harness_options=harness_options,
limit_to=used_files,
)
else:
if options.use_server:
from cuddlefish.server import run_app
else:
from cuddlefish.runner import run_app
if options.profiledir:
options.profiledir = os.path.expanduser(options.profiledir)
options.profiledir = os.path.abspath(options.profiledir)
if options.addons is not None:
options.addons = options.addons.split(",")
try:
retval = run_app(
harness_root_dir=app_extension_dir,
harness_options=harness_options,
app_type=options.app,
binary=options.binary,
profiledir=options.profiledir,
verbose=options.verbose,
timeout=timeout,
logfile=options.logfile,
addons=options.addons,
args=options.cmdargs,
norun=options.no_run,
)
except Exception, e:
if str(e).startswith(MOZRUNNER_BIN_NOT_FOUND):
print >> sys.stderr, MOZRUNNER_BIN_NOT_FOUND_HELP.strip()
retval = -1
else:
raise
# If we're on OS X, at least point into the XULRunner
# app dir so we run as a proper app if using XULRunner.
app_extension_dir = os.path.join(mydir, "Test App.app",
"Contents", "Resources")
else:
app_extension_dir = os.path.join(mydir, "app-extension")
harness_options['manifest'] = manifest.get_harness_options_manifest(uri_prefix)
if command == 'xpi':
from cuddlefish.xpi import build_xpi
from cuddlefish.rdf import gen_manifest, RDFUpdate
manifest_rdf = gen_manifest(template_root_dir=app_extension_dir,
target_cfg=target_cfg,
bundle_id=bundle_id,
update_url=options.update_url,
bootstrap=True)
if options.update_link:
rdf_name = UPDATE_RDF_FILENAME % target_cfg.name
print >>stdout, "Exporting update description to %s." % rdf_name
update = RDFUpdate()
update.add(manifest_rdf, options.update_link)
open(rdf_name, "w").write(str(update))
# ask the manifest what files were used, so we can construct an XPI
# without the rest. This will include the loader (and everything it
# uses) because of the "loader_modules" starting points we passed to
# build_manifest earlier
used_files = set(manifest.get_used_files())
