def validate_packaged_app(path,
listed=True,
format="json",
market_urls=None,
timeout=None,
spidermonkey=False):
"""
A handy function for validating apps.
`path`:
The path to the packaged app.
`listed`:
Whether the app is headed for the app marketplace.
`format`:
The output format to return the results in.
`market_urls`:
A list of URLs to use when validating the `installs_allowed_from`
field of the manifest. Does not apply if `listed` is not set to `True`.
`timeout`:
The amount of time (in seconds) that the validation process may take.
When this value is `None`, timeouts are disabled.
`spidermonkey`:
Path to the local spidermonkey installation. Defaults to `False`, which
uses the validator's built-in detection of Spidermonkey. Specifying
`None` will disable JavaScript tests. Any other value is treated as the
path.
"""
bundle = ErrorBundle(listed=listed, spidermonkey=spidermonkey)
bundle.save_resource("packaged", True)
# Set the market URLs.
bundle.save_resource("market_urls", market_urls)
submain.prepare_package(bundle, path, timeout)
return format_result(bundle, format)
def validate_packaged_app(path, listed=True, format="json", market_urls=None,
timeout=None, spidermonkey=False):
"""
A handy function for validating apps.
`path`:
The path to the packaged app.
`listed`:
Whether the app is headed for the app marketplace.
`format`:
The output format to return the results in.
`market_urls`:
A list of URLs to use when validating the `installs_allowed_from`
field of the manifest. Does not apply if `listed` is not set to `True`.
`timeout`:
The amount of time (in seconds) that the validation process may take.
When this value is `None`, timeouts are disabled.
`spidermonkey`:
Path to the local spidermonkey installation. Defaults to `False`, which
uses the validator's built-in detection of Spidermonkey. Specifying
`None` will disable JavaScript tests. Any other value is treated as the
path.
"""
bundle = ErrorBundle(listed=listed, spidermonkey=spidermonkey)
bundle.save_resource("packaged", True)
# Set the market URLs.
set_market_urls(market_urls)
submain.prepare_package(bundle, path, timeout)
return format_result(bundle, format)
def validate(path,
format='json',
approved_applications=os.path.join(os.path.dirname(__file__),
'app_versions.json'),
determined=True,
listed=True,
debug=False,
expectation=PACKAGE_ANY,
for_appversions=None,
overrides=None,
timeout=-1,
compat_test=False,
**kw):
"""
Perform validation in one easy step!
`path`:
*Required*
A file system path to the package to be validated.
`format`:
The format to return the results in. Defaults to "json". Currently, any
other format will simply return the error bundle.
`approved_applications`:
Path to the list of approved application versions
`determined`:
If set to `False`, validation will halt at the end of the first tier
that raises errors.
`listed`:
Whether the app is headed for the app marketplace or AMO. Defaults to
`True`.
`expectation`:
The type of package that should be expected. Must be a symbolic
constant from validator.constants (i.e.:
validator.constants.PACKAGE_*). Defaults to PACKAGE_ANY.
`for_appversions`:
A dict of app GUIDs referencing lists of versions. Determines which
version-dependant tests should be run.
`timeout`:
Number of seconds before aborting addon validation, or -1 to
run with no timeout.
`compat_tests`:
A flag to signal the validator to skip tests which should not be run
during compatibility bumps. Defaults to `False`.
"""
bundle = ErrorBundle(listed=listed,
determined=determined,
debug=debug,
overrides=overrides,
for_appversions=for_appversions)
bundle.save_resource('is_compat_test', compat_test)
if isinstance(approved_applications, types.StringTypes):
# Load up the target applications if the approved applications is a
# path (string).
with open(approved_applications) as approved_apps:
apps = json.load(approved_apps)
elif isinstance(approved_applications, dict):
# If the lists of approved applications are already in a dict, just use
# that instead of trying to pull from a file.
apps = approved_applications
else:
raise ValueError('Unknown format for `approved_applications`.')
constants.APPROVED_APPLICATIONS.clear()
constants.APPROVED_APPLICATIONS.update(apps)
submain.prepare_package(bundle,
path,
expectation,
for_appversions=for_appversions,
timeout=timeout)
return format_result(bundle, format)
def validate(path, format="json",
approved_applications=os.path.join(os.path.dirname(__file__),
"app_versions.json"),
determined=True,
spidermonkey=False,
listed=True,
expectation=PACKAGE_ANY,
for_appversions=None,
overrides=None,
timeout=None,
compat_test=False,
**kw):
"""
Perform validation in one easy step!
`path`:
*Required*
A file system path to the package to be validated.
`format`:
The format to return the results in. Defaults to "json". Currently, any
other format will simply return the error bundle.
`approved_applications`:
Path to the list of approved application versions
`determined`:
If set to `False`, validation will halt at the end of the first tier
that raises errors.
`spidermonkey`:
Path to the local spidermonkey installation. Defaults to `False`, which
uses the validator's built-in detection of Spidermonkey. Specifying
`None` will disable JavaScript tests. Any other value is treated as the
path.
`listed`:
Whether the app is headed for the app marketplace or AMO. Defaults to
`True`.
`expectation`:
The type of package that should be expected. Must be a symbolic constant
from validator.constants (i.e.: validator.constants.PACKAGE_*). Defaults
to PACKAGE_ANY.
`for_appversions`:
A dict of app GUIDs referencing lists of versions. Determines which
version-dependant tests should be run.
`timeout`:
Number of seconds before aborting addon validation.
`compat_tests`:
A flag to signal the validator to skip tests which should not be run
during compatibility bumps. Defaults to `False`.
"""
bundle = ErrorBundle(listed=listed, determined=determined,
overrides=overrides, spidermonkey=spidermonkey,
for_appversions=for_appversions)
bundle.save_resource("is_compat_test", compat_test)
if isinstance(approved_applications, types.StringTypes):
# Load up the target applications if the approved applications is a
# path (string).
with open(approved_applications) as approved_apps:
apps = json.load(approved_apps)
elif isinstance(approved_applications, dict):
# If the lists of approved applications are already in a dict, just use
# that instead of trying to pull from a file.
apps = approved_applications
else:
raise ValueError("Unknown format for `approved_applications`.")
constants.APPROVED_APPLICATIONS.clear()
constants.APPROVED_APPLICATIONS.update(apps)
submain.prepare_package(bundle, path, expectation,
for_appversions=for_appversions,
timeout=timeout)
return format_result(bundle, format)
