def make_sandbox(report,
config_dir,
cache_dir=None,
sandbox_dir=None,
extra_packages=[],
verbose=False,
log_timestamps=False,
dynamic_origins=False):
'''Build a sandbox with the packages that belong to a particular report.
This downloads and unpacks all packages from the report's Package and
Dependencies fields, plus all packages that ship the files from ProcMaps
(often, runtime plugins do not appear in Dependencies), plus optionally
some extra ones, for the distro release and architecture of the report.
For unpackaged executables, there are no Dependencies. Packages for shared
libaries are unpacked.
report is an apport.Report object to build a sandbox for. Presence of the
Package field determines whether to determine dependencies through
packaging (via the optional report['Dependencies'] field), or through ldd
via needed_runtime_packages() -> shared_libraries(). Usually
report['Architecture'] and report['Uname'] are present.
config_dir points to a directory with by-release configuration files for
the packaging system, or "system"; this is passed to
apport.packaging.install_packages(), see that method for details.
cache_dir points to a directory where the downloaded packages and debug
symbols are kept, which is useful if you create sandboxes very often. If
not given, the downloaded packages get deleted at program exit.
sandbox_dir points to a directory with a permanently unpacked sandbox with
the already unpacked packages. This speeds up operations even further if
you need to create sandboxes for different reports very often; but the
sandboxes can become very big over time, and you must ensure that an
already existing sandbox matches the DistroRelease: and Architecture: of
report. If not given, a temporary directory will be created which gets
deleted at program exit.
extra_packages can specify a list of additional packages to install which
are not derived from the report and will be installed along with their
dependencies.
If verbose is True (False by default), this will write some additional
logging to stdout.
If log_timestamps is True, these log messages will be prefixed with the
current time.
If dynamic_origins is True (False by default), the sandbox will be built
with packages from foreign origins that appear in the report's
Packages:/Dependencies:.
Return a tuple (sandbox_dir, cache_dir, outdated_msg).
'''
# sandbox
if sandbox_dir:
sandbox_dir = os.path.abspath(sandbox_dir)
if not os.path.isdir(sandbox_dir):
os.makedirs(sandbox_dir)
permanent_rootdir = True
else:
sandbox_dir = tempfile.mkdtemp(prefix='apport_sandbox_')
atexit.register(shutil.rmtree, sandbox_dir)
permanent_rootdir = False
# cache
if cache_dir:
cache_dir = os.path.abspath(cache_dir)
else:
cache_dir = tempfile.mkdtemp(prefix='apport_cache_')
atexit.register(shutil.rmtree, cache_dir)
pkgmap_cache_dir = os.path.join(cache_dir, report['DistroRelease'])
pkgs = []
# when ProcMaps is available and we don't have any third-party packages, it
# is enough to get the libraries in it and map their files to packages;
# otherwise, get Package/Dependencies
if 'ProcMaps' not in report or '[origin' in (
report.get('Package', '') + report.get('Dependencies', '')):
pkgs = needed_packages(report)
# add user-specified extra packages, if any
extra_pkgs = []
for p in extra_packages:
extra_pkgs.append((p, None))
if config_dir == 'system':
config_dir = None
origins = None
if dynamic_origins:
pkg_list = report.get('Package', '') + '\n' + report.get(
'Dependencies', '')
m = re.compile(r'\[origin: ([a-zA-Z0-9][a-zA-Z0-9\+\.\-]+)\]')
origins = set(m.findall(pkg_list))
if origins:
apport.log("Origins: %s" % origins)
# unpack packages, if any, using cache and sandbox
try:
outdated_msg = apport.packaging.install_packages(
sandbox_dir,
config_dir,
report['DistroRelease'],
pkgs,
verbose,
cache_dir,
permanent_rootdir,
architecture=report.get('Architecture'),
origins=origins)
except SystemError as e:
apport.fatal(str(e))
# install the extra packages and their deps
if extra_pkgs:
try:
outdated_msg += apport.packaging.install_packages(
sandbox_dir,
config_dir,
report['DistroRelease'],
extra_pkgs,
verbose,
cache_dir,
permanent_rootdir,
architecture=report.get('Architecture'),
origins=origins,
install_dbg=False,
install_deps=True)
except SystemError as e:
apport.fatal(str(e))
pkg_versions = report_package_versions(report)
pkgs = needed_runtime_packages(report, sandbox_dir, pkgmap_cache_dir,
pkg_versions, verbose)
# package hooks might reassign Package:, check that we have the originally
# crashing binary
for path in ('InterpreterPath', 'ExecutablePath'):
if path in report:
pkg = apport.packaging.get_file_package(
report[path],
True,
pkgmap_cache_dir,
release=report['DistroRelease'],
arch=report.get('Architecture'))
if pkg:
apport.log(
'Installing extra package %s to get %s' % (pkg, path),
log_timestamps)
pkgs.append((pkg, pkg_versions.get(pkg)))
else:
apport.fatal('Cannot find package which ships %s %s', path,
report[path])
# unpack packages for executable using cache and sandbox
if pkgs:
try:
outdated_msg += apport.packaging.install_packages(
sandbox_dir,
config_dir,
report['DistroRelease'],
pkgs,
verbose,
cache_dir,
permanent_rootdir,
architecture=report.get('Architecture'),
origins=origins)
except SystemError as e:
apport.fatal(str(e))
# sanity check: for a packaged binary we require having the executable in
# the sandbox; TODO: for an unpackage binary we don't currently copy its
# potential local library dependencies (like those in build trees) into the
# sandbox, and we call gdb/valgrind on the binary outside the sandbox.
if 'Package' in report:
for path in ('InterpreterPath', 'ExecutablePath'):
if path in report and not os.path.exists(sandbox_dir +
report[path]):
apport.fatal(
'%s %s does not exist (report specified package %s)', path,
sandbox_dir + report[path], report['Package'])
if outdated_msg:
report['RetraceOutdatedPackages'] = outdated_msg
apport.memdbg('built sandbox')
return sandbox_dir, cache_dir, outdated_msg
def make_sandbox(report, config_dir, cache_dir=None, sandbox_dir=None,
extra_packages=[], verbose=False, log_timestamps=False):
'''Build a sandbox with the packages that belong to a particular report.
This downloads and unpacks all packages from the report's Package and
Dependencies fields, plus all packages that ship the files from ProcMaps
(often, runtime plugins do not appear in Dependencies), plus optionally
some extra ones, for the distro release and architecture of the report.
For unpackaged executables, there are no Dependencies. Packages for shared
libaries are unpacked.
report is an apport.Report object to build a sandbox for. Presence of the
Package field determines whether to determine dependencies through
packaging (via the optional report['Dependencies'] field), or through ldd
via needed_runtime_packages() -> shared_libraries(). Usually
report['Architecture'] and report['Uname'] are present.
config_dir points to a directory with by-release configuration files for
the packaging system, or "system"; this is passed to
apport.packaging.install_packages(), see that method for details.
cache_dir points to a directory where the downloaded packages and debug
symbols are kept, which is useful if you create sandboxes very often. If
not given, the downloaded packages get deleted at program exit.
sandbox_dir points to a directory with a permanently unpacked sandbox with
the already unpacked packages. This speeds up operations even further if
you need to create sandboxes for different reports very often; but the
sandboxes can become very big over time, and you must ensure that an
already existing sandbox matches the DistroRelease: and Architecture: of
report. If not given, a temporary directory will be created which gets
deleted at program exit.
extra_packages can specify a list of additional packages to install which
are not derived from the report.
If verbose is True (False by default), this will write some additional
logging to stdout. If log_timestamps is True, these log messages will be
prefixed with the current time.
Return a tuple (sandbox_dir, cache_dir, outdated_msg).
'''
# sandbox
if sandbox_dir:
sandbox_dir = os.path.abspath(sandbox_dir)
if not os.path.isdir(sandbox_dir):
os.makedirs(sandbox_dir)
permanent_rootdir = True
else:
sandbox_dir = tempfile.mkdtemp(prefix='apport_sandbox_')
atexit.register(shutil.rmtree, sandbox_dir)
permanent_rootdir = False
# cache
if cache_dir:
cache_dir = os.path.abspath(cache_dir)
else:
cache_dir = tempfile.mkdtemp(prefix='apport_cache_')
atexit.register(shutil.rmtree, cache_dir)
pkgs = []
# when ProcMaps is available and we don't have any third-party packages, it
# is enough to get the libraries in it and map their files to packages;
# otherwise, get Package/Dependencies
if 'ProcMaps' not in report or '[origin' in (report.get('Package', '') + report.get('Dependencies', '')):
pkgs = needed_packages(report)
# add user-specified extra packages, if any
for p in extra_packages:
pkgs.append((p, None))
if config_dir == 'system':
config_dir = None
# unpack packages, if any, using cache and sandbox
try:
outdated_msg = apport.packaging.install_packages(
sandbox_dir, config_dir, report['DistroRelease'], pkgs,
verbose, cache_dir, permanent_rootdir,
architecture=report.get('Architecture'))
except SystemError as e:
sys.stderr.write(str(e) + '\n')
sys.exit(1)
pkgs = needed_runtime_packages(report, sandbox_dir, cache_dir, verbose)
# package hooks might reassign Package:, check that we have the originally
# crashing binary
for path in ('InterpreterPath', 'ExecutablePath'):
if path in report and not os.path.exists(sandbox_dir + report[path]):
pkg = apport.packaging.get_file_package(report[path], True, cache_dir,
release=report['DistroRelease'],
arch=report.get('Architecture'))
if pkg:
apport.log('Installing extra package %s to get %s' % (pkg, path), log_timestamps)
pkgs.append((pkg, None))
else:
apport.warning('Cannot find package which ships %s', path)
# unpack packages for executable using cache and sandbox
if pkgs:
try:
outdated_msg += apport.packaging.install_packages(
sandbox_dir, config_dir, report['DistroRelease'], pkgs,
cache_dir=cache_dir, architecture=report.get('Architecture'))
except SystemError as e:
sys.stderr.write(str(e) + '\n')
sys.exit(1)
# sanity check: for a packaged binary we require having the executable in
# the sandbox; TODO: for an unpackage binary we don't currently copy its
# potential local library dependencies (like those in build trees) into the
# sandbox, and we call gdb/valgrind on the binary outside the sandbox.
if 'Package' in report:
for path in ('InterpreterPath', 'ExecutablePath'):
if path in report and not os.path.exists(sandbox_dir + report[path]):
apport.error('%s %s does not exist (report specified package %s)',
path, sandbox_dir + report[path], report['Package'])
sys.exit(0)
if outdated_msg:
report['RetraceOutdatedPackages'] = outdated_msg
apport.memdbg('built sandbox')
return sandbox_dir, cache_dir, outdated_msg