def __init__(self): # instanticate the proper OS-specific Appifier utility class s = platform.system() if s == 'Darwin': import _osx as osappifier elif s == 'Linux': import _linux as osappifier elif s == 'Windows': import _win32 as osappifier self.osappifier = osappifier.OSAppifier() self.dirs = chromeless.Dirs()
def __init__(self): # instantiate a dirs object which has some important directories # as properties self.dirs = chromeless.Dirs()
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 == "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 == "sdocs": import docgen import chromeless dirname = os.path.join(chromeless.Dirs().build_dir, "docs") docgen.generate_static_docs(env_root, dirname) print "Created docs in %s." % dirname 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 == "package": use_main = True elif command == "appify": 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 ('package', 'run', 'appify'): 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, 'staticArgs': options.static_args, } 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 a = appifier.Appifier() if command == 'package': browser_code_path = json.loads(options.static_args)["browser"] a.output_xul_app(browser_code=browser_code_path, harness_options=harness_options, dev_mode=False) elif command == 'appify': browser_code_path = json.loads(options.static_args)["browser"] a.output_application(browser_code=browser_code_path, harness_options=harness_options, dev_mode=False) else: # on OSX we must invoke xulrunner from within a proper .app bundle, # otherwise many basic application features will not work. For instance # keyboard focus and mouse interactions will be broken. # for this reason, on OSX we'll actually generate a full standalone # application and launch that using the open command. On other # platforms we'll build a xulrunner application (directory) and # invoke xulrunner-bin pointing at that. browser_code_path = json.loads(options.static_args)["browser"] if options.profiledir: options.profiledir = os.path.expanduser(options.profiledir) options.profiledir = os.path.abspath(options.profiledir) if (platform.system() == 'Darwin'): # because of the manner in which we run the application, we must use a # temporary file to enable console output [fd, tmppath] = tempfile.mkstemp() os.close(fd) print "logging to '%s'" % tmppath harness_options['logFile'] = tmppath standalone_app_dir = a.output_application( browser_code=browser_code_path, harness_options=harness_options, dev_mode=True) print "opening '%s'" % standalone_app_dir tailProcess = None try: tailProcess = subprocess.Popen(["tail", "-f", tmppath]) retval = subprocess.call(["open", "-W", standalone_app_dir]) except KeyboardInterrupt: print "got ^C, exiting..." killProcessByName(standalone_app_dir) finally: tailProcess.terminate() os.remove(tmppath) else: xul_app_dir = a.output_xul_app(browser_code=browser_code_path, harness_options=harness_options, dev_mode=True) from cuddlefish.runner import run_app if options.addons is not None: options.addons = options.addons.split(",") try: retval = run_app(harness_root_dir=xul_app_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 sys.exit(retval)
def generate_static_docs(env_root, output_dir): docgen = DocGen(env_root=env_root) if os.path.exists(output_dir): shutil.rmtree(output_dir) # first, copy static-files shutil.copytree(docgen.root, output_dir) # py2.5 doesn't have ignore=, so we delete tempfiles afterwards. If we # required >=py2.6, we could use ignore=shutil.ignore_patterns("*~") for (dirpath, dirnames, filenames) in os.walk(output_dir): for n in filenames: if n.endswith("~"): os.unlink(os.path.join(dirpath, n)) # iterate through each package and generate docs for it extractor = DocStract() apidocs = {} path_to_modules = os.path.join(chromeless.Dirs().cuddlefish_root, "modules") for pkg_name in os.listdir(path_to_modules): path = os.path.join(path_to_modules, pkg_name) oldPath = os.getcwd() os.chdir(path) isInternal = False if (pkg_name == "internal"): isInternal = True apidocs[pkg_name] = {"name": pkg_name} # now we'll walk the lib dir and generate documenation for each module for root, dirs, files in os.walk(path): for f in files: if f[-8:] == ".test.js": continue if f[-3:] == ".js": # now get the lib/ relative path of this module relpath = os.path.join(root, f)[len(path) + 1:] try: moduleDocs = extractor.extractFromFile(relpath) # insert module documentation into the great map if not 'modules' in apidocs[pkg_name]: apidocs[pkg_name]['modules'] = {} apidocs[pkg_name]['modules'][ moduleDocs['module']] = moduleDocs apidocs[pkg_name]['modules'][ moduleDocs['module']]["internal"] = isInternal except Exception as e: print "WARNING, skipping module due to malformed docs (%s/lib/%s):" % ( pkg_name, relpath) print " %s" % re.sub("\n", " ", str(e)) pass os.chdir(oldPath) # add version number if available version = chromeless.version() if not version == None: apidocs["version"] = version apidocs_path = os.path.join(output_dir, 'apidocs.json') open(apidocs_path, 'w').write(json.dumps(apidocs, sort_keys=True, indent=2))
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 == "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 == "sdocs": import docgen import chromeless dirname = os.path.join(chromeless.Dirs().build_dir, "docs") docgen.generate_static_docs(env_root, dirname) print "Created docs in %s." % dirname return use_main = False timeout = None inherited_options = ['verbose', 'enable_e10s'] if command in ("run", "package", "appify"): use_main = True elif command == "test": timeout = TEST_RUN_TIMEOUT inherited_options.extend(['iterations', 'filter', 'profileMemory']) else: print >>sys.stderr, "Unknown command: %s" % command print >>sys.stderr, "Try using '--help' for assistance." sys.exit(1) target = "main" # the harness_guid is used for an XPCOM class ID. import uuid harness_guid = str(uuid.uuid4()) targets = [target] if command == "test": targets.append(options.test_runner_pkg) if options.extra_packages: targets.extend(options.extra_packages.split(",")) resources = { } rootPaths = [ ] import chromeless path_to_modules = os.path.join(chromeless.Dirs().cuddlefish_root, "modules") for f in os.listdir(path_to_modules): resourceName = harness_guid + "-" + f resources[resourceName] = os.path.join(path_to_modules, f) rootPaths.append("resource://" + resourceName + "/"); # now add custom modules as specified by the app app_info = chromeless.AppInfo(dir=options.static_args["browser"]) if app_info.module_dirs: ac_path = options.static_args["browser"] if os.path.isfile(ac_path): ac_path = os.path.dirname(ac_path) for d in app_info.module_dirs: resourceName = harness_guid + "-appmodules-" + os.path.basename(d) if not os.path.isabs(d): d = os.path.normpath(os.path.join(ac_path, d)) resources[resourceName] = d rootPaths.append("resource://" + resourceName + "/") harness_contract_id = ('@mozilla.org/harness-service;1?id=%s' % harness_guid) harness_options = { 'bootstrap': { 'contractID': harness_contract_id, 'classID': '{%s}' % harness_guid }, 'jetpackID': harness_guid, 'bundleID': harness_guid, 'staticArgs': options.static_args, 'resources': resources, 'loader': "resource://%s-%s/%s" % (harness_guid, "internal", "cuddlefish.js"), 'rootPaths': rootPaths } if command == "test": harness_options['main'] = 'test_harness/run-tests' # XXX: we should write 'test-app' into a tempdir... harness_options['testDir'] = os.path.join(chromeless.Dirs().cuddlefish_root, "modules", "internal", "test_harness") resourceName = harness_guid + "-app-tests" resources[resourceName] = os.path.join(harness_options['testDir']) rootPaths.append("resource://" + resourceName + "/"); else: harness_options['main'] = 'main' retval = 0 a = appifier.Appifier() if command == 'package': browser_code_path = options.static_args["browser"] a.output_xul_app(browser_code=browser_code_path, harness_options=harness_options, dev_mode=False) elif command == 'appify': browser_code_path = options.static_args["browser"] a.output_application(browser_code=browser_code_path, harness_options=harness_options, dev_mode=False) else: browser_code_path = options.static_args["browser"] 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(",") print "app code path: " + browser_code_path if (platform.system() == 'Darwin'): # because of the manner in which we run the application, we must use a # temporary file to enable console output [fd, tmppath] = tempfile.mkstemp() os.close(fd) print "And logging to '%s'" % tmppath harness_options['logFile'] = tmppath standalone_app_dir = a.output_application(browser_code=browser_code_path, harness_options=harness_options, dev_mode=True, verbose=False) print "opening '%s'" % standalone_app_dir tailProcess = None try: import subprocess tailProcess = subprocess.Popen(["tail", "-f", tmppath]) retval = subprocess.call(["open", "-W", standalone_app_dir]) except KeyboardInterrupt: print "got ^C, exiting..." killProcessByName(standalone_app_dir) finally: tailProcess.terminate() os.remove(tmppath) else: xul_app_dir = a.output_xul_app(browser_code=browser_code_path, harness_options=harness_options, dev_mode=True, verbose=False) from cuddlefish.runner import run_app try: retval = run_app(harness_root_dir=xul_app_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 sys.exit(retval)
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 == "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 == "sdocs": import docgen import chromeless dirname = os.path.join(chromeless.Dirs().build_dir, "docs") docgen.generate_static_docs(env_root, dirname) print "Created docs in %s." % dirname 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 if command == "appify": 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', 'appify'): 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: 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, } 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 a = appifier.Appifier() if command == 'package': browser_code_path = options.static_args["browser"] a.output_xul_app(browser_code=browser_code_path, harness_options=harness_options, dev_mode=False) elif command == 'appify': browser_code_path = options.static_args["browser"] a.output_application(browser_code=browser_code_path, harness_options=harness_options, dev_mode=False) if command == 'run': browser_code_path = options.static_args["browser"] 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(",") if (platform.system() == 'Darwin'): # because of the manner in which we run the application, we mus t use a # temporary file to enable console output [fd, tmppath] = tempfile.mkstemp() os.close(fd) print "__init__: tmppath" + tmppath print "__init__: browser code path: " + browser_code_path print "And logging to '%s'" % tmppath harness_options['logFile'] = tmppath standalone_app_dir = a.output_application( browser_code=browser_code_path, harness_options=harness_options, dev_mode=True) print "opening '%s'" % standalone_app_dir tailProcess = None try: import subprocess tailProcess = subprocess.Popen(["tail", "-f", tmppath]) retval = subprocess.call(["open", "-W", standalone_app_dir]) except KeyboardInterrupt: print "got ^C, exiting..." killProcessByName(standalone_app_dir) finally: tailProcess.terminate() os.remove(tmppath) 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(",") app_extension_dir = os.path.join(env_root, "impl", "appifier", "resources", "xulrunner.template") 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